bbdd15d38faaccae4abd201c729f2e4f084822b9
[framework/graphics/cairo.git] / util / cairo-script / cairo-script-interpreter.h
1 /* cairo - a vector graphics library with display and print output
2  *
3  * Copyright © 2008 Chris Wilson
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it either under the terms of the GNU Lesser General Public
7  * License version 2.1 as published by the Free Software Foundation
8  * (the "LGPL") or, at your option, under the terms of the Mozilla
9  * Public License Version 1.1 (the "MPL"). If you do not alter this
10  * notice, a recipient may use your version of this file under either
11  * the MPL or the LGPL.
12  *
13  * You should have received a copy of the LGPL along with this library
14  * in the file COPYING-LGPL-2.1; if not, write to the Free Software
15  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
16  * You should have received a copy of the MPL along with this library
17  * in the file COPYING-MPL-1.1
18  *
19  * The contents of this file are subject to the Mozilla Public License
20  * Version 1.1 (the "License"); you may not use this file except in
21  * compliance with the License. You may obtain a copy of the License at
22  * http://www.mozilla.org/MPL/
23  *
24  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
25  * OF ANY KIND, either express or implied. See the LGPL or the MPL for
26  * the specific language governing rights and limitations.
27  *
28  * The Original Code is the cairo graphics library.
29  *
30  * The Initial Developer of the Original Code is Chris Wilson
31  *
32  * Contributor(s):
33  *      Chris Wilson <chris@chris-wilson.co.uk>
34  */
35
36 #ifndef CAIRO_SCRIPT_INTERPRETER_H
37 #define CAIRO_SCRIPT_INTERPRETER_H
38
39 #include <cairo.h>
40 #include <stdio.h>
41
42 CAIRO_BEGIN_DECLS
43
44 typedef struct _cairo_script_interpreter cairo_script_interpreter_t;
45
46 /* XXX expose csi_dictionary_t and pass to hooks */
47 typedef void
48 (*csi_destroy_func_t) (void *closure,
49                        void *ptr);
50
51 typedef cairo_surface_t *
52 (*csi_surface_create_func_t) (void *closure,
53                               cairo_content_t content,
54                               double width,
55                               double height,
56                               long uid);
57 typedef cairo_t *
58 (*csi_context_create_func_t) (void *closure,
59                               cairo_surface_t *surface);
60 typedef void
61 (*csi_show_page_func_t) (void *closure,
62                          cairo_t *cr);
63
64 typedef void
65 (*csi_copy_page_func_t) (void *closure,
66                          cairo_t *cr);
67
68 typedef struct _cairo_script_interpreter_hooks {
69     void *closure;
70     csi_surface_create_func_t surface_create;
71     csi_destroy_func_t surface_destroy;
72     csi_context_create_func_t context_create;
73     csi_destroy_func_t context_destroy;
74     csi_show_page_func_t show_page;
75     csi_copy_page_func_t copy_page;
76 } cairo_script_interpreter_hooks_t;
77
78 cairo_public cairo_script_interpreter_t *
79 cairo_script_interpreter_create (void);
80
81 cairo_public void
82 cairo_script_interpreter_install_hooks (cairo_script_interpreter_t *ctx,
83                                         const cairo_script_interpreter_hooks_t *hooks);
84
85 cairo_public cairo_status_t
86 cairo_script_interpreter_run (cairo_script_interpreter_t *ctx,
87                               const char *filename);
88
89 cairo_public cairo_status_t
90 cairo_script_interpreter_feed_stream (cairo_script_interpreter_t *ctx,
91                                       FILE *stream);
92
93 cairo_public cairo_status_t
94 cairo_script_interpreter_feed_string (cairo_script_interpreter_t *ctx,
95                                       const char *line,
96                                       int len);
97
98 cairo_public unsigned int
99 cairo_script_interpreter_get_line_number (cairo_script_interpreter_t *ctx);
100
101 cairo_public cairo_script_interpreter_t *
102 cairo_script_interpreter_reference (cairo_script_interpreter_t *ctx);
103
104 cairo_public cairo_status_t
105 cairo_script_interpreter_finish (cairo_script_interpreter_t *ctx);
106
107 cairo_public cairo_status_t
108 cairo_script_interpreter_destroy (cairo_script_interpreter_t *ctx);
109
110 cairo_public cairo_status_t
111 cairo_script_interpreter_translate_stream (FILE *stream,
112                                            cairo_write_func_t write_func,
113                                            void *closure);
114
115 CAIRO_END_DECLS
116
117 #endif /*CAIRO_SCRIPT_INTERPRETER_H*/