1
/* -*- Mode: c; tab-width: 8; c-basic-offset: 4; indent-tabs-mode: t; -*- */
2
/* cairo - a vector graphics library with display and print output
3
 *
4
 * Copyright © 2002 University of Southern California
5
 * Copyright © 2005 Red Hat, Inc.
6
 *
7
 * This library is free software; you can redistribute it and/or
8
 * modify it either under the terms of the GNU Lesser General Public
9
 * License version 2.1 as published by the Free Software Foundation
10
 * (the "LGPL") or, at your option, under the terms of the Mozilla
11
 * Public License Version 1.1 (the "MPL"). If you do not alter this
12
 * notice, a recipient may use your version of this file under either
13
 * the MPL or the LGPL.
14
 *
15
 * You should have received a copy of the LGPL along with this library
16
 * in the file COPYING-LGPL-2.1; if not, write to the Free Software
17
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
18
 * You should have received a copy of the MPL along with this library
19
 * in the file COPYING-MPL-1.1
20
 *
21
 * The contents of this file are subject to the Mozilla Public License
22
 * Version 1.1 (the "License"); you may not use this file except in
23
 * compliance with the License. You may obtain a copy of the License at
24
 * http://www.mozilla.org/MPL/
25
 *
26
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
27
 * OF ANY KIND, either express or implied. See the LGPL or the MPL for
28
 * the specific language governing rights and limitations.
29
 *
30
 * The Original Code is the cairo graphics library.
31
 *
32
 * The Initial Developer of the Original Code is University of Southern
33
 * California.
34
 *
35
 * Contributor(s):
36
 *	Carl D. Worth <cworth@cworth.org>
37
 */
38

            
39
#include "cairoint.h"
40

            
41
#include "cairo-array-private.h"
42
#include "cairo-clip-inline.h"
43
#include "cairo-clip-private.h"
44
#include "cairo-damage-private.h"
45
#include "cairo-device-private.h"
46
#include "cairo-error-private.h"
47
#include "cairo-list-inline.h"
48
#include "cairo-image-surface-inline.h"
49
#include "cairo-recording-surface-private.h"
50
#include "cairo-region-private.h"
51
#include "cairo-surface-inline.h"
52

            
53
/**
54
 * SECTION:cairo-surface
55
 * @Title: cairo_surface_t
56
 * @Short_Description: Base class for surfaces
57
 * @See_Also: #cairo_t, #cairo_pattern_t
58
 *
59
 * #cairo_surface_t is the abstract type representing all different drawing
60
 * targets that cairo can render to.  The actual drawings are
61
 * performed using a cairo <firstterm>context</firstterm>.
62
 *
63
 * A cairo surface is created by using <firstterm>backend</firstterm>-specific
64
 * constructors, typically of the form
65
 * <function>cairo_<emphasis>backend</emphasis>_surface_create(<!-- -->)</function>.
66
 *
67
 * Most surface types allow accessing the surface without using Cairo
68
 * functions. If you do this, keep in mind that it is mandatory that you call
69
 * cairo_surface_flush() before reading from or writing to the surface and that
70
 * you must use cairo_surface_mark_dirty() after modifying it.
71
 * <example>
72
 * <title>Directly modifying an image surface</title>
73
 * <programlisting>
74
 * void
75
 * modify_image_surface (cairo_surface_t *surface)
76
 * {
77
 *   unsigned char *data;
78
 *   int width, height, stride;
79
 *
80
 *   // flush to ensure all writing to the image was done
81
 *   cairo_surface_flush (surface);
82
 *
83
 *   // modify the image
84
 *   data = cairo_image_surface_get_data (surface);
85
 *   width = cairo_image_surface_get_width (surface);
86
 *   height = cairo_image_surface_get_height (surface);
87
 *   stride = cairo_image_surface_get_stride (surface);
88
 *   modify_image_data (data, width, height, stride);
89
 *
90
 *   // mark the image dirty so Cairo clears its caches.
91
 *   cairo_surface_mark_dirty (surface);
92
 * }
93
 * </programlisting>
94
 * </example>
95
 * Note that for other surface types it might be necessary to acquire the
96
 * surface's device first. See cairo_device_acquire() for a discussion of
97
 * devices.
98
 **/
99

            
100
#define DEFINE_NIL_SURFACE(status, name)			\
101
const cairo_surface_t name = {					\
102
    NULL,				/* backend */		\
103
    NULL,				/* device */		\
104
    CAIRO_SURFACE_TYPE_IMAGE,		/* type */		\
105
    CAIRO_CONTENT_COLOR,		/* content */		\
106
    CAIRO_REFERENCE_COUNT_INVALID,	/* ref_count */		\
107
    status,				/* status */		\
108
    0,					/* unique id */		\
109
    0,					/* serial */		\
110
    NULL,				/* damage */		\
111
    FALSE,				/* _finishing */	\
112
    FALSE,				/* finished */		\
113
    TRUE,				/* is_clear */		\
114
    FALSE,				/* has_font_options */	\
115
    FALSE,				/* owns_device */ \
116
    FALSE,                              /* is_vector */ \
117
    { 0, 0, 0, NULL, },			/* user_data */		\
118
    { 0, 0, 0, NULL, },			/* mime_data */         \
119
    { 1.0, 0.0, 0.0, 1.0, 0.0, 0.0 },   /* device_transform */	\
120
    { 1.0, 0.0,	0.0, 1.0, 0.0, 0.0 },	/* device_transform_inverse */	\
121
    { NULL, NULL },			/* device_transform_observers */ \
122
    0.0,				/* x_resolution */	\
123
    0.0,				/* y_resolution */	\
124
    0.0,				/* x_fallback_resolution */	\
125
    0.0,				/* y_fallback_resolution */	\
126
    NULL,				/* snapshot_of */	\
127
    NULL,				/* snapshot_detach */	\
128
    { NULL, NULL },			/* snapshots */		\
129
    { NULL, NULL },			/* snapshot */		\
130
    {                                   /* font options begin */\
131
      CAIRO_ANTIALIAS_DEFAULT,		/* antialias */		\
132
      CAIRO_SUBPIXEL_ORDER_DEFAULT,	/* subpixel_order */	\
133
      CAIRO_LCD_FILTER_DEFAULT,		/* lcd_filter */	\
134
      CAIRO_HINT_STYLE_DEFAULT,		/* hint_style */	\
135
      CAIRO_HINT_METRICS_DEFAULT,	/* hint_metrics */	\
136
      CAIRO_ROUND_GLYPH_POS_DEFAULT,	/* round_glyph_positions */	\
137
      NULL,                            /* variations */ \
138
      CAIRO_COLOR_MODE_DEFAULT,                /* color mode */ \
139
      CAIRO_COLOR_PALETTE_DEFAULT,     /* color palette */ \
140
      NULL, 0,                         /* custom palette */ \
141
    },					/* font_options end */		\
142
    NULL,                               /* foreground_source */		\
143
    FALSE,                              /* foreground_used */   \
144
}
145

            
146
/* XXX error object! */
147

            
148
static DEFINE_NIL_SURFACE(CAIRO_STATUS_NO_MEMORY, _cairo_surface_nil);
149
static DEFINE_NIL_SURFACE(CAIRO_STATUS_SURFACE_TYPE_MISMATCH, _cairo_surface_nil_surface_type_mismatch);
150
static DEFINE_NIL_SURFACE(CAIRO_STATUS_INVALID_STATUS, _cairo_surface_nil_invalid_status);
151
static DEFINE_NIL_SURFACE(CAIRO_STATUS_INVALID_CONTENT, _cairo_surface_nil_invalid_content);
152
static DEFINE_NIL_SURFACE(CAIRO_STATUS_INVALID_FORMAT, _cairo_surface_nil_invalid_format);
153
static DEFINE_NIL_SURFACE(CAIRO_STATUS_INVALID_VISUAL, _cairo_surface_nil_invalid_visual);
154
static DEFINE_NIL_SURFACE(CAIRO_STATUS_FILE_NOT_FOUND, _cairo_surface_nil_file_not_found);
155
static DEFINE_NIL_SURFACE(CAIRO_STATUS_TEMP_FILE_ERROR, _cairo_surface_nil_temp_file_error);
156
static DEFINE_NIL_SURFACE(CAIRO_STATUS_READ_ERROR, _cairo_surface_nil_read_error);
157
static DEFINE_NIL_SURFACE(CAIRO_STATUS_WRITE_ERROR, _cairo_surface_nil_write_error);
158
static DEFINE_NIL_SURFACE(CAIRO_STATUS_INVALID_STRIDE, _cairo_surface_nil_invalid_stride);
159
static DEFINE_NIL_SURFACE(CAIRO_STATUS_INVALID_SIZE, _cairo_surface_nil_invalid_size);
160
static DEFINE_NIL_SURFACE(CAIRO_STATUS_DEVICE_TYPE_MISMATCH, _cairo_surface_nil_device_type_mismatch);
161
static DEFINE_NIL_SURFACE(CAIRO_STATUS_DEVICE_ERROR, _cairo_surface_nil_device_error);
162
static DEFINE_NIL_SURFACE(CAIRO_STATUS_PNG_ERROR, _cairo_surface_nil_png_error);
163

            
164
static DEFINE_NIL_SURFACE(CAIRO_INT_STATUS_UNSUPPORTED, _cairo_surface_nil_unsupported);
165
static DEFINE_NIL_SURFACE(CAIRO_INT_STATUS_NOTHING_TO_DO, _cairo_surface_nil_nothing_to_do);
166

            
167
static void _cairo_surface_finish_snapshots (cairo_surface_t *surface);
168
static void _cairo_surface_finish (cairo_surface_t *surface);
169

            
170
/**
171
 * _cairo_surface_set_error:
172
 * @surface: a surface
173
 * @status: a status value indicating an error
174
 *
175
 * Atomically sets surface->status to @status and calls _cairo_error;
176
 * Does nothing if status is %CAIRO_STATUS_SUCCESS or any of the internal
177
 * status values.
178
 *
179
 * All assignments of an error status to surface->status should happen
180
 * through _cairo_surface_set_error(). Note that due to the nature of
181
 * the atomic operation, it is not safe to call this function on the
182
 * nil objects.
183
 *
184
 * The purpose of this function is to allow the user to set a
185
 * breakpoint in _cairo_error() to generate a stack trace for when the
186
 * user causes cairo to detect an error.
187
 *
188
 * Return value: the error status.
189
 **/
190
cairo_int_status_t
191
1494334
_cairo_surface_set_error (cairo_surface_t *surface,
192
			  cairo_int_status_t status)
193
{
194
    /* NOTHING_TO_DO is magic. We use it to break out of the inner-most
195
     * surface function, but anything higher just sees "success".
196
     */
197
1494334
    if (status == CAIRO_INT_STATUS_NOTHING_TO_DO)
198
294470
	status = CAIRO_INT_STATUS_SUCCESS;
199

            
200
1494334
    if (status == CAIRO_INT_STATUS_SUCCESS ||
201
        status >= (int)CAIRO_INT_STATUS_LAST_STATUS)
202
1494139
        return status;
203

            
204
    /* Don't overwrite an existing error. This preserves the first
205
     * error, which is the most significant. */
206
195
    _cairo_status_set_error (&surface->status, (cairo_status_t)status);
207

            
208
195
    return _cairo_error (status);
209
}
210

            
211
/**
212
 * cairo_surface_get_type:
213
 * @surface: a #cairo_surface_t
214
 *
215
 * This function returns the type of the backend used to create
216
 * a surface. See #cairo_surface_type_t for available types.
217
 *
218
 * Return value: The type of @surface.
219
 *
220
 * Since: 1.2
221
 **/
222
cairo_surface_type_t
223
3508
cairo_surface_get_type (cairo_surface_t *surface)
224
{
225
    /* We don't use surface->backend->type here so that some of the
226
     * special "wrapper" surfaces such as cairo_paginated_surface_t
227
     * can override surface->type with the type of the "child"
228
     * surface. */
229
3508
    return surface->type;
230
}
231

            
232
/**
233
 * cairo_surface_get_content:
234
 * @surface: a #cairo_surface_t
235
 *
236
 * This function returns the content type of @surface which indicates
237
 * whether the surface contains color and/or alpha information. See
238
 * #cairo_content_t.
239
 *
240
 * Return value: The content type of @surface.
241
 *
242
 * Since: 1.2
243
 **/
244
cairo_content_t
245
13693
cairo_surface_get_content (cairo_surface_t *surface)
246
{
247
13693
    return surface->content;
248
}
249

            
250
/**
251
 * cairo_surface_status:
252
 * @surface: a #cairo_surface_t
253
 *
254
 * Checks whether an error has previously occurred for this
255
 * surface.
256
 *
257
 * Return value: %CAIRO_STATUS_SUCCESS, %CAIRO_STATUS_NULL_POINTER,
258
 * %CAIRO_STATUS_NO_MEMORY, %CAIRO_STATUS_READ_ERROR,
259
 * %CAIRO_STATUS_INVALID_CONTENT, %CAIRO_STATUS_INVALID_FORMAT, or
260
 * %CAIRO_STATUS_INVALID_VISUAL.
261
 *
262
 * Since: 1.0
263
 **/
264
cairo_status_t
265
14747
cairo_surface_status (cairo_surface_t *surface)
266
{
267
14747
    return surface->status;
268
}
269

            
270
static unsigned int
271
218633
_cairo_surface_allocate_unique_id (void)
272
{
273
    static cairo_atomic_int_t unique_id;
274

            
275
#if CAIRO_NO_MUTEX
276
    if (++unique_id == 0)
277
	unique_id = 1;
278
    return unique_id;
279
#else
280
    int old, id;
281

            
282
    do {
283
219494
	old = _cairo_atomic_uint_get (&unique_id);
284
219494
	id = old + 1;
285
219494
	if (id == 0)
286
	    id = 1;
287
219494
    } while (! _cairo_atomic_uint_cmpxchg (&unique_id, old, id));
288

            
289
218633
    return id;
290
#endif
291
}
292

            
293
/**
294
 * cairo_surface_get_device:
295
 * @surface: a #cairo_surface_t
296
 *
297
 * This function returns the device for a @surface.
298
 * See #cairo_device_t.
299
 *
300
 * Return value: The device for @surface or %NULL if the surface does
301
 *               not have an associated device.
302
 *
303
 * Since: 1.10
304
 **/
