1 /* cairo - a vector graphics library with display and print output
3 * Copyright © 2005 Red Hat, Inc
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.
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
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/
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.
28 * The Original Code is the cairo graphics library.
30 * The Initial Developer of the Original Code is Red Hat, Inc.
33 * Carl Worth <cworth@cworth.org>
36 /* This isn't a "real" surface, but just something to be used by the
37 * test suite to help exercise the paginated-surface paths in cairo.
39 * The defining feature of this backend is that it uses a paginated
40 * surface to record all operations, and then replays everything to an
43 * It's possible that this code might serve as a good starting point
44 * for someone working on bringing up a new paginated-surface-based
50 #include "test-paginated-surface.h"
52 #include "cairo-default-context-private.h"
53 #include "cairo-error-private.h"
54 #include "cairo-paginated-private.h"
55 #include "cairo-surface-backend-private.h"
57 typedef struct _test_paginated_surface
{
59 cairo_surface_t
*target
;
60 cairo_paginated_mode_t paginated_mode
;
61 } test_paginated_surface_t
;
63 static const cairo_surface_backend_t test_paginated_surface_backend
;
64 static const cairo_paginated_surface_backend_t test_paginated_surface_paginated_backend
;
67 _cairo_test_paginated_surface_create (cairo_surface_t
*target
)
69 cairo_status_t status
;
70 cairo_surface_t
*paginated
;
71 test_paginated_surface_t
*surface
;
73 status
= cairo_surface_status (target
);
74 if (unlikely (status
))
75 return _cairo_surface_create_in_error (status
);
77 surface
= malloc (sizeof (test_paginated_surface_t
));
78 if (unlikely (surface
== NULL
))
79 return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_NO_MEMORY
));
81 _cairo_surface_init (&surface
->base
,
82 &test_paginated_surface_backend
,
86 surface
->target
= cairo_surface_reference (target
);
88 paginated
= _cairo_paginated_surface_create (&surface
->base
,
90 &test_paginated_surface_paginated_backend
);
91 status
= paginated
->status
;
92 if (status
== CAIRO_STATUS_SUCCESS
) {
93 /* paginated keeps the only reference to surface now, drop ours */
94 cairo_surface_destroy (&surface
->base
);
98 cairo_surface_destroy (target
);
100 return _cairo_surface_create_in_error (status
);
103 static cairo_status_t
104 _test_paginated_surface_finish (void *abstract_surface
)
106 test_paginated_surface_t
*surface
= abstract_surface
;
108 cairo_surface_destroy (surface
->target
);
110 return CAIRO_STATUS_SUCCESS
;
114 _test_paginated_surface_get_extents (void *abstract_surface
,
115 cairo_rectangle_int_t
*rectangle
)
117 test_paginated_surface_t
*surface
= abstract_surface
;
119 return _cairo_surface_get_extents (surface
->target
, rectangle
);
122 static cairo_int_status_t
123 _test_paginated_surface_paint (void *abstract_surface
,
125 const cairo_pattern_t
*source
,
126 const cairo_clip_t
*clip
)
128 test_paginated_surface_t
*surface
= abstract_surface
;
130 if (surface
->paginated_mode
== CAIRO_PAGINATED_MODE_ANALYZE
)
131 return CAIRO_STATUS_SUCCESS
;
133 return _cairo_surface_paint (surface
->target
, op
, source
, clip
);
136 static cairo_int_status_t
137 _test_paginated_surface_mask (void *abstract_surface
,
139 const cairo_pattern_t
*source
,
140 const cairo_pattern_t
*mask
,
141 const cairo_clip_t
*clip
)
143 test_paginated_surface_t
*surface
= abstract_surface
;
145 if (surface
->paginated_mode
== CAIRO_PAGINATED_MODE_ANALYZE
)
146 return CAIRO_STATUS_SUCCESS
;
148 return _cairo_surface_mask (surface
->target
,
149 op
, source
, mask
, clip
);
152 static cairo_int_status_t
153 _test_paginated_surface_stroke (void *abstract_surface
,
155 const cairo_pattern_t
*source
,
156 const cairo_path_fixed_t
*path
,
157 const cairo_stroke_style_t
*style
,
158 const cairo_matrix_t
*ctm
,
159 const cairo_matrix_t
*ctm_inverse
,
161 cairo_antialias_t antialias
,
162 const cairo_clip_t
*clip
)
164 test_paginated_surface_t
*surface
= abstract_surface
;
166 if (surface
->paginated_mode
== CAIRO_PAGINATED_MODE_ANALYZE
)
167 return CAIRO_STATUS_SUCCESS
;
169 return _cairo_surface_stroke (surface
->target
, op
, source
,
172 tolerance
, antialias
,
176 static cairo_int_status_t
177 _test_paginated_surface_fill (void *abstract_surface
,
179 const cairo_pattern_t
*source
,
180 const cairo_path_fixed_t
*path
,
181 cairo_fill_rule_t fill_rule
,
183 cairo_antialias_t antialias
,
184 const cairo_clip_t
*clip
)
186 test_paginated_surface_t
*surface
= abstract_surface
;
188 if (surface
->paginated_mode
== CAIRO_PAGINATED_MODE_ANALYZE
)
189 return CAIRO_STATUS_SUCCESS
;
191 return _cairo_surface_fill (surface
->target
, op
, source
,
193 tolerance
, antialias
,
198 _test_paginated_surface_has_show_text_glyphs (void *abstract_surface
)
200 test_paginated_surface_t
*surface
= abstract_surface
;
202 return cairo_surface_has_show_text_glyphs (surface
->target
);
205 static cairo_int_status_t
206 _test_paginated_surface_show_text_glyphs (void *abstract_surface
,
208 const cairo_pattern_t
*source
,
211 cairo_glyph_t
*glyphs
,
213 const cairo_text_cluster_t
*clusters
,
215 cairo_text_cluster_flags_t cluster_flags
,
216 cairo_scaled_font_t
*scaled_font
,
217 const cairo_clip_t
*clip
)
219 test_paginated_surface_t
*surface
= abstract_surface
;
221 if (surface
->paginated_mode
== CAIRO_PAGINATED_MODE_ANALYZE
)
222 return CAIRO_STATUS_SUCCESS
;
224 return _cairo_surface_show_text_glyphs (surface
->target
, op
, source
,
227 clusters
, num_clusters
,
235 _test_paginated_surface_set_paginated_mode (void *abstract_surface
,
236 cairo_paginated_mode_t mode
)
238 test_paginated_surface_t
*surface
= abstract_surface
;
240 surface
->paginated_mode
= mode
;
243 static const cairo_surface_backend_t test_paginated_surface_backend
= {
244 CAIRO_INTERNAL_SURFACE_TYPE_TEST_PAGINATED
,
245 _test_paginated_surface_finish
,
246 _cairo_default_context_create
,
248 /* Since we are a paginated user, we get to regard most of the
249 * surface backend interface as historical cruft and ignore it. */
251 NULL
, /* create_similar */
252 NULL
, /* create similar image */
253 NULL
, /* map to image */
254 NULL
, /* unmap image */
256 _cairo_surface_default_source
,
257 NULL
, /* acquire_source_image */
258 NULL
, /* release_source_image */
261 NULL
, /* copy_page */
262 NULL
, /* show_page */
264 _test_paginated_surface_get_extents
,
265 NULL
, /* get_font_options */
268 NULL
, /* mark_dirty_rectangle */
270 /* Here is the more "modern" section of the surface backend
271 * interface which is mostly just drawing functions */
273 _test_paginated_surface_paint
,
274 _test_paginated_surface_mask
,
275 _test_paginated_surface_stroke
,
276 _test_paginated_surface_fill
,
277 NULL
, /* fill-stroke */
278 NULL
, /* replaced by show_text_glyphs */
279 _test_paginated_surface_has_show_text_glyphs
,
280 _test_paginated_surface_show_text_glyphs
283 static const cairo_paginated_surface_backend_t test_paginated_surface_paginated_backend
= {
284 NULL
, /* start_page */
285 _test_paginated_surface_set_paginated_mode