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

            
36
#include "cairoint.h"
37
#include "cairo-error-private.h"
38

            
39
void
40
34936
_cairo_stroke_style_init (cairo_stroke_style_t *style)
41
{
42
    VG (VALGRIND_MAKE_MEM_UNDEFINED (style, sizeof (cairo_stroke_style_t)));
43

            
44
34936
    style->line_width = CAIRO_GSTATE_LINE_WIDTH_DEFAULT;
45
34936
    style->line_cap = CAIRO_GSTATE_LINE_CAP_DEFAULT;
46
34936
    style->line_join = CAIRO_GSTATE_LINE_JOIN_DEFAULT;
47
34936
    style->miter_limit = CAIRO_GSTATE_MITER_LIMIT_DEFAULT;
48

            
49
34936
    style->dash = NULL;
50
34936
    style->num_dashes = 0;
51
34936
    style->dash_offset = 0.0;
52

            
53
34936
    style->is_hairline = FALSE;
54
34936
}
55

            
56
cairo_status_t
57
66621
_cairo_stroke_style_init_copy (cairo_stroke_style_t *style,
58
			       const cairo_stroke_style_t *other)
59
{
60
    if (CAIRO_INJECT_FAULT ())
61
	return _cairo_error (CAIRO_STATUS_NO_MEMORY);
62

            
63
    VG (VALGRIND_MAKE_MEM_UNDEFINED (style, sizeof (cairo_stroke_style_t)));
64

            
65
66621
    style->line_width = other->line_width;
66
66621
    style->line_cap = other->line_cap;
67
66621
    style->line_join = other->line_join;
68
66621
    style->miter_limit = other->miter_limit;
69

            
70
66621
    style->num_dashes = other->num_dashes;
71

            
72
66621
    if (other->dash == NULL) {
73
66555
	style->dash = NULL;
74
    } else {
75
66
	style->dash = _cairo_malloc_ab (style->num_dashes, sizeof (double));
76
66
	if (unlikely (style->dash == NULL))
77
	    return _cairo_error (CAIRO_STATUS_NO_MEMORY);
78

            
79
66
	memcpy (style->dash, other->dash,
80
66
		style->num_dashes * sizeof (double));
81
    }
82

            
83
66621
    style->dash_offset = other->dash_offset;
84

            
85
66621
    style->is_hairline = other->is_hairline;
86

            
87
66621
    return CAIRO_STATUS_SUCCESS;
88
}
89

            
90
void
91
100876
_cairo_stroke_style_fini (cairo_stroke_style_t *style)
92
{
93
100876
    free (style->dash);
94
100876
    style->dash = NULL;
95

            
96
100876
    style->num_dashes = 0;
97

            
98
    VG (VALGRIND_MAKE_MEM_UNDEFINED (style, sizeof (cairo_stroke_style_t)));
99
100876
}
100

            
101
/*
102
 * For a stroke in the given style, compute the maximum distance
103
 * from the path that vertices could be generated.  In the case
104
 * of rotation in the ctm, the distance will not be exact.
105
 */
106
void
107
75292
_cairo_stroke_style_max_distance_from_path (const cairo_stroke_style_t *style,
108
					    const cairo_path_fixed_t *path,
109
                                            const cairo_matrix_t *ctm,
110
                                            double *dx, double *dy)
111
{
112
75292
    double style_expansion = 0.5;
113

            
114
75292
    if (style->line_cap == CAIRO_LINE_CAP_SQUARE)
115
408
	style_expansion = M_SQRT1_2;
116

            
117
75292
    if (style->line_join == CAIRO_LINE_JOIN_MITER &&
118
73711
	! path->stroke_is_rectilinear &&
119
70791
	style_expansion < M_SQRT2 * style->miter_limit)
120
    {
121
70791
	style_expansion = M_SQRT2 * style->miter_limit;
122
    }
123

            
124
75292
    style_expansion *= style->line_width;
125

            
126
75292
    if (_cairo_matrix_has_unity_scale (ctm)) {
127
73231
	*dx = *dy = style_expansion;
128
    } else {
129
2061
	*dx = style_expansion * hypot (ctm->xx, ctm->xy);
130
2061
	*dy = style_expansion * hypot (ctm->yy, ctm->yx);
131
    }
132
75292
}
133

            
134
void
135
6
_cairo_stroke_style_max_line_distance_from_path (const cairo_stroke_style_t *style,
136
						 const cairo_path_fixed_t *path,
137
						 const cairo_matrix_t *ctm,
138
						 double *dx, double *dy)
