Fri, 21 Feb 2003 12:29:16 +0000
updated HDRS
1 /*
2 * t2p: Create a PDF file from the contents of one or more TIFF
3 * bilevel image files. The images in the resulting PDF file
4 * will be compressed using ITU-T T.6 (G4) fax encoding.
5 *
6 * PDF routines
7 * $Id: pdf_prim.h,v 1.4 2003/02/21 02:49:11 eric Exp $
8 * Copyright 2001, 2002, 2003 Eric Smith <eric@brouhaha.com>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation. Note that permission is
13 * not granted to redistribute this program under the terms of any
14 * other version of the General Public License.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
24 */
27 typedef enum
28 {
29 PT_BAD,
31 /* scalar */
32 PT_NULL,
33 PT_BOOL,
34 PT_NAME,
35 PT_STRING,
36 PT_INTEGER,
37 PT_REAL,
38 PT_IND_REF,
40 /* composite */
41 PT_DICTIONARY,
42 PT_ARRAY,
43 PT_STREAM
44 } pdf_obj_type;
47 struct pdf_obj;
50 typedef void (*pdf_stream_write_callback)(pdf_file_handle pdf_file,
51 struct pdf_obj *stream,
52 void *app_data);
55 void pdf_set_dict_entry (struct pdf_obj *dict_obj, char *key, struct pdf_obj *val);
56 struct pdf_obj *pdf_get_dict_entry (struct pdf_obj *dict_obj, char *key);
59 void pdf_add_array_elem (struct pdf_obj *array_obj, struct pdf_obj *val);
62 /* Create a new object that will NOT be used indirectly */
63 struct pdf_obj *pdf_new_obj (pdf_obj_type type);
65 struct pdf_obj *pdf_new_bool (bool val);
67 struct pdf_obj *pdf_new_name (char *name);
69 struct pdf_obj *pdf_new_string (char *str);
71 struct pdf_obj *pdf_new_integer (unsigned long val);
73 struct pdf_obj *pdf_new_real (double val);
76 /* Create a new indirect object */
77 struct pdf_obj *pdf_new_ind_ref (pdf_file_handle pdf_file, struct pdf_obj *obj);
79 /* get the object referenced by an indirect reference */
80 struct pdf_obj *pdf_deref_ind_obj (struct pdf_obj *ind_obj);
83 unsigned long pdf_get_integer (struct pdf_obj *obj);
84 void pdf_set_integer (struct pdf_obj *obj, unsigned long val);
87 double pdf_get_real (struct pdf_obj *obj);
88 void pdf_set_real (struct pdf_obj *obj, double val);
91 /* The callback will be called when the stream data is to be written to the
92 file. app_data will be passed as an argument to the callback. */
93 struct pdf_obj *pdf_new_stream (pdf_file_handle pdf_file,
94 struct pdf_obj *stream_dict,
95 pdf_stream_write_callback callback,
96 void *app_data);
98 /* The callback should call pdf_stream_write_bits(), pdf_stream_write_data(),
99 or pdf_stream_printf() to write the actual stream data. If
100 pdf_stream_write_bits() is used, pdf_stream_flush_bits() should be
101 called after all the bits are written. */
103 void pdf_stream_write_bits (pdf_file_handle pdf_file,
104 struct pdf_obj *stream,
105 uint32_t count,
106 uint32_t bits);
108 void pdf_stream_flush_bits (pdf_file_handle pdf_file,
109 struct pdf_obj *stream);
111 void pdf_stream_write_data (pdf_file_handle pdf_file,
112 struct pdf_obj *stream,
113 char *data,
114 unsigned long len);
116 void pdf_stream_printf (pdf_file_handle pdf_file,
117 struct pdf_obj *stream,
118 char *fmt, ...);
121 void pdf_stream_add_filter (struct pdf_obj *stream,
122 char *filter_name,
123 struct pdf_obj *decode_parms);
126 /* Write the object to the file */
127 void pdf_write_obj (pdf_file_handle pdf_file, struct pdf_obj *obj);
130 /* Write the indirect object to the file. For most objects this should
131 be done by pdf_write_all_ind_obj() when the file is being closed, but for
132 large objects such as streams, it's probably better to do it as soon as the
133 object is complete. */
134 void pdf_write_ind_obj (pdf_file_handle pdf_file, struct pdf_obj *ind_obj);
137 /* Write all indirect objects that haven't already been written to the file. */
138 void pdf_write_all_ind_obj (pdf_file_handle pdf_file);
141 /* Write the cross reference table, and return the maximum object number */
142 unsigned long pdf_write_xref (pdf_file_handle pdf_file);