1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* Copyright (C) 2001-2019 Artifex Software, Inc.
All Rights Reserved.
This software is provided AS-IS with no warranty, either express or
implied.
This software is distributed under license and may not be copied,
modified or distributed except as expressly authorized under the terms
of the license contained in the file LICENSE in this distribution.
Refer to licensing information at http://www.artifex.com or contact
Artifex Software, Inc., 1305 Grant Avenue - Suite 200, Novato,
CA 94945, U.S.A., +1(415)492-9861, for further information.
*/
/* plapi.h */
/* pcl6 as a library or dll api */
#ifndef gsapi_INCLUDED
# define gsapi_INCLUDED
/*
* This API level is intended to hide everything behind
* a simple main_like argc, argv interface
*/
/* Exported functions may need different prefix
* GSDLLEXPORT marks functions as exported
* GSDLLAPI is the calling convention used on functions exported
* When you include this header file in the caller, you may
* need to change the definitions by defining these
* before including this header file.
* Make sure you get the calling convention correct, otherwise your
* program will crash soon after returning due to stack corruption.
*/
#ifdef __WINDOWS__
# define _Windows
#endif
#ifdef _Windows
# ifndef GSDLLEXPORT
# define GSDLLEXPORT __declspec(dllexport)
# endif
# ifndef GSDLLAPI
# define GSDLLAPI __stdcall
# endif
# ifndef GSDLLCALL
# define GSDLLCALL __stdcall
# endif
#endif /* _Windows */
#if defined(OS2) && defined(__IBMC__)
# ifndef GSDLLAPI
# define GSDLLAPI _System
# endif
# ifndef GSDLLCALL
# define GSDLLCALL _System
# endif
#endif /* OS2 && __IBMC */
#ifdef __MACINTOSH__
# pragma export on
#endif
#ifndef GSDLLEXPORT
# define GSDLLEXPORT
#endif
#ifndef GSDLLAPI
# define GSDLLAPI
#endif
#ifndef GSDLLCALL
# define GSDLLCALL
#endif
#if defined(__IBMC__)
# define GSDLLAPIPTR * GSDLLAPI
# define GSDLLCALLPTR * GSDLLCALL
#else
# define GSDLLAPIPTR GSDLLAPI *
# define GSDLLCALLPTR GSDLLCALL *
#endif
#ifndef display_callback_DEFINED
# define display_callback_DEFINED
typedef struct display_callback_s display_callback;
#endif
#ifdef _Windows
GSDLLEXPORT int GSDLLAPI
pl_wchar_to_utf8(char *out, const void *in);
#endif
typedef struct gsapi_revision_s {
const char *product;
const char *copyright;
long revision;
long revisiondate;
} gsapi_revision_t;
/* Get version numbers and strings.
* This is safe to call at any time.
* You should call this first to make sure that the correct version
* of GhostPDL is being used.
* pr is a pointer to a revision structure.
* len is the size of this structure in bytes.
* Returns 0 if OK, or if len too small (additional parameters
* have been added to the structure) it will return the required
* size of the structure.
*/
GSDLLEXPORT int GSDLLAPI gsapi_revision(gsapi_revision_t *pr, int len);
/* Create a new instance of GhostPDL.
* This instance is passed to most other API functions.
* The caller_handle will be provided to callback functions.
*
* On success: Returns 0, with *instance set to the newly created
* instance handle.
* On error: (such as the maximum number of instances being exceeded)
* this will return <0 and set *instance=NULL.
*/
GSDLLEXPORT int GSDLLAPI gsapi_new_instance(void **instance, void *caller_handle);
/* Destroy an instance of GhostPDL
* Before you call this, GhostPDL must have finished.
* If GhostPDL has been initialised, you must call gsapi_exit()
* before gsapi_delete_instance.
*/
GSDLLEXPORT int GSDLLAPI gsapi_delete_instance(void *instance);
/* Set the callback functions for stdio
* The stdin callback function should return the number of
* characters read, 0 for EOF, or -1 for error.
* The stdout and stderr callback functions should return
* the number of characters written.
* If a callback address is NULL, the real stdio will be used.
*/
GSDLLEXPORT int GSDLLAPI
gsapi_set_stdio(void *instance,
int (GSDLLCALLPTR stdin_fn)(void *caller_handle, char *buf, int len),
int (GSDLLCALLPTR stdout_fn)(void *caller_handle, const char *str, int len),
int (GSDLLCALLPTR stderr_fn)(void *caller_handle, const char *str, int len));
/* Set the callback function for polling.
* This is used for handling window events or cooperative
* multitasking. This function will only be called if
* Ghostscript was compiled with CHECK_INTERRUPTS
* as described in gpcheck.h.
* The polling function should return 0 if all is well,
* and negative if it wants ghostscript to abort.
* The polling function must be fast.
*/
GSDLLEXPORT int GSDLLAPI gsapi_set_poll(void *instance,
int (GSDLLCALLPTR poll_fn)(void *caller_handle));
/* Set the display device callback structure.
* If the display device is used, this must be called
* after gsapi_new_instance() and before gsapi_init_with_args().
* See gdevdisp.h for more details.
*/
GSDLLEXPORT int GSDLLAPI gsapi_set_display_callback(
void *instance, display_callback *callback);
/* Set the string containing the list of default device names
* for example "display x11alpha x11 bbox". Allows the calling
* application to influence which device(s) gs will try in order
* to select the default device
*
* If this is to be called, it must be called after
* gsapi_new_instance() and before gsapi_init_with_args().
*/
GSDLLEXPORT int GSDLLAPI
gsapi_set_default_device_list(void *instance, char *list, int listlen);
/* Returns a pointer to the current default device string.
*/
GSDLLEXPORT int GSDLLAPI
gsapi_get_default_device_list(void *instance, char **list, int *listlen);
/* Set the encoding used for the args. By default we assume
* 'local' encoding. For windows this equates to whatever the current
* codepage is. For linux this is utf8.
*
* Use of this API (gsapi) with 'local' encodings (and hence without calling
* this function) is now deprecated!
*/
GSDLLEXPORT int GSDLLAPI gsapi_set_arg_encoding(void *instance,
int encoding);
enum {
PL_ARG_ENCODING_LOCAL = 0,
PL_ARG_ENCODING_UTF8 = 1,
PL_ARG_ENCODING_UTF16LE = 2
};
/* Initialise the interpreter.
* If this returns gs_error_Quit, then the interpreter quit due to
* an explicit .quit. This is not an error. You must call gsapi_exit()
* and gsapi_destroy_instance(). You may not call any other plapi
* functions.
* If this returns gs_error_Info, then usage info should be displayed.
* This is not an error. You must call gsapi_exit() and
* gsapi_destroy_instance(). You may not call any other plapi functions.
* If this returns another negative value, this is an error.
* Normal return is 0 or greater. Callers can then call other
* gsapi_run... functions if required, ending with gsapi_exit and
* gsapi_destroy_instance.
*/
GSDLLEXPORT int GSDLLAPI gsapi_init_with_args(void *instance, int argc, char **argv);
GSDLLEXPORT int GSDLLAPI gsapi_run_file(void *instance, const char *file_name);
GSDLLEXPORT int GSDLLAPI gsapi_exit(void *instance);
GSDLLEXPORT int GSDLLAPI gsapi_run_string_begin(void *instance);
GSDLLEXPORT int GSDLLAPI gsapi_run_string_continue(void *instance, const char *str, unsigned int length);
GSDLLEXPORT int GSDLLAPI gsapi_run_string_end(void *instance);
typedef enum {
gs_spt_invalid = -1,
gs_spt_null = 0, /* void * is NULL */
gs_spt_bool = 1, /* void * is NULL (false) or non-NULL (true) */
gs_spt_int = 2, /* void * is a pointer to an int */
gs_spt_float = 3, /* void * is a float * */
gs_spt_name = 4, /* void * is a char * */
gs_spt_string = 5 /* void * is a char * */
} gs_set_param_type;
GSDLLEXPORT int GSDLLAPI gsapi_set_param(void *instance, gs_set_param_type type, const char *param, const void *value);
#endif /* gsapi_INCLUDED */
|
