path: root/src/cairo-path-data.c

/* cairo - a vector graphics library with display and print output
 *
 * Copyright © 2005 Red Hat, Inc.
 *
 * 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 Red Hat, Inc.
 *
 * Contributor(s):
 *	Carl D. Worth <cworth@redhat.com>
 */

#include "cairo-path-data-private.h"
#include "cairo-path-fixed-private.h"
#include "cairo-gstate-private.h"

static cairo_path_t
cairo_path_nil = { CAIRO_STATUS_NO_MEMORY, NULL, 0 };

/* Closure for path interpretation. */
typedef struct cairo_path_data_count {
    int count;
    double tolerance;
    cairo_point_t current_point;
} cpdc_t;

static cairo_status_t
_cpdc_move_to (void *closure, cairo_point_t *point)
{
    cpdc_t *cpdc = closure;

    cpdc->count += 2;

    cpdc->current_point = *point;

    return CAIRO_STATUS_SUCCESS;
}

static cairo_status_t
_cpdc_line_to (void *closure, cairo_point_t *point)
{
    cpdc_t *cpdc = closure;

    cpdc->count += 2;

    cpdc->current_point = *point;

    return CAIRO_STATUS_SUCCESS;
}

static cairo_status_t
_cpdc_curve_to (void	      *closure,
		cairo_point_t *p1,
		cairo_point_t *p2,
		cairo_point_t *p3)
{
    cpdc_t *cpdc = closure;

    cpdc->count += 4;

    cpdc->current_point = *p3;

    return CAIRO_STATUS_SUCCESS;
}

static cairo_status_t
_cpdc_curve_to_flatten (void	      *closure,
			cairo_point_t *p1,
			cairo_point_t *p2,
			cairo_point_t *p3)
{
    cpdc_t *cpdc = closure;
    cairo_status_t status;
    cairo_spline_t spline;
    int i;

    cairo_point_t *p0 = &cpdc->current_point;

    status = _cairo_spline_init (&spline, p0, p1, p2, p3);
    if (status == CAIRO_INT_STATUS_DEGENERATE)
	return CAIRO_STATUS_SUCCESS;

    status = _cairo_spline_decompose (&spline, cpdc->tolerance);
    if (status)
      goto out;

    for (i=1; i < spline.num_points; i++)
	_cpdc_line_to (cpdc, &spline.points[i]);

    cpdc->current_point = *p3;

    status = CAIRO_STATUS_SUCCESS;

 out:
    _cairo_spline_fini (&spline);
    return status;
}

static cairo_status_t
_cpdc_close_path (void *closure)
{
    cpdc_t *cpdc = closure;

    cpdc->count += 1;

    cpdc->current_point.x = 0;
    cpdc->current_point.y = 0;

    return CAIRO_STATUS_SUCCESS;
}

static int
_cairo_path_data_count (cairo_path_t	   *path,
			cairo_path_fixed_t *path_fixed,
			double		    tolerance,
			cairo_bool_t	    flatten)
{
    cpdc_t cpdc;

    cpdc.count = 0;
    cpdc.tolerance = tolerance;
    cpdc.current_point.x = 0;
    cpdc.current_point.y = 0;

    _cairo_path_fixed_interpret (path_fixed,
				 CAIRO_DIRECTION_FORWARD,
				 _cpdc_move_to,
				 _cpdc_line_to,
				 flatten ?
				 _cpdc_curve_to_flatten :
				 _cpdc_curve_to,
				 _cpdc_close_path,
				 &cpdc);

    return cpdc.count;
}

/* Closure for path interpretation. */
typedef struct cairo_path_data_populate {
    cairo_path_data_t *data;
    cairo_gstate_t    *gstate;
    cairo_point_t      current_point;
} cpdp_t;

static cairo_status_t
_cpdp_move_to (void *closure, cairo_point_t *point)
{
    cpdp_t *cpdp = closure;
    cairo_path_data_t *data = cpdp->data;
    double x, y;

    x = _cairo_fixed_to_double (point->x);
    y = _cairo_fixed_to_double (point->y);

    _cairo_gstate_backend_to_user (cpdp->gstate, &x, &y);

    data->header.type = CAIRO_PATH_MOVE_TO;
    data->header.length = 2;

    /* We index from 1 to leave room for data->header */
    data[1].point.x = x;
    data[1].point.y = y;

    cpdp->data += data->header.length;

    cpdp->current_point = *point;

    return CAIRO_STATUS_SUCCESS;
}

static cairo_status_t
_cpdp_line_to (void *closure, cairo_point_t *point)
{
    cpdp_t *cpdp = closure;
    cairo_path_data_t *data = cpdp->data;
    double x, y;

    x = _cairo_fixed_to_double (point->x);
    y = _cairo_fixed_to_double (point->y);

    _cairo_gstate_backend_to_user (cpdp->gstate, &x, &y);

    data->header.type = CAIRO_PATH_LINE_TO;
    data->header.length = 2;

    /* We index from 1 to leave room for data->header */
    data[1].point.x = x;
    data[1].point.y = y;

    cpdp->data += data->header.length;

    cpdp->current_point = *point;

    return CAIRO_STATUS_SUCCESS;
}

static cairo_status_t
_cpdp_curve_to (void	      *closure,
		cairo_point_t *p1,
		cairo_point_t *p2,
		cairo_point_t *p3)
{
    cpdp_t *cpdp = closure;
    cairo_path_data_t *data = cpdp->data;
    double x1, y1;
    double x2, y2;
    double x3, y3;

    x1 = _cairo_fixed_to_double (p1->x);
    y1 = _cairo_fixed_to_double (p1->y);
    _cairo_gstate_backend_to_user (cpdp->gstate, &x1, &y1);

    x2 = _cairo_fixed_to_double (p2->x);
    y2 = _cairo_fixed_to_double (p2->y);
    _cairo_gstate_backend_to_user (cpdp->gstate, &x2, &y2);

    x3 = _cairo_fixed_to_double (p3->x);
    y3 = _cairo_fixed_to_double (p3->y);
    _cairo_gstate_backend_to_user (cpdp->gstate, &x3, &y3);

    data->header.type = CAIRO_PATH_CURVE_TO;
    data->header.length = 4;

    /* We index from 1 to leave room for data->header */
    data[1].point.x = x1;
    data[1].point.y = y1;

    data[2].point.x = x2;
    data[2].point.y = y2;

    data[3].point.x = x3;
    data[3].point.y = y3;

    cpdp->data += data->header.length;

    cpdp->current_point = *p3;

    return CAIRO_STATUS_SUCCESS;
}

static cairo_status_t
_cpdp_curve_to_flatten (void	      *closure,
			cairo_point_t *p1,
			cairo_point_t *p2,
			cairo_point_t *p3)
{
    cpdp_t *cpdp = closure;
    cairo_status_t status;
    cairo_spline_t spline;
    int i;

    cairo_point_t *p0 = &cpdp->current_point;

    status = _cairo_spline_init (&spline, p0, p1, p2, p3);
    if (status == CAIRO_INT_STATUS_DEGENERATE)
	return CAIRO_STATUS_SUCCESS;

    status = _cairo_spline_decompose (&spline, cpdp->gstate->tolerance);
    if (status)
      goto out;

    for (i=1; i < spline.num_points; i++)
	_cpdp_line_to (cpdp, &spline.points[i]);

    cpdp->current_point = *p3;

    status = CAIRO_STATUS_SUCCESS;

 out:
    _cairo_spline_fini (&spline);
    return status;
}

static cairo_status_t
_cpdp_close_path (void *closure)
{
    cpdp_t *cpdp = closure;
    cairo_path_data_t *data = cpdp->data;

    data->header.type = CAIRO_PATH_CLOSE_PATH;
    data->header.length = 1;

    cpdp->data += data->header.length;

    cpdp->current_point.x = 0;
    cpdp->current_point.y = 0;

    return CAIRO_STATUS_SUCCESS;
}

static void
_cairo_path_data_populate (cairo_path_t   *path,
			   cairo_path_fixed_t *path_fixed,
			   cairo_gstate_t *gstate,
			   cairo_bool_t	   flatten)
{
    cpdp_t cpdp;

    cpdp.data = path->data;
    cpdp.gstate = gstate;
    cpdp.current_point.x = 0;
    cpdp.current_point.y = 0;

    _cairo_path_fixed_interpret (path_fixed,
				 CAIRO_DIRECTION_FORWARD,
				 _cpdp_move_to,
				 _cpdp_line_to,
				 flatten ?
				 _cpdp_curve_to_flatten :
				 _cpdp_curve_to,
				 _cpdp_close_path,
				 &cpdp);

    /* Sanity check the count */
    assert (cpdp.data - path->data == path->num_data);
}

static cairo_path_t *
_cairo_path_data_create_real (cairo_path_fixed_t *path_fixed,
			      cairo_gstate_t     *gstate,
			      cairo_bool_t	  flatten)
{
    cairo_path_t *path;

    path = malloc (sizeof (cairo_path_t));
    if (path == NULL)
	return &cairo_path_nil;

    path->num_data = _cairo_path_data_count (path, path_fixed,
					     gstate->tolerance, flatten);

    path->data = malloc (path->num_data * sizeof (cairo_path_data_t));
    if (path->data == NULL) {
	free (path);
	return &cairo_path_nil;
    }

    path->status = CAIRO_STATUS_SUCCESS;

    _cairo_path_data_populate (path, path_fixed,
			       gstate, flatten);

    return path;
}

/**
 * cairo_path_destroy:
 * @path: a path to destroy which was previously returned by either
 * cairo_copy_path or cairo_copy_path_flat.
 * 
 * Immediately releases all memory associated with @path. After a call
 * to cairo_path_destroy() the @path pointer is no longer valid and
 * should not be used further.
 *
 * NOTE: cairo_path_destroy function should only be called with a
 * pointer to a #cairo_path_t returned by a cairo function. Any path
 * that is created manually (ie. outside of cairo) should be destroyed
 * manually as well.
 **/
void
cairo_path_destroy (cairo_path_t *path)
{
    if (path == NULL || path == &cairo_path_nil)
	return;

    free (path->data);
    path->num_data = 0;
    free (path);
}

/**
 * _cairo_path_data_create:
 * @path: a fixed-point, device-space path to be converted and copied
 * @gstate: the current graphics state
 * 
 * Creates a user-space #cairo_path_t copy of the given device-space
 * @path. The @gstate parameter provides the inverse CTM for the
 * conversion.
 * 
 * Return value: the new copy of the path. If there is insufficient
 * memory a pointer to a special static cairo_path_nil will be
 * returned instead with status==CAIRO_STATUS_NO_MEMORY and
 * data==NULL.
 **/
cairo_path_t *
_cairo_path_data_create (cairo_path_fixed_t *path,
			 cairo_gstate_t     *gstate)
{
    return _cairo_path_data_create_real (path, gstate, FALSE);
}

/**
 * _cairo_path_data_create_flat:
 * @path: a fixed-point, device-space path to be flattened, converted and copied
 * @gstate: the current graphics state
 * 
 * Creates a flattened, user-space #cairo_path_t copy of the given
 * device-space @path. The @gstate parameter provide the inverse CTM
 * for the conversion, as well as the tolerance value to control the
 * accuracy of the flattening.
 * 
 * Return value: the flattened copy of the path. If there is insufficient
 * memory a pointer to a special static cairo_path_nil will be
 * returned instead with status==CAIRO_STATUS_NO_MEMORY and
 * data==NULL.
 **/
cairo_path_t *
_cairo_path_data_create_flat (cairo_path_fixed_t *path,
			      cairo_gstate_t     *gstate)
{
    return _cairo_path_data_create_real (path, gstate, TRUE);
}

/**
 * _cairo_path_data_create_in_error:
 * @status: an error status
 * 
 * Create an empty #cairo_path_t object to hold an error status. This
 * is useful for propagating status values from an existing object to
 * a new #cairo_path_t.
 * 
 * Return value: a #cairo_path_t object with status of @status, NULL
 * data, and 0 num_data. If there is insufficient memory a pointer to
 * a special static cairo_path_nil will be returned instead with
 * status==CAIRO_STATUS_NO_MEMORY rather than @status.
 **/
cairo_path_t *
_cairo_path_data_create_in_error (cairo_status_t status)
{
    cairo_path_t *path;

    path = malloc (sizeof (cairo_path_t));
    if (path == NULL)
	return &cairo_path_nil;

    path->status = status;
    path->data = NULL;
    path->num_data = 0;

    return path;
}

/**
 * _cairo_path_data_append_to_context:
 * @path: the path data to be appended
 * @cr: a cairo context
 * 
 * Append @path to the current path within @cr.
 * 
 * Return value: CAIRO_STATUS_INVALID_PATH_DATA if the data in @path
 * is invalid, and CAIRO_STATUS_SUCCESS otherwise.
 **/
cairo_status_t
_cairo_path_data_append_to_context (cairo_path_t *path,
				    cairo_t	 *cr)
{
    int i;
    cairo_path_data_t *p;

    for (i=0; i < path->num_data; i += path->data[i].header.length) {
	p = &path->data[i];
	switch (p->header.type) {
	case CAIRO_PATH_MOVE_TO:
	    cairo_move_to (cr,
			   p[1].point.x, p[1].point.y);
	    if (p->header.length != 2)
		return CAIRO_STATUS_INVALID_PATH_DATA;
	    break;
	case CAIRO_PATH_LINE_TO:
	    cairo_line_to (cr,
			   p[1].point.x, p[1].point.y);
	    if (p->header.length != 2)
		return CAIRO_STATUS_INVALID_PATH_DATA;
	    break;
	case CAIRO_PATH_CURVE_TO:
	    cairo_curve_to (cr,
			    p[1].point.x, p[1].point.y,
			    p[2].point.x, p[2].point.y,
			    p[3].point.x, p[3].point.y);
	    if (p->header.length != 4)
		return CAIRO_STATUS_INVALID_PATH_DATA;
	    break;
	case CAIRO_PATH_CLOSE_PATH:
	    cairo_close_path (cr);
	    if (p->header.length != 1)
		return CAIRO_STATUS_INVALID_PATH_DATA;
	    break;
	default:
	    return CAIRO_STATUS_INVALID_PATH_DATA;
	}
    }

    return CAIRO_STATUS_SUCCESS;
}