cairo/src/cairo.c
Carl Worth a6d9b6a671 Change type of data parameter from char* to unsigned char*.
Propagate the unsigned char* change down the stack.
Add cast since XImage uses char* rather than unsigned char*.
Fix memory leak of image data.
Switch to use cairo_surface_write_png rather than a custom write_png_argb32.
Add test to exercise the cairo_image_surface_create_for_png function.
2005-04-04 09:47:12 +00:00

2303 lines
58 KiB
C

/* cairo - a vector graphics library with display and print output
*
* Copyright © 2002 University of Southern California
*
* This library is free software; you can redistribute it and/or
* modify it either under the terms of the GNU Lesser General Public
* License version 2.1 as published by the Free Software Foundation
* (the "LGPL") or, at your option, under the terms of the Mozilla
* Public License Version 1.1 (the "MPL"). If you do not alter this
* notice, a recipient may use your version of this file under either
* the MPL or the LGPL.
*
* You should have received a copy of the LGPL along with this library
* in the file COPYING-LGPL-2.1; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
* You should have received a copy of the MPL along with this library
* in the file COPYING-MPL-1.1
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
* OF ANY KIND, either express or implied. See the LGPL or the MPL for
* the specific language governing rights and limitations.
*
* The Original Code is the cairo graphics library.
*
* The Initial Developer of the Original Code is University of Southern
* California.
*
* Contributor(s):
* Carl D. Worth <cworth@cworth.org>
*/
#include "cairoint.h"
#include "cairo-private.h"
#include "cairo-path-data-private.h"
#define CAIRO_TOLERANCE_MINIMUM 0.0002 /* We're limited by 16 bits of sub-pixel precision */
#ifdef CAIRO_DO_SANITY_CHECKING
#include <assert.h>
static int
cairo_sane_state (cairo_t *cr)
{
if (cr == NULL)
return 0;
switch (cr->status) {
case CAIRO_STATUS_SUCCESS:
case CAIRO_STATUS_NO_MEMORY:
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_NO_TARGET_SURFACE:
case CAIRO_STATUS_NULL_POINTER:
case CAIRO_STATUS_INVALID_STRING:
case CAIRO_STATUS_INVALID_PATH_DATA:
break;
default:
return 0;
}
return 1;
}
#define CAIRO_CHECK_SANITY(cr) assert(cairo_sane_state ((cr)))
#else
#define CAIRO_CHECK_SANITY(cr)
#endif
/**
* cairo_create:
*
* Creates a new #cairo_t with default values. The target
* surface must be set on the #cairo_t with cairo_set_target_surface(),
* or a backend-specific function like cairo_set_target_image() before
* drawing with the #cairo_t.
*
* Return value: a newly allocated #cairo_t with a reference
* count of 1. The initial reference count should be released
* with cairo_destroy() when you are done using the #cairo_t.
**/
cairo_t *
cairo_create (void)
{
cairo_t *cr;
cr = malloc (sizeof (cairo_t));
if (cr == NULL)
return NULL;
cr->status = CAIRO_STATUS_SUCCESS;
cr->ref_count = 1;
cr->gstate = _cairo_gstate_create ();
if (cr->gstate == NULL)
cr->status = CAIRO_STATUS_NO_MEMORY;
CAIRO_CHECK_SANITY (cr);
return cr;
}
/**
* cairo_reference:
* @cr: a #cairo_t
*
* Increases the reference count on @cr by one. This prevents
* @cr from being destroyed until a matching call to cairo_destroy()
* is made.
**/
void
cairo_reference (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->ref_count++;
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_destroy:
* @cr: a #cairo_t
*
* Decreases the reference count on @cr by one. If the result
* is zero, then @cr and all associated resources are freed.
* See cairo_reference().
**/
void
cairo_destroy (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
cr->ref_count--;
if (cr->ref_count)
return;
while (cr->gstate) {
cairo_gstate_t *tmp = cr->gstate;
cr->gstate = tmp->next;
_cairo_gstate_destroy (tmp);
}
free (cr);
}
/**
* cairo_save:
* @cr: a #cairo_t
*
* Makes a copy of the current state of @cr and saves it
* on an internal stack of saved states for @cr. When
* cairo_restore() is called, @cr will be restored to
* the saved state. Multiple calls to cairo_save() and
* cairo_restore() can be nested; each call to cairo_restore()
* restores the state from the matching paired cairo_save().
*
* It isn't necessary to clear all saved states before
* a #cairo_t is freed. If the reference count of a #cairo_t
* drops to zero in response to a call to cairo_destroy(),
* any saved states will be freed along with the #cairo_t.
**/
void
cairo_save (cairo_t *cr)
{
cairo_gstate_t *top;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
if (cr->gstate) {
top = _cairo_gstate_clone (cr->gstate);
} else {
top = _cairo_gstate_create ();
}
if (top == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
CAIRO_CHECK_SANITY (cr);
return;
}
top->next = cr->gstate;
cr->gstate = top;
CAIRO_CHECK_SANITY (cr);
}
slim_hidden_def(cairo_save);
/**
* cairo_restore:
* @cr: a #cairo_t
*
* Restores @cr to the state saved by a preceding call to
* cairo_save() and removes that state from the stack of
* saved states.
**/
void
cairo_restore (cairo_t *cr)
{
cairo_gstate_t *top;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
top = cr->gstate;
cr->gstate = top->next;
_cairo_gstate_destroy (top);
if (cr->gstate == NULL)
cr->status = CAIRO_STATUS_INVALID_RESTORE;
if (cr->status)
return;
cr->status = _cairo_gstate_restore_external_state (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
slim_hidden_def(cairo_restore);
/**
* cairo_copy:
* @dest: a #cairo_t
* @src: another #cairo_t
*
* This function copies all current state information from src to
* dest. This includes the current point and path, the target surface,
* the transformation matrix, and so forth.
*
* The stack of states saved with cairo_save() is <emphasis>not</emphasis>
* not copied; nor are any saved states on @dest cleared. The
* operation only copies the current state of @src to the current
* state of @dest.
**/
void
cairo_copy (cairo_t *dest, cairo_t *src)
{
CAIRO_CHECK_SANITY (src);
CAIRO_CHECK_SANITY (dest);
if (dest->status)
return;
if (src->status) {
dest->status = src->status;
return;
}
dest->status = _cairo_gstate_copy (dest->gstate, src->gstate);
CAIRO_CHECK_SANITY (src);
CAIRO_CHECK_SANITY (dest);
}
/* XXX: I want to rethink this API
void
cairo_push_group (cairo_t *cr)
{
if (cr->status)
return;
cr->status = cairoPush (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_begin_group (cr->gstate);
}
void
cairo_pop_group (cairo_t *cr)
{
if (cr->status)
return;
cr->status = _cairo_gstate_end_group (cr->gstate);
if (cr->status)
return;
cr->status = cairoPop (cr);
}
*/
/**
* cairo_set_target_surface:
* @cr: a #cairo_t
* @surface: a #cairo_surface_t
*
* Directs output for a #cairo_t to a given surface. The surface
* will be referenced by the #cairo_t, so you can immediately
* call cairo_surface_destroy() on it if you don't need to
* keep a reference to it around.
**/
void
cairo_set_target_surface (cairo_t *cr, cairo_surface_t *surface)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_target_surface (cr->gstate, surface);
CAIRO_CHECK_SANITY (cr);
}
slim_hidden_def(cairo_set_target_surface);
/**
* cairo_set_target_image:
* @cr: a #cairo_t
* @data: a pointer to a buffer supplied by the application
* in which to write contents.
* @format: the format of pixels in the buffer
* @width: the width of the image to be stored in the buffer
* @height: the eight of the image to be stored in the buffer
* @stride: the number of bytes between the start of rows
* in the buffer. Having this be specified separate from @width
* allows for padding at the end of rows, or for writing
* to a subportion of a larger image.
*
* Directs output for a #cairo_t to an in-memory image. The output
* buffer must be kept around until the #cairo_t is destroyed or set
* to to have a different target. The initial contents of @buffer
* will be used as the inital image contents; you must explicitly
* clear the buffer, using, for example, cairo_rectangle() and
* cairo_fill() if you want it cleared.
**/
void
cairo_set_target_image (cairo_t *cr,
unsigned char *data,
cairo_format_t format,
int width,
int height,
int stride)
{
cairo_surface_t *surface;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
surface = cairo_image_surface_create_for_data (data,
format,
width, height, stride);
if (surface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
CAIRO_CHECK_SANITY (cr);
return;
}
cairo_set_target_surface (cr, surface);
cairo_surface_destroy (surface);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_set_target_image_no_data:
* @cr: a #cairo_t
* @format: the format of pixels in the buffer
* @width: the width of the image to be stored in the buffer
* @height: the eight of the image to be stored in the buffer
*
* Directs output for a #cairo_t to an implicit image surface of the
* given format that will be created and owned by the cairo
* context. The initial contents of the target surface will be
* cleared to 0 in all channels, (ie. transparent black).
*
* NOTE: This function has an unconventional name, but that will be
* straightened out in a future change in which all set_target
* functions will be renamed.
**/
void
cairo_set_target_image_no_data (cairo_t *cr,
cairo_format_t format,
int width,
int height)
{
cairo_surface_t *surface;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
surface = cairo_image_surface_create (format, width, height);
if (surface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
CAIRO_CHECK_SANITY (cr);
return;
}
cairo_set_target_surface (cr, surface);
cairo_surface_destroy (surface);
CAIRO_CHECK_SANITY (cr);
}
#ifdef CAIRO_HAS_GLITZ_SURFACE
#include "cairo-glitz.h"
void
cairo_set_target_glitz (cairo_t *cr, glitz_surface_t *surface)
{
cairo_surface_t *crsurface;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
crsurface = cairo_glitz_surface_create (surface);
if (crsurface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
return;
}
cairo_set_target_surface (cr, crsurface);
cairo_surface_destroy (crsurface);
CAIRO_CHECK_SANITY (cr);
}
#endif /* CAIRO_HAS_GLITZ_SURFACE */
#ifdef CAIRO_HAS_PDF_SURFACE
#include "cairo-pdf.h"
void
cairo_set_target_pdf_for_callback (cairo_t *cr,
cairo_write_func_t write,
cairo_destroy_func_t destroy_closure,
void *closure,
double width_inches,
double height_inches,
double x_pixels_per_inch,
double y_pixels_per_inch)
{
cairo_surface_t *surface;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
surface = cairo_pdf_surface_create_for_callback (write,
destroy_closure, closure,
width_inches, height_inches,
x_pixels_per_inch, y_pixels_per_inch);
if (surface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
return;
}
cairo_set_target_surface (cr, surface);
/* cairo_set_target_surface takes a reference, so we must destroy ours */
cairo_surface_destroy (surface);
}
void
cairo_set_target_pdf (cairo_t *cr,
FILE *fp,
double width_inches,
double height_inches,
double x_pixels_per_inch,
double y_pixels_per_inch)
{
cairo_surface_t *surface;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
surface = cairo_pdf_surface_create (fp,
width_inches, height_inches,
x_pixels_per_inch,
y_pixels_per_inch);
if (surface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
return;
}
cairo_set_target_surface (cr, surface);
/* cairo_set_target_surface takes a reference, so we must destroy ours */
cairo_surface_destroy (surface);
}
#endif /* CAIRO_HAS_PDF_SURFACE */
#ifdef CAIRO_HAS_PS_SURFACE
#include "cairo-ps.h"
/**
* cairo_set_target_ps:
* @cr: a #cairo_t
* @file: an open, writeable file
* @width_inches: width of the output page, in inches
* @height_inches: height of the output page, in inches
* @x_pixels_per_inch: X resolution to use for image fallbacks;
* not all cairo drawing can be represented in a postscript
* file, so cairo will write out images for some portions
* of the output.
* @y_pixels_per_inch: Y resolution to use for image fallbacks.
*
* Directs output for a #cairo_t to a postscript file. The file must
* be kept open until the #cairo_t is destroyed or set to have a
* different target, and then must be closed by the application.
**/
void
cairo_set_target_ps (cairo_t *cr,
FILE *file,
double width_inches,
double height_inches,
double x_pixels_per_inch,
double y_pixels_per_inch)
{
cairo_surface_t *surface;
surface = cairo_ps_surface_create (file,
width_inches, height_inches,
x_pixels_per_inch, y_pixels_per_inch);
if (surface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
return;
}
cairo_set_target_surface (cr, surface);
/* cairo_set_target_surface takes a reference, so we must destroy ours */
cairo_surface_destroy (surface);
}
#endif /* CAIRO_HAS_PS_SURFACE */
#ifdef CAIRO_HAS_WIN32_SURFACE
#include "cairo-win32.h"
void
cairo_set_target_win32 (cairo_t *cr,
HDC hdc)
{
cairo_surface_t *surface;
if (cr->status && cr->status != CAIRO_STATUS_NO_TARGET_SURFACE)
return;
surface = cairo_win32_surface_create (hdc);
if (surface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
return;
}
cairo_set_target_surface (cr, surface);
/* cairo_set_target_surface takes a reference, so we must destroy ours */
cairo_surface_destroy (surface);
}
#endif /* CAIRO_HAS_WIN32_SURFACE */
#ifdef CAIRO_HAS_XCB_SURFACE
#include "cairo-xcb.h"
void
cairo_set_target_xcb (cairo_t *cr,
XCBConnection *dpy,
XCBDRAWABLE drawable,
XCBVISUALTYPE *visual,
cairo_format_t format)
{
cairo_surface_t *surface;
if (cr->status && cr->status != CAIRO_STATUS_NO_TARGET_SURFACE)
return;
surface = cairo_xcb_surface_create (dpy, drawable, visual, format);
if (surface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
return;
}
cairo_set_target_surface (cr, surface);
/* cairo_set_target_surface takes a reference, so we must destroy ours */
cairo_surface_destroy (surface);
}
#endif /* CAIRO_HAS_XCB_SURFACE */
#ifdef CAIRO_HAS_XLIB_SURFACE
#include "cairo-xlib.h"
/**
* cairo_set_target_drawable:
* @cr: a #cairo_t
* @dpy: an X display
* @drawable: a window or pixmap on the default screen of @dpy
*
* Directs output for a #cairo_t to an Xlib drawable. @drawable must
* be a Window or Pixmap on the default screen of @dpy using the
* default colormap and visual. Using this function is slow because
* the function must retrieve information about @drawable from the X
* server.
* The combination of cairo_xlib_surface_create() and
* cairo_set_target_surface() is somewhat more flexible, although
* it still is slow.
**/
void
cairo_set_target_drawable (cairo_t *cr,
Display *dpy,
Drawable drawable)
{
cairo_surface_t *surface;
if (cr->status && cr->status != CAIRO_STATUS_NO_TARGET_SURFACE)
return;
surface = cairo_xlib_surface_create (dpy, drawable,
DefaultVisual (dpy, DefaultScreen (dpy)),
0,
DefaultColormap (dpy, DefaultScreen (dpy)));
if (surface == NULL) {
cr->status = CAIRO_STATUS_NO_MEMORY;
return;
}
cairo_set_target_surface (cr, surface);
/* cairo_set_target_surface takes a reference, so we must destroy ours */
cairo_surface_destroy (surface);
}
#endif /* CAIRO_HAS_XLIB_SURFACE */
/**
* cairo_set_operator:
* @cr: a #cairo_t
* @op: a compositing operator, specified as a #cairo_operator_t
*
* Sets the compositing operator to be used for all drawing
* operations. See #cairo_operator_t for details on the semantics of
* each available drawing operator.
*
* XXX: I'd also like to direct the reader's attention to some
* (not-yet-written) section on cairo's imaging model. How would I do
* that if such a section existed? (cworth).
**/
void
cairo_set_operator (cairo_t *cr, cairo_operator_t op)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_operator (cr->gstate, op);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_set_rgb_color:
* @cr: a #cairo_t
* @red: red component of color
* @green: green component of color
* @blue: blue component of color
*
* Sets a constant color for filling and stroking. This replaces any
* pattern set with cairo_set_pattern(). The color components are
* floating point numbers in the range 0 to 1. If the values passed in
* are outside that range, they will be clamped.
**/
void
cairo_set_rgb_color (cairo_t *cr, double red, double green, double blue)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
_cairo_restrict_value (&red, 0.0, 1.0);
_cairo_restrict_value (&green, 0.0, 1.0);
_cairo_restrict_value (&blue, 0.0, 1.0);
cr->status = _cairo_gstate_set_rgb_color (cr->gstate, red, green, blue);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_set_pattern:
* @cr: a #cairo_t
* @pattern: a #cairo_pattern_t to be used as the source for
* subsequent drawing operations.
*
* Sets the source pattern within @cr to @pattern. This pattern will
* then be used for any subsequent drawing operation until a new
* pattern is set.
*
* XXX: I'd also like to direct the reader's attention to some
* (not-yet-written) section on cairo's imaging model. How would I do
* that if such a section existed? (cworth).
**/
void
cairo_set_pattern (cairo_t *cr, cairo_pattern_t *pattern)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_pattern (cr->gstate, pattern);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_get_pattern:
* @cr: a #cairo_t
*
* Gets the current source pattern for a #cairo_t.
*
* Return value: the current source pattern. This object is owned by
* cairo. To keep a reference to it, you must call
* cairo_pattern_reference().
**/
cairo_pattern_t *
cairo_get_pattern (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_pattern (cr->gstate);
}
DEPRECATE(cairo_current_pattern, cairo_get_pattern);
/**
* cairo_set_tolerance:
* @cr: a #cairo_t
* @tolerance: the tolerance, in device units (typically pixels)
*
* Sets the tolerance used when converting paths into trapezoids.
* Curved segments of the path will be subdivided until the maximum
* deviation between the original path and the polygonal approximation
* is less than @tolerance. The default value is 0.1. A larger
* value will give better performance, a smaller value, better
* appearance. (Reducing the value from the default value of 0.1
* is unlikely to improve appearance significantly.)
**/
void
cairo_set_tolerance (cairo_t *cr, double tolerance)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
_cairo_restrict_value (&tolerance, CAIRO_TOLERANCE_MINIMUM, tolerance);
cr->status = _cairo_gstate_set_tolerance (cr->gstate, tolerance);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_set_alpha:
* @cr: a #cairo_t
* @alpha: the alpha value. 0 is transparent, 1 fully opaque.
* if the value is outside the range 0 to 1, it will be
* clamped to that range.
*
* Sets an overall alpha value used for stroking and filling. This
* value is multiplied with any alpha value coming from a gradient or
* image pattern.
**/
void
cairo_set_alpha (cairo_t *cr, double alpha)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
_cairo_restrict_value (&alpha, 0.0, 1.0);
cr->status = _cairo_gstate_set_alpha (cr->gstate, alpha);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_set_fill_rule:
* @cr: a #cairo_t
* @fill_rule: a fill rule, specified as a #cairo_fill_rule_t
*
* Set the current fill rule within the cairo context. The fill rule
* is used to determine which regions are inside or outside a complex
* (potentially self-intersecting) path. The current fill rule affects
* both cairo_fill and cairo_clip. See #cairo_fill_rule_t for details
* on the semantics of each available fill rule.
**/
void
cairo_set_fill_rule (cairo_t *cr, cairo_fill_rule_t fill_rule)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_fill_rule (cr->gstate, fill_rule);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_set_line_width:
* @cr: a #cairo_t
* @width: a line width, as a user-space value
*
* Sets the current line width within the cairo context. The line
* width specifies the diameter of a pen that is circular in
* user-space.
*
* As with the other stroke parameters, the current line cap style is
* examined by cairo_stroke(), cairo_stroke_extents(), and
* cairo_stroke_to_path(), but does not have any effect during path
* construction.
**/
void
cairo_set_line_width (cairo_t *cr, double width)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
_cairo_restrict_value (&width, 0.0, width);
cr->status = _cairo_gstate_set_line_width (cr->gstate, width);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_set_line_cap:
* @cr: a cairo context, as a #cairo_t
* @line_cap: a line cap style, as a #cairo_line_cap_t
*
* Sets the current line cap style within the cairo context. See
* #cairo_line_cap_t for details about how the available line cap
* styles are drawn.
*
* As with the other stroke parameters, the current line cap style is
* examined by cairo_stroke(), cairo_stroke_extents(), and
* cairo_stroke_to_path(), but does not have any effect during path
* construction.
**/
void
cairo_set_line_cap (cairo_t *cr, cairo_line_cap_t line_cap)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_line_cap (cr->gstate, line_cap);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_set_line_join:
* @cr: a cairo context, as a #cairo_t
* @line_join: a line joint style, as a #cairo_line_join_t
*
* Sets the current line join style within the cairo context. See
* #cairo_line_join_t for details about how the available line join
* styles are drawn.
*
* As with the other stroke parameters, the current line join style is
* examined by cairo_stroke(), cairo_stroke_extents(), and
* cairo_stroke_to_path(), but does not have any effect during path
* construction.
**/
void
cairo_set_line_join (cairo_t *cr, cairo_line_join_t line_join)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_line_join (cr->gstate, line_join);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_set_dash (cairo_t *cr, double *dashes, int ndash, double offset)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_dash (cr->gstate, dashes, ndash, offset);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_set_miter_limit (cairo_t *cr, double limit)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_miter_limit (cr->gstate, limit);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_translate:
* @cr: a cairo context
* @tx: amount to translate in the X direction
* @ty: amount to translate in the Y direction
*
* Modifies the current transformation matrix (CTM) by tanslating the
* user-space origin by (@tx, @ty). This offset is interpreted as a
* user-space coordinate according to the CTM in place before the new
* call to cairo_translate. In other words, the translation of the
* user-space origin takes place after any existing transformation.
**/
void
cairo_translate (cairo_t *cr, double tx, double ty)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_translate (cr->gstate, tx, ty);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_scale:
* @cr: a cairo context
* @sx: scale factor for the X dimension
* @sy: scale factor for the Y dimension
*
* Modifies the current transformation matrix (CTM) by scaling the X
* and Y user-space axes by @sx and @sy respectively. The scaling of
* the axes takes place after any existing transformation of user
* space.
**/
void
cairo_scale (cairo_t *cr, double sx, double sy)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_scale (cr->gstate, sx, sy);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_rotate:
* @cr: a cairo context
* @angle: angle (in radians) by which the user-space axes will be
* rotated
*
* Modifies the current transformation matrix (CTM) by rotating the
* user-space axes by @angle radians. The rotation of the axes takes
* places after any existing transformation of user space. The
* rotation direction for positive angles is from the positive X axis
* toward the positive Y axis.
**/
void
cairo_rotate (cairo_t *cr, double angle)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_rotate (cr->gstate, angle);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_transform:
* @cr: a cairo context
* @matrix: a transformation to be applied to the user-space axes
*
* Modifies the current transformation matrix (CTM) by applying
* @matrix as an additional transformation. The new transformation of
* user space takes place after any existing transformation.
**/
void
cairo_transform (cairo_t *cr, cairo_matrix_t *matrix)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_transform (cr->gstate, matrix);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE(cairo_concat_matrix, cairo_transform);
/**
* cairo_set_matrix:
* @cr: a cairo context
* @matrix: a transformation matrix from user space to device space
*
* Modifies the current transformation matrix (CTM) by setting it
* equal to @matrix.
**/
void
cairo_set_matrix (cairo_t *cr,
cairo_matrix_t *matrix)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_matrix (cr->gstate, matrix);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_identity_matrix:
* @cr: a cairo context
*
* Resets the current transformation matrix (CTM) by setting it equal
* to the identity matrix. That is, the user-space and device-space
* axes will be aligned and one user-space unit will transform to one
* device-space unit.
**/
void
cairo_identity_matrix (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_identity_matrix (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE(cairo_default_matrix, cairo_identity_matrix);
/**
* cairo_user_to_device:
* @cr: a cairo context
* @x: X value of coordinate (in/out parameter)
* @y: Y value of coordinate (in/out parameter)
*
* Transform a coordinate from user space to device space by
* multiplying the given point by the current transformation matrix
* (CTM).
**/
void
cairo_user_to_device (cairo_t *cr, double *x, double *y)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_user_to_device (cr->gstate, x, y);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE(cairo_transform_point, cairo_user_to_device);
/**
* cairo_user_to_device_distance:
* @cr: a cairo context
* @dx: X component of a distance vector (in/out parameter)
* @dy: Y component of a distance vector (in/out parameter)
*
* Transform a distance vector from user space to device space. This
* function is similar to cairo_user_to_device() except that the
* translation components of the CTM will be ignored when transforming
* (@dx,@dy).
**/
void
cairo_user_to_device_distance (cairo_t *cr, double *dx, double *dy)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_user_to_device_distance (cr->gstate, dx, dy);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE(cairo_transform_distance, cairo_user_to_device_distance);
/**
* cairo_device_to_user:
* @cr: a cairo
* @x: X value of coordinate (in/out parameter)
* @y: Y value of coordinate (in/out parameter)
*
* Transform a coordinate from device space to user space by
* multiplying the given point by the inverse of the current
* transformation matrix (CTM).
**/
void
cairo_device_to_user (cairo_t *cr, double *x, double *y)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_device_to_user (cr->gstate, x, y);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE(cairo_inverse_transform_point, cairo_device_to_user);
/**
* cairo_device_to_user_distance:
* @cr: a cairo context
* @dx: X component of a distance vector (in/out parameter)
* @dy: Y component of a distance vector (in/out parameter)
*
* Transform a distance vector from device space to user space. This
* function is similar to cairo_device_to_user() except that the
* translation components of the inverse CTM will be ignored when
* transforming (@dx,@dy).
**/
void
cairo_device_to_user_distance (cairo_t *cr, double *dx, double *dy)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_device_to_user_distance (cr->gstate, dx, dy);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE(cairo_inverse_transform_distance, cairo_device_to_user_distance);
void
cairo_new_path (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_new_path (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_move_to (cairo_t *cr, double x, double y)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_move_to (cr->gstate, x, y);
CAIRO_CHECK_SANITY (cr);
}
slim_hidden_def(cairo_move_to);
void
cairo_line_to (cairo_t *cr, double x, double y)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_line_to (cr->gstate, x, y);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_curve_to (cairo_t *cr,
double x1, double y1,
double x2, double y2,
double x3, double y3)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_curve_to (cr->gstate,
x1, y1,
x2, y2,
x3, y3);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_arc:
* @cr: a cairo context
* @xc: X position of the center of the arc
* @yc: Y position of the center of the arc
* @radius: the radius of the arc
* @angle1: the start angle, in radians
* @angle2: the end angle, in radians
*
* Adds an arc from @angle1 to @angle2 to the current path. If there
* is a current point, that point is connected to the start of the arc
* by a straight line segment. Angles are measured in radians with an
* angle of 0 along the X axis and an angle of %M_PI radians (90
* degrees) along the Y axis, so with the default transformation
* matrix, positive angles are clockwise. (To convert from degrees to
* radians, use <literal>degrees * (M_PI / 180.)</literal>.) This
* function gives the arc in the direction of increasing angle; see
* cairo_arc_negative() to get the arc in the direction of decreasing
* angle.
*
* A full arc is drawn as a circle. To make an oval arc, you can scale
* the current transformation matrix by different amounts in the X and
* Y directions. For example, to draw a full oval in the box given
* by @x, @y, @width, @height:
* <informalexample><programlisting>
* cairo_save (cr);
* cairo_translate (x + width / 2., y + height / 2.);
* cairo_scale (1. / (height / 2.), 1. / (width / 2.));
* cairo_arc (cr, 0., 0., 1., 0., 2 * M_PI);
* cairo_restore (cr);
* </programlisting></informalexample>
**/
void
cairo_arc (cairo_t *cr,
double xc, double yc,
double radius,
double angle1, double angle2)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_arc (cr->gstate,
xc, yc,
radius,
angle1, angle2);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_arc_negative:
* @cr: a cairo context
* @xc: X position of the center of the arc
* @yc: Y position of the center of the arc
* @radius: the radius of the arc
* @angle1: the start angle, in radians
* @angle2: the end angle, in radians
*
* Adds an arc from @angle1 to @angle2 to the current path. The
* function behaves identically to cairo_arc() except that instead of
* giving the arc in the direction of increasing angle, it gives
* the arc in the direction of decreasing angle.
**/
void
cairo_arc_negative (cairo_t *cr,
double xc, double yc,
double radius,
double angle1, double angle2)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_arc_negative (cr->gstate,
xc, yc,
radius,
angle1, angle2);
CAIRO_CHECK_SANITY (cr);
}
/* XXX: NYI
void
cairo_arc_to (cairo_t *cr,
double x1, double y1,
double x2, double y2,
double radius)
{
if (cr->status)
return;
cr->status = _cairo_gstate_arc_to (cr->gstate,
x1, y1,
x2, y2,
radius);
}
*/
void
cairo_rel_move_to (cairo_t *cr, double dx, double dy)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_rel_move_to (cr->gstate, dx, dy);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_rel_line_to (cairo_t *cr, double dx, double dy)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_rel_line_to (cr->gstate, dx, dy);
CAIRO_CHECK_SANITY (cr);
}
slim_hidden_def(cairo_rel_line_to);
void
cairo_rel_curve_to (cairo_t *cr,
double dx1, double dy1,
double dx2, double dy2,
double dx3, double dy3)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_rel_curve_to (cr->gstate,
dx1, dy1,
dx2, dy2,
dx3, dy3);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_rectangle (cairo_t *cr,
double x, double y,
double width, double height)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cairo_move_to (cr, x, y);
cairo_rel_line_to (cr, width, 0);
cairo_rel_line_to (cr, 0, height);
cairo_rel_line_to (cr, -width, 0);
cairo_close_path (cr);
CAIRO_CHECK_SANITY (cr);
}
/* XXX: NYI
void
cairo_stroke_path (cairo_t *cr)
{
if (cr->status)
return;
cr->status = _cairo_gstate_stroke_path (cr->gstate);
}
*/
void
cairo_close_path (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_close_path (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
slim_hidden_def(cairo_close_path);
void
cairo_stroke (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_stroke (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_fill (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_fill (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_copy_page (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_copy_page (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_show_page (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_show_page (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
cairo_bool_t
cairo_in_stroke (cairo_t *cr, double x, double y)
{
int inside;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return 0;
cr->status = _cairo_gstate_in_stroke (cr->gstate, x, y, &inside);
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return 0;
return inside;
}
int
cairo_in_fill (cairo_t *cr, double x, double y)
{
int inside;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return 0;
cr->status = _cairo_gstate_in_fill (cr->gstate, x, y, &inside);
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return 0;
return inside;
}
void
cairo_stroke_extents (cairo_t *cr,
double *x1, double *y1, double *x2, double *y2)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_stroke_extents (cr->gstate, x1, y1, x2, y2);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_fill_extents (cairo_t *cr,
double *x1, double *y1, double *x2, double *y2)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_fill_extents (cr->gstate, x1, y1, x2, y2);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_clip:
* @cr: a cairo context
*
* Establishes a new clip region by intersecting the current clip
* region with the current path as it would be filled by cairo_fill()
* and according to the current fill rule (see cairo_set_fill_rule()).
*
* The current clip region affects all drawing operations by
* effectively masking out any changes to the surface that are outside
* the current clip region.
*
* Calling cairo_clip() can only make the clip region smaller, never
* larger. But the current clip is part of the graphics state, so a
* tempoarary restriction of the clip region can be achieved by
* calling cairo_clip() within a cairo_save()/cairo_restore()
* pair. The only other means of increasing the size of the clip
* region is cairo_reset_clip().
**/
void
cairo_clip (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_clip (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_reset_clip:
* @cr: a cairo context
*
* Reset the current clip region to its original, unrestricted
* state. That is, set the clip region to an infinitely large shape
* containing the target surface. Equivalently, if infinity is too
* hard to grasp, one can imagine the clip region being reset to the
* exact bounds of the target surface.
*
* Note that code meant to be reusable should not call
* cairo_reset_clip() as it will cause results unexpected by
* higher-level code which calls cairo_clip(). Consider using
* cairo_save() and cairo_restore() around cairo_clip() as a more
* robust means of temporarily restricting the clip region.
**/
void
cairo_reset_clip (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_reset_clip (cr->gstate);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE (cairo_init_clip, cairo_reset_clip);
void
cairo_select_font (cairo_t *cr,
const char *family,
cairo_font_slant_t slant,
cairo_font_weight_t weight)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_select_font (cr->gstate, family, slant, weight);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_get_font:
* @cr: a #cairo_t
*
* Gets the current font object for a #cairo_t. If there is no current
* font object, because the font parameters, transform, or target
* surface has been changed since a font was last used, a font object
* will be created and stored in in the #cairo_t.
*
* Return value: the current font object. Can return %NULL
* on out-of-memory or if the context is already in
* an error state. This object is owned by cairo. To keep
* a reference to it, you must call cairo_font_reference().
**/
cairo_font_t *
cairo_get_font (cairo_t *cr)
{
cairo_font_t *ret;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return NULL;
cr->status = _cairo_gstate_get_font (cr->gstate, &ret);
CAIRO_CHECK_SANITY (cr);
return ret;
}
DEPRECATE (cairo_current_font, cairo_get_font);
/**
* cairo_get_font_extents:
* @cr: a #cairo_t
* @extents: a #cairo_font_extents_t object into which the results
* will be stored.
*
* Gets the font extents for the current font. This is a convenience
* function that is equivalent to:
*
* cairo_font_extents (cairo_get_font (cr));
*
* XXX: This function seems gratuitous to me, shall we drop it?
* (cworth)
**/
void
cairo_get_font_extents (cairo_t *cr,
cairo_font_extents_t *extents)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_get_font_extents (cr->gstate, extents);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE (cairo_current_font_extents, cairo_get_font_extents);
/**
* cairo_set_font:
* @cr: a #cairo_t
* @font: a #cairo_font_t, or %NULL to unset any previously set font.
*
* Replaces the current #cairo_font_t object in the #cairo_t with
* @font. The replaced font in the #cairo_t will be destroyed if there
* are no other references to it. Since a #cairo_font_t is specific to
* a particular output device and size, changing the transformation,
* font transformation, or target surfaces of a #cairo_t will clear
* any previously set font. Setting the font using cairo_set_font() is
* exclusive with the simple font selection API provided by
* cairo_select_font(). The size and transformation set by
* cairo_scale_font() and cairo_transform_font() are ignored unless
* they were taken into account when creating @font.
**/
void
cairo_set_font (cairo_t *cr, cairo_font_t *font)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_set_font (cr->gstate, font);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_scale_font:
* @cr: a #cairo_t
* @scale: a scale factor
*
* Scale the current font by the factor @scale. This function is
* designed to work well with cairo_select_font(), and will usually be
* called immediately afterwards to set the desired font size.
*
* If this function is called after a #cairo_font_t has been set by
* cairo_font_t() then that font will be discarded from the
* #cairo_t. Instead, cairo_scale_font will operate on the last font
* selected by cairo_select_font(), or the default font if
* cairo_select_font() has never been called.
*
* XXX: The interaction with cairo_set_font described above is very
* confusing and violates the principle of least surprise. I think
* this is an API bug that we should resolve somehow (cworth).
**/
void
cairo_scale_font (cairo_t *cr, double scale)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_scale_font (cr->gstate, scale);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_transform_font:
* @cr: a #cairo_t
* @matrix: a #cairo_matrix_t describing a transform to be applied to
* the current font.
*
* Transform the current font according to @matrix. The transformation
* is applied in addition to any previous transformations applied by
* either cairo_transform_font() or cairo_scale_font().
*
* This function is designed to work well with cairo_select_font().
*
* If this function is called after a #cairo_font_t has been set by
* cairo_font_t() then that font will be discarded from the
* #cairo_t. Instead, cairo_scale_font will operate on the last font
* selected by cairo_select_font(), or the default font if
* cairo_select_font() has never been called.
*
* XXX: The interaction with cairo_set_font described above is very
* confusing and violates the principle of least surprise. I think
* this is an API bug that we should resolve somehow (cworth).
**/
void
cairo_transform_font (cairo_t *cr, cairo_matrix_t *matrix)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_transform_font (cr->gstate, matrix);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_text_extents:
* @cr: a #cairo_t
* @utf8: a string of text, encoded in utf-8
* @extents: a #cairo_text_extents_t object into which the results
* will be stored.
*
* Gets the extents for a string of text. The extents describe a
* user-space rectangle that encloses the "inked" portion of the text,
* (as it would be drawn by cairo_show_text). Additionally, the
* x_advance and y_advance values indicate the amount by which the
* current point would be advanced by cairo_show_text.
*
* Note that whitespace characters do not directly contribute to the
* size of the rectangle (extents.width and extents.height). They do
* contribute indirectly by changing the position of non-whitespace
* characters. In particular, trailing whitespace characters are
* likely to not affect the size of the rectangle, though they will
* affect the x_advance and y_advance values.
**/
void
cairo_text_extents (cairo_t *cr,
const unsigned char *utf8,
cairo_text_extents_t *extents)
{
cairo_glyph_t *glyphs = NULL;
int num_glyphs;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
if (utf8 == NULL) {
extents->x_bearing = 0.0;
extents->y_bearing = 0.0;
extents->width = 0.0;
extents->height = 0.0;
extents->x_advance = 0.0;
extents->y_advance = 0.0;
return;
}
cr->status = _cairo_gstate_text_to_glyphs (cr->gstate, utf8, &glyphs, &num_glyphs);
CAIRO_CHECK_SANITY (cr);
if (cr->status) {
if (glyphs)
free (glyphs);
return;
}
cr->status = _cairo_gstate_glyph_extents (cr->gstate, glyphs, num_glyphs, extents);
CAIRO_CHECK_SANITY (cr);
if (glyphs)
free (glyphs);
}
/**
* cairo_glyph_extents:
* @cr: a #cairo_t
* @glyphs: an array of #cairo_glyph_t objects
* @num_glyphs: the number of elements in @glyphs
* @extents: a #cairo_text_extents_t object into which the results
* will be stored
*
* Gets the extents for an array of glyphs. The extents describe a
* user-space rectangle that encloses the "inked" portion of the
* glyphs, (as they would be drawn by cairo_show_glyphs).
* Additionally, the x_advance and y_advance values indicate the
* amount by which the current point would be advanced by
* cairo_show_glyphs.
*
* Note that whitespace glyphs do not contribute to the size of the
* rectangle (extents.width and extents.height).
**/
void
cairo_glyph_extents (cairo_t *cr,
cairo_glyph_t *glyphs,
int num_glyphs,
cairo_text_extents_t *extents)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_glyph_extents (cr->gstate, glyphs, num_glyphs,
extents);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_show_text (cairo_t *cr, const unsigned char *utf8)
{
cairo_glyph_t *glyphs = NULL;
int num_glyphs;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
if (utf8 == NULL)
return;
cr->status = _cairo_gstate_text_to_glyphs (cr->gstate, utf8,
&glyphs, &num_glyphs);
CAIRO_CHECK_SANITY (cr);
if (cr->status) {
if (glyphs)
free (glyphs);
return;
}
cr->status = _cairo_gstate_show_glyphs (cr->gstate, glyphs, num_glyphs);
CAIRO_CHECK_SANITY (cr);
if (glyphs)
free (glyphs);
}
void
cairo_show_glyphs (cairo_t *cr, cairo_glyph_t *glyphs, int num_glyphs)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_show_glyphs (cr->gstate, glyphs, num_glyphs);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_text_path (cairo_t *cr, const unsigned char *utf8)
{
cairo_glyph_t *glyphs = NULL;
int num_glyphs;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_text_to_glyphs (cr->gstate, utf8,
&glyphs, &num_glyphs);
CAIRO_CHECK_SANITY (cr);
if (cr->status) {
if (glyphs)
free (glyphs);
return;
}
cr->status = _cairo_gstate_glyph_path (cr->gstate, glyphs, num_glyphs);
CAIRO_CHECK_SANITY (cr);
if (glyphs)
free (glyphs);
}
void
cairo_glyph_path (cairo_t *cr, cairo_glyph_t *glyphs, int num_glyphs)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_glyph_path (cr->gstate, glyphs, num_glyphs);
CAIRO_CHECK_SANITY (cr);
}
void
cairo_show_surface (cairo_t *cr,
cairo_surface_t *surface,
int width,
int height)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
cr->status = _cairo_gstate_show_surface (cr->gstate,
surface, width, height);
CAIRO_CHECK_SANITY (cr);
}
/**
* cairo_get_operator:
* @cr: a cairo context
*
* Gets the current compositing operator for a cairo context.
*
* Return value: the current compositing operator.
**/
cairo_operator_t
cairo_get_operator (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_operator (cr->gstate);
}
DEPRECATE (cairo_current_operator, cairo_get_operator);
/**
* cairo_get_rgb_color:
* @cr: a cairo context
* @red: return value for red channel
* @green: return value for green channel
* @blue: return value for blue channel
*
* Gets the current color for a cairo context, as set by
* cairo_set_rgb_color().
*
* Note that this color may not actually be used for drawing
* operations, (in the case of an alternate source pattern being set
* by cairo_set_pattern()).
*
* WARNING: This function is scheduled to be removed as part of the
* upcoming API Shakeup.
**/
void
cairo_get_rgb_color (cairo_t *cr, double *red, double *green, double *blue)
{
CAIRO_CHECK_SANITY (cr);
_cairo_gstate_get_rgb_color (cr->gstate, red, green, blue);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE (cairo_current_rgb_color, cairo_get_rgb_color);
/**
* cairo_get_alpha:
* @cr: a cairo context
*
* Gets the current alpha value, as set by cairo_set_alpha().
*
* Return value: the current alpha value.
*
* WARNING: This function is scheduled to be removed as part of the
* upcoming API Shakeup.
**/
double
cairo_get_alpha (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_alpha (cr->gstate);
}
DEPRECATE (cairo_current_alpha, cairo_get_alpha);
/**
* cairo_get_tolerance:
* @cr: a cairo context
*
* Gets the current tolerance value, as set by cairo_set_tolerance().
*
* Return value: the current tolerance value.
**/
double
cairo_get_tolerance (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_tolerance (cr->gstate);
}
DEPRECATE (cairo_current_tolerance, cairo_get_tolerance);
/**
* cairo_get_current_point:
* @cr: a cairo context
* @x: return value for X coordinate of the current point
* @y: return value for Y coordinate of the current point
*
* Gets the current point of the current path, which is
* conceptually the final point reached by the path so far.
*
* The current point is returned in the user-space coordinate
* system. If there is no defined current point then @x and @y will
* both be set to 0.0.
*
* Most path construction functions alter the current point. See the
* following for details on how they affect the current point:
*
* cairo_new_path(), cairo_move_to(), cairo_line_to(),
* cairo_curve_to(), cairo_arc(), cairo_rel_move_to(),
* cairo_rel_line_to(), cairo_rel_curve_to(), cairo_arc(),
* cairo_text_path(), cairo_stroke_to_path()
**/
void
cairo_get_current_point (cairo_t *cr, double *x, double *y)
{
CAIRO_CHECK_SANITY (cr);
_cairo_gstate_get_current_point (cr->gstate, x, y);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE (cairo_current_point, cairo_get_current_point);
/**
* cairo_get_fill_rule:
* @cr: a cairo context
*
* Gets the current fill rule, as set by cairo_set_fill_rule().
*
* Return value: the current fill rule.
**/
cairo_fill_rule_t
cairo_get_fill_rule (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_fill_rule (cr->gstate);
}
DEPRECATE (cairo_current_fill_rule, cairo_get_fill_rule);
/**
* cairo_get_line_width:
* @cr: a cairo context
*
* Gets the current line width, as set by cairo_set_line_width().
*
* Return value: the current line width, in user-space units.
**/
double
cairo_get_line_width (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_line_width (cr->gstate);
}
DEPRECATE (cairo_current_line_width, cairo_get_line_width);
/**
* cairo_get_line_cap:
* @cr: a cairo context
*
* Gets the current line cap style, as set by cairo_set_line_cap().
*
* Return value: the current line cap style.
**/
cairo_line_cap_t
cairo_get_line_cap (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_line_cap (cr->gstate);
}
DEPRECATE (cairo_current_line_cap, cairo_get_line_cap);
/**
* cairo_get_line_join:
* @cr: a cairo context
*
* Gets the current line join style, as set by cairo_set_line_join().
*
* Return value: the current line join style.
**/
cairo_line_join_t
cairo_get_line_join (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_line_join (cr->gstate);
}
DEPRECATE (cairo_current_line_join, cairo_get_line_join);
/**
* cairo_get_miter_limit:
* @cr: a cairo context
*
* Gets the current miter limit, as set by cairo_set_miter_limit().
*
* Return value: the current miter limit.
**/
double
cairo_get_miter_limit (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_miter_limit (cr->gstate);
}
DEPRECATE (cairo_current_miter_limit, cairo_get_miter_limit);
/**
* cairo_get_matrix:
* @cr: a cairo context
* @matrix: return value for the matrix
*
* Stores the current transformation matrix (CTM) into @matrix.
**/
void
cairo_get_matrix (cairo_t *cr, cairo_matrix_t *matrix)
{
CAIRO_CHECK_SANITY (cr);
_cairo_gstate_get_matrix (cr->gstate, matrix);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE (cairo_current_matrix, cairo_get_matrix);
/**
* cairo_get_target_surface:
* @cr: a cairo context
*
* Gets the current target surface, as set by cairo_set_target_surface().
*
* Return value: the current target surface.
*
* WARNING: This function is scheduled to be removed as part of the
* upcoming API Shakeup.
**/
cairo_surface_t *
cairo_get_target_surface (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return _cairo_gstate_get_target_surface (cr->gstate);
}
DEPRECATE (cairo_current_target_surface, cairo_get_target_surface);
void
cairo_get_path (cairo_t *cr,
cairo_move_to_func_t *move_to,
cairo_line_to_func_t *line_to,
cairo_curve_to_func_t *curve_to,
cairo_close_path_func_t *close_path,
void *closure)
{
int i;
cairo_path_t *path;
cairo_path_data_t *data;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
path = cairo_copy_path (cr);
for (i=0; i < path->num_data; i += path->data[i].header.length) {
data = &path->data[i];
switch (data->header.type) {
case CAIRO_PATH_MOVE_TO:
(move_to) (closure, data[1].point.x, data[1].point.y);
break;
case CAIRO_PATH_LINE_TO:
(line_to) (closure, data[1].point.x, data[1].point.y);
break;
case CAIRO_PATH_CURVE_TO:
(curve_to) (closure,
data[1].point.x, data[1].point.y,
data[2].point.x, data[2].point.y,
data[3].point.x, data[3].point.y);
break;
case CAIRO_PATH_CLOSE_PATH:
(close_path) (closure);
break;
}
}
cairo_path_destroy (path);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE (cairo_current_path, cairo_get_path);
void
cairo_get_path_flat (cairo_t *cr,
cairo_move_to_func_t *move_to,
cairo_line_to_func_t *line_to,
cairo_close_path_func_t *close_path,
void *closure)
{
int i;
cairo_path_t *path;
cairo_path_data_t *data;
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
path = cairo_copy_path_flat (cr);
for (i=0; i < path->num_data; i += path->data[i].header.length) {
data = &path->data[i];
switch (data->header.type) {
case CAIRO_PATH_MOVE_TO:
(move_to) (closure, data[1].point.x, data[1].point.y);
break;
case CAIRO_PATH_LINE_TO:
(line_to) (closure, data[1].point.x, data[1].point.y);
break;
case CAIRO_PATH_CLOSE_PATH:
(close_path) (closure);
break;
case CAIRO_PATH_CURVE_TO:
ASSERT_NOT_REACHED;
break;
}
}
cairo_path_destroy (path);
CAIRO_CHECK_SANITY (cr);
}
DEPRECATE (cairo_current_path_flat, cairo_get_path_flat);
/**
* cairo_copy_path:
* @cr: a cairo context
*
* Creates a copy of the current path and returns it to the user as a
* #cairo_path_t. See #cairo_path_data_t for hints on how to iterate
* over the returned data structure.
*
* Return value: the copy of the current path. The caller owns the
* returned object and should call cairo_path_destroy() when finished
* with it.
**/
cairo_path_t *
cairo_copy_path (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return &_cairo_path_nil;
return _cairo_path_data_create (cr->gstate);
}
/**
* cairo_copy_path_flat:
* @cr: a cairo context
*
* Gets a flattened copy of the current path and returns it to the
* user as a #cairo_path_t. See #cairo_path_data_t for hints on
* how to iterate over the returned data structure.
*
* This function is like cairo_copy_path() except that any curves
* in the path will be approximated with piecewise-linear
* approximations, (accurate to within the current tolerance
* value). That is, the result is guaranteed to not have any elements
* of type CAIRO_PATH_CURVE_TO which will instead be replaced by a
* series of CAIRO_PATH_LINE_TO elements.
*
* Return value: the copy of the current path. The caller owns the
* returned object and should call cairo_path_destroy() when finished
* with it.
**/
cairo_path_t *
cairo_copy_path_flat (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return &_cairo_path_nil;
return _cairo_path_data_create_flat (cr->gstate);
}
/**
* cairo_append_path:
* @cr: a cairo context
* @path: path to be appended
*
* Append the @path onto the current path. See #cairo_path_t
* for details on how the path data structure must be initialized.
**/
void
cairo_append_path (cairo_t *cr,
cairo_path_t *path)
{
CAIRO_CHECK_SANITY (cr);
if (cr->status)
return;
if (path == NULL || path->data == NULL) {
cr->status = CAIRO_STATUS_NULL_POINTER;
return;
}
if (path == &_cairo_path_nil) {
cr->status = CAIRO_STATUS_NO_MEMORY;
return;
}
cr->status = _cairo_path_data_append_to_context (path, cr);
CAIRO_CHECK_SANITY (cr);
}
cairo_status_t
cairo_status (cairo_t *cr)
{
CAIRO_CHECK_SANITY (cr);
return cr->status;
}
DEPRECATE (cairo_get_status, cairo_status);
const char *
cairo_status_string (cairo_t *cr)
{
switch (cr->status) {
case CAIRO_STATUS_SUCCESS:
return "success";
case CAIRO_STATUS_NO_MEMORY:
return "out of memory";
case CAIRO_STATUS_INVALID_RESTORE:
return "cairo_restore without matching cairo_save";
case CAIRO_STATUS_INVALID_POP_GROUP:
return "cairo_pop_group without matching cairo_push_group";
case CAIRO_STATUS_NO_CURRENT_POINT:
return "no current point defined";
case CAIRO_STATUS_INVALID_MATRIX:
return "invalid matrix (not invertible)";
case CAIRO_STATUS_NO_TARGET_SURFACE:
return "no target surface has been set";
case CAIRO_STATUS_NULL_POINTER:
return "NULL pointer";
case CAIRO_STATUS_INVALID_STRING:
return "input string not valid UTF-8";
case CAIRO_STATUS_INVALID_PATH_DATA:
return "input path data not valid";
case CAIRO_STATUS_WRITE_ERROR:
return "error while writing to output stream";
case CAIRO_STATUS_SURFACE_FINISHED:
return "the target surface has been finished";
}
return "<unknown error status>";
}
DEPRECATE (cairo_get_status_string, cairo_status_string);
void
_cairo_restrict_value (double *value, double min, double max)
{
if (*value < min)
*value = min;
else if (*value > max)
*value = max;
}