305
cairo_device_t *
306
12
cairo_surface_get_device (cairo_surface_t *surface)
307
{
308
12
    if (unlikely (surface->status))
309
1
	return _cairo_device_create_in_error (surface->status);
310

            
311
11
    return surface->device;
312
}
313

            
314
static cairo_bool_t
315
1922387
_cairo_surface_has_snapshots (cairo_surface_t *surface)
316
{
317
1922387
    return ! cairo_list_is_empty (&surface->snapshots);
318
}
319

            
320
static cairo_bool_t
321
1498211
_cairo_surface_has_mime_data (cairo_surface_t *surface)
322
{
323
1498211
    return surface->mime_data.num_elements != 0;
324
}
325

            
326
static void
327
1498172
_cairo_surface_detach_mime_data (cairo_surface_t *surface)
328
{
329
1498172
    if (! _cairo_surface_has_mime_data (surface))
330
1497746
	return;
331

            
332
426
    _cairo_user_data_array_fini (&surface->mime_data);
333
426
    _cairo_user_data_array_init (&surface->mime_data);
334
}
335

            
336
static void
337
1498172
_cairo_surface_detach_snapshots (cairo_surface_t *surface)
338
{
339
1498512
    while (_cairo_surface_has_snapshots (surface)) {
340
340
	_cairo_surface_detach_snapshot (cairo_list_first_entry (&surface->snapshots,
341
								cairo_surface_t,
342
								snapshot));
343
    }
344
1498172
}
345

            
346
void
347
11859
_cairo_surface_detach_snapshot (cairo_surface_t *snapshot)
348
{
349
11859
    assert (snapshot->snapshot_of != NULL);
350

            
351
11859
    snapshot->snapshot_of = NULL;
352
11859
    cairo_list_del (&snapshot->snapshot);
353

            
354
11859
    if (snapshot->snapshot_detach != NULL)
355
337
	snapshot->snapshot_detach (snapshot);
356

            
357
11859
    cairo_surface_destroy (snapshot);
358
11859
}
359

            
360
void
361
11868
_cairo_surface_attach_snapshot (cairo_surface_t *surface,
362
				 cairo_surface_t *snapshot,
363
				 cairo_surface_func_t detach_func)
364
{
365
11868
    assert (surface != snapshot);
366
11868
    assert (snapshot->snapshot_of != surface);
367

            
368
11868
    cairo_surface_reference (snapshot);
369

            
370
11868
    if (snapshot->snapshot_of != NULL)
371
	_cairo_surface_detach_snapshot (snapshot);
372

            
373
11868
    snapshot->snapshot_of = surface;
374
11868
    snapshot->snapshot_detach = detach_func;
375

            
376
11868
    cairo_list_add (&snapshot->snapshot, &surface->snapshots);
377

            
378
11868
    assert (_cairo_surface_has_snapshot (surface, snapshot->backend) == snapshot);
379
11868
}
380

            
381
cairo_surface_t *
382
23805
_cairo_surface_has_snapshot (cairo_surface_t *surface,
383
			     const cairo_surface_backend_t *backend)
384
{
385
    cairo_surface_t *snapshot;
386

            
387
23934
    cairo_list_foreach_entry (snapshot, cairo_surface_t,
388
			      &surface->snapshots, snapshot)
389
    {
390
12063
	if (snapshot->backend == backend)
391
11934
	    return snapshot;
392
    }
393

            
394
11871
    return NULL;
395
}
396

            
397
cairo_status_t
398
1282733
_cairo_surface_begin_modification (cairo_surface_t *surface)
399
{
400
1282733
    assert (surface->status == CAIRO_STATUS_SUCCESS);
401
1282733
    assert (! surface->finished);
402

            
403
1282733
    return _cairo_surface_flush (surface, 1);
404
}
405

            
406
void
407
218633
_cairo_surface_init (cairo_surface_t			*surface,
408
		     const cairo_surface_backend_t	*backend,
409
		     cairo_device_t			*device,
410
		     cairo_content_t			 content,
411
		     cairo_bool_t                        is_vector)
412
{
413
    CAIRO_MUTEX_INITIALIZE ();
414

            
415
218633
    surface->backend = backend;
416
218633
    surface->device = cairo_device_reference (device);
417
218633
    surface->content = content;
418
218633
    surface->type = backend->type;
419
218633
    surface->is_vector = is_vector;
420

            
421
218633
    CAIRO_REFERENCE_COUNT_INIT (&surface->ref_count, 1);
422
218633
    surface->status = CAIRO_STATUS_SUCCESS;
423
218633
    surface->unique_id = _cairo_surface_allocate_unique_id ();
424
218633
    surface->finished = FALSE;
425
218633
    surface->_finishing = FALSE;
426
218633
    surface->is_clear = FALSE;
427
218633
    surface->serial = 0;
428
218633
    surface->damage = NULL;
429
218633
    surface->owns_device = (device != NULL);
430

            
431
218633
    _cairo_user_data_array_init (&surface->user_data);
432
218633
    _cairo_user_data_array_init (&surface->mime_data);
433

            
434
218633
    cairo_matrix_init_identity (&surface->device_transform);
435
218633
    cairo_matrix_init_identity (&surface->device_transform_inverse);
436
218633
    cairo_list_init (&surface->device_transform_observers);
437

            
438
218633
    surface->x_resolution = CAIRO_SURFACE_RESOLUTION_DEFAULT;
439
218633
    surface->y_resolution = CAIRO_SURFACE_RESOLUTION_DEFAULT;
440

            
441
218633
    surface->x_fallback_resolution = CAIRO_SURFACE_FALLBACK_RESOLUTION_DEFAULT;
442
218633
    surface->y_fallback_resolution = CAIRO_SURFACE_FALLBACK_RESOLUTION_DEFAULT;
443

            
444
218633
    cairo_list_init (&surface->snapshots);
445
218633
    surface->snapshot_of = NULL;
446

            
447
218633
    surface->has_font_options = FALSE;
448

            
449
218633
    surface->foreground_source = NULL;
450
218633
    surface->foreground_used = FALSE;
451
218633
}
452

            
453
static void
454
9173
_cairo_surface_copy_similar_properties (cairo_surface_t *surface,
455
					cairo_surface_t *other)
456
{
457
9173
    if (other->has_font_options || other->backend != surface->backend) {
458
	cairo_font_options_t options;
459

            
460
5682
	cairo_surface_get_font_options (other, &options);
461
5682
	_cairo_surface_set_font_options (surface, &options);
462
5682
	_cairo_font_options_fini (&options);
463
    }
464

            
465
9173
    cairo_surface_set_fallback_resolution (surface,
466
					   other->x_fallback_resolution,
467
					   other->y_fallback_resolution);
468
9173
}
469

            
470
/**
471
 * cairo_surface_create_similar:
472
 * @other: an existing surface used to select the backend of the new surface
473
 * @content: the content for the new surface
474
 * @width: width of the new surface, (in device-space units)
475
 * @height: height of the new surface (in device-space units)
476
 *
477
 * Create a new surface that is as compatible as possible with an
478
 * existing surface. For example the new surface will have the same
479
 * device scale, fallback resolution and font options as
480
 * @other. Generally, the new surface will also use the same backend
481
 * as @other, unless that is not possible for some reason. The type of
482
 * the returned surface may be examined with
483
 * cairo_surface_get_type().
484
 *
485
 * Initially the surface contents are all 0 (transparent if contents
486
 * have transparency, black otherwise.)
487
 *
488
 * Use cairo_surface_create_similar_image() if you need an image surface
489
 * which can be painted quickly to the target surface.
490
 *
491
 * Return value: a pointer to the newly allocated surface. The caller
492
 * owns the surface and should call cairo_surface_destroy() when done
493
 * with it.
494
 *
495
 * This function always returns a valid pointer, but it will return a
496
 * pointer to a "nil" surface if @other is already in an error state
497
 * or any other error occurs.
498
 *
499
 * Since: 1.0
500
 **/
501
cairo_surface_t *
502
7684
cairo_surface_create_similar (cairo_surface_t  *other,
503
			      cairo_content_t	content,
504
			      int		width,
505
			      int		height)
506
{
507
    cairo_surface_t *surface;
508
    cairo_status_t status;
509
    cairo_solid_pattern_t pattern;
510

            
511
7684
    if (unlikely (other->status))
512
1
	return _cairo_surface_create_in_error (other->status);
513
7683
    if (unlikely (other->finished))
514
3
	return _cairo_surface_create_in_error (CAIRO_STATUS_SURFACE_FINISHED);
515
7680
    if (unlikely (width < 0 || height < 0))
516
	return _cairo_surface_create_in_error (CAIRO_STATUS_INVALID_SIZE);
517
7680
    if (unlikely (! CAIRO_CONTENT_VALID (content)))
518
	return _cairo_surface_create_in_error (CAIRO_STATUS_INVALID_CONTENT);
519

            
520
    /* We inherit the device scale, so create a larger surface */
521
7680
    width = width * other->device_transform.xx;
522
7680
    height = height * other->device_transform.yy;
523

            
524
7680
    surface = NULL;
525
7680
    if (other->backend->create_similar)
526
7680
	surface = other->backend->create_similar (other, content, width, height);
527
7680
    if (surface == NULL)
528
	surface = cairo_surface_create_similar_image (other,
529
						      _cairo_format_from_content (content),
530
						      width, height);
531

            
532
7680
    if (unlikely (surface->status))
533
	return surface;
534

            
535
7680
    _cairo_surface_copy_similar_properties (surface, other);
536
7680
    cairo_surface_set_device_scale (surface,
537
				    other->device_transform.xx,
538
				    other->device_transform.yy);
539

            
540
7680
    if (unlikely (surface->status))
541
	return surface;
542

            
543
7680
    _cairo_pattern_init_solid (&pattern, CAIRO_COLOR_TRANSPARENT);
544
7680
    status = _cairo_surface_paint (surface,
545
				   CAIRO_OPERATOR_CLEAR,
546
				   &pattern.base, NULL);
547
7680
    if (unlikely (status)) {
548
	cairo_surface_destroy (surface);
549
	surface = _cairo_surface_create_in_error (status);
550
    }
551

            
552
7680
    assert (surface->is_clear);
553

            
554
7680
    return surface;
555
}
556

            
557
/**
558
 * cairo_surface_create_similar_image:
559
 * @other: an existing surface used to select the preference of the new surface
560
 * @format: the format for the new surface
561
 * @width: width of the new surface, (in pixels)
562
 * @height: height of the new surface (in pixels)
563
 *
564
 * Create a new image surface that is as compatible as possible for uploading
565
 * to and the use in conjunction with an existing surface. However, this surface
566
 * can still be used like any normal image surface. Unlike
567
 * cairo_surface_create_similar() the new image surface won't inherit
568
 * the device scale from @other.
569
 *
570
 * Initially the surface contents are all 0 (transparent if contents
571
 * have transparency, black otherwise.)
572
 *
573
 * Use cairo_surface_create_similar() if you don't need an image surface.
574
 *
575
 * Return value: a pointer to the newly allocated image surface. The caller
576
 * owns the surface and should call cairo_surface_destroy() when done
577
 * with it.
578
 *
579
 * This function always returns a valid pointer, but it will return a
580
 * pointer to a "nil" surface if @other is already in an error state
581
 * or any other error occurs.
582
 *
583
 * Since: 1.12
584
 **/
585
cairo_surface_t *
586
24
cairo_surface_create_similar_image (cairo_surface_t  *other,
587
				    cairo_format_t    format,
588
				    int		width,
589
				    int		height)
590
{
591
    cairo_surface_t *image;
592

            
593
24
    if (unlikely (other->status))
594
	return _cairo_surface_create_in_error (other->status);
595
24
    if (unlikely (other->finished))
596
	return _cairo_surface_create_in_error (CAIRO_STATUS_SURFACE_FINISHED);
597

            
598
24
    if (unlikely (width < 0 || height < 0))
599
	return _cairo_surface_create_in_error (CAIRO_STATUS_INVALID_SIZE);
600
24
    if (unlikely (! CAIRO_FORMAT_VALID (format)))
601
	return _cairo_surface_create_in_error (CAIRO_STATUS_INVALID_FORMAT);
602

            
603
24
    image = NULL;
604
24
    if (other->backend->create_similar_image)
605
	image = other->backend->create_similar_image (other,
606
						      format, width, height);
607
24
    if (image == NULL)
608
24
	image = cairo_image_surface_create (format, width, height);
609

            
610
24
    assert (image->is_clear);
611

            
612
24
    return image;
613
}
614

            
615
/**
616
 * _cairo_surface_map_to_image:
617
 * @surface: an existing surface used to extract the image from
618
 * @extents: limit the extraction to an rectangular region
619
 *
620
 * Returns an image surface that is the most efficient mechanism for
621
 * modifying the backing store of the target surface. The region
622
 * retrieved is limited to @extents.
623
 *
624
 * Note, the use of the original surface as a target or source whilst
625
 * it is mapped is undefined. The result of mapping the surface
626
 * multiple times is undefined. Calling cairo_surface_destroy() or
627
 * cairo_surface_finish() on the resulting image surface results in
628
 * undefined behavior. Changing the device transform of the image
629
 * surface or of @surface before the image surface is unmapped results
630
 * in undefined behavior.
631
 *
632
 * Assumes that @surface is valid (CAIRO_STATUS_SUCCESS,
633
 * non-finished).
634
 *
635
 * Return value: a pointer to the newly allocated image surface. The
636
 * caller must use _cairo_surface_unmap_image() to destroy this image
637
 * surface.
638
 *
639
 * This function always returns a valid pointer, but it will return a
640
 * pointer to a "nil" surface if @other is already in an error state
641
 * or any other error occurs.
642
 *
643
 * The returned image might have a %CAIRO_FORMAT_INVALID format.
644
 **/
645
cairo_image_surface_t *
646
15
_cairo_surface_map_to_image (cairo_surface_t  *surface,
647
			     const cairo_rectangle_int_t *extents)
648
{
649
15
    cairo_image_surface_t *image = NULL;
650

            
651
15
    assert (extents != NULL);
652

            
653
    /* TODO: require map_to_image != NULL */
654
15
    if (surface->backend->map_to_image)
655
15
	image = surface->backend->map_to_image (surface, extents);
656

            
657
15
    if (image == NULL)
658
	image = _cairo_image_surface_clone_subimage (surface, extents);
659

            
660
15
    return image;
661
}
662

            
663
/**
664
 * _cairo_surface_unmap_image:
665
 * @surface: the surface passed to _cairo_surface_map_to_image().
666
 * @image: the currently mapped image
667
 *
668
 * Unmaps the image surface as returned from
669
 * _cairo_surface_map_to_image().
670
 *
671
 * The content of the image will be uploaded to the target surface.
672
 * Afterwards, the image is destroyed.
673
 *
674
 * Using an image surface which wasn't returned by
675
 * _cairo_surface_map_to_image() results in undefined behavior.
676
 *
677
 * An image surface in error status can be passed to
678
 * _cairo_surface_unmap_image().
679
 *
680
 * Return value: the unmap status.
681
 *
682
 * Even if the unmap status is not successful, @image is destroyed.
683
 **/
684
cairo_int_status_t
685
15
_cairo_surface_unmap_image (cairo_surface_t       *surface,
686
			    cairo_image_surface_t *image)
687
{
688
    cairo_surface_pattern_t pattern;
689
    cairo_rectangle_int_t extents;
690
    cairo_clip_t *clip;
691
    cairo_int_status_t status;
692

            
693
    /* map_to_image can return error surfaces */
694
15
    if (unlikely (image->base.status)) {
695
	status = image->base.status;
696
	goto destroy;
697
    }
698

            
699
    /* If the image is untouched just skip the update */
700
15
    if (image->base.serial == 0) {
701
6
	status = CAIRO_STATUS_SUCCESS;
702
6
	goto destroy;
703
    }
704

            
705
    /* TODO: require unmap_image != NULL */
706
18
    if (surface->backend->unmap_image &&
707
9
	! _cairo_image_surface_is_clone (image))
708
    {
709
9
	status = surface->backend->unmap_image (surface, image);
710
9
	if (status != CAIRO_INT_STATUS_UNSUPPORTED)
711
9
	    return status;
712
    }
713

            
714
    _cairo_pattern_init_for_surface (&pattern, &image->base);
715
    pattern.base.filter = CAIRO_FILTER_NEAREST;
716

            
717
    /* We have to apply the translate from map_to_image's extents.x and .y */
718
    cairo_matrix_init_translate (&pattern.base.matrix,
719
				 image->base.device_transform.x0,
720
				 image->base.device_transform.y0);
721

            
722
    /* And we also have to clip the operation to the image's extents */
723
    extents.x = image->base.device_transform_inverse.x0;
724
    extents.y = image->base.device_transform_inverse.y0;
725
    extents.width  = image->width;
726
    extents.height = image->height;
727
    clip = _cairo_clip_intersect_rectangle (NULL, &extents);
728

            
729
    status = _cairo_surface_paint (surface,
730
				   CAIRO_OPERATOR_SOURCE,
731
				   &pattern.base,
732
				   clip);
733

            
734
    _cairo_pattern_fini (&pattern.base);
735
    _cairo_clip_destroy (clip);
736

            
737
6
destroy:
738
6
    cairo_surface_finish (&image->base);
739
6
    cairo_surface_destroy (&image->base);
740

            
741
6
    return status;
742
}
743

            
744
/**
745
 * cairo_surface_map_to_image:
746
 * @surface: an existing surface used to extract the image from
747
 * @extents: limit the extraction to an rectangular region
748
 *
749
 * Returns an image surface that is the most efficient mechanism for
750
 * modifying the backing store of the target surface. The region retrieved
751
 * may be limited to the @extents or %NULL for the whole surface
752
 *
753
 * Note, the use of the original surface as a target or source whilst
754
 * it is mapped is undefined. The result of mapping the surface
755
 * multiple times is undefined. Calling cairo_surface_destroy() or
756
 * cairo_surface_finish() on the resulting image surface results in
757
 * undefined behavior. Changing the device transform of the image
758
 * surface or of @surface before the image surface is unmapped results
759
 * in undefined behavior.
760
 *
761
 * Return value: a pointer to the newly allocated image surface. The caller
762
 * must use cairo_surface_unmap_image() to destroy this image surface.
763
 *
764
 * This function always returns a valid pointer, but it will return a
765
 * pointer to a "nil" surface if @other is already in an error state
766
 * or any other error occurs. If the returned pointer does not have an
767
 * error status, it is guaranteed to be an image surface whose format
768
 * is not %CAIRO_FORMAT_INVALID.
769
 *
770
 * Since: 1.12
771
 **/
772
cairo_surface_t *
773
15
cairo_surface_map_to_image (cairo_surface_t  *surface,
774
			    const cairo_rectangle_int_t *extents)
775
{
776
    cairo_rectangle_int_t rect;
777
    cairo_image_surface_t *image;
778
    cairo_status_t status;
779

            
780
15
    if (unlikely (surface->status))
781
	return _cairo_surface_create_in_error (surface->status);
782
15
    if (unlikely (surface->finished))
783
	return _cairo_surface_create_in_error (CAIRO_STATUS_SURFACE_FINISHED);
784

            
785
15
    if (extents == NULL) {
786
6
	if (unlikely (! surface->backend->get_extents (surface, &rect)))
787
	    return _cairo_surface_create_in_error (CAIRO_STATUS_INVALID_SIZE);
788

            
789
6
	extents = &rect;
790
    } else {
791
	cairo_rectangle_int_t surface_extents;
792

            
793
	/* If this surface is bounded, we can't map parts
794
	 * that are outside of it. */
795
9
	if (likely (surface->backend->get_extents (surface, &surface_extents))) {
796
9
	    if (unlikely (! _cairo_rectangle_contains_rectangle (&surface_extents, extents)))
797
		return _cairo_surface_create_in_error (CAIRO_STATUS_INVALID_SIZE);
798
	}
799
    }
800

            
801
15
    image = _cairo_surface_map_to_image (surface, extents);
802

            
803
15
    status = image->base.status;
804
15
    if (unlikely (status)) {
805
	cairo_surface_destroy (&image->base);
806
	return _cairo_surface_create_in_error (status);
807
    }
808

            
809
15
    if (image->format == CAIRO_FORMAT_INVALID) {
810
	cairo_surface_destroy (&image->base);
811
	image = _cairo_image_surface_clone_subimage (surface, extents);
812
    }
813

            
814
15
    return &image->base;
815
}
816

            
817
/**
818
 * cairo_surface_unmap_image:
819
 * @surface: the surface passed to cairo_surface_map_to_image().
820
 * @image: the currently mapped image
821
 *
822
 * Unmaps the image surface as returned from #cairo_surface_map_to_image().
823
 *
824
 * The content of the image will be uploaded to the target surface.
825
 * Afterwards, the image is destroyed.
826
 *
827
 * Using an image surface which wasn't returned by cairo_surface_map_to_image()
828
 * results in undefined behavior.
829
 *
830
 * Since: 1.12
831
 **/
832
void
833
15
cairo_surface_unmap_image (cairo_surface_t *surface,
834
			   cairo_surface_t *image)
835
{
836
15
    cairo_int_status_t status = CAIRO_STATUS_SUCCESS;
837

            
838
15
    if (unlikely (surface->status)) {
839
	status = surface->status;
840
	goto error;
841
    }
842
15
    if (unlikely (surface->finished)) {
843
	status = _cairo_error (CAIRO_STATUS_SURFACE_FINISHED);
844
	goto error;
845
    }
846
15
    if (unlikely (image->status)) {
847
	status = image->status;
848
	goto error;
849
    }
850
15
    if (unlikely (image->finished)) {
851
	status = _cairo_error (CAIRO_STATUS_SURFACE_FINISHED);
852
	goto error;
853
    }
854
15
    if (unlikely (! _cairo_surface_is_image (image))) {
855
	status = _cairo_error (CAIRO_STATUS_SURFACE_TYPE_MISMATCH);
856
	goto error;
857
    }
858

            
859
15
    status = _cairo_surface_unmap_image (surface,
860
					 (cairo_image_surface_t *) image);
861
15
    if (unlikely (status))
862
	_cairo_surface_set_error (surface, status);
863

            
864
15
    return;
865

            
866
error:
867
    _cairo_surface_set_error (surface, status);
868
    cairo_surface_finish (image);
869
    cairo_surface_destroy (image);
870
}
871

            
872
cairo_surface_t *
873
1493
_cairo_surface_create_scratch (cairo_surface_t	 *other,
874
			       cairo_content_t	  content,
875
			       int		  width,
876
			       int		  height,
877
			       const cairo_color_t *color)
878
{
879
    cairo_surface_t *surface;
880
    cairo_status_t status;
881
    cairo_solid_pattern_t pattern;
882

            
883
1493
    if (unlikely (other->status))
884
	return _cairo_surface_create_in_error (other->status);
885

            
886
1493
    surface = NULL;
887
1493
    if (other->backend->create_similar)
888
1493
	surface = other->backend->create_similar (other, content, width, height);
889
1493
    if (surface == NULL)
890
	surface = cairo_surface_create_similar_image (other,
891
						      _cairo_format_from_content (content),
892
						      width, height);
893

            
894
1493
    if (unlikely (surface->status))
895
	return surface;
896

            
897
1493
    _cairo_surface_copy_similar_properties (surface, other);
898

            
899
1493
    if (unlikely (surface->status))
900
	return surface;
901

            
902
1493
    if (color) {
903
557
	_cairo_pattern_init_solid (&pattern, color);
904
557
	status = _cairo_surface_paint (surface,
905
557
				       color == CAIRO_COLOR_TRANSPARENT ?
906
				       CAIRO_OPERATOR_CLEAR : CAIRO_OPERATOR_SOURCE,
907
				       &pattern.base, NULL);
908
557
	if (unlikely (status)) {
909
	    cairo_surface_destroy (surface);
910
	    surface = _cairo_surface_create_in_error (status);
911
	}
912
    }
913

            
914
1493
    return surface;
915
}
916

            
917
/**
918
 * cairo_surface_reference:
919
 * @surface: a #cairo_surface_t
920
 *
921
 * Increases the reference count on @surface by one. This prevents
922
 * @surface from being destroyed until a matching call to
923
 * cairo_surface_destroy() is made.
924
 *
925
 * Use cairo_surface_get_reference_count() to get the number of
926
 * references to a #cairo_surface_t.
927
 *
928
 * Return value: the referenced #cairo_surface_t.
929
 *
930
 * Since: 1.0
931
 **/
932
cairo_surface_t *
933
478256
cairo_surface_reference (cairo_surface_t *surface)
934
{
935
478256
    if (surface == NULL ||
936
956508
	    CAIRO_REFERENCE_COUNT_IS_INVALID (&surface->ref_count))
937
3
	return surface;
938

            
939
956506
    assert (CAIRO_REFERENCE_COUNT_HAS_REFERENCE (&surface->ref_count));
940

            
941
478253
    _cairo_reference_count_inc (&surface->ref_count);
942

            
943
478253
    return surface;
944
}
945

            
946
/**
947
 * cairo_surface_destroy:
948
 * @surface: a #cairo_surface_t
949
 *
950
 * Decreases the reference count on @surface by one. If the result is
951
 * zero, then @surface and all associated resources are freed.  See
952
 * cairo_surface_reference().
953
 *
954
 * Since: 1.0
955
 **/
956
void
957
1022678
cairo_surface_destroy (cairo_surface_t *surface)
958
{
959
1022678
    if (surface == NULL ||
960
1696160
	    CAIRO_REFERENCE_COUNT_IS_INVALID (&surface->ref_count))
961
175019
	return;
962

            
963
1695318
    assert (CAIRO_REFERENCE_COUNT_HAS_REFERENCE (&surface->ref_count));
964

            
965
847659
    if (! _cairo_reference_count_dec_and_test (&surface->ref_count))
966
635741
	return;
967

            
968
211918
    assert (surface->snapshot_of == NULL);
969

            
970
211918
    if (! surface->finished) {
971
198869
	_cairo_surface_finish_snapshots (surface);
972
	/* We may have been referenced by a snapshot prior to have
973
	 * detaching it with the copy-on-write.
974
	 */
975
397738
	if (CAIRO_REFERENCE_COUNT_GET_VALUE (&surface->ref_count))
976
	    return;
977

            
978
198869
	_cairo_surface_finish (surface);
979
    }
980

            
981
211918
    if (surface->damage)
982
3
	_cairo_damage_destroy (surface->damage);
983

            
984
211918
    _cairo_user_data_array_fini (&surface->user_data);
985
211918
    _cairo_user_data_array_fini (&surface->mime_data);
986

            
987
211918
    if (surface->foreground_source)
988
90
	cairo_pattern_destroy (surface->foreground_source);
989

            
990
211918
    if (surface->owns_device)
991
23
        cairo_device_destroy (surface->device);
992

            
993
211918
    if (surface->has_font_options)
994
27831
	_cairo_font_options_fini (&surface->font_options);
995

            
996
211918
    assert (surface->snapshot_of == NULL);
997
211918
    assert (! _cairo_surface_has_snapshots (surface));
998
    /* paranoid check that nobody took a reference whilst finishing */
999
423836
    assert (! CAIRO_REFERENCE_COUNT_HAS_REFERENCE (&surface->ref_count));
211918
    free (surface);
}
/**
 * cairo_surface_get_reference_count:
 * @surface: a #cairo_surface_t
 *
 * Returns the current reference count of @surface.
 *
 * Return value: the current reference count of @surface.  If the
 * object is a nil object, 0 will be returned.
 *
 * Since: 1.4
 **/
unsigned int
4
cairo_surface_get_reference_count (cairo_surface_t *surface)
{
4
    if (surface == NULL ||
8
	    CAIRO_REFERENCE_COUNT_IS_INVALID (&surface->ref_count))
1
	return 0;
6
    return CAIRO_REFERENCE_COUNT_GET_VALUE (&surface->ref_count);
}
static void
211918
_cairo_surface_finish_snapshots (cairo_surface_t *surface)
{
    cairo_status_t status;
    /* update the snapshots *before* we declare the surface as finished */
211918
    surface->_finishing = TRUE;
211918
    status = _cairo_surface_flush (surface, 0);
    (void) status;
211918
}
static void
211918
_cairo_surface_finish (cairo_surface_t *surface)
{
    cairo_status_t status;
    /* call finish even if in error mode */
211918
    if (surface->backend->finish) {
210842
	status = surface->backend->finish (surface);
210842
	if (unlikely (status))
	    _cairo_surface_set_error (surface, status);
    }
211918
    surface->finished = TRUE;
211918
    assert (surface->snapshot_of == NULL);
211918
    assert (!_cairo_surface_has_snapshots (surface));
211918
}
/**
 * cairo_surface_finish:
 * @surface: the #cairo_surface_t to finish
 *
 * This function finishes the surface and drops all references to
 * external resources.  For example, for the Xlib backend it means
 * that cairo will no longer access the drawable, which can be freed.
 * After calling cairo_surface_finish() the only valid operations on a
 * surface are checking status, getting and setting user, referencing
 * and destroying, and flushing and finishing it.
 * Further drawing to the surface will not affect the
 * surface but will instead trigger a %CAIRO_STATUS_SURFACE_FINISHED
 * error.
 *
 * When the last call to cairo_surface_destroy() decreases the
 * reference count to zero, cairo will call cairo_surface_finish() if
 * it hasn't been called already, before freeing the resources
 * associated with the surface.
 *
 * Since: 1.0
 **/
void
13068
cairo_surface_finish (cairo_surface_t *surface)
{
13068
    if (surface == NULL)
3
	return;
26130
    if (CAIRO_REFERENCE_COUNT_IS_INVALID (&surface->ref_count))
4
	return;
13061
    if (surface->finished)
12
	return;
    /* We have to be careful when decoupling potential reference cycles */
13049
    cairo_surface_reference (surface);
13049
    _cairo_surface_finish_snapshots (surface);
    /* XXX need to block and wait for snapshot references */
13049
    _cairo_surface_finish (surface);
13049
    cairo_surface_destroy (surface);
}
/**
 * _cairo_surface_release_device_reference:
 * @surface: a #cairo_surface_t
 *
 * This function makes @surface release the reference to its device. The
 * function is intended to be used for avoiding cycling references for
 * surfaces that are owned by their device, for example cache surfaces.
 * Note that the @surface will still assume that the device is available.
 * So it is the caller's responsibility to ensure the device stays around
 * until the @surface is destroyed. Just calling cairo_surface_finish() is
 * not enough.
 **/
void
_cairo_surface_release_device_reference (cairo_surface_t *surface)
{
    assert (surface->owns_device);
    cairo_device_destroy (surface->device);
    surface->owns_device = FALSE;
}
/**
 * cairo_surface_get_user_data:
 * @surface: a #cairo_surface_t
 * @key: the address of the #cairo_user_data_key_t the user data was
 * attached to
 *
 * Return user data previously attached to @surface using the specified
 * key.  If no user data has been attached with the given key this
 * function returns %NULL.
 *
 * Return value: the user data previously attached or %NULL.
 *
 * Since: 1.0
 **/
void *
6
cairo_surface_get_user_data (cairo_surface_t		 *surface,
			     const cairo_user_data_key_t *key)
{
    /* Prevent reads of the array during teardown */
12
    if (! CAIRO_REFERENCE_COUNT_HAS_REFERENCE (&surface->ref_count))
	return NULL;
6
    return _cairo_user_data_array_get_data (&surface->user_data, key);
}
/**
 * cairo_surface_set_user_data:
 * @surface: a #cairo_surface_t
 * @key: the address of a #cairo_user_data_key_t to attach the user data to
 * @user_data: the user data to attach to the surface
 * @destroy: a #cairo_destroy_func_t which will be called when the
 * surface is destroyed or when new user data is attached using the
 * same key.
 *
 * Attach user data to @surface.  To remove user data from a surface,
 * call this function with the key that was used to set it and %NULL
 * for @data.
 *
 * Return value: %CAIRO_STATUS_SUCCESS or %CAIRO_STATUS_NO_MEMORY if a
 * slot could not be allocated for the user data.
 *
 * Since: 1.0
 **/
cairo_status_t
1741
cairo_surface_set_user_data (cairo_surface_t		 *surface,
			     const cairo_user_data_key_t *key,
			     void			 *user_data,
			     cairo_destroy_func_t	 destroy)
{
3482
    if (CAIRO_REFERENCE_COUNT_IS_INVALID (&surface->ref_count))
1
	return surface->status;
3480
    if (! CAIRO_REFERENCE_COUNT_HAS_REFERENCE (&surface->ref_count))
	return _cairo_error (CAIRO_STATUS_SURFACE_FINISHED);
1740
    return _cairo_user_data_array_set_data (&surface->user_data,
					    key, user_data, destroy);
}
/**
 * cairo_surface_get_mime_data:
 * @surface: a #cairo_surface_t
 * @mime_type: the mime type of the image data
 * @data: the image data to attached to the surface
 * @length: the length of the image data
 *
 * Return mime data previously attached to @surface using the
 * specified mime type.  If no data has been attached with the given
 * mime type, @data is set %NULL.
 *
 * Since: 1.10
 **/
void
174
cairo_surface_get_mime_data (cairo_surface_t		*surface,
                             const char			*mime_type,
                             const unsigned char       **data,
                             unsigned long		*length)
{
    cairo_user_data_slot_t *slots;
    int i, num_slots;
174
    *data = NULL;
174
    *length = 0;
    /* Prevent reads of the array during teardown */
348
    if (! CAIRO_REFERENCE_COUNT_HAS_REFERENCE (&surface->ref_count))
1
	return;
    /* The number of mime-types attached to a surface is usually small,
     * typically zero. Therefore it is quicker to do a strcmp() against
     * each key than it is to intern the string (i.e. compute a hash,
     * search the hash table, and do a final strcmp).
     */
173
    num_slots = surface->mime_data.num_elements;
173
    slots = _cairo_array_index (&surface->mime_data, 0);
174
    for (i = 0; i < num_slots; i++) {
3
	if (slots[i].key != NULL && strcmp ((char *) slots[i].key, mime_type) == 0) {
2
	    cairo_mime_data_t *mime_data = slots[i].user_data;
2
	    *data = mime_data->data;
2
	    *length = mime_data->length;
2
	    return;
	}
    }
}
static void
577
_cairo_mime_data_destroy (void *ptr)
{
577
    cairo_mime_data_t *mime_data = ptr;
577
    if (! _cairo_reference_count_dec_and_test (&mime_data->ref_count))
51
	return;
526
    if (mime_data->destroy && mime_data->closure)
508
	mime_data->destroy (mime_data->closure);
526
    free (mime_data);
}
static const char *_cairo_surface_image_mime_types[] = {
    CAIRO_MIME_TYPE_JPEG,
    CAIRO_MIME_TYPE_PNG,
    CAIRO_MIME_TYPE_JP2,
    CAIRO_MIME_TYPE_JBIG2,
    CAIRO_MIME_TYPE_CCITT_FAX,
};
cairo_bool_t
158
_cairo_surface_has_mime_image (cairo_surface_t *surface)
{
    cairo_user_data_slot_t *slots;
    int i, j, num_slots;
    /* Prevent reads of the array during teardown */
316
    if (! CAIRO_REFERENCE_COUNT_HAS_REFERENCE (&surface->ref_count))
	return FALSE;
    /* The number of mime-types attached to a surface is usually small,
     * typically zero. Therefore it is quicker to do a strcmp() against
     * each key than it is to intern the string (i.e. compute a hash,
     * search the hash table, and do a final strcmp).
     */
158
    num_slots = surface->mime_data.num_elements;
158
    slots = _cairo_array_index (&surface->mime_data, 0);
158
    for (i = 0; i < num_slots; i++) {
	if (slots[i].key != NULL) {
	    for (j = 0; j < ARRAY_LENGTH (_cairo_surface_image_mime_types); j++) {
		if (strcmp ((char *) slots[i].key, _cairo_surface_image_mime_types[j]) == 0)
		    return TRUE;
	    }
	}
    }
158
    return FALSE;
}
/**
 * CAIRO_MIME_TYPE_CCITT_FAX:
 *
 * Group 3 or Group 4 CCITT facsimile encoding (International
 * Telecommunication Union, Recommendations T.4 and T.6.)
 *
 * Since: 1.16
 **/
/**
 * CAIRO_MIME_TYPE_CCITT_FAX_PARAMS:
 *
 * Decode parameters for Group 3 or Group 4 CCITT facsimile encoding.
 * See [CCITT Fax Images][ccitt].
 *
 * Since: 1.16
 **/
/**
 * CAIRO_MIME_TYPE_EPS:
 *
 * Encapsulated PostScript file.
 * [Encapsulated PostScript File Format Specification](http://wwwimages.adobe.com/content/dam/Adobe/endevnet/postscript/pdfs/5002.EPSF_Spec.pdf)
 *
 * Since: 1.16
 **/
/**
 * CAIRO_MIME_TYPE_EPS_PARAMS:
 *
 * Embedding parameters Encapsulated PostScript data.
 * See [Embedding EPS files][eps].
 *
 * Since: 1.16
 **/
/**
 * CAIRO_MIME_TYPE_JBIG2:
 *
 * Joint Bi-level Image Experts Group image coding standard (ISO/IEC 11544).
 *
 * Since: 1.14
 **/
/**
 * CAIRO_MIME_TYPE_JBIG2_GLOBAL:
 *
 * Joint Bi-level Image Experts Group image coding standard (ISO/IEC 11544) global segment.
 *
 * Since: 1.14
 **/
/**
 * CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID:
 *
 * An unique identifier shared by a JBIG2 global segment and all JBIG2 images
 * that depend on the global segment.
 *
 * Since: 1.14
 **/
/**
 * CAIRO_MIME_TYPE_JP2:
 *
 * The Joint Photographic Experts Group (JPEG) 2000 image coding standard (ISO/IEC 15444-1).
 *
 * Since: 1.10
 **/
/**
 * CAIRO_MIME_TYPE_JPEG:
 *
 * The Joint Photographic Experts Group (JPEG) image coding standard (ISO/IEC 10918-1).
 *
 * Since: 1.10
 **/
/**
 * CAIRO_MIME_TYPE_PNG:
 *
 * The Portable Network Graphics image file format (ISO/IEC 15948).
 *
 * Since: 1.10
 **/
/**
 * CAIRO_MIME_TYPE_URI:
 *
 * URI for an image file (unofficial MIME type).
 *
 * Since: 1.10
 **/
/**
 * CAIRO_MIME_TYPE_UNIQUE_ID:
 *
 * Unique identifier for a surface (cairo specific MIME type). All surfaces with
 * the same unique identifier will only be embedded once.
 *
 * Since: 1.12
 **/
/**
 * cairo_surface_set_mime_data:
 * @surface: a #cairo_surface_t
 * @mime_type: the MIME type of the image data
 * @data: the image data to attach to the surface
 * @length: the length of the image data
 * @destroy: a #cairo_destroy_func_t which will be called when the
 * surface is destroyed or when new image data is attached using the
 * same mime type.
 * @closure: the data to be passed to the @destroy notifier
 *
 * Attach an image in the format @mime_type to @surface. To remove
 * the data from a surface, call this function with same mime type
 * and %NULL for @data.
 *
 * The attached image (or filename) data can later be used by backends
 * which support it (currently: PDF, PS, SVG and Win32 Printing
 * surfaces) to emit this data instead of making a snapshot of the
 * @surface.  This approach tends to be faster and requires less
 * memory and disk space.
 *
 * The recognized MIME types are the following: %CAIRO_MIME_TYPE_JPEG,
 * %CAIRO_MIME_TYPE_PNG, %CAIRO_MIME_TYPE_JP2, %CAIRO_MIME_TYPE_URI,
 * %CAIRO_MIME_TYPE_UNIQUE_ID, %CAIRO_MIME_TYPE_JBIG2,
 * %CAIRO_MIME_TYPE_JBIG2_GLOBAL, %CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID,
 * %CAIRO_MIME_TYPE_CCITT_FAX, %CAIRO_MIME_TYPE_CCITT_FAX_PARAMS.
 *
 * See corresponding backend surface docs for details about which MIME
 * types it can handle. Caution: the associated MIME data will be
 * discarded if you draw on the surface afterwards. Use this function
 * with care.
 *
 * Even if a backend supports a MIME type, that does not mean cairo
 * will always be able to use the attached MIME data. For example, if
 * the backend does not natively support the compositing operation used
 * to apply the MIME data to the backend. In that case, the MIME data
 * will be ignored. Therefore, to apply an image in all cases, it is best
 * to create an image surface which contains the decoded image data and
 * then attach the MIME data to that. This ensures the image will always
 * be used while still allowing the MIME data to be used whenever
 * possible.
 *
 * Return value: %CAIRO_STATUS_SUCCESS or %CAIRO_STATUS_NO_MEMORY if a
 * slot could not be allocated for the user data.
 *
 * Since: 1.10
 **/
cairo_status_t
1904
cairo_surface_set_mime_data (cairo_surface_t		*surface,
                             const char			*mime_type,
                             const unsigned char	*data,
                             unsigned long		 length,
			     cairo_destroy_func_t	 destroy,
			     void			*closure)
{
    cairo_status_t status;
    cairo_mime_data_t *mime_data;
3808
    if (CAIRO_REFERENCE_COUNT_IS_INVALID (&surface->ref_count))
2
	return surface->status;
3804
    if (! CAIRO_REFERENCE_COUNT_HAS_REFERENCE (&surface->ref_count))
	return _cairo_error (CAIRO_STATUS_SURFACE_FINISHED);
1902
    if (unlikely (surface->status))
	return surface->status;
1902
    if (unlikely (surface->finished))
3
	return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
1899
    status = _cairo_intern_string (&mime_type, -1);
1899
    if (unlikely (status))
	return _cairo_surface_set_error (surface, status);
1899
    if (data != NULL) {
1898
	mime_data = _cairo_calloc (sizeof (cairo_mime_data_t));
1898
	if (unlikely (mime_data == NULL))
	    return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_NO_MEMORY));
1898
	CAIRO_REFERENCE_COUNT_INIT (&mime_data->ref_count, 1);
1898
	mime_data->data = (unsigned char *) data;
1898
	mime_data->length = length;
1898
	mime_data->destroy = destroy;
1898
	mime_data->closure = closure;
    } else
1
	mime_data = NULL;
1899
    status = _cairo_user_data_array_set_data (&surface->mime_data,
					      (cairo_user_data_key_t *) mime_type,
					      mime_data,
					      _cairo_mime_data_destroy);
1899
    if (unlikely (status)) {
	free (mime_data);
	return _cairo_surface_set_error (surface, status);
    }
1899
    surface->is_clear = FALSE;
1899
    return CAIRO_STATUS_SUCCESS;
}
/**
 * cairo_surface_supports_mime_type:
 * @surface: a #cairo_surface_t
 * @mime_type: the mime type
 *
 * Return whether @surface supports @mime_type.
 *
 * Return value: %TRUE if @surface supports
 *               @mime_type, %FALSE otherwise
 *
 * Since: 1.12
 **/
cairo_bool_t
cairo_surface_supports_mime_type (cairo_surface_t		*surface,
				  const char			*mime_type)
{
    const char **types;
    if (unlikely (surface->status))
	return FALSE;
    if (unlikely (surface->finished)) {
	_cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
	return FALSE;
    }
    if (surface->backend->get_supported_mime_types) {
	types = surface->backend->get_supported_mime_types (surface);
	if (types) {
	    while (*types) {
		if (strcmp (*types, mime_type) == 0)
		    return TRUE;
		types++;
	    }
	}
    }
    return FALSE;
}
static void
51
_cairo_mime_data_reference (const void *key, void *elt, void *closure)
{
51
    cairo_mime_data_t *mime_data = elt;
51
    _cairo_reference_count_inc (&mime_data->ref_count);
51
}
cairo_status_t
345
_cairo_surface_copy_mime_data (cairo_surface_t *dst,
			       cairo_surface_t *src)
{
    cairo_status_t status;
345
    if (dst->status)
	return dst->status;
345
    if (src->status)
	return _cairo_surface_set_error (dst, src->status);
    /* first copy the mime-data, discarding any already set on dst */
345
    status = _cairo_user_data_array_copy (&dst->mime_data, &src->mime_data);
345
    if (unlikely (status))
	return _cairo_surface_set_error (dst, status);
    /* now increment the reference counters for the copies */
345
    _cairo_user_data_array_foreach (&dst->mime_data,
				    _cairo_mime_data_reference,
				    NULL);
345
    dst->is_clear = FALSE;
345
    return CAIRO_STATUS_SUCCESS;
}
/**
 * _cairo_surface_set_font_options:
 * @surface: a #cairo_surface_t
 * @options: a #cairo_font_options_t object that contains the
 *   options to use for this surface instead of backend's default
 *   font options.
 *
 * Sets the default font rendering options for the surface.
 * This is useful to correctly propagate default font options when
 * falling back to an image surface in a backend implementation.
 * This affects the options returned in cairo_surface_get_font_options().
 *
 * If @options is %NULL the surface options are reset to those of
 * the backend default.
 **/
void
5718
_cairo_surface_set_font_options (cairo_surface_t       *surface,
				 cairo_font_options_t  *options)
{
5718
    if (surface->status)
	return;
5718
    assert (surface->snapshot_of == NULL);
5718
    if (surface->finished) {
	_cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
	return;
    }
5718
    if (options) {
5718
	surface->has_font_options = TRUE;
5718
	_cairo_font_options_init_copy (&surface->font_options, options);
    } else {
	surface->has_font_options = FALSE;
    }
}
/**
 * cairo_surface_get_font_options:
 * @surface: a #cairo_surface_t
 * @options: a #cairo_font_options_t object into which to store
 *   the retrieved options. All existing values are overwritten
 *
 * Retrieves the default font rendering options for the surface.
 * This allows display surfaces to report the correct subpixel order
 * for rendering on them, print surfaces to disable hinting of
 * metrics and so forth. The result can then be used with
 * cairo_scaled_font_create().
 *
 * Since: 1.0
 **/
void
136473
cairo_surface_get_font_options (cairo_surface_t       *surface,
				cairo_font_options_t  *options)
{
136473
    if (cairo_font_options_status (options))
	return;
136473
    if (surface->status) {
1
	_cairo_font_options_init_default (options);
1
	return;
    }
136472
    if (! surface->has_font_options) {
22323
	surface->has_font_options = TRUE;
22323
	_cairo_font_options_init_default (&surface->font_options);
22323
	if (!surface->finished && surface->backend->get_font_options) {
22071
	    surface->backend->get_font_options (surface, &surface->font_options);
	}
    }
136472
    _cairo_font_options_init_copy (options, &surface->font_options);
}
cairo_status_t
1498172
_cairo_surface_flush (cairo_surface_t *surface, unsigned flags)
{
    /* update the current snapshots *before* the user updates the surface */
1498172
    _cairo_surface_detach_snapshots (surface);
1498172
    if (surface->snapshot_of != NULL)
11519
	_cairo_surface_detach_snapshot (surface);
1498172
    _cairo_surface_detach_mime_data (surface);
1498172
    return __cairo_surface_flush (surface, flags);
}
/**
 * cairo_surface_flush:
 * @surface: a #cairo_surface_t
 *
 * Do any pending drawing for the surface and also restore any temporary
 * modifications cairo has made to the surface's state. This function
 * must be called before switching from drawing on the surface with
 * cairo to drawing on it directly with native APIs, or accessing its
 * memory outside of Cairo. If the surface doesn't support direct
 * access, then this function does nothing.
 *
 * Since: 1.0
 **/
void
3093
cairo_surface_flush (cairo_surface_t *surface)
{
    cairo_status_t status;
3093
    if (surface->status)
1
	return;
3092
    if (surface->finished)
3
	return;
3089
    status = _cairo_surface_flush (surface, 0);
3089
    if (unlikely (status))
	_cairo_surface_set_error (surface, status);
}
/**
 * cairo_surface_mark_dirty:
 * @surface: a #cairo_surface_t
 *
 * Tells cairo that drawing has been done to surface using means other
 * than cairo, and that cairo should reread any cached areas. Note
 * that you must call cairo_surface_flush() before doing such drawing.
 *
 * Since: 1.0
 **/
void
43
cairo_surface_mark_dirty (cairo_surface_t *surface)
{
    cairo_rectangle_int_t extents;
43
    if (unlikely (surface->status))
4
	return;
42
    if (unlikely (surface->finished)) {
3
	_cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
3
	return;
    }
39
    _cairo_surface_get_extents (surface, &extents);
39
    cairo_surface_mark_dirty_rectangle (surface,
					extents.x, extents.y,
					extents.width, extents.height);
}
/**
 * cairo_surface_mark_dirty_rectangle:
 * @surface: a #cairo_surface_t
 * @x: X coordinate of dirty rectangle
 * @y: Y coordinate of dirty rectangle
 * @width: width of dirty rectangle
 * @height: height of dirty rectangle
 *
 * Like cairo_surface_mark_dirty(), but drawing has been done only to
 * the specified rectangle, so that cairo can retain cached contents
 * for other parts of the surface.
 *
 * Any cached clip set on the surface will be reset by this function,
 * to make sure that future cairo calls have the clip set that they
 * expect.
 *
 * Since: 1.0
 **/
void
43
cairo_surface_mark_dirty_rectangle (cairo_surface_t *surface,
				    int              x,
				    int              y,
				    int              width,
				    int              height)
{
    cairo_status_t status;
43
    if (unlikely (surface->status))
1
	return;
42
    assert (surface->snapshot_of == NULL);
42
    if (unlikely (surface->finished)) {
3
	_cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
3
	return;
    }
    /* The application *should* have called cairo_surface_flush() before
     * modifying the surface independently of cairo (and thus having to
     * call mark_dirty()). */
39
    assert (! _cairo_surface_has_snapshots (surface));
39
    assert (! _cairo_surface_has_mime_data (surface));
39
    surface->is_clear = FALSE;
39
    surface->serial++;
39
    if (surface->damage) {
	cairo_box_t box;
	box.p1.x = x;
	box.p1.y = y;
	box.p2.x = x + width;
	box.p2.y = y + height;
	surface->damage = _cairo_damage_add_box (surface->damage, &box);
    }
39
    if (surface->backend->mark_dirty_rectangle != NULL) {
	/* XXX: FRAGILE: We're ignoring the scaling component of
	 * device_transform here. I don't know what the right thing to
	 * do would actually be if there were some scaling here, but
	 * we avoid this since device_transfom scaling is not exported
	 * publicly and mark_dirty is not used internally. */
	status = surface->backend->mark_dirty_rectangle (surface,
                                                         x + surface->device_transform.x0,
                                                         y + surface->device_transform.y0,
							 width, height);
	if (unlikely (status))
	    _cairo_surface_set_error (surface, status);
    }
}
/**
 * cairo_surface_set_device_scale:
 * @surface: a #cairo_surface_t
 * @x_scale: a scale factor in the X direction
 * @y_scale: a scale factor in the Y direction
 *
 * Sets a scale that is multiplied to the device coordinates determined
 * by the CTM when drawing to @surface. One common use for this is to
 * render to very high resolution display devices at a scale factor, so
 * that code that assumes 1 pixel will be a certain size will still work.
 * Setting a transformation via cairo_scale() isn't
 * sufficient to do this, since functions like
 * cairo_device_to_user() will expose the hidden scale.
 *
 * Note that the scale affects drawing to the surface as well as
 * using the surface in a source pattern.
 *
 * Since: 1.14
 **/
void
10139
cairo_surface_set_device_scale (cairo_surface_t *surface,
				double		 x_scale,
				double		 y_scale)
{
    cairo_status_t status;
10139
    if (unlikely (surface->status))
	return;
10139
    assert (surface->snapshot_of == NULL);
10139
    if (unlikely (surface->finished)) {
	_cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
	return;
    }
10139
    status = _cairo_surface_begin_modification (surface);
10139
    if (unlikely (status)) {
	_cairo_surface_set_error (surface, status);
	return;
    }
10139
    surface->device_transform.xx = x_scale;
10139
    surface->device_transform.yy = y_scale;
10139
    surface->device_transform.xy = 0.0;
10139
    surface->device_transform.yx = 0.0;
10139
    surface->device_transform_inverse = surface->device_transform;
10139
    status = cairo_matrix_invert (&surface->device_transform_inverse);
    /* should always be invertible unless given pathological input */
10139
    assert (status == CAIRO_STATUS_SUCCESS);
10139
    _cairo_observers_notify (&surface->device_transform_observers, surface);
}
/**
 * cairo_surface_get_device_scale:
 * @surface: a #cairo_surface_t
 * @x_scale: the scale in the X direction, in device units
 * @y_scale: the scale in the Y direction, in device units
 *
 * This function returns the previous device scale set by
 * cairo_surface_set_device_scale().
 *
 * Since: 1.14
 **/
void
cairo_surface_get_device_scale (cairo_surface_t *surface,
				double          *x_scale,
				double          *y_scale)
{
    if (x_scale)
	*x_scale = surface->device_transform.xx;
    if (y_scale)
	*y_scale = surface->device_transform.yy;
}
/**
 * cairo_surface_set_device_offset:
 * @surface: a #cairo_surface_t
 * @x_offset: the offset in the X direction, in device units
 * @y_offset: the offset in the Y direction, in device units
 *
 * Sets an offset that is added to the device coordinates determined
 * by the CTM when drawing to @surface. One use case for this function
 * is when we want to create a #cairo_surface_t that redirects drawing
 * for a portion of an onscreen surface to an offscreen surface in a
 * way that is completely invisible to the user of the cairo
 * API. Setting a transformation via cairo_translate() isn't
 * sufficient to do this, since functions like
 * cairo_device_to_user() will expose the hidden offset.
 *
 * Note that the offset affects drawing to the surface as well as
 * using the surface in a source pattern.
 *
 * Since: 1.0
 **/
void
6554
cairo_surface_set_device_offset (cairo_surface_t *surface,
				 double           x_offset,
				 double           y_offset)
{
    cairo_status_t status;
6554
    if (unlikely (surface->status))
2
	return;
6552
    assert (surface->snapshot_of == NULL);
6552
    if (unlikely (surface->finished)) {
3
	_cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
3
	return;
    }
6549
    status = _cairo_surface_begin_modification (surface);
6549
    if (unlikely (status)) {
	_cairo_surface_set_error (surface, status);
	return;
    }
6549
    surface->device_transform.x0 = x_offset;
6549
    surface->device_transform.y0 = y_offset;
6549
    surface->device_transform_inverse = surface->device_transform;
6549
    status = cairo_matrix_invert (&surface->device_transform_inverse);
    /* should always be invertible unless given pathological input */
6549
    assert (status == CAIRO_STATUS_SUCCESS);
6549
    _cairo_observers_notify (&surface->device_transform_observers, surface);
}
/**
 * cairo_surface_get_device_offset:
 * @surface: a #cairo_surface_t
 * @x_offset: the offset in the X direction, in device units
 * @y_offset: the offset in the Y direction, in device units
 *
 * This function returns the previous device offset set by
 * cairo_surface_set_device_offset().
 *
 * Since: 1.2
 **/
void
292
cairo_surface_get_device_offset (cairo_surface_t *surface,
				 double          *x_offset,
				 double          *y_offset)
{
292
    if (x_offset)
292
	*x_offset = surface->device_transform.x0;
292
    if (y_offset)
292
	*y_offset = surface->device_transform.y0;
292
}
/**
 * cairo_surface_set_fallback_resolution:
 * @surface: a #cairo_surface_t
 * @x_pixels_per_inch: horizontal setting for pixels per inch
 * @y_pixels_per_inch: vertical setting for pixels per inch
 *
 * Set the horizontal and vertical resolution for image fallbacks.
 *
 * When certain operations aren't supported natively by a backend,
 * cairo will fallback by rendering operations to an image and then
 * overlaying that image onto the output. For backends that are
 * natively vector-oriented, this function can be used to set the
 * resolution used for these image fallbacks, (larger values will
 * result in more detailed images, but also larger file sizes).
 *
 * Some examples of natively vector-oriented backends are the ps, pdf,
 * and svg backends.
 *
 * For backends that are natively raster-oriented, image fallbacks are
 * still possible, but they are always performed at the native
 * device resolution. So this function has no effect on those
 * backends.
 *
 * Note: The fallback resolution only takes effect at the time of
 * completing a page (with cairo_show_page() or cairo_copy_page()) so
 * there is currently no way to have more than one fallback resolution
 * in effect on a single page.
 *
 * The default fallback resolution is 300 pixels per inch in both
 * dimensions.
 *
 * Since: 1.2
 **/
void
9202
cairo_surface_set_fallback_resolution (cairo_surface_t	*surface,
				       double		 x_pixels_per_inch,
				       double		 y_pixels_per_inch)
{
    cairo_status_t status;
9202
    if (unlikely (surface->status))
2
	return;
9200
    assert (surface->snapshot_of == NULL);
9200
    if (unlikely (surface->finished)) {
3
	_cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
3
	return;
    }
9197
    if (x_pixels_per_inch <= 0 || y_pixels_per_inch <= 0) {
	/* XXX Could delay raising the error until we fallback, but throwing
	 * the error here means that we can catch the real culprit.
	 */
	_cairo_surface_set_error (surface, CAIRO_STATUS_INVALID_MATRIX);
	return;
    }
9197
    status = _cairo_surface_begin_modification (surface);
9197
    if (unlikely (status)) {
	_cairo_surface_set_error (surface, status);
	return;
    }
9197
    surface->x_fallback_resolution = x_pixels_per_inch;
9197
    surface->y_fallback_resolution = y_pixels_per_inch;
}
/**
 * cairo_surface_get_fallback_resolution:
 * @surface: a #cairo_surface_t
 * @x_pixels_per_inch: horizontal pixels per inch
 * @y_pixels_per_inch: vertical pixels per inch
 *
 * This function returns the previous fallback resolution set by
 * cairo_surface_set_fallback_resolution(), or default fallback
 * resolution if never set.
 *
 * Since: 1.8
 **/
void
4
cairo_surface_get_fallback_resolution (cairo_surface_t	*surface,
				       double		*x_pixels_per_inch,
				       double		*y_pixels_per_inch)
{
4
    if (x_pixels_per_inch)
4
	*x_pixels_per_inch = surface->x_fallback_resolution;
4
    if (y_pixels_per_inch)
4
	*y_pixels_per_inch = surface->y_fallback_resolution;
4
}
cairo_bool_t
1382555
_cairo_surface_has_device_transform (cairo_surface_t *surface)
{
1382555
    return ! _cairo_matrix_is_identity (&surface->device_transform);
}
/**
 * _cairo_surface_acquire_source_image:
 * @surface: a #cairo_surface_t
 * @image_out: location to store a pointer to an image surface that
 *    has identical contents to @surface. This surface could be @surface
 *    itself, a surface held internal to @surface, or it could be a new
 *    surface with a copy of the relevant portion of @surface.
 * @image_extra: location to store image specific backend data
 *
 * Gets an image surface to use when drawing as a fallback when drawing with
 * @surface as a source. _cairo_surface_release_source_image() must be called
 * when finished.
 *
 * Return value: %CAIRO_STATUS_SUCCESS if an image was stored in @image_out.
 * %CAIRO_INT_STATUS_UNSUPPORTED if an image cannot be retrieved for the specified
 * surface. Or %CAIRO_STATUS_NO_MEMORY.
 **/
cairo_status_t
2281
_cairo_surface_acquire_source_image (cairo_surface_t         *surface,
				     cairo_image_surface_t  **image_out,
				     void                   **image_extra)
{
    cairo_status_t status;
2281
    if (unlikely (surface->status))
	return surface->status;
2281
    assert (!surface->finished);
2281
    if (surface->backend->acquire_source_image == NULL)
	return CAIRO_INT_STATUS_UNSUPPORTED;
2281
    status = surface->backend->acquire_source_image (surface,
						     image_out, image_extra);
2281
    if (unlikely (status))
	return _cairo_surface_set_error (surface, status);
    _cairo_debug_check_image_surface_is_defined (&(*image_out)->base);
2281
    return CAIRO_STATUS_SUCCESS;
}
cairo_status_t
_cairo_surface_default_acquire_source_image (void                    *_surface,
					     cairo_image_surface_t  **image_out,
					     void                   **image_extra)
{
    cairo_surface_t *surface = _surface;
    cairo_rectangle_int_t extents;
    if (unlikely (! surface->backend->get_extents (surface, &extents)))
	return _cairo_error (CAIRO_STATUS_INVALID_SIZE);
    *image_out = _cairo_surface_map_to_image (surface, &extents);
    *image_extra = NULL;
    return (*image_out)->base.status;
}
/**
 * _cairo_surface_release_source_image:
 * @surface: a #cairo_surface_t
 * @image_extra: same as return from the matching _cairo_surface_acquire_source_image()
 *
 * Releases any resources obtained with _cairo_surface_acquire_source_image()
 **/
void
2281
_cairo_surface_release_source_image (cairo_surface_t        *surface,
				     cairo_image_surface_t  *image,
				     void                   *image_extra)
{
2281
    assert (!surface->finished);
2281
    if (surface->backend->release_source_image)
2281
	surface->backend->release_source_image (surface, image, image_extra);
2281
}
void
_cairo_surface_default_release_source_image (void                   *surface,
					     cairo_image_surface_t  *image,
					     void                   *image_extra)
{
    cairo_status_t ignored;
    ignored = _cairo_surface_unmap_image (surface, image);
    (void)ignored;
}
cairo_surface_t *
330307
_cairo_surface_get_source (cairo_surface_t *surface,
			   cairo_rectangle_int_t *extents)
{
330307
    assert (surface->backend->source);
330307
    return surface->backend->source (surface, extents);
}
cairo_surface_t *
246018
_cairo_surface_default_source (void *surface,
			       cairo_rectangle_int_t *extents)
{
246018
    if (extents)
245854
	_cairo_surface_get_extents(surface, extents);
246018
    return surface;
}
static cairo_status_t
1272442
_pattern_has_error (const cairo_pattern_t *pattern)
{
    const cairo_surface_pattern_t *spattern;
1272442
    if (unlikely (pattern->status))
	return pattern->status;
1272442
    if (pattern->type != CAIRO_PATTERN_TYPE_SURFACE)
896651
	return CAIRO_STATUS_SUCCESS;
375791
    spattern = (const cairo_surface_pattern_t *) pattern;
375791
    if (unlikely (spattern->surface->status))
	return spattern->surface->status;
375791
    if (unlikely (spattern->surface->finished))
	return _cairo_error (CAIRO_STATUS_SURFACE_FINISHED);
375791
    return CAIRO_STATUS_SUCCESS;
}
static cairo_bool_t
1267279
nothing_to_do (cairo_surface_t *surface,
	       cairo_operator_t op,
	       const cairo_pattern_t *source)
{
1267279
    if (_cairo_pattern_is_clear (source)) {
11345
	if (op == CAIRO_OPERATOR_OVER || op == CAIRO_OPERATOR_ADD)
829
	    return TRUE;
10516
	if (op == CAIRO_OPERATOR_SOURCE)
17
	    op = CAIRO_OPERATOR_CLEAR;
    }
1266450
    if (op == CAIRO_OPERATOR_CLEAR && surface->is_clear)
10085
	return TRUE;
1256365
    if (op == CAIRO_OPERATOR_ATOP && (surface->content & CAIRO_CONTENT_COLOR) ==0)
3
	return TRUE;
1256362
    return FALSE;
}
cairo_status_t
649571
_cairo_surface_paint (cairo_surface_t		*surface,
		      cairo_operator_t		 op,
		      const cairo_pattern_t	*source,
		      const cairo_clip_t	*clip)
{
    cairo_int_status_t status;
    cairo_bool_t is_clear;
    TRACE ((stderr, "%s\n", __FUNCTION__));
649571
    if (unlikely (surface->status))
	return surface->status;
649571
    if (unlikely (surface->finished))
18
	return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
649553
    if (_cairo_clip_is_all_clipped (clip))
	return CAIRO_STATUS_SUCCESS;
649553
    status = _pattern_has_error (source);
649553
    if (unlikely (status))
	return status;
649553
    if (nothing_to_do (surface, op, source))
10203
	return CAIRO_STATUS_SUCCESS;
639350
    status = _cairo_surface_begin_modification (surface);
639350
    if (unlikely (status))
	return status;
639350
    if (source->is_foreground_marker && surface->foreground_source) {
	source = surface->foreground_source;
	surface->foreground_used = TRUE;
    }
639350
    status = surface->backend->paint (surface, op, source, clip);
639350
    is_clear = op == CAIRO_OPERATOR_CLEAR && clip == NULL;
639350
    if (status != CAIRO_INT_STATUS_NOTHING_TO_DO || is_clear) {
563227
	surface->is_clear = is_clear;
563227
	surface->serial++;
    }
639350
    return _cairo_surface_set_error (surface, status);
}
cairo_status_t
4710
_cairo_surface_mask (cairo_surface_t		*surface,
		     cairo_operator_t		 op,
		     const cairo_pattern_t	*source,
		     const cairo_pattern_t	*mask,
		     const cairo_clip_t		*clip)
{
    cairo_int_status_t status;
    TRACE ((stderr, "%s\n", __FUNCTION__));
4710
    if (unlikely (surface->status))
	return surface->status;
4710
    if (unlikely (surface->finished))
	return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
4710
    if (_cairo_clip_is_all_clipped (clip))
	return CAIRO_STATUS_SUCCESS;
    /* If the mask is blank, this is just an expensive no-op */
4710
    if (_cairo_pattern_is_clear (mask) &&
48
	_cairo_operator_bounded_by_mask (op))
    {
	return CAIRO_STATUS_SUCCESS;
    }
4710
    status = _pattern_has_error (source);
4710
    if (unlikely (status))
	return status;
4710
    status = _pattern_has_error (mask);
4710
    if (unlikely (status))
	return status;
4710
    if (nothing_to_do (surface, op, source))
	return CAIRO_STATUS_SUCCESS;
4710
    status = _cairo_surface_begin_modification (surface);
4710
    if (unlikely (status))
	return status;
4710
    if (source->is_foreground_marker && surface->foreground_source) {
	source = surface->foreground_source;
	surface->foreground_used = TRUE;
    }
4710
    status = surface->backend->mask (surface, op, source, mask, clip);
4710
    if (status != CAIRO_INT_STATUS_NOTHING_TO_DO) {
4551
	surface->is_clear = FALSE;
4551
	surface->serial++;
    }
4710
    return _cairo_surface_set_error (surface, status);
}
cairo_status_t
_cairo_surface_fill_stroke (cairo_surface_t	    *surface,
			    cairo_operator_t	     fill_op,
			    const cairo_pattern_t   *fill_source,
			    cairo_fill_rule_t	     fill_rule,
			    double		     fill_tolerance,
			    cairo_antialias_t	     fill_antialias,
			    cairo_path_fixed_t	    *path,
			    cairo_operator_t	     stroke_op,
			    const cairo_pattern_t   *stroke_source,
			    const cairo_stroke_style_t    *stroke_style,
			    const cairo_matrix_t	    *stroke_ctm,
			    const cairo_matrix_t	    *stroke_ctm_inverse,
			    double		     stroke_tolerance,
			    cairo_antialias_t	     stroke_antialias,
			    const cairo_clip_t	    *clip)
{
    cairo_int_status_t status;
    TRACE ((stderr, "%s\n", __FUNCTION__));
    if (unlikely (surface->status))
	return surface->status;
    if (unlikely (surface->finished))
	return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
    if (_cairo_clip_is_all_clipped (clip))
	return CAIRO_STATUS_SUCCESS;
    if (surface->is_clear &&
	fill_op == CAIRO_OPERATOR_CLEAR &&
	stroke_op == CAIRO_OPERATOR_CLEAR)
    {
	return CAIRO_STATUS_SUCCESS;
    }
    status = _pattern_has_error (fill_source);
    if (unlikely (status))
	return status;
    status = _pattern_has_error (stroke_source);
    if (unlikely (status))
	return status;
    status = _cairo_surface_begin_modification (surface);
    if (unlikely (status))
	return status;
    if (fill_source->is_foreground_marker && surface->foreground_source) {
	fill_source = surface->foreground_source;
	surface->foreground_used = TRUE;
    }
    if (stroke_source->is_foreground_marker && surface->foreground_source) {
	stroke_source = surface->foreground_source;
	surface->foreground_used = TRUE;
    }
    if (surface->backend->fill_stroke) {
	cairo_matrix_t dev_ctm = *stroke_ctm;
	cairo_matrix_t dev_ctm_inverse = *stroke_ctm_inverse;
	status = surface->backend->fill_stroke (surface,
						fill_op, fill_source, fill_rule,
						fill_tolerance, fill_antialias,
						path,
						stroke_op, stroke_source,
						stroke_style,
						&dev_ctm, &dev_ctm_inverse,
						stroke_tolerance, stroke_antialias,
						clip);
	if (status != CAIRO_INT_STATUS_UNSUPPORTED)
	    goto FINISH;
    }
    status = _cairo_surface_fill (surface, fill_op, fill_source, path,
				  fill_rule, fill_tolerance, fill_antialias,
				  clip);
    if (unlikely (status))
	goto FINISH;
    status = _cairo_surface_stroke (surface, stroke_op, stroke_source, path,
				    stroke_style, stroke_ctm, stroke_ctm_inverse,
				    stroke_tolerance, stroke_antialias,
				    clip);
    if (unlikely (status))
	goto FINISH;
  FINISH:
    if (status != CAIRO_INT_STATUS_NOTHING_TO_DO) {
	surface->is_clear = FALSE;
	surface->serial++;
    }
    return _cairo_surface_set_error (surface, status);
}
cairo_status_t
41483
_cairo_surface_stroke (cairo_surface_t			*surface,
		       cairo_operator_t			 op,
		       const cairo_pattern_t		*source,
		       const cairo_path_fixed_t		*path,
		       const cairo_stroke_style_t	*stroke_style,
		       const cairo_matrix_t		*ctm,
		       const cairo_matrix_t		*ctm_inverse,
		       double				 tolerance,
		       cairo_antialias_t		 antialias,
		       const cairo_clip_t		*clip)
{
    cairo_int_status_t status;
    TRACE ((stderr, "%s\n", __FUNCTION__));
41483
    if (unlikely (surface->status))
	return surface->status;
41483
    if (unlikely (surface->finished))
12
	return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
41471
    if (_cairo_clip_is_all_clipped (clip))
	return CAIRO_STATUS_SUCCESS;
41471
    status = _pattern_has_error (source);
41471
    if (unlikely (status))
	return status;
41471
    if (nothing_to_do (surface, op, source))
12
	return CAIRO_STATUS_SUCCESS;
41459
    status = _cairo_surface_begin_modification (surface);
41459
    if (unlikely (status))
	return status;
41459
    if (source->is_foreground_marker && surface->foreground_source) {
	source = surface->foreground_source;
	surface->foreground_used = TRUE;
    }
41459
    status = surface->backend->stroke (surface, op, source,
				       path, stroke_style,
				       ctm, ctm_inverse,
				       tolerance, antialias,
				       clip);
41459
    if (status != CAIRO_INT_STATUS_NOTHING_TO_DO) {
41012
	surface->is_clear = FALSE;
41012
	surface->serial++;
    }
41459
    return _cairo_surface_set_error (surface, status);
}
cairo_status_t
501408
_cairo_surface_fill (cairo_surface_t		*surface,
		     cairo_operator_t		 op,
		     const cairo_pattern_t	 *source,
		     const cairo_path_fixed_t	*path,
		     cairo_fill_rule_t		 fill_rule,
		     double			 tolerance,
		     cairo_antialias_t		 antialias,
		     const cairo_clip_t		*clip)
{
    cairo_int_status_t status;
    TRACE ((stderr, "%s\n", __FUNCTION__));
501408
    if (unlikely (surface->status))
6
	return surface->status;
501402
    if (unlikely (surface->finished))
	return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
501402
    if (_cairo_clip_is_all_clipped (clip))
	return CAIRO_STATUS_SUCCESS;
501402
    status = _pattern_has_error (source);
501402
    if (unlikely (status))
	return status;
501402
    if (nothing_to_do (surface, op, source))
690
	return CAIRO_STATUS_SUCCESS;
500712
    status = _cairo_surface_begin_modification (surface);
500712
    if (unlikely (status))
	return status;
500712
    if (source->is_foreground_marker && surface->foreground_source) {
21
	source = surface->foreground_source;
21
	surface->foreground_used = TRUE;
    }
500712
    status = surface->backend->fill (surface, op, source,
				     path, fill_rule,
				     tolerance, antialias,
				     clip);
500712
    if (status != CAIRO_INT_STATUS_NOTHING_TO_DO) {
284162
	surface->is_clear = FALSE;
284162
	surface->serial++;
    }
500712
    return _cairo_surface_set_error (surface, status);
}
/**
 * cairo_surface_copy_page:
 * @surface: a #cairo_surface_t
 *
 * Emits the current page for backends that support multiple pages,
 * but doesn't clear it, so that the contents of the current page will
 * be retained for the next page.  Use cairo_surface_show_page() if you
 * want to get an empty page after the emission.
 *
 * There is a convenience function for this that takes a #cairo_t,
 * namely cairo_copy_page().
 *
 * Since: 1.6
 **/
void
10
cairo_surface_copy_page (cairo_surface_t *surface)
{
10
    if (unlikely (surface->status))
1
	return;
9
    assert (surface->snapshot_of == NULL);
9
    if (unlikely (surface->finished)) {
9
	_cairo_surface_set_error (surface, CAIRO_STATUS_SURFACE_FINISHED);
9
	return;
    }
    /* It's fine if some backends don't implement copy_page */
    if (surface->backend->copy_page == NULL)
	return;
    _cairo_surface_set_error (surface, surface->backend->copy_page (surface));
}
/**
 * cairo_surface_show_page:
 * @surface: a #cairo_Surface_t
 *
 * Emits and clears the current page for backends that support multiple
 * pages.  Use cairo_surface_copy_page() if you don't want to clear the page.
 *
 * There is a convenience function for this that takes a #cairo_t,
 * namely cairo_show_page().
 *
 * Since: 1.6
 **/
void
43
cairo_surface_show_page (cairo_surface_t *surface)
{
    cairo_status_t status;
43
    if (unlikely (surface->status))
1
	return;
42
    if (unlikely (surface->finished)) {
9
	_cairo_surface_set_error (surface, CAIRO_STATUS_SURFACE_FINISHED);
9
	return;
    }
33
    status = _cairo_surface_begin_modification (surface);
33
    if (unlikely (status)) {
	_cairo_surface_set_error (surface, status);
	return;
    }
    /* It's fine if some backends don't implement show_page */
33
    if (surface->backend->show_page == NULL)
	return;
33
    _cairo_surface_set_error (surface, surface->backend->show_page (surface));
}
/**
 * _cairo_surface_get_extents:
 * @surface: the #cairo_surface_t to fetch extents for
 *
 * This function returns a bounding box for the surface.  The surface
 * bounds are defined as a region beyond which no rendering will
 * possibly be recorded, in other words, it is the maximum extent of
 * potentially usable coordinates.
 *
 * For vector surfaces, (PDF, PS, SVG and recording-surfaces), the surface
 * might be conceived as unbounded, but we force the user to provide a
 * maximum size at the time of surface_create. So get_extents uses
 * that size.
 *
 * Note: The coordinates returned are in "backend" space rather than
 * "surface" space. That is, they are relative to the true (0,0)
 * origin rather than the device_transform origin. This might seem a
 * bit inconsistent with other #cairo_surface_t interfaces, but all
 * current callers are within the surface layer where backend space is
 * desired.
 *
 * This behavior would have to be changed is we ever exported a public
 * variant of this function.
 **/
cairo_bool_t
3277258
_cairo_surface_get_extents (cairo_surface_t         *surface,
			    cairo_rectangle_int_t   *extents)
{
    cairo_bool_t bounded;
3277258
    if (unlikely (surface->status))
6
	goto zero_extents;
3277252
    if (unlikely (surface->finished)) {
30
	_cairo_surface_set_error(surface, CAIRO_STATUS_SURFACE_FINISHED);
30
	goto zero_extents;
    }
3277222
    bounded = FALSE;
3277222
    if (surface->backend->get_extents != NULL)
3274597
	bounded = surface->backend->get_extents (surface, extents);
3277222
    if (! bounded)
1056881
	_cairo_unbounded_rectangle_init (extents);
3277222
    return bounded;
36
zero_extents:
36
    extents->x = extents->y = 0;
36
    extents->width = extents->height = 0;
36
    return TRUE;
}
/**
 * cairo_surface_has_show_text_glyphs:
 * @surface: a #cairo_surface_t
 *
 * Returns whether the surface supports
 * sophisticated cairo_show_text_glyphs() operations.  That is,
 * whether it actually uses the provided text and cluster data
 * to a cairo_show_text_glyphs() call.
 *
 * Note: Even if this function returns %FALSE, a
 * cairo_show_text_glyphs() operation targeted at @surface will
 * still succeed.  It just will
 * act like a cairo_show_glyphs() operation.  Users can use this
 * function to avoid computing UTF-8 text and cluster mapping if the
 * target surface does not use it.
 *
 * Return value: %TRUE if @surface supports
 *               cairo_show_text_glyphs(), %FALSE otherwise
 *
 * Since: 1.8
 **/
cairo_bool_t
69691
cairo_surface_has_show_text_glyphs (cairo_surface_t	    *surface)
{
69691
    if (unlikely (surface->status))
1
	return FALSE;
69690
    if (unlikely (surface->finished)) {
9
	_cairo_surface_set_error (surface, CAIRO_STATUS_SURFACE_FINISHED);
9
	return FALSE;
    }
69681
    if (surface->backend->has_show_text_glyphs)
513
	return surface->backend->has_show_text_glyphs (surface);
    else
69168
	return surface->backend->show_text_glyphs != NULL;
}
#define GLYPH_CACHE_SIZE 64
static inline cairo_int_status_t
543
ensure_scaled_glyph (cairo_scaled_font_t   *scaled_font,
		     cairo_color_t         *foreground_color,
                     cairo_scaled_glyph_t **glyph_cache,
                     cairo_glyph_t         *glyph,
                     cairo_scaled_glyph_t **scaled_glyph)
{
    int cache_index;
543
    cairo_int_status_t status = CAIRO_INT_STATUS_SUCCESS;
543
    cache_index = glyph->index % GLYPH_CACHE_SIZE;
543
    *scaled_glyph = glyph_cache[cache_index];
543
    if (*scaled_glyph == NULL || _cairo_scaled_glyph_index (*scaled_glyph) != glyph->index) {
537
        status = _cairo_scaled_glyph_lookup (scaled_font,
                                             glyph->index,
                                             CAIRO_SCALED_GLYPH_INFO_COLOR_SURFACE,
                                             foreground_color,
                                             scaled_glyph);
537
        if (status == CAIRO_INT_STATUS_UNSUPPORTED) {
            /* If the color surface not available, ensure scaled_glyph is not NULL. */
42
            status = _cairo_scaled_glyph_lookup (scaled_font,
                                                 glyph->index,
                                                 CAIRO_SCALED_GLYPH_INFO_SURFACE,
                                                 NULL, /* foreground color */
                                                 scaled_glyph);
        }
537
        if (unlikely (status))
            status = _cairo_scaled_font_set_error (scaled_font, status);
537
        glyph_cache[cache_index] = *scaled_glyph;
    }
543
    return status;
}
static inline cairo_int_status_t
501
composite_one_color_glyph (cairo_surface_t       *surface,
                           cairo_operator_t       op,
                           const cairo_pattern_t *source,
                           const cairo_clip_t    *clip,
                           cairo_glyph_t         *glyph,
                           cairo_scaled_glyph_t  *scaled_glyph,
			   double                 x_scale,
			   double                 y_scale)
{
    cairo_int_status_t status;
    cairo_image_surface_t *glyph_surface;
    cairo_pattern_t *pattern;
    cairo_matrix_t matrix;
    int has_color;
501
    status = CAIRO_INT_STATUS_SUCCESS;
501
    has_color = scaled_glyph->has_info & CAIRO_SCALED_GLYPH_INFO_COLOR_SURFACE;
501
    if (has_color)
501
        glyph_surface = scaled_glyph->color_surface;
    else
        glyph_surface = scaled_glyph->surface;
501
    if (glyph_surface->width && glyph_surface->height) {
        int x, y;
        /* round glyph locations to the nearest pixels */
        /* XXX: FRAGILE: We're ignoring device_transform scaling here. A bug? */
348
	x = _cairo_lround (glyph->x * x_scale - glyph_surface->base.device_transform.x0);
348
	y = _cairo_lround (glyph->y * y_scale - glyph_surface->base.device_transform.y0);
348
        pattern = cairo_pattern_create_for_surface ((cairo_surface_t *)glyph_surface);
348
        cairo_matrix_init_translate (&matrix, - x, - y);
348
	cairo_matrix_scale (&matrix, x_scale, y_scale);
348
        cairo_pattern_set_matrix (pattern, &matrix);
348
        if (op == CAIRO_OPERATOR_SOURCE || op == CAIRO_OPERATOR_CLEAR || !has_color)
	    status = _cairo_surface_mask (surface, op, pattern, pattern, clip);
        else
348
	    status = _cairo_surface_paint (surface, op, pattern, clip);
348
        cairo_pattern_destroy (pattern);
    }
501
    return status;
}
static cairo_int_status_t
453
composite_color_glyphs (cairo_surface_t             *surface,
                        cairo_operator_t             op,
                        const cairo_pattern_t       *source,
                        char                        *utf8,
                        int                         *utf8_len,
                        cairo_glyph_t               *glyphs,
                        int                         *num_glyphs,
                        cairo_text_cluster_t        *clusters,
	                int			    *num_clusters,
		        cairo_text_cluster_flags_t   cluster_flags,
                        cairo_scaled_font_t         *scaled_font,
                        const cairo_clip_t          *clip)
{
    cairo_int_status_t status;
    int i, j;
    cairo_scaled_glyph_t *scaled_glyph;
453
    int remaining_clusters = 0;
453
    int remaining_glyphs = 0;
453
    int remaining_bytes = 0;
453
    int glyph_pos = 0;
453
    int byte_pos = 0;
    int gp;
    cairo_scaled_glyph_t *glyph_cache[GLYPH_CACHE_SIZE];
453
    cairo_color_t *foreground_color = NULL;
453
    double x_scale = 1.0;
453
    double y_scale = 1.0;
453
    if (surface->is_vector) {
	cairo_font_face_t *font_face;
	cairo_matrix_t font_matrix;
	cairo_matrix_t ctm;
	cairo_font_options_t font_options;
	x_scale = surface->x_fallback_resolution / surface->x_resolution;
	y_scale = surface->y_fallback_resolution / surface->y_resolution;
	font_face = cairo_scaled_font_get_font_face (scaled_font);
	cairo_scaled_font_get_font_matrix (scaled_font, &font_matrix);
	cairo_scaled_font_get_ctm (scaled_font, &ctm);
	_cairo_font_options_init_default (&font_options);
	cairo_scaled_font_get_font_options (scaled_font, &font_options);
	cairo_matrix_scale (&ctm, x_scale, y_scale);
	scaled_font = cairo_scaled_font_create (font_face,
						&font_matrix,
						&ctm,
						&font_options);
    }
453
    if (source->type == CAIRO_PATTERN_TYPE_SOLID)
453
	foreground_color = &((cairo_solid_pattern_t *) source)->color;
453
    memset (glyph_cache, 0, sizeof (glyph_cache));
453
    status = CAIRO_INT_STATUS_SUCCESS;
453
    _cairo_scaled_font_freeze_cache (scaled_font);
453
    if (clusters) {
        if (cluster_flags & CAIRO_TEXT_CLUSTER_FLAG_BACKWARD)
            glyph_pos = *num_glyphs - 1;
        for (i = 0; i < *num_clusters; i++) {
            cairo_bool_t skip_cluster = TRUE;
            for (j = 0; j < clusters[i].num_glyphs; j++) {
                if (cluster_flags & CAIRO_TEXT_CLUSTER_FLAG_BACKWARD)
                    gp = glyph_pos - j;
                else
                    gp = glyph_pos + j;
                status = ensure_scaled_glyph (scaled_font, foreground_color, glyph_cache,
                                              &glyphs[gp], &scaled_glyph);
                if (unlikely (status))
                    goto UNLOCK;
                if ((scaled_glyph->has_info & CAIRO_SCALED_GLYPH_INFO_COLOR_SURFACE) != 0) {
		    cairo_bool_t supports_color_glyph = FALSE;
		    if (surface->backend->supports_color_glyph) {
			_cairo_scaled_font_thaw_cache (scaled_font);
			supports_color_glyph = _cairo_surface_supports_color_glyph (surface, scaled_font, glyphs[gp].index);
			memset (glyph_cache, 0, sizeof (glyph_cache));
			_cairo_scaled_font_freeze_cache (scaled_font);
		    }
		    if (!supports_color_glyph) {
			skip_cluster = FALSE;
			break;
		    }
		}
            }
            if (skip_cluster) {
                memmove (utf8 + remaining_bytes, utf8 + byte_pos, clusters[i].num_bytes);
                remaining_bytes += clusters[i].num_bytes;
                byte_pos += clusters[i].num_bytes;
                for (j = 0; j < clusters[i].num_glyphs; j++, remaining_glyphs++) {
                    if (cluster_flags & CAIRO_TEXT_CLUSTER_FLAG_BACKWARD)
                        glyphs[*num_glyphs - 1 - remaining_glyphs] = glyphs[glyph_pos--];
                    else
                        glyphs[remaining_glyphs] = glyphs[glyph_pos++];
                }
                clusters[remaining_clusters++] = clusters[i];
                continue;
            }
            for (j = 0; j < clusters[i].num_glyphs; j++) {
                if (cluster_flags & CAIRO_TEXT_CLUSTER_FLAG_BACKWARD)
                    gp = glyph_pos - j;
                else
                    gp = glyph_pos + j;
                status = ensure_scaled_glyph (scaled_font, foreground_color, glyph_cache,
                                              &glyphs[gp], &scaled_glyph);
                if (unlikely (status))
                    goto UNLOCK;
                status = composite_one_color_glyph (surface, op, source, clip,
						    &glyphs[gp], scaled_glyph,
						    x_scale, y_scale);
                if (unlikely (status && status != CAIRO_INT_STATUS_NOTHING_TO_DO))
                    goto UNLOCK;
            }
            if (cluster_flags & CAIRO_TEXT_CLUSTER_FLAG_BACKWARD)
                glyph_pos -= clusters[i].num_glyphs;
            else
                glyph_pos += clusters[i].num_glyphs;
            byte_pos += clusters[i].num_bytes;
        }
        if (cluster_flags & CAIRO_TEXT_CLUSTER_FLAG_BACKWARD) {
            memmove (utf8, utf8 + *utf8_len - remaining_bytes, remaining_bytes);
            memmove (glyphs, glyphs + (*num_glyphs - remaining_glyphs), sizeof (cairo_glyph_t) * remaining_glyphs);
        }
        *utf8_len = remaining_bytes;
        *num_glyphs = remaining_glyphs;
        *num_clusters = remaining_clusters;
    } else {
996
       for (glyph_pos = 0; glyph_pos < *num_glyphs; glyph_pos++) {
543
           status = ensure_scaled_glyph (scaled_font, foreground_color, glyph_cache,
543
                                         &glyphs[glyph_pos], &scaled_glyph);
543
           if (unlikely (status))
               goto UNLOCK;
543
           if ((scaled_glyph->has_info & CAIRO_SCALED_GLYPH_INFO_COLOR_SURFACE) == 0) {
42
               glyphs[remaining_glyphs++] = glyphs[glyph_pos];
42
               continue;
           }
501
           status = composite_one_color_glyph (surface, op, source, clip,
501
					       &glyphs[glyph_pos], scaled_glyph,
					       x_scale, y_scale);
501
           if (unlikely (status && status != CAIRO_INT_STATUS_NOTHING_TO_DO))
               goto UNLOCK;
        }
453
        *num_glyphs = remaining_glyphs;
    }
453
UNLOCK:
453
    _cairo_scaled_font_thaw_cache (scaled_font);
453
    if (surface->is_vector)
	cairo_scaled_font_destroy (scaled_font);
453
    return status;
}
/* Note: the backends may modify the contents of the glyph array as long as
 * they do not return %CAIRO_INT_STATUS_UNSUPPORTED. This makes it possible to
 * avoid copying the array again and again, and edit it in-place.
 * Backends are in fact free to use the array as a generic buffer as they
 * see fit.
 *
 * For show_glyphs backend method, and NOT for show_text_glyphs method,
 * when they do return UNSUPPORTED, they may adjust remaining_glyphs to notify
 * that they have successfully rendered some of the glyphs (from the beginning
 * of the array), but not all.  If they don't touch remaining_glyphs, it
 * defaults to all glyphs.
 *
 * See commits 5a9642c5746fd677aed35ce620ce90b1029b1a0c and
 * 1781e6018c17909311295a9cc74b70500c6b4d0a for the rationale.
 */
cairo_status_t
70596
_cairo_surface_show_text_glyphs (cairo_surface_t	    *surface,
				 cairo_operator_t	     op,
				 const cairo_pattern_t	    *source,
				 const char		    *utf8,
				 int			     utf8_len,
				 cairo_glyph_t		    *glyphs,
				 int			     num_glyphs,
				 const cairo_text_cluster_t *clusters,
				 int			     num_clusters,
				 cairo_text_cluster_flags_t  cluster_flags,
				 cairo_scaled_font_t	    *scaled_font,
				 const cairo_clip_t	    *clip)
{
    cairo_int_status_t status;
70596
    char *utf8_copy = NULL;
    TRACE ((stderr, "%s\n", __FUNCTION__));
70596
    if (unlikely (surface->status))
	return surface->status;
70596
    if (unlikely (surface->finished))
	return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
70596
    if (num_glyphs == 0 && utf8_len == 0)
	return CAIRO_STATUS_SUCCESS;
70596
    if (_cairo_clip_is_all_clipped (clip))
	return CAIRO_STATUS_SUCCESS;
70596
    status = _pattern_has_error (source);
70596
    if (unlikely (status))
	return status;
70596
    status = cairo_scaled_font_status (scaled_font);
70596
    if (unlikely (status))
	return status;
70596
    if (!(_cairo_scaled_font_has_color_glyphs (scaled_font) &&
498
	  scaled_font->options.color_mode != CAIRO_COLOR_MODE_NO_COLOR))
    {
70143
        if (nothing_to_do (surface, op, source))
12
	    return CAIRO_STATUS_SUCCESS;
    }
70584
    status = _cairo_surface_begin_modification (surface);
70584
    if (unlikely (status))
	return status;
70584
    if (source->is_foreground_marker && surface->foreground_source)
	source = surface->foreground_source;
70584
    if (_cairo_scaled_font_has_color_glyphs (scaled_font) &&
498
	scaled_font->options.color_mode != CAIRO_COLOR_MODE_NO_COLOR)
    {
453
        utf8_copy = malloc (sizeof (char) * utf8_len);
453
        memcpy (utf8_copy, utf8, sizeof (char) * utf8_len);
453
        utf8 = utf8_copy;
453
        status = composite_color_glyphs (surface, op,
                                         source,
                                         (char *)utf8, &utf8_len,
                                         glyphs, &num_glyphs,
                                         (cairo_text_cluster_t *)clusters, &num_clusters, cluster_flags,
                                         scaled_font,
                                         clip);
453
        if (unlikely (status && status != CAIRO_INT_STATUS_NOTHING_TO_DO))
            goto DONE;
453
        if (num_glyphs == 0)
411
            goto DONE;
    } else {
70131
      utf8_copy = NULL;
    }
    /* The logic here is duplicated in _cairo_analysis_surface show_glyphs and
     * show_text_glyphs.  Keep in synch. */
70173
    if (clusters) {
35787
        status = CAIRO_INT_STATUS_UNSUPPORTED;
	/* A real show_text_glyphs call.  Try show_text_glyphs backend
	 * method first */
35787
	if (surface->backend->show_text_glyphs != NULL) {
258
	    status = surface->backend->show_text_glyphs (surface, op,
							 source,
							 utf8, utf8_len,
							 glyphs, num_glyphs,
							 clusters, num_clusters, cluster_flags,
							 scaled_font,
							 clip);
	}
35787
	if (status == CAIRO_INT_STATUS_UNSUPPORTED &&
35529
	    surface->backend->show_glyphs)
	{
35529
	    status = surface->backend->show_glyphs (surface, op,
						    source,
						    glyphs, num_glyphs,
						    scaled_font,
						    clip);
	}
    } else {
	/* A mere show_glyphs call.  Try show_glyphs backend method first */
34386
	if (surface->backend->show_glyphs != NULL) {
34293
	    status = surface->backend->show_glyphs (surface, op,
						    source,
						    glyphs, num_glyphs,
						    scaled_font,
						    clip);
93
	} else if (surface->backend->show_text_glyphs != NULL) {
	    /* Intentionally only try show_text_glyphs method for show_glyphs
	     * calls if backend does not have show_glyphs.  If backend has
	     * both methods implemented, we don't fallback from show_glyphs to
	     * show_text_glyphs, and hence the backend can assume in its
	     * show_text_glyphs call that clusters is not NULL (which also
	     * implies that UTF-8 is not NULL, unless the text is
	     * zero-length).
	     */
93
	    status = surface->backend->show_text_glyphs (surface, op,
							 source,
							 utf8, utf8_len,
							 glyphs, num_glyphs,
							 clusters, num_clusters, cluster_flags,
							 scaled_font,
							 clip);
	}
    }
DONE:
70584
    if (status != CAIRO_INT_STATUS_NOTHING_TO_DO) {
69393
	surface->is_clear = FALSE;
69393
	surface->serial++;
    }
70584
    if (utf8_copy)
453
        free (utf8_copy);
70584
    return _cairo_surface_set_error (surface, status);
}
cairo_status_t
12
_cairo_surface_tag (cairo_surface_t	        *surface,
		    cairo_bool_t                 begin,
		    const char                  *tag_name,
		    const char                  *attributes)
{
    cairo_int_status_t status;
    TRACE ((stderr, "%s\n", __FUNCTION__));
12
    if (unlikely (surface->status))
	return surface->status;
12
    if (unlikely (surface->finished))
	return _cairo_surface_set_error (surface, _cairo_error (CAIRO_STATUS_SURFACE_FINISHED));
12
    if (surface->backend->tag == NULL)
6
	return CAIRO_STATUS_SUCCESS;
6
    status = surface->backend->tag (surface, begin, tag_name, attributes);
6
    surface->is_clear = FALSE;
6
    return _cairo_surface_set_error (surface, status);
}
cairo_bool_t
_cairo_surface_supports_color_glyph (cairo_surface_t       *surface,
				     cairo_scaled_font_t   *scaled_font,
				     unsigned long          glyph_index)
{
    if (surface->backend->supports_color_glyph != NULL)
	return surface->backend->supports_color_glyph (surface, scaled_font, glyph_index);
    return FALSE;
}
/**
 * _cairo_surface_set_resolution:
 * @surface: the surface
 * @x_res: x resolution, in dpi
 * @y_res: y resolution, in dpi
 *
 * Set the actual surface resolution of @surface to the given x and y DPI.
 * Mainly used for correctly computing the scale factor when fallback
 * rendering needs to take place in the paginated surface.
 **/
void
_cairo_surface_set_resolution (cairo_surface_t *surface,
			       double x_res,
			       double y_res)
{
    if (surface->status)
	return;
    surface->x_resolution = x_res;
    surface->y_resolution = y_res;
}
/**
 * _cairo_surface_create_in_error:
 * @status: the error status
 *
 * Return an appropriate static error surface for the error status.
 * On error, surface creation functions should always return a surface
 * created with _cairo_surface_create_in_error() instead of a new surface
 * in an error state. This simplifies internal code as no refcounting has
 * to be done.
 **/
cairo_surface_t *
433
_cairo_surface_create_in_error (cairo_status_t status)
{
433
    assert (status < CAIRO_STATUS_LAST_STATUS);
433
    switch (status) {
1
    case CAIRO_STATUS_NO_MEMORY:
1
	return (cairo_surface_t *) &_cairo_surface_nil;
3
    case CAIRO_STATUS_SURFACE_TYPE_MISMATCH:
3
	return (cairo_surface_t *) &_cairo_surface_nil_surface_type_mismatch;
    case CAIRO_STATUS_INVALID_STATUS:
	return (cairo_surface_t *) &_cairo_surface_nil_invalid_status;
    case CAIRO_STATUS_INVALID_CONTENT:
	return (cairo_surface_t *) &_cairo_surface_nil_invalid_content;
    case CAIRO_STATUS_INVALID_FORMAT:
	return (cairo_surface_t *) &_cairo_surface_nil_invalid_format;
    case CAIRO_STATUS_INVALID_VISUAL:
	return (cairo_surface_t *) &_cairo_surface_nil_invalid_visual;
1
    case CAIRO_STATUS_READ_ERROR:
1
	return (cairo_surface_t *) &_cairo_surface_nil_read_error;
    case CAIRO_STATUS_WRITE_ERROR:
	return (cairo_surface_t *) &_cairo_surface_nil_write_error;
127
    case CAIRO_STATUS_FILE_NOT_FOUND:
127
	return (cairo_surface_t *) &_cairo_surface_nil_file_not_found;
    case CAIRO_STATUS_TEMP_FILE_ERROR:
	return (cairo_surface_t *) &_cairo_surface_nil_temp_file_error;
122
    case CAIRO_STATUS_INVALID_STRIDE:
122
	return (cairo_surface_t *) &_cairo_surface_nil_invalid_stride;
158
    case CAIRO_STATUS_INVALID_SIZE:
158
	return (cairo_surface_t *) &_cairo_surface_nil_invalid_size;
    case CAIRO_STATUS_DEVICE_TYPE_MISMATCH:
	return (cairo_surface_t *) &_cairo_surface_nil_device_type_mismatch;
    case CAIRO_STATUS_DEVICE_ERROR:
	return (cairo_surface_t *) &_cairo_surface_nil_device_error;
1
    case CAIRO_STATUS_PNG_ERROR:
1
	return (cairo_surface_t *) &_cairo_surface_nil_png_error;
    case CAIRO_STATUS_SUCCESS:
    case CAIRO_STATUS_LAST_STATUS:
	ASSERT_NOT_REACHED;
	/* fall-through */
    case CAIRO_STATUS_INVALID_RESTORE:
    case CAIRO_STATUS_INVALID_POP_GROUP:
    case CAIRO_STATUS_NO_CURRENT_POINT:
    case CAIRO_STATUS_INVALID_MATRIX:
    case CAIRO_STATUS_NULL_POINTER:
    case CAIRO_STATUS_INVALID_STRING:
    case CAIRO_STATUS_INVALID_PATH_DATA:
    case CAIRO_STATUS_SURFACE_FINISHED:
    case CAIRO_STATUS_PATTERN_TYPE_MISMATCH:
    case CAIRO_STATUS_INVALID_DASH:
    case CAIRO_STATUS_INVALID_DSC_COMMENT:
    case CAIRO_STATUS_INVALID_INDEX:
    case CAIRO_STATUS_CLIP_NOT_REPRESENTABLE:
    case CAIRO_STATUS_FONT_TYPE_MISMATCH:
    case CAIRO_STATUS_USER_FONT_IMMUTABLE:
    case CAIRO_STATUS_USER_FONT_ERROR:
    case CAIRO_STATUS_NEGATIVE_COUNT:
    case CAIRO_STATUS_INVALID_CLUSTERS:
    case CAIRO_STATUS_INVALID_SLANT:
    case CAIRO_STATUS_INVALID_WEIGHT:
    case CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED:
    case CAIRO_STATUS_INVALID_MESH_CONSTRUCTION:
    case CAIRO_STATUS_DEVICE_FINISHED:
    case CAIRO_STATUS_JBIG2_GLOBAL_MISSING:
    case CAIRO_STATUS_FREETYPE_ERROR:
    case CAIRO_STATUS_WIN32_GDI_ERROR:
    case CAIRO_INT_STATUS_DWRITE_ERROR:
    case CAIRO_STATUS_TAG_ERROR:
    case CAIRO_STATUS_SVG_FONT_ERROR:
    default:
20
	_cairo_error_throw (CAIRO_STATUS_NO_MEMORY);
20
	return (cairo_surface_t *) &_cairo_surface_nil;
    }
}
cairo_surface_t *
_cairo_int_surface_create_in_error (cairo_int_status_t status)
{
    if (status < CAIRO_INT_STATUS_LAST_STATUS)
	return _cairo_surface_create_in_error (status);
    switch ((int)status) {
    case CAIRO_INT_STATUS_UNSUPPORTED:
	return (cairo_surface_t *) &_cairo_surface_nil_unsupported;
    case CAIRO_INT_STATUS_NOTHING_TO_DO:
	return (cairo_surface_t *) &_cairo_surface_nil_nothing_to_do;
    default:
	_cairo_error_throw (CAIRO_STATUS_NO_MEMORY);
	return (cairo_surface_t *) &_cairo_surface_nil;
    }
}
/*  LocalWords:  rasterized
 */