src/style.h

   1 #ifndef __SP_STYLE_H__
   2 #define __SP_STYLE_H__
   3
   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  */
  15
  16 #include "color.h"
  17 #include "forward.h"
  18 #include "sp-marker-loc.h"
  19 #include "sp-filter.h"
  20 #include "sp-filter-reference.h"
  21 #include "uri-references.h"
  22 #include "uri.h"
  23 #include "sp-paint-server.h"
  24
  25 #include <sigc++/connection.h>
  26
  27 namespace Inkscape {
  28 namespace XML {
  29 class Node;
  30 }
  31 }
  32
  33 class SPCSSAttr;
  34
  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;
  44
  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 };
  52
  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)
  77
  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)
  80
  81 /// 24 bit data type internal to SPStyle.
  82 struct SPIScale24 {
  83     unsigned set : 1;
  84     unsigned inherit : 1;
  85     unsigned value : 24;
  86 };
  87
  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 };
  95
  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 };
 103
 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 };
 111
 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 };
 119
 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 };
 132
 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 };
 141
 142 #define SP_STYLE_FILL_SERVER(s) (((SPStyle *) (s))->getFillPaintServer())
 143 #define SP_STYLE_STROKE_SERVER(s) (((SPStyle *) (s))->getStrokePaintServer())
 144 #define SP_OBJECT_STYLE_FILL_SERVER(o) (SP_OBJECT (o)->style->getFillPaintServer())
 145 #define SP_OBJECT_STYLE_STROKE_SERVER(o) (SP_OBJECT (o)->style->getStrokePaintServer())
 146
 147 class SVGICCColor;
 148
 149 /// Paint type internal to SPStyle.
 150 struct SPIPaint {
 151     unsigned set : 1;
 152     unsigned inherit : 1;
 153     unsigned currentcolor : 1;
 154     unsigned int colorSet : 1;
 155     unsigned int noneSet : 1;
 156     struct {
 157          SPPaintServerReference *href;
 158          SPColor color;
 159     } value;
 160
 161
 162     bool isSet() const { return true; /* set || colorSet*/}
 163     bool isSameType( SPIPaint const & other ) const {return (isPaintserver() == other.isPaintserver()) && (colorSet == other.colorSet) && (currentcolor == other.currentcolor);}
 164
 165     bool isNoneSet() const {return noneSet;}
 166
 167     bool isNone() const {return !currentcolor && !colorSet && !isPaintserver();} // TODO refine
 168     bool isColor() const {return colorSet && !isPaintserver();}
 169     bool isPaintserver() const {return value.href && value.href->getObject();}
 170
 171     void clear();
 172
 173     void setColor( float r, float g, float b ) {value.color.set( r, g, b ); colorSet = true;}
 174     void setColor( guint32 val ) {value.color.set( val ); colorSet = true;}
 175     void setColor( SPColor const& color ) {value.color = color; colorSet = true;}
 176 };
 177
 178 /// Filter type internal to SPStyle
 179 struct SPIFilter {
 180     unsigned set : 1;
 181     unsigned inherit : 1;
 182     SPFilterReference *href;
 183 };
 184
 185 enum {
 186     SP_FONT_SIZE_LITERAL,
 187     SP_FONT_SIZE_LENGTH,
 188     SP_FONT_SIZE_PERCENTAGE
 189 };
 190
 191 #define SP_FONT_SIZE ((1 << 24) - 1)
 192
 193 #define SP_F8_16_TO_FLOAT(v) ((gdouble) (v) / (1 << 16))
 194 #define SP_F8_16_FROM_FLOAT(v) ((int) ((v) * ((1 << 16) + 0.9999)))
 195
 196 #define SP_STYLE_FLAG_IFSET (1 << 0)
 197 #define SP_STYLE_FLAG_IFDIFF (1 << 1)
 198 #define SP_STYLE_FLAG_ALWAYS (1 << 2)
 199
 200 /// Fontsize type internal to SPStyle.
 201 struct SPIFontSize {
 202     unsigned set : 1;
 203     unsigned inherit : 1;
 204     unsigned type : 2;
 205     unsigned value : 24;
 206     float computed;
 207 };
 208
 209 /// Text decoration type internal to SPStyle.
 210 struct SPITextDecoration {
 211     unsigned set : 1;
 212     unsigned inherit : 1;
 213     unsigned underline : 1;
 214     unsigned overline : 1;
 215     unsigned line_through : 1;
 216     unsigned blink : 1;    // "Conforming user agents are not required to support this value." yay!
 217 };
 218
 219 /// Extended length type internal to SPStyle.
 220 struct SPILengthOrNormal {
 221     unsigned set : 1;
 222     unsigned inherit : 1;
 223     unsigned normal : 1;
 224     unsigned unit : 4;
 225     float value;
 226     float computed;
 227 };
 228
 229 class SPTextStyle;
 230
 231 /// Stroke dash details.
 232 class NRVpathDash {
 233 public:
 234     double offset;
 235     int n_dash;
 236     double *dash;
 237 };
 238
 239 /// An SVG style object.
 240 struct SPStyle {
 241     int refcount;
 242
 243     /** Object we are attached to */
 244     SPObject *object;
 245     /** Document we are associated with */
 246     SPDocument *document;
 247
 248     /** Our text style component */
 249     SPTextStyle *text;
 250     unsigned text_private : 1;
 251
 252     /* CSS2 */
 253     /* Font */
 254     /** Size of the font */
 255     SPIFontSize font_size;
 256     /** Style of the font */
 257     SPIEnum font_style;
 258     /** Which substyle of the font */
 259     SPIEnum font_variant;
 260     /** Weight of the font */
 261     SPIEnum font_weight;
 262     /** Stretch of the font */
 263     SPIEnum font_stretch;
 264
 265     /** First line indent of paragraphs (css2 16.1) */
 266     SPILength text_indent;
 267     /** text alignment (css2 16.2) (not to be confused with text-anchor) */
 268     SPIEnum text_align;
 269     /** text decoration (css2 16.3.1) */
 270     SPITextDecoration text_decoration;
 271     // 16.3.2 is text-shadow. That's complicated.
 272     /** Line spacing (css2 10.8.1) */
 273     SPILengthOrNormal line_height;
 274     /** letter spacing (css2 16.4) */
 275     SPILengthOrNormal letter_spacing;
 276     /** word spacing (also css2 16.4) */
 277     SPILengthOrNormal word_spacing;
 278     /** capitalization (css2 16.5) */
 279     SPIEnum text_transform;
 280
 281     /* CSS3 Text */
 282     /** text direction (css3 text 3.2) */
 283     SPIEnum direction;
 284     /** block progression (css3 text 3.2) */
 285     SPIEnum block_progression;
 286     /** Writing mode (css3 text 3.2 and svg1.1 10.7.2) */
 287     SPIEnum writing_mode;
 288
 289     /* SVG */
 290     /** Anchor of the text (svg1.1 10.9.1) */
 291     SPIEnum text_anchor;
 292
 293     /* Misc attributes */
 294     unsigned clip_set : 1;
 295     unsigned color_set : 1;
 296     unsigned cursor_set : 1;
 297     unsigned overflow_set : 1;
 298     unsigned clip_path_set : 1;
 299     unsigned clip_rule_set : 1;
 300     unsigned mask_set : 1;
 301
 302     /** display */
 303     SPIEnum display;
 304
 305     /** overflow */
 306     SPIEnum overflow;
 307
 308     /** visibility */
 309     SPIEnum visibility;
 310
 311     /** opacity */
 312     SPIScale24 opacity;
 313
 314     /** color */
 315     SPIPaint color;
 316
 317     /** fill */
 318     SPIPaint fill;
 319     /** fill-opacity */
 320     SPIScale24 fill_opacity;
 321     /** fill-rule: 0 nonzero, 1 evenodd */
 322     SPIEnum fill_rule;
 323
 324     /** stroke */
 325     SPIPaint stroke;
 326     /** stroke-width */
 327     SPILength stroke_width;
 328     /** stroke-linecap */
 329     SPIEnum stroke_linecap;
 330     /** stroke-linejoin */
 331     SPIEnum stroke_linejoin;
 332     /** stroke-miterlimit */
 333     SPIFloat stroke_miterlimit;
 334     /** stroke-dash* */
 335     NRVpathDash stroke_dash;
 336     unsigned stroke_dasharray_set : 1;
 337     unsigned stroke_dasharray_inherit : 1;
 338     unsigned stroke_dashoffset_set : 1;
 339     /** stroke-opacity */
 340     SPIScale24 stroke_opacity;
 341
 342     /** Marker list */
 343     SPIString marker[SP_MARKER_LOC_QTY];
 344
 345     /** Filter effect */
 346     SPIFilter filter;
 347
 348     SPIEnum filter_blend_mode;
 349
 350    /** normally not used, but duplicates the Gaussian blur deviation (if any) from the attached
 351         filter when the style is used for querying */
 352     SPILength filter_gaussianBlur_deviation;
 353
 354     /** enable-background, used for defining where filter effects get
 355      * their background image */
 356     SPIEnum enable_background;
 357
 358     /// style belongs to a cloned object
 359     bool cloned;
 360
 361     sigc::connection release_connection;
 362
 363     sigc::connection filter_modified_connection;
 364     sigc::connection fill_ps_modified_connection;
 365     sigc::connection stroke_ps_modified_connection;
 366
 367     SPObject *getFilter() {if (filter.href) return filter.href->getObject(); else return NULL;}
 368     const gchar *getFilterURI() {if (filter.href) return filter.href->getURI()->toString(); else return NULL;}
 369     SPPaintServer *getFillPaintServer() {if (fill.value.href) return fill.value.href->getObject(); else return NULL;}
 370     const gchar *getFillURI() {if (fill.value.href) return fill.value.href->getURI()->toString(); else return NULL;}
 371     SPPaintServer *getStrokePaintServer() {if (stroke.value.href) return stroke.value.href->getObject(); else return NULL;}
 372     const gchar *getStrokeURI() {if (stroke.value.href) return stroke.value.href->getURI()->toString(); else return NULL;}
 373 };
 374
 375 SPStyle *sp_style_new(SPDocument *document);
 376
 377 SPStyle *sp_style_new_from_object(SPObject *object);
 378
 379 SPStyle *sp_style_ref(SPStyle *style);
 380
 381 SPStyle *sp_style_unref(SPStyle *style);
 382
 383 void sp_style_read_from_object(SPStyle *style, SPObject *object);
 384
 385 void sp_style_read_from_prefs(SPStyle *style, Glib::ustring const &path);
 386
 387 void sp_style_merge_from_style_string(SPStyle *style, gchar const *p);
 388
 389 void sp_style_merge_from_parent(SPStyle *style, SPStyle const *parent);
 390
 391 void sp_style_merge_from_dying_parent(SPStyle *style, SPStyle const *parent);
 392
 393 gchar *sp_style_write_string(SPStyle const *style, guint flags = SP_STYLE_FLAG_IFSET);
 394
 395 gchar *sp_style_write_difference(SPStyle const *from, SPStyle const *to);
 396
 397 void sp_style_set_to_uri_string (SPStyle *style, bool isfill, const gchar *uri);
 398
 399 /* SPTextStyle */
 400
 401 enum SPCSSFontSize {
 402     SP_CSS_FONT_SIZE_XX_SMALL,
 403     SP_CSS_FONT_SIZE_X_SMALL,
 404     SP_CSS_FONT_SIZE_SMALL,
 405     SP_CSS_FONT_SIZE_MEDIUM,
 406     SP_CSS_FONT_SIZE_LARGE,
 407     SP_CSS_FONT_SIZE_X_LARGE,
 408     SP_CSS_FONT_SIZE_XX_LARGE,
 409     SP_CSS_FONT_SIZE_SMALLER,
 410     SP_CSS_FONT_SIZE_LARGER
 411 };
 412
 413 enum SPCSSFontStyle {
 414     SP_CSS_FONT_STYLE_NORMAL,
 415     SP_CSS_FONT_STYLE_ITALIC,
 416     SP_CSS_FONT_STYLE_OBLIQUE
 417 };
 418
 419 enum SPCSSFontVariant {
 420     SP_CSS_FONT_VARIANT_NORMAL,
 421     SP_CSS_FONT_VARIANT_SMALL_CAPS
 422 };
 423
 424 enum SPCSSFontWeight {
 425     SP_CSS_FONT_WEIGHT_100,
 426     SP_CSS_FONT_WEIGHT_200,
 427     SP_CSS_FONT_WEIGHT_300,
 428     SP_CSS_FONT_WEIGHT_400,
 429     SP_CSS_FONT_WEIGHT_500,
 430     SP_CSS_FONT_WEIGHT_600,
 431     SP_CSS_FONT_WEIGHT_700,
 432     SP_CSS_FONT_WEIGHT_800,
 433     SP_CSS_FONT_WEIGHT_900,
 434     SP_CSS_FONT_WEIGHT_NORMAL,
 435     SP_CSS_FONT_WEIGHT_BOLD,
 436     SP_CSS_FONT_WEIGHT_LIGHTER,
 437     SP_CSS_FONT_WEIGHT_BOLDER
 438 };
 439
 440 enum SPCSSFontStretch {
 441     SP_CSS_FONT_STRETCH_ULTRA_CONDENSED,
 442     SP_CSS_FONT_STRETCH_EXTRA_CONDENSED,
 443     SP_CSS_FONT_STRETCH_CONDENSED,
 444     SP_CSS_FONT_STRETCH_SEMI_CONDENSED,
 445     SP_CSS_FONT_STRETCH_NORMAL,
 446     SP_CSS_FONT_STRETCH_SEMI_EXPANDED,
 447     SP_CSS_FONT_STRETCH_EXPANDED,
 448     SP_CSS_FONT_STRETCH_EXTRA_EXPANDED,
 449     SP_CSS_FONT_STRETCH_ULTRA_EXPANDED,
 450     SP_CSS_FONT_STRETCH_NARROWER,
 451     SP_CSS_FONT_STRETCH_WIDER
 452 };
 453
 454 enum SPCSSTextAlign {
 455     SP_CSS_TEXT_ALIGN_START,
 456     SP_CSS_TEXT_ALIGN_END,
 457     SP_CSS_TEXT_ALIGN_LEFT,
 458     SP_CSS_TEXT_ALIGN_RIGHT,
 459     SP_CSS_TEXT_ALIGN_CENTER,
 460     SP_CSS_TEXT_ALIGN_JUSTIFY
 461     // also <string> is allowed, but only within table calls
 462 };
 463
 464 enum SPCSSTextTransform {
 465     SP_CSS_TEXT_TRANSFORM_CAPITALIZE,
 466     SP_CSS_TEXT_TRANSFORM_UPPERCASE,
 467     SP_CSS_TEXT_TRANSFORM_LOWERCASE,
 468     SP_CSS_TEXT_TRANSFORM_NONE
 469 };
 470
 471 enum SPCSSDirection {
 472     SP_CSS_DIRECTION_LTR,
 473     SP_CSS_DIRECTION_RTL
 474 };
 475
 476 enum SPCSSBlockProgression {
 477     SP_CSS_BLOCK_PROGRESSION_TB,
 478     SP_CSS_BLOCK_PROGRESSION_RL,
 479     SP_CSS_BLOCK_PROGRESSION_LR
 480 };
 481
 482 enum SPCSSWritingMode {
 483     SP_CSS_WRITING_MODE_LR_TB,
 484     SP_CSS_WRITING_MODE_RL_TB,
 485     SP_CSS_WRITING_MODE_TB_RL,
 486     SP_CSS_WRITING_MODE_TB_LR
 487 };
 488
 489 enum SPTextAnchor {
 490     SP_CSS_TEXT_ANCHOR_START,
 491     SP_CSS_TEXT_ANCHOR_MIDDLE,
 492     SP_CSS_TEXT_ANCHOR_END
 493 };
 494
 495 enum SPVisibility {
 496     SP_CSS_VISIBILITY_HIDDEN,
 497     SP_CSS_VISIBILITY_COLLAPSE,
 498     SP_CSS_VISIBILITY_VISIBLE
 499 };
 500
 501 enum SPOverflow {
 502     SP_CSS_OVERFLOW_VISIBLE,
 503     SP_CSS_OVERFLOW_HIDDEN,
 504     SP_CSS_OVERFLOW_SCROLL,
 505     SP_CSS_OVERFLOW_AUTO
 506 };
 507
 508 /// \todo more display types
 509 enum SPCSSDisplay {
 510     SP_CSS_DISPLAY_NONE,
 511     SP_CSS_DISPLAY_INLINE,
 512     SP_CSS_DISPLAY_BLOCK,
 513     SP_CSS_DISPLAY_LIST_ITEM,
 514     SP_CSS_DISPLAY_RUN_IN,
 515     SP_CSS_DISPLAY_COMPACT,
 516     SP_CSS_DISPLAY_MARKER,
 517     SP_CSS_DISPLAY_TABLE,
 518     SP_CSS_DISPLAY_INLINE_TABLE,
 519     SP_CSS_DISPLAY_TABLE_ROW_GROUP,
 520     SP_CSS_DISPLAY_TABLE_HEADER_GROUP,
 521     SP_CSS_DISPLAY_TABLE_FOOTER_GROUP,
 522     SP_CSS_DISPLAY_TABLE_ROW,
 523     SP_CSS_DISPLAY_TABLE_COLUMN_GROUP,
 524     SP_CSS_DISPLAY_TABLE_COLUMN,
 525     SP_CSS_DISPLAY_TABLE_CELL,
 526     SP_CSS_DISPLAY_TABLE_CAPTION
 527 };
 528
 529 enum SPEnableBackground {
 530     SP_CSS_BACKGROUND_ACCUMULATE,
 531     SP_CSS_BACKGROUND_NEW
 532 };
 533
 534 /// An SPTextStyle has a refcount, a font family, and a font name.
 535 struct SPTextStyle {
 536     int refcount;
 537
 538     /* CSS font properties */
 539     SPIString font_family;
 540
 541     /* Full font name, as font_factory::ConstructFontSpecification would give */
 542     SPIString font_specification;
 543
 544     /** \todo fixme: The 'font' property is ugly, and not working (lauris) */
 545     SPIString font;
 546 };
 547
 548 SPCSSAttr *sp_css_attr_from_style (SPStyle const *const style, guint flags);
 549 SPCSSAttr *sp_css_attr_from_object(SPObject *object, guint flags = SP_STYLE_FLAG_IFSET);
 550 SPCSSAttr *sp_css_attr_unset_text(SPCSSAttr *css);
 551 SPCSSAttr *sp_css_attr_unset_uris(SPCSSAttr *css);
 552 SPCSSAttr *sp_css_attr_scale(SPCSSAttr *css, double ex);
 553
 554 void sp_style_unset_property_attrs(SPObject *o);
 555
 556 void sp_style_set_property_url (SPObject *item, gchar const *property, SPObject *linked, bool recursive);
 557
 558 gchar *attribute_unquote(gchar const *val);
 559 gchar *css2_escape_quote(gchar const *val);
 560
 561 #endif
 562
 563
 564 /*
 565   Local Variables:
 566   mode:c++
 567   c-file-style:"stroustrup"
 568   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 569   indent-tabs-mode:nil
 570   fill-column:99
 571   End:
 572 */
 573 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :