summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorTor Andersson <tor.andersson@artifex.com>2015-12-15 11:31:36 +0100
committerTor Andersson <tor.andersson@artifex.com>2015-12-15 14:11:10 +0100
commit3afdcd7307fd5e68f35c7bb91a4d856499f1df44 (patch)
tree13253bb6d7af2716f882e878be956fa157544ec6 /include
parent88a1d527a50e3cc48606ce097a335669ae84a716 (diff)
downloadmupdf-3afdcd7307fd5e68f35c7bb91a4d856499f1df44.tar.xz
Rename fz_write_x to fz_save_pixmap_as_x or fz_save_bitmap_as_x.
Separate naming of functions that save complete files to disk from functions that write data to streams.
Diffstat (limited to 'include')
-rw-r--r--include/mupdf/fitz/document.h10
-rw-r--r--include/mupdf/fitz/output-pcl.h4
-rw-r--r--include/mupdf/fitz/output-png.h4
-rw-r--r--include/mupdf/fitz/output-pnm.h12
-rw-r--r--include/mupdf/fitz/output-pwg.h8
-rw-r--r--include/mupdf/fitz/output-tga.h2
-rw-r--r--include/mupdf/fitz/write-document.h10
-rw-r--r--include/mupdf/pdf/clean.h2
-rw-r--r--include/mupdf/pdf/output-pdf.h4
9 files changed, 28 insertions, 28 deletions
diff --git a/include/mupdf/fitz/document.h b/include/mupdf/fitz/document.h
index ff399dba..459a5fbd 100644
--- a/include/mupdf/fitz/document.h
+++ b/include/mupdf/fitz/document.h
@@ -27,7 +27,7 @@ typedef enum
fz_permission;
// TODO: move out of this interface (it's pdf specific)
-typedef struct fz_write_options_s fz_write_options;
+typedef struct fz_save_options_s fz_save_options;
typedef void (fz_document_close_fn)(fz_context *ctx, fz_document *doc);
typedef int (fz_document_needs_password_fn)(fz_context *ctx, fz_document *doc);
@@ -38,7 +38,7 @@ typedef void (fz_document_layout_fn)(fz_context *ctx, fz_document *doc, float w,
typedef int (fz_document_count_pages_fn)(fz_context *ctx, fz_document *doc);
typedef fz_page *(fz_document_load_page_fn)(fz_context *ctx, fz_document *doc, int number);
typedef int (fz_document_lookup_metadata_fn)(fz_context *ctx, fz_document *doc, const char *key, char *buf, int size);
-typedef void (fz_document_write_fn)(fz_context *ctx, fz_document *doc, char *filename, fz_write_options *opts);
+typedef void (fz_document_save_fn)(fz_context *ctx, fz_document *doc, char *filename, fz_save_options *opts);
typedef fz_link *(fz_page_load_links_fn)(fz_context *ctx, fz_page *page);
typedef fz_rect *(fz_page_bound_page_fn)(fz_context *ctx, fz_page *page, fz_rect *);
@@ -86,7 +86,7 @@ struct fz_document_s
fz_document_count_pages_fn *count_pages;
fz_document_load_page_fn *load_page;
fz_document_lookup_metadata_fn *lookup_metadata;
- fz_document_write_fn *write;
+ fz_document_save_fn *save;
int did_layout;
};
@@ -397,7 +397,7 @@ int fz_separation_disabled_on_page (fz_context *ctx, fz_page *, int sep);
const char *fz_get_separation_on_page(fz_context *ctx, fz_page *page, int sep, uint32_t *rgba, uint32_t *cmyk);
/*
- fz_write_gproof_file: Given a currently open document, create a
+ fz_save_gproof: Given a currently open document, create a
gproof skeleton file from that document.
doc_filename: The name of the currently opened document file.
@@ -412,7 +412,7 @@ const char *fz_get_separation_on_page(fz_context *ctx, fz_page *page, int sep, u
display_profile: The filename of the ICC profile for our display device
*/
-void fz_write_gproof_file(fz_context *ctx, const char *doc_filename, fz_document *doc, const char *filename, int res,
+void fz_save_gproof(fz_context *ctx, const char *doc_filename, fz_document *doc, const char *filename, int res,
const char *print_profile, const char *display_profile);
#endif
diff --git a/include/mupdf/fitz/output-pcl.h b/include/mupdf/fitz/output-pcl.h
index 778b31fb..83f6cd79 100644
--- a/include/mupdf/fitz/output-pcl.h
+++ b/include/mupdf/fitz/output-pcl.h
@@ -93,8 +93,8 @@ void fz_output_pcl(fz_context *ctx, fz_output *out, const fz_pixmap *pixmap, fz_
void fz_output_pcl_bitmap(fz_context *ctx, fz_output *out, const fz_bitmap *bitmap, fz_pcl_options *pcl);
-void fz_write_pcl(fz_context *ctx, fz_pixmap *pixmap, char *filename, int append, fz_pcl_options *pcl);
+void fz_save_pixmap_as_pcl(fz_context *ctx, fz_pixmap *pixmap, char *filename, int append, fz_pcl_options *pcl);
-void fz_write_pcl_bitmap(fz_context *ctx, fz_bitmap *bitmap, char *filename, int append, fz_pcl_options *pcl);
+void fz_save_bitmap_as_pcl(fz_context *ctx, fz_bitmap *bitmap, char *filename, int append, fz_pcl_options *pcl);
#endif
diff --git a/include/mupdf/fitz/output-png.h b/include/mupdf/fitz/output-png.h
index 63c167e9..3ae6d3d0 100644
--- a/include/mupdf/fitz/output-png.h
+++ b/include/mupdf/fitz/output-png.h
@@ -11,11 +11,11 @@
#include "mupdf/fitz/image.h"
/*
- fz_write_png: Save a pixmap as a png
+ fz_save_pixmap_as_png: Save a pixmap as a png
filename: The filename to save as (including extension).
*/
-void fz_write_png(fz_context *ctx, fz_pixmap *pixmap, char *filename, int savealpha);
+void fz_save_pixmap_as_png(fz_context *ctx, fz_pixmap *pixmap, const char *filename, int savealpha);
/*
Output a pixmap to an output stream as a png.
diff --git a/include/mupdf/fitz/output-pnm.h b/include/mupdf/fitz/output-pnm.h
index 0ea8a894..33dcde4e 100644
--- a/include/mupdf/fitz/output-pnm.h
+++ b/include/mupdf/fitz/output-pnm.h
@@ -8,27 +8,27 @@
#include "mupdf/fitz/bitmap.h"
/*
- fz_write_pnm: Save a pixmap as a PNM image file.
+ fz_save_pixmap_as_pnm: Save a pixmap as a PNM image file.
*/
-void fz_write_pnm(fz_context *ctx, fz_pixmap *pixmap, char *filename);
+void fz_save_pixmap_as_pnm(fz_context *ctx, fz_pixmap *pixmap, char *filename);
void fz_output_pnm(fz_context *ctx, fz_output *out, fz_pixmap *pixmap);
void fz_output_pnm_header(fz_context *ctx, fz_output *out, int w, int h, int n);
void fz_output_pnm_band(fz_context *ctx, fz_output *out, int w, int h, int n, int band, int bandheight, unsigned char *p);
/*
- fz_write_pam: Save a pixmap as a PAM image file.
+ fz_save_pixmap_as_pam: Save a pixmap as a PAM image file.
*/
-void fz_write_pam(fz_context *ctx, fz_pixmap *pixmap, char *filename, int savealpha);
+void fz_save_pixmap_as_pam(fz_context *ctx, fz_pixmap *pixmap, char *filename, int savealpha);
void fz_output_pam(fz_context *ctx, fz_output *out, fz_pixmap *pixmap, int savealpha);
void fz_output_pam_header(fz_context *ctx, fz_output *out, int w, int h, int n, int savealpha);
void fz_output_pam_band(fz_context *ctx, fz_output *out, int w, int h, int n, int band, int bandheight, unsigned char *sp, int savealpha);
/*
- fz_write_pbm: Save a bitmap as a PBM image file.
+ fz_save_bitmap_as_pbm: Save a bitmap as a PBM image file.
*/
-void fz_write_pbm(fz_context *ctx, fz_bitmap *bitmap, char *filename);
+void fz_save_bitmap_as_pbm(fz_context *ctx, fz_bitmap *bitmap, char *filename);
void fz_output_pbm(fz_context *ctx, fz_output *out, fz_bitmap *bitmap);
diff --git a/include/mupdf/fitz/output-pwg.h b/include/mupdf/fitz/output-pwg.h
index d2bb4a1f..6d399848 100644
--- a/include/mupdf/fitz/output-pwg.h
+++ b/include/mupdf/fitz/output-pwg.h
@@ -52,7 +52,7 @@ struct fz_pwg_options_s
};
/*
- fz_write_pwg: Save a pixmap as a pwg
+ fz_save_pixmap_as_pwg: Save a pixmap as a pwg
filename: The filename to save as (including extension).
@@ -61,10 +61,10 @@ struct fz_pwg_options_s
pwg: NULL, or a pointer to an options structure (initialised to zero
before being filled in, for future expansion).
*/
-void fz_write_pwg(fz_context *ctx, fz_pixmap *pixmap, char *filename, int append, const fz_pwg_options *pwg);
+void fz_save_pixmap_as_pwg(fz_context *ctx, fz_pixmap *pixmap, char *filename, int append, const fz_pwg_options *pwg);
/*
- fz_write_pwg_bitmap: Save a bitmap as a pwg
+ fz_save_bitmap_as_pwg: Save a bitmap as a pwg
filename: The filename to save as (including extension).
@@ -73,7 +73,7 @@ void fz_write_pwg(fz_context *ctx, fz_pixmap *pixmap, char *filename, int append
pwg: NULL, or a pointer to an options structure (initialised to zero
before being filled in, for future expansion).
*/
-void fz_write_pwg_bitmap(fz_context *ctx, fz_bitmap *bitmap, char *filename, int append, const fz_pwg_options *pwg);
+void fz_save_bitmap_as_pwg(fz_context *ctx, fz_bitmap *bitmap, char *filename, int append, const fz_pwg_options *pwg);
/*
Output a pixmap to an output stream as a pwg raster.
diff --git a/include/mupdf/fitz/output-tga.h b/include/mupdf/fitz/output-tga.h
index 316eb182..4bd9e2ba 100644
--- a/include/mupdf/fitz/output-tga.h
+++ b/include/mupdf/fitz/output-tga.h
@@ -5,6 +5,6 @@
#include "mupdf/fitz/context.h"
#include "mupdf/fitz/pixmap.h"
-void fz_write_tga(fz_context *ctx, fz_pixmap *pixmap, const char *filename, int savealpha);
+void fz_save_pixmap_as_tga(fz_context *ctx, fz_pixmap *pixmap, const char *filename, int savealpha);
#endif
diff --git a/include/mupdf/fitz/write-document.h b/include/mupdf/fitz/write-document.h
index a26077e9..f3974e71 100644
--- a/include/mupdf/fitz/write-document.h
+++ b/include/mupdf/fitz/write-document.h
@@ -6,11 +6,11 @@
#include "mupdf/fitz/document.h"
/*
- In calls to fz_write, the following options structure can be used
+ In calls to fz_save_document, the following options structure can be used
to control aspects of the writing process. This structure may grow
in future, and should be zero-filled to allow forwards compatiblity.
*/
-struct fz_write_options_s
+struct fz_save_options_s
{
int do_incremental; /* Write just the changed objects */
int do_ascii; /* If non-zero then attempt (where possible) to make
@@ -29,7 +29,7 @@ struct fz_write_options_s
};
/* An enumeration of bitflags to use in the above 'do_expand' field of
- fz_write_options.
+ fz_save_options.
*/
enum
{
@@ -39,7 +39,7 @@ enum
};
/*
- fz_write: Write a document out.
+ fz_save_document: Write a document out to a file.
(In development - Subject to change in future versions)
@@ -54,6 +54,6 @@ enum
May throw exceptions.
*/
-void fz_write_document(fz_context *ctx, fz_document *doc, char *filename, fz_write_options *opts);
+void fz_save_document(fz_context *ctx, fz_document *doc, char *filename, fz_save_options *opts);
#endif
diff --git a/include/mupdf/pdf/clean.h b/include/mupdf/pdf/clean.h
index 11ebf0c7..f1068cfb 100644
--- a/include/mupdf/pdf/clean.h
+++ b/include/mupdf/pdf/clean.h
@@ -2,6 +2,6 @@
#define MUPDF_PDF_CLEAN_H
/* Read infile, and write selected pages to outfile with the given options. */
-void pdf_clean_file(fz_context *ctx, char *infile, char *outfile, char *password, fz_write_options *opts, char *retainlist[], int retainlen);
+void pdf_clean_file(fz_context *ctx, char *infile, char *outfile, char *password, fz_save_options *opts, char *retainlist[], int retainlen);
#endif
diff --git a/include/mupdf/pdf/output-pdf.h b/include/mupdf/pdf/output-pdf.h
index 617d32fc..a1506dfb 100644
--- a/include/mupdf/pdf/output-pdf.h
+++ b/include/mupdf/pdf/output-pdf.h
@@ -13,9 +13,9 @@
fz_device *pdf_new_pdf_device(fz_context *ctx, pdf_document *doc, pdf_obj *contents, pdf_obj *resources, const fz_matrix *ctm, fz_buffer *buf);
/*
- pdf_write_document: Write out the document to a file with all changes finalised.
+ pdf_save_document: Write out the document to a file with all changes finalised.
*/
-void pdf_write_document(fz_context *ctx, pdf_document *doc, char *filename, fz_write_options *opts);
+void pdf_save_document(fz_context *ctx, pdf_document *doc, char *filename, fz_save_options *opts);
void pdf_localise_page_resources(fz_context *ctx, pdf_document *doc);