139
{
140
6
    double style_expansion = 0.5 * style->line_width;
141
6
    if (_cairo_matrix_has_unity_scale (ctm)) {
142
	*dx = *dy = style_expansion;
143
    } else {
144
6
	*dx = style_expansion * hypot (ctm->xx, ctm->xy);
145
6
	*dy = style_expansion * hypot (ctm->yy, ctm->yx);
146
    }
147
6
}
148

            
149
void
150
6
_cairo_stroke_style_max_join_distance_from_path (const cairo_stroke_style_t *style,
151
						 const cairo_path_fixed_t *path,
152
						 const cairo_matrix_t *ctm,
153
						 double *dx, double *dy)
154
{
155
6
    double style_expansion = 0.5;
156

            
157
6
    if (style->line_join == CAIRO_LINE_JOIN_MITER &&
158
6
	! path->stroke_is_rectilinear &&
159
6
	style_expansion < M_SQRT2 * style->miter_limit)
160
    {
161
6
	style_expansion = M_SQRT2 * style->miter_limit;
162
    }
163

            
164
6
    style_expansion *= style->line_width;
165

            
166
6
    if (_cairo_matrix_has_unity_scale (ctm)) {
167
	*dx = *dy = style_expansion;
168
    } else {
169
6
	*dx = style_expansion * hypot (ctm->xx, ctm->xy);
170
6
	*dy = style_expansion * hypot (ctm->yy, ctm->yx);
171
    }
172
6
}
173
/*
174
 * Computes the period of a dashed stroke style.
175
 * Returns 0 for non-dashed styles.
176
 */
177
double
178
1287
_cairo_stroke_style_dash_period (const cairo_stroke_style_t *style)
179
{
180
    double period;
181
    unsigned int i;
182

            
183
1287
    period = 0.0;
184
4209
    for (i = 0; i < style->num_dashes; i++)
185
2922
	period += style->dash[i];
186

            
187
1287
    if (style->num_dashes & 1)
188
228
	period *= 2.0;
189

            
190
1287
    return period;
191
}
192

            
193
/*
194
 * Coefficient of the linear approximation (minimizing square difference)
195
 * of the surface covered by round caps
196
 *
197
 * This can be computed in the following way:
198
 * the area inside the circle with radius w/2 and the region -d/2 <= x <= d/2 is:
199
 *   f(w,d) = 2 * integrate (sqrt (w*w/4 - x*x), x, -d/2, d/2)
200
 * The square difference to a generic linear approximation (c*d) in the range (0,w) would be:
201
 *   integrate ((f(w,d) - c*d)^2, d, 0, w)
202
 * To minimize this difference it is sufficient to find a solution of the differential with
203
 * respect to c:
204
 *   solve ( diff (integrate ((f(w,d) - c*d)^2, d, 0, w), c), c)
205
 * Which leads to c = 9/32*pi*w
206
 * Since we're not interested in the true area, but just in a coverage estimate,
207
 * we always divide the real area by the line width (w).
208
 * The same computation for square caps would be
209
 *   f(w,d) = 2 * integrate(w/2, x, -d/2, d/2)
210
 *   c = 1*w
211
 * but in this case it would not be an approximation, since f is already linear in d.
212
 */
213
#define ROUND_MINSQ_APPROXIMATION (9*M_PI/32)
214

            
215
/*
216
 * Computes the length of the "on" part of a dashed stroke style,
217
 * taking into account also line caps.
218
 * Returns 0 for non-dashed styles.
219
 */
220
double
221
_cairo_stroke_style_dash_stroked (const cairo_stroke_style_t *style)
222
{
223
    double stroked, cap_scale;
224
    unsigned int i;
225

            
226
    switch (style->line_cap) {
227
    default: ASSERT_NOT_REACHED;
228
    case CAIRO_LINE_CAP_BUTT:   cap_scale = 0.0; break;
229
    case CAIRO_LINE_CAP_ROUND:  cap_scale = ROUND_MINSQ_APPROXIMATION; break;
230
    case CAIRO_LINE_CAP_SQUARE: cap_scale = 1.0; break;
231
    }
232

            
233
    stroked = 0.0;
234
    if (style->num_dashes & 1) {
235
        /* Each dash element is used both as on and as off. The order in which they are summed is
236
	 * irrelevant, so sum the coverage of one dash element, taken both on and off at each iteration */
237
	for (i = 0; i < style->num_dashes; i++)
238
	    stroked += style->dash[i] + cap_scale * MIN (style->dash[i], style->line_width);
239
    } else {
240
        /* Even (0, 2, ...) dashes are on and simply counted for the coverage, odd dashes are off, thus
241
	 * their coverage is approximated based on the area covered by the caps of adjacent on dases. */
242
	for (i = 0; i + 1 < style->num_dashes; i += 2)
243
	    stroked += style->dash[i] + cap_scale * MIN (style->dash[i+1], style->line_width);
244
    }
245

            
246
    return stroked;
247
}
248

            
249
/*
250
 * Verifies if _cairo_stroke_style_dash_approximate should be used to generate
251
 * an approximation of the dash pattern in the specified style, when used for
252
 * stroking a path with the given CTM and tolerance.
253
 * Always %FALSE for non-dashed styles.
254
 */
255
cairo_bool_t
256
39712
_cairo_stroke_style_dash_can_approximate (const cairo_stroke_style_t *style,
257
					  const cairo_matrix_t *ctm,
258
					  double tolerance)
259
{
260
    double period;
261

            
262
39712
    if (! style->num_dashes)
263
38425
        return FALSE;
264

            
265
1287
    period = _cairo_stroke_style_dash_period (style);
266
1287
    return _cairo_matrix_transformed_circle_major_axis (ctm, period) < tolerance;
267
}
268

            
269
/*
270
 * Create a 2-dashes approximation of a dashed style, by making the "on" and "off"
271
 * parts respect the original ratio.
272
 */
273
void
274
_cairo_stroke_style_dash_approximate (const cairo_stroke_style_t *style,
275
				      const cairo_matrix_t *ctm,
276
				      double tolerance,
277
				      double *dash_offset,
278
				      double *dashes,
279
				      unsigned int *num_dashes)
280
{
281
    double coverage, scale, offset;
282
    cairo_bool_t on = TRUE;
283
    unsigned int i = 0;
284

            
285
    coverage = _cairo_stroke_style_dash_stroked (style) / _cairo_stroke_style_dash_period (style);
286
    coverage = MIN (coverage, 1.0);
287
    scale = tolerance / _cairo_matrix_transformed_circle_major_axis (ctm, 1.0);
288

            
289
    /* We stop searching for a starting point as soon as the
290
     * offset reaches zero.  Otherwise when an initial dash
291
     * segment shrinks to zero it will be skipped over. */
292
    offset = style->dash_offset;
293
    while (offset > 0.0 && offset >= style->dash[i]) {
294
	offset -= style->dash[i];
295
	on = !on;
296
	if (++i == style->num_dashes)
297
	    i = 0;
298
    }
299

            
300
    *num_dashes = 2;
301

            
302
    /*
303
     * We want to create a new dash pattern with the same relative coverage,
304
     * but composed of just 2 elements with total length equal to scale.
305
     * Based on the formula in _cairo_stroke_style_dash_stroked:
306
     * scale * coverage = dashes[0] + cap_scale * MIN (dashes[1], line_width)
307
     *                  = MIN (dashes[0] + cap_scale * (scale - dashes[0]),
308
     *                         dashes[0] + cap_scale * line_width) = 
309
     *                  = MIN (dashes[0] * (1 - cap_scale) + cap_scale * scale,
310
     *	                       dashes[0] + cap_scale * line_width)
311
     *
312
     * Solving both cases we get:
313
     *   dashes[0] = scale * (coverage - cap_scale) / (1 - cap_scale)
314
     *	  when scale - dashes[0] <= line_width
315
     *	dashes[0] = scale * coverage - cap_scale * line_width
316
     *	  when scale - dashes[0] > line_width.
317
     *
318
     * Comparing the two cases we get:
319
     *   second > first
320
     *   second > scale * (coverage - cap_scale) / (1 - cap_scale)
321
     *   second - cap_scale * second - scale * coverage + scale * cap_scale > 0
322
     * 	 (scale * coverage - cap_scale * line_width) - cap_scale * second - scale * coverage + scale * cap_scale > 0
323
     *   - line_width - second + scale > 0
324
     *   scale - second > line_width
325
     * which is the condition for the second solution to be the valid one.
326
     * So when second > first, the second solution is the correct one (i.e.
327
     * the solution is always MAX (first, second).
328
     */
329
    switch (style->line_cap) {
330
    default:
331
        ASSERT_NOT_REACHED;
332
	dashes[0] = 0.0;
333
	break;
334

            
335
    case CAIRO_LINE_CAP_BUTT:
336
        /* Simplified formula (substituting 0 for cap_scale): */
337
        dashes[0] = scale * coverage;
338
	break;
339

            
340
    case CAIRO_LINE_CAP_ROUND:
341
        dashes[0] = MAX(scale * (coverage - ROUND_MINSQ_APPROXIMATION) / (1.0 - ROUND_MINSQ_APPROXIMATION),
342
			scale * coverage - ROUND_MINSQ_APPROXIMATION * style->line_width);
343
	break;
344

            
345
    case CAIRO_LINE_CAP_SQUARE:
346
        /*
347
	 * Special attention is needed to handle the case cap_scale == 1 (since the first solution
348
	 * is either indeterminate or -inf in this case). Since dash lengths are always >=0, using
349
	 * 0 as first solution always leads to the correct solution.
350
	 */
351
        dashes[0] = MAX(0.0, scale * coverage - style->line_width);
352
	break;
353
    }
354

            
355
    dashes[1] = scale - dashes[0];
356

            
357
    *dash_offset = on ? 0.0 : dashes[0];
358
}