Code

New file. use for building with gtk28
[inkscape.git] / src / style.h
1 #ifndef __SP_STYLE_H__
2 #define __SP_STYLE_H__
4 /** \file
5  * SPStyle - a style object for SPItem objects
6  *
7  * Authors:
8  *   Lauris Kaplinski <lauris@kaplinski.com>
9  *
10  * Copyright (C) 2001-2002 Lauris Kaplinski
11  * Copyright (C) 2001 Ximian, Inc.
12  *
13  * Released under GNU GPL, read the file 'COPYING' for more information
14  */
16 #include "color.h"
17 #include "forward.h"
18 #include "sp-marker-loc.h"
19 #include "sp-filter.h"
21 #include <sigc++/connection.h>
23 namespace Inkscape {
24 namespace XML {
25 class Node;
26 }
27 }
29 class SPCSSAttr;
31 namespace Inkscape {
32 gchar *parse_css_url(gchar const *string);
33 }
35 class SPIFloat;
36 class SPIScale24;
37 class SPIInt;
38 class SPIShort;
39 class SPIEnum;
40 class SPIString;
41 class SPILength;
42 class SPIPaint;
43 class SPIFontSize;
45 /// Float type internal to SPStyle.
46 struct SPIFloat {
47     unsigned set : 1;
48     unsigned inherit : 1;
49     unsigned data : 30;
50     float value;
51 };
53 /*
54  * One might think that the best value for SP_SCALE24_MAX would be ((1<<24)-1), which allows the
55  * greatest possible precision for fitting [0, 1] fractions into 24 bits.
56  *
57  * However, in practice, that gives a problem with 0.5, which falls half way between two fractions
58  * of ((1<<24)-1).  What's worse is that casting double(1<<23) / ((1<<24)-1) to float on x86
59  * produces wrong rounding behaviour, resulting in a fraction of ((1<<23)+2.0f) / (1<<24) rather
60  * than ((1<<23)+1.0f) / (1<<24) as one would expect, let alone ((1<<23)+0.0f) / (1<<24) as one
61  * would ideally like for this example.
62  *
63  * The value (1<<23) is thus best if one considers float conversions alone.
64  *
65  * The value 0xff0000 can exactly represent all 8-bit alpha channel values,
66  * and can exactly represent all multiples of 0.1.  I haven't yet tested whether
67  * rounding bugs still get in the way of conversions to & from float, but my instinct is that
68  * it's fairly safe because 0xff fits three times inside float's significand.
69  *
70  * We should probably use the value 0xffff00 once we support 16 bits per channel and/or LittleCMS,
71  * though that might need to be accompanied by greater use of double instead of float for
72  * colours and opacities, to be safe from rounding bugs.
73  */
74 #define SP_SCALE24_MAX (0xff0000)
75 #define SP_SCALE24_TO_FLOAT(v) ((double) (v) / SP_SCALE24_MAX)
76 #define SP_SCALE24_FROM_FLOAT(v) unsigned(((v) * SP_SCALE24_MAX) + .5)
78 /** Returns a scale24 for the product of two scale24 values. */
79 #define SP_SCALE24_MUL(_v1, _v2) unsigned((double)(_v1) * (_v2) / SP_SCALE24_MAX + .5)
81 /// 24 bit data type internal to SPStyle.
82 struct SPIScale24 {
83     unsigned set : 1;
84     unsigned inherit : 1;
85     unsigned value : 24;
86 };
88 /// Int type internal to SPStyle.
89 struct SPIInt {
90     unsigned set : 1;
91     unsigned inherit : 1;
92     unsigned data : 30;
93     int value;
94 };
96 /// Short type internal to SPStyle.
97 struct SPIShort {
98     unsigned set : 1;
99     unsigned inherit : 1;
100     unsigned data : 14;
101     int value : 16;
102 };
104 /// Enum type internal to SPStyle.
105 struct SPIEnum {
106     unsigned set : 1;
107     unsigned inherit : 1;
108     unsigned value : 8;
109     unsigned computed : 8;
110 };
112 /// String type internal to SPStyle.
113 struct SPIString {
114     unsigned set : 1;
115     unsigned inherit : 1;
116     unsigned data : 30;
117     gchar *value;
118 };
120 enum {
121     SP_CSS_UNIT_NONE,
122     SP_CSS_UNIT_PX,
123     SP_CSS_UNIT_PT,
124     SP_CSS_UNIT_PC,
125     SP_CSS_UNIT_MM,
126     SP_CSS_UNIT_CM,
127     SP_CSS_UNIT_IN,
128     SP_CSS_UNIT_EM,
129     SP_CSS_UNIT_EX,
130     SP_CSS_UNIT_PERCENT
131 };
133 /// Length type internal to SPStyle.
134 struct SPILength {
135     unsigned set : 1;
136     unsigned inherit : 1;
137     unsigned unit : 4;
138     float value;
139     float computed;
140 };
142 #define SP_STYLE_FILL_SERVER(s) (((SPStyle *) (s))->fill.value.paint.server)
143 #define SP_STYLE_STROKE_SERVER(s) (((SPStyle *) (s))->stroke.value.paint.server)
144 #define SP_OBJECT_STYLE_FILL_SERVER(o) (SP_OBJECT (o)->style->fill.value.paint.server)
145 #define SP_OBJECT_STYLE_STROKE_SERVER(o) (SP_OBJECT (o)->style->stroke.value.paint.server)
147 enum {
148     SP_PAINT_TYPE_NONE,
149     SP_PAINT_TYPE_COLOR,
150     SP_PAINT_TYPE_PAINTSERVER,
151     SP_PAINT_TYPE_IMPOSSIBLE
152 };
154 class SVGICCColor;
156 /// Paint type internal to SPStyle.
157 struct SPIPaint {
158     unsigned set : 1;
159     unsigned inherit : 1;
160     unsigned currentcolor : 1;
161     unsigned type : 2;
162     union {
163         SPColor color;
164         struct {
165             SPPaintServer *server;
166             gchar *uri;
167         } paint;
168     } value;
169     SVGICCColor *iccColor;
170 };
172 /// Filter type internal to SPStyle
173 struct SPIFilter {
174     unsigned set : 1;
175     unsigned inherit : 1;
176     SPFilter *filter;
177     gchar *uri;
178 };
180 enum {
181     SP_FONT_SIZE_LITERAL,
182     SP_FONT_SIZE_LENGTH,
183     SP_FONT_SIZE_PERCENTAGE
184 };
186 #define SP_FONT_SIZE ((1 << 24) - 1)
188 #define SP_F8_16_TO_FLOAT(v) ((gdouble) (v) / (1 << 16))
189 #define SP_F8_16_FROM_FLOAT(v) ((int) ((v) * ((1 << 16) + 0.9999)))
191 #define SP_STYLE_FLAG_IFSET (1 << 0)
192 #define SP_STYLE_FLAG_IFDIFF (1 << 1)
193 #define SP_STYLE_FLAG_ALWAYS (1 << 2)
195 /// Fontsize type internal to SPStyle.
196 struct SPIFontSize {
197     unsigned set : 1;
198     unsigned inherit : 1;
199     unsigned type : 2;
200     unsigned value : 24;
201     float computed;
202 };
204 /// Text decoration type internal to SPStyle.
205 struct SPITextDecoration {
206     unsigned set : 1;
207     unsigned inherit : 1;
208     unsigned underline : 1;
209     unsigned overline : 1;
210     unsigned line_through : 1;
211     unsigned blink : 1;    // "Conforming user agents are not required to support this value." yay!
212 };
214 /// Extended length type internal to SPStyle.
215 struct SPILengthOrNormal {
216     unsigned set : 1;
217     unsigned inherit : 1;
218     unsigned normal : 1;
219     unsigned unit : 4;
220     float value;
221     float computed;
222 };
224 class SPTextStyle;
226 /// Stroke dash details.
227 class NRVpathDash {
228 public:
229     double offset;
230     int n_dash;
231     double *dash;
232 };
234 /// An SVG style object.
235 struct SPStyle {
236     int refcount;
237     /** Object we are attached to */
238     SPObject *object;
239     /** Our text style component */
240     SPTextStyle *text;
241     unsigned text_private : 1;
243     /* CSS2 */
244     /* Font */
245     /** Size of the font */
246     SPIFontSize font_size;
247     /** Style of the font */
248     SPIEnum font_style;
249     /** Which substyle of the font */
250     SPIEnum font_variant;
251     /** Weight of the font */
252     SPIEnum font_weight;
253     /** Stretch of the font */
254     SPIEnum font_stretch;
256     /** First line indent of paragraphs (css2 16.1) */
257     SPILength text_indent;
258     /** text alignment (css2 16.2) (not to be confused with text-anchor) */
259     SPIEnum text_align;
260     /** text decoration (css2 16.3.1) */
261     SPITextDecoration text_decoration;
262     // 16.3.2 is text-shadow. That's complicated.
263     /** Line spacing (css2 10.8.1) */
264     SPILengthOrNormal line_height;
265     /** letter spacing (css2 16.4) */
266     SPILengthOrNormal letter_spacing;
267     /** word spacing (also css2 16.4) */
268     SPILengthOrNormal word_spacing;
269     /** capitalization (css2 16.5) */
270     SPIEnum text_transform;
272     /* CSS3 Text */
273     /** text direction (css3 text 3.2) */
274     SPIEnum direction;
275     /** block progression (css3 text 3.2) */
276     SPIEnum block_progression;
277     /** Writing mode (css3 text 3.2 and svg1.1 10.7.2) */
278     SPIEnum writing_mode;
280     /* SVG */
281     /** Anchor of the text (svg1.1 10.9.1) */
282     SPIEnum text_anchor;
284     /* Misc attributes */
285     unsigned clip_set : 1;
286     unsigned color_set : 1;
287     unsigned cursor_set : 1;
288     unsigned overflow_set : 1;
289     unsigned clip_path_set : 1;
290     unsigned clip_rule_set : 1;
291     unsigned mask_set : 1;
293     /** display */
294     SPIEnum display;
296     /** overflow */
297     SPIEnum overflow;
299     /** visibility */
300     SPIEnum visibility;
302     /** opacity */
303     SPIScale24 opacity;
305     /** color */
306     SPIPaint color;
308     /** fill */
309     SPIPaint fill;
310     /** fill-opacity */
311     SPIScale24 fill_opacity;
312     /** fill-rule: 0 nonzero, 1 evenodd */
313     SPIEnum fill_rule;
315     /** stroke */
316     SPIPaint stroke;
317     /** stroke-width */
318     SPILength stroke_width;
319     /** stroke-linecap */
320     SPIEnum stroke_linecap;
321     /** stroke-linejoin */
322     SPIEnum stroke_linejoin;
323     /** stroke-miterlimit */
324     SPIFloat stroke_miterlimit;
325     /** stroke-dash* */
326     NRVpathDash stroke_dash;
327     unsigned stroke_dasharray_set : 1;
328     unsigned stroke_dasharray_inherit : 1;
329     unsigned stroke_dashoffset_set : 1;
330     /** stroke-opacity */
331     SPIScale24 stroke_opacity;
333     /** Marker list */
334     SPIString marker[SP_MARKER_LOC_QTY];
336     /** Filter effect */
337     SPIFilter filter;
339    /** normally not used, but duplicates the Gaussian blur deviation (if any) from the attached
340         filter when the style is used for querying */
341     SPILength filter_gaussianBlur_deviation;
343     /** enable-background, used for defining where filter effects get
344      * their background image */
345     SPIEnum enable_background;
347     /// style belongs to a cloned object, must not href anything
348     bool cloned; 
349     /// style has hreffed its fill/stroke paintservers, needs to release.
350     bool fill_hreffed; 
351     bool stroke_hreffed; 
352     bool filter_hreffed; 
354     sigc::connection release_connection;
356     sigc::connection fill_release_connection;
357     sigc::connection fill_modified_connection;
359     sigc::connection stroke_release_connection;
360     sigc::connection stroke_modified_connection;
362     sigc::connection filter_release_connection;
363     sigc::connection filter_modified_connection;
364 };
366 SPStyle *sp_style_new();
368 SPStyle *sp_style_new_from_object(SPObject *object);
370 SPStyle *sp_style_ref(SPStyle *style);
372 SPStyle *sp_style_unref(SPStyle *style);
374 void sp_style_read_from_object(SPStyle *style, SPObject *object);
376 void sp_style_read_from_repr(SPStyle *style, Inkscape::XML::Node *repr);
378 void sp_style_merge_from_style_string(SPStyle *style, gchar const *p);
380 void sp_style_merge_from_parent(SPStyle *style, SPStyle const *parent);
382 void sp_style_merge_from_dying_parent(SPStyle *style, SPStyle const *parent);
384 gchar *sp_style_write_string(SPStyle const *style, guint flags = SP_STYLE_FLAG_IFSET);
386 gchar *sp_style_write_difference(SPStyle const *from, SPStyle const *to);
388 /* SPTextStyle */
390 enum SPCSSFontSize {
391     SP_CSS_FONT_SIZE_XX_SMALL,
392     SP_CSS_FONT_SIZE_X_SMALL,
393     SP_CSS_FONT_SIZE_SMALL,
394     SP_CSS_FONT_SIZE_MEDIUM,
395     SP_CSS_FONT_SIZE_LARGE,
396     SP_CSS_FONT_SIZE_X_LARGE,
397     SP_CSS_FONT_SIZE_XX_LARGE,
398     SP_CSS_FONT_SIZE_SMALLER,
399     SP_CSS_FONT_SIZE_LARGER
400 };
402 enum SPCSSFontStyle {
403     SP_CSS_FONT_STYLE_NORMAL,
404     SP_CSS_FONT_STYLE_ITALIC,
405     SP_CSS_FONT_STYLE_OBLIQUE
406 };
408 enum SPCSSFontVariant {
409     SP_CSS_FONT_VARIANT_NORMAL,
410     SP_CSS_FONT_VARIANT_SMALL_CAPS
411 };
413 enum SPCSSFontWeight {
414     SP_CSS_FONT_WEIGHT_100,
415     SP_CSS_FONT_WEIGHT_200,
416     SP_CSS_FONT_WEIGHT_300,
417     SP_CSS_FONT_WEIGHT_400,
418     SP_CSS_FONT_WEIGHT_500,
419     SP_CSS_FONT_WEIGHT_600,
420     SP_CSS_FONT_WEIGHT_700,
421     SP_CSS_FONT_WEIGHT_800,
422     SP_CSS_FONT_WEIGHT_900,
423     SP_CSS_FONT_WEIGHT_NORMAL,
424     SP_CSS_FONT_WEIGHT_BOLD,
425     SP_CSS_FONT_WEIGHT_LIGHTER,
426     SP_CSS_FONT_WEIGHT_BOLDER
427 };
429 enum SPCSSFontStretch {
430     SP_CSS_FONT_STRETCH_ULTRA_CONDENSED,
431     SP_CSS_FONT_STRETCH_EXTRA_CONDENSED,
432     SP_CSS_FONT_STRETCH_CONDENSED,
433     SP_CSS_FONT_STRETCH_SEMI_CONDENSED,
434     SP_CSS_FONT_STRETCH_NORMAL,
435     SP_CSS_FONT_STRETCH_SEMI_EXPANDED,
436     SP_CSS_FONT_STRETCH_EXPANDED,
437     SP_CSS_FONT_STRETCH_EXTRA_EXPANDED,
438     SP_CSS_FONT_STRETCH_ULTRA_EXPANDED,
439     SP_CSS_FONT_STRETCH_NARROWER,
440     SP_CSS_FONT_STRETCH_WIDER
441 };
443 enum SPCSSTextAlign {
444     SP_CSS_TEXT_ALIGN_START,
445     SP_CSS_TEXT_ALIGN_END,
446     SP_CSS_TEXT_ALIGN_LEFT,
447     SP_CSS_TEXT_ALIGN_RIGHT,
448     SP_CSS_TEXT_ALIGN_CENTER,
449     SP_CSS_TEXT_ALIGN_JUSTIFY
450     // also <string> is allowed, but only within table calls
451 };
453 enum SPCSSTextTransform {
454     SP_CSS_TEXT_TRANSFORM_CAPITALIZE,
455     SP_CSS_TEXT_TRANSFORM_UPPERCASE,
456     SP_CSS_TEXT_TRANSFORM_LOWERCASE,
457     SP_CSS_TEXT_TRANSFORM_NONE
458 };
460 enum SPCSSDirection {
461     SP_CSS_DIRECTION_LTR,
462     SP_CSS_DIRECTION_RTL
463 };
465 enum SPCSSBlockProgression {
466     SP_CSS_BLOCK_PROGRESSION_TB,
467     SP_CSS_BLOCK_PROGRESSION_RL,
468     SP_CSS_BLOCK_PROGRESSION_LR
469 };
471 enum SPCSSWritingMode {
472     SP_CSS_WRITING_MODE_LR_TB,
473     SP_CSS_WRITING_MODE_RL_TB,
474     SP_CSS_WRITING_MODE_TB_RL,
475     SP_CSS_WRITING_MODE_TB_LR
476 };
478 enum SPTextAnchor {
479     SP_CSS_TEXT_ANCHOR_START,
480     SP_CSS_TEXT_ANCHOR_MIDDLE,
481     SP_CSS_TEXT_ANCHOR_END
482 };
484 enum SPVisibility {
485     SP_CSS_VISIBILITY_HIDDEN,
486     SP_CSS_VISIBILITY_COLLAPSE,
487     SP_CSS_VISIBILITY_VISIBLE
488 };
490 enum SPOverflow {
491     SP_CSS_OVERFLOW_VISIBLE,
492     SP_CSS_OVERFLOW_HIDDEN,
493     SP_CSS_OVERFLOW_SCROLL,
494     SP_CSS_OVERFLOW_AUTO
495 };
497 /// \todo more display types
498 enum SPCSSDisplay {
499     SP_CSS_DISPLAY_NONE,
500     SP_CSS_DISPLAY_INLINE,
501     SP_CSS_DISPLAY_BLOCK,
502     SP_CSS_DISPLAY_LIST_ITEM,
503     SP_CSS_DISPLAY_RUN_IN,
504     SP_CSS_DISPLAY_COMPACT,
505     SP_CSS_DISPLAY_MARKER,
506     SP_CSS_DISPLAY_TABLE,
507     SP_CSS_DISPLAY_INLINE_TABLE,
508     SP_CSS_DISPLAY_TABLE_ROW_GROUP,
509     SP_CSS_DISPLAY_TABLE_HEADER_GROUP,
510     SP_CSS_DISPLAY_TABLE_FOOTER_GROUP,
511     SP_CSS_DISPLAY_TABLE_ROW,
512     SP_CSS_DISPLAY_TABLE_COLUMN_GROUP,
513     SP_CSS_DISPLAY_TABLE_COLUMN,
514     SP_CSS_DISPLAY_TABLE_CELL,
515     SP_CSS_DISPLAY_TABLE_CAPTION
516 };
518 enum SPEnableBackground {
519     SP_CSS_BACKGROUND_ACCUMULATE,
520     SP_CSS_BACKGROUND_NEW
521 };
523 /// An SPTextStyle has a refcount, a font family, and a font name.
524 struct SPTextStyle {
525     int refcount;
527     /* CSS font properties */
528     SPIString font_family;
530     /** \todo fixme: The 'font' property is ugly, and not working (lauris) */
531     SPIString font;
532 };
534 SPCSSAttr *sp_css_attr_from_style (SPStyle const *const style, guint flags);
535 SPCSSAttr *sp_css_attr_from_object(SPObject *object, guint flags = SP_STYLE_FLAG_IFSET);
536 SPCSSAttr *sp_css_attr_unset_text(SPCSSAttr *css);
537 SPCSSAttr *sp_css_attr_unset_uris(SPCSSAttr *css);
538 SPCSSAttr *sp_css_attr_scale(SPCSSAttr *css, double ex);
540 void sp_style_unset_property_attrs(SPObject *o);
542 void sp_style_set_property_url (SPObject *item, gchar const *property, SPObject *linked, bool recursive);
544 #endif
547 /*
548   Local Variables:
549   mode:c++
550   c-file-style:"stroustrup"
551   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
552   indent-tabs-mode:nil
553   fill-column:99
554   End:
555 */
556 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :