Bug 691691: Add way of clearing cached objects out of the xref.

We add various facilities here, intended to allow us to efficiently
minimise the memory we use for holding cached pdf objects.

Firstly, we add the ability to 'mark' all the currently loaded objects.

Next we add the ability to 'clear the xref' - to drop all the currently
loaded objects that have no other references except the ones held by the
xref table itself.

Finally, we add the ability to 'clear the xref to the last mark' - to
drop all the currently loaded objects that have been created since the
last 'mark' operation and have no other references except the ones held
by the xref table.

We expose this to the user by adding a new device hint 'FZ_NO_CACHE'.
If set on the device, then the PDF interpreter will pdf_mark_xref before
starting and pdf_clear_xref_to_mark afterwards. Thus no additional
objects will be retained in memory after a given page is run, unless
someone else picks them up and takes a reference to them as part of
the run.

We amend our simple example app to set this device hint when loading
pages as part of a search.

1 files changed, 11 insertions, 1 deletions

diff --git a/include/mupdf/pdf/xref.h b/include/mupdf/pdf/xref.h
index f9e1657f..5f1a49d1 100644
--- a/include/mupdf/pdf/xref.h
+++ b/include/mupdf/pdf/xref.h
@@ -35,13 +35,19 @@ typedef struct pdf_xref_entry_s pdf_xref_entry;
 struct pdf_xref_entry_s
 {
 	char type;	/* 0=unset (f)ree i(n)use (o)bjstm */
+	unsigned char flags; /* bit 0 = marked */
+	unsigned short gen;	/* generation / objstm index */
 	int ofs;	/* file offset / objstm object number */
-	int gen;	/* generation / objstm index */
 	int stm_ofs;	/* on-disk stream */
 	fz_buffer *stm_buf; /* in-memory stream (for updated objects) */
 	pdf_obj *obj;	/* stored/cached object */
 };
 
+enum
+{
+	PDF_OBJ_FLAG_MARK = 1,
+};
+
 struct pdf_xref_s
 {
 	int len;
@@ -83,6 +89,10 @@ void pdf_repair_xref(pdf_document *doc, pdf_lexbuf *buf);
 void pdf_repair_obj_stms(pdf_document *doc);
 pdf_obj *pdf_new_ref(pdf_document *doc, pdf_obj *obj);
 
+void pdf_mark_xref(pdf_document *doc);
+void pdf_clear_xref(pdf_document *doc);
+void pdf_clear_xref_to_mark(pdf_document *doc);
+
 int pdf_repair_obj(pdf_document *doc, pdf_lexbuf *buf, int *stmofsp, int *stmlenp, pdf_obj **encrypt, pdf_obj **id, pdf_obj **page, int *tmpofs);
 
 pdf_obj *pdf_progressive_advance(pdf_document *doc, int pagenum);