diff options
author | Owen Taylor <otaylor@redhat.com> | 2000-02-15 07:11:45 +0000 |
---|---|---|
committer | Owen Taylor <otaylor@src.gnome.org> | 2000-02-15 07:11:45 +0000 |
commit | 4f335d6e4a3f5b4e6ddd1cd78f919aa80c990262 (patch) | |
tree | 58a31ae23e609367d0bc27537f87e663a3c7bef2 | |
parent | dacd0541b9430958e43610621e117d1be2f3bdb8 (diff) | |
download | pango-4f335d6e4a3f5b4e6ddd1cd78f919aa80c990262.tar.gz |
Add documentation for attributes.
Tue Feb 15 02:35:56 2000 Owen Taylor <otaylor@redhat.com>
* docs/**: Add documentation for attributes.
* Makefile.am libpango/pango-attributes.[ch]: Finish initial
implementation of attributes APIs.
-rw-r--r-- | ChangeLog | 7 | ||||
-rw-r--r-- | ChangeLog.pre-1-0 | 7 | ||||
-rw-r--r-- | ChangeLog.pre-1-10 | 7 | ||||
-rw-r--r-- | ChangeLog.pre-1-2 | 7 | ||||
-rw-r--r-- | ChangeLog.pre-1-4 | 7 | ||||
-rw-r--r-- | ChangeLog.pre-1-6 | 7 | ||||
-rw-r--r-- | ChangeLog.pre-1-8 | 7 | ||||
-rw-r--r-- | docs/pango-docs.sgml | 2 | ||||
-rw-r--r-- | docs/pango-sections.txt | 41 | ||||
-rw-r--r-- | docs/tmpl/pango-unused.sgml | 8 | ||||
-rw-r--r-- | docs/tmpl/text-attributes.sgml | 362 | ||||
-rw-r--r-- | pango/Makefile.am | 46 | ||||
-rw-r--r-- | pango/pango-attributes.c | 626 | ||||
-rw-r--r-- | pango/pango-attributes.h | 152 |
14 files changed, 1107 insertions, 179 deletions
@@ -1,3 +1,10 @@ +Tue Feb 15 02:35:56 2000 Owen Taylor <otaylor@redhat.com> + + * docs/**: Add documentation for attributes. + + * Makefile.am libpango/pango-attributes.[ch]: Finish initial + implementation of attributes APIs. + Mon Feb 14 22:04:38 2000 Owen Taylor <otaylor@redhat.com> * libpango/pango-attributes.[ch]: Start of attribute lists. diff --git a/ChangeLog.pre-1-0 b/ChangeLog.pre-1-0 index a2d99e85..21363b54 100644 --- a/ChangeLog.pre-1-0 +++ b/ChangeLog.pre-1-0 @@ -1,3 +1,10 @@ +Tue Feb 15 02:35:56 2000 Owen Taylor <otaylor@redhat.com> + + * docs/**: Add documentation for attributes. + + * Makefile.am libpango/pango-attributes.[ch]: Finish initial + implementation of attributes APIs. + Mon Feb 14 22:04:38 2000 Owen Taylor <otaylor@redhat.com> * libpango/pango-attributes.[ch]: Start of attribute lists. diff --git a/ChangeLog.pre-1-10 b/ChangeLog.pre-1-10 index a2d99e85..21363b54 100644 --- a/ChangeLog.pre-1-10 +++ b/ChangeLog.pre-1-10 @@ -1,3 +1,10 @@ +Tue Feb 15 02:35:56 2000 Owen Taylor <otaylor@redhat.com> + + * docs/**: Add documentation for attributes. + + * Makefile.am libpango/pango-attributes.[ch]: Finish initial + implementation of attributes APIs. + Mon Feb 14 22:04:38 2000 Owen Taylor <otaylor@redhat.com> * libpango/pango-attributes.[ch]: Start of attribute lists. diff --git a/ChangeLog.pre-1-2 b/ChangeLog.pre-1-2 index a2d99e85..21363b54 100644 --- a/ChangeLog.pre-1-2 +++ b/ChangeLog.pre-1-2 @@ -1,3 +1,10 @@ +Tue Feb 15 02:35:56 2000 Owen Taylor <otaylor@redhat.com> + + * docs/**: Add documentation for attributes. + + * Makefile.am libpango/pango-attributes.[ch]: Finish initial + implementation of attributes APIs. + Mon Feb 14 22:04:38 2000 Owen Taylor <otaylor@redhat.com> * libpango/pango-attributes.[ch]: Start of attribute lists. diff --git a/ChangeLog.pre-1-4 b/ChangeLog.pre-1-4 index a2d99e85..21363b54 100644 --- a/ChangeLog.pre-1-4 +++ b/ChangeLog.pre-1-4 @@ -1,3 +1,10 @@ +Tue Feb 15 02:35:56 2000 Owen Taylor <otaylor@redhat.com> + + * docs/**: Add documentation for attributes. + + * Makefile.am libpango/pango-attributes.[ch]: Finish initial + implementation of attributes APIs. + Mon Feb 14 22:04:38 2000 Owen Taylor <otaylor@redhat.com> * libpango/pango-attributes.[ch]: Start of attribute lists. diff --git a/ChangeLog.pre-1-6 b/ChangeLog.pre-1-6 index a2d99e85..21363b54 100644 --- a/ChangeLog.pre-1-6 +++ b/ChangeLog.pre-1-6 @@ -1,3 +1,10 @@ +Tue Feb 15 02:35:56 2000 Owen Taylor <otaylor@redhat.com> + + * docs/**: Add documentation for attributes. + + * Makefile.am libpango/pango-attributes.[ch]: Finish initial + implementation of attributes APIs. + Mon Feb 14 22:04:38 2000 Owen Taylor <otaylor@redhat.com> * libpango/pango-attributes.[ch]: Start of attribute lists. diff --git a/ChangeLog.pre-1-8 b/ChangeLog.pre-1-8 index a2d99e85..21363b54 100644 --- a/ChangeLog.pre-1-8 +++ b/ChangeLog.pre-1-8 @@ -1,3 +1,10 @@ +Tue Feb 15 02:35:56 2000 Owen Taylor <otaylor@redhat.com> + + * docs/**: Add documentation for attributes. + + * Makefile.am libpango/pango-attributes.[ch]: Finish initial + implementation of attributes APIs. + Mon Feb 14 22:04:38 2000 Owen Taylor <otaylor@redhat.com> * libpango/pango-attributes.[ch]: Start of attribute lists. diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml index 9e0d724d..a6e75d8c 100644 --- a/docs/pango-docs.sgml +++ b/docs/pango-docs.sgml @@ -2,6 +2,7 @@ <!entity pango-main SYSTEM "sgml/main.sgml"> <!entity pango-glyphs SYSTEM "sgml/glyphs.sgml"> <!entity pango-fonts SYSTEM "sgml/fonts.sgml"> +<!entity pango-text-attributes SYSTEM "sgml/text-attributes.sgml"> <!entity pango-coverage-maps SYSTEM "sgml/coverage-maps.sgml"> <!entity pango-engines SYSTEM "sgml/engines.sgml"> <!entity x-fonts SYSTEM "sgml/x-fonts.sgml"> @@ -17,6 +18,7 @@ &pango-main; &pango-glyphs; &pango-fonts; + &pango-text-attributes; &pango-coverage-maps; &pango-engines; </chapter> diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt index e628cc4f..12540f28 100644 --- a/docs/pango-sections.txt +++ b/docs/pango-sections.txt @@ -95,6 +95,47 @@ pango_font_map_list_fonts </SECTION> <SECTION> +<TITLE>Text Attributes</TITLE> +<FILE>text-attributes</FILE> +PangoAttrType +PangoAttrClass +PangoAttribute +PangoAttrString +PangoAttrColor +PangoAttrInt +pango_attr_type_register +pango_attribute_copy +pango_attribute_compare +pango_attribute_destroy +<SUBSECTION> +pango_attr_lang_new +pango_attr_family_new +pango_attr_style_new +pango_attr_variant_new +pango_attr_stretch_new +pango_attr_weight_new +pango_attr_size_new +pango_attr_foreground_new +pango_attr_background_new +pango_attr_strikethrough_new +pango_attr_underline_new +pango_attr_rise_new +<SUBSECTION> +PangoAttrList +pango_attr_list_new +pango_attr_list_ref +pango_attr_list_unref +pango_attr_list_insert +pango_attr_list_change +pango_attr_list_get_iterator +PangoAttrIterator +pango_attr_iterator_next +pango_attr_iterator_get +pango_attr_iterator_get_font +pango_attr_iterator_destroy +</SECTION> + +<SECTION> <TITLE>Engines</TITLE> <FILE>engines</FILE> PangoEngineInfo diff --git a/docs/tmpl/pango-unused.sgml b/docs/tmpl/pango-unused.sgml index 24361688..c86590dd 100644 --- a/docs/tmpl/pango-unused.sgml +++ b/docs/tmpl/pango-unused.sgml @@ -78,6 +78,14 @@ Functions for rendering and measuring glyphs on the X Window system. +<!-- ##### FUNCTION pango_attribute_register_type ##### --> +<para> + +</para> + +@name: +@Returns: + <!-- ##### FUNCTION g_glyph_string_new ##### --> <para> diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml new file mode 100644 index 00000000..4ab6a762 --- /dev/null +++ b/docs/tmpl/text-attributes.sgml @@ -0,0 +1,362 @@ +<!-- ##### SECTION Title ##### --> +Text Attributes + +<!-- ##### SECTION Short_Description ##### --> +Font and other attributes for annotating text. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Attributed text is used in a number of places in Pango. It +is used as the input to the itemization process and also when +creating a #PangoLayout. The data types and functions in +this section are used to represent and manipulate sets +of attributes applied to a portion of text. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### ENUM PangoAttrType ##### --> +<para> +distinguishes between different types of attributes. Along with the +predefined values, it is possible to allocate additional values +for custom attributes using pango_attr_register_type(). The predefined +values are given below. The type of structure used to store the +attribute is listed in parentheses after the description. +</para> + +@PANGO_ATTR_LANG: language tag (#PangoAttrString) +@PANGO_ATTR_FAMILY: font family name list (#PangoAttrString) +@PANGO_ATTR_STYLE: font slant style (#PangoAttrInt) +@PANGO_ATTR_WEIGHT: font weight (#PangoAttrInt) +@PANGO_ATTR_VARIANT: font variant (normal or small caps) (#PangoAttrInt) +@PANGO_ATTR_STRETCH: font stretch (#PangoAttrInt) +@PANGO_ATTR_SIZE: font size in 1000th's of a point (#PangoAttrInt) +@PANGO_ATTR_FOREGROUND: foreground color (#PangoAttrColor) +@PANGO_ATTR_BACKGROUND: background color (#PangoAttrColor) +@PANGO_ATTR_UNDERLINE: whether the text has an underline (#PangoAttrInt) +@PANGO_ATTR_STRIKETHROUGH: whether the text is struck-through (#PangoAttrInt) +@PANGO_ATTR_RISE: baseline displacement (#PangoAttrInt) + +<!-- ##### STRUCT PangoAttrClass ##### --> +<para> +The #PangoAttrClass structure stores the type and operations for +a particular type of attribute. The functions in this structure should +not be called directly. Instead, one should use the wrapper functions +provided for #PangoAttribute. +</para> + +@type: the type ID for this attribute +@copy: function to duplicate an attribute of this type (see pango_attribute_copy()) +@destroy: function to free an attribute of this type (see pango_attribute_destroy()) +@compare: function to compare two attributes of this type (see pango_attribute_compare()) + +<!-- ##### STRUCT PangoAttribute ##### --> +<para> +The #PangoAttribute structure represents the common portions of all +attributes. Particular types of attributes include this structure +as their initial portion. The common portion of the attribute holds +the range to which the value in the type-specific part of the attribute +applies. +</para> + +@klass: the class structure holding information about the type of the attribute +@start_index: the start index of the range. +@end_index: end index of the range. The character at this index is not + included in the range. + +<!-- ##### STRUCT PangoAttrString ##### --> +<para> +The #PangoAttrString structure is used to represent attributes with +a string value. +</para> + +@attr: the common portion of the attribute +@value: the value of the attribute + +<!-- ##### STRUCT PangoAttrColor ##### --> +<para> +The #PangoAttrString structure is used to represent attributes that +are colors. +</para> + +@attr: the common portion of the attribute +@red: the red value, in the range 0 to 65535 +@green: the green value +@blue: the blue value + +<!-- ##### STRUCT PangoAttrInt ##### --> +<para> +The #PangoAttrString structure is used to represent attributes with +a integer or enumeration value. +</para> + +@attr: the common portion of the attribute +@value: the value of the attribute + +<!-- ##### FUNCTION pango_attr_type_register ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION pango_attribute_copy ##### --> +<para> + +</para> + +@attr: +@Returns: + + +<!-- ##### FUNCTION pango_attribute_compare ##### --> +<para> + +</para> + +@attr1: +@attr2: +@Returns: + + +<!-- ##### FUNCTION pango_attribute_destroy ##### --> +<para> + +</para> + +@attr: + + +<!-- ##### FUNCTION pango_attr_lang_new ##### --> +<para> + +</para> + +@lang: +@Returns: + + +<!-- ##### FUNCTION pango_attr_family_new ##### --> +<para> + +</para> + +@family: +@Returns: + + +<!-- ##### FUNCTION pango_attr_style_new ##### --> +<para> + +</para> + +@style: +@Returns: + + +<!-- ##### FUNCTION pango_attr_variant_new ##### --> +<para> + +</para> + +@variant: +@Returns: + + +<!-- ##### FUNCTION pango_attr_stretch_new ##### --> +<para> + +</para> + +@stretch: +@Returns: + + +<!-- ##### FUNCTION pango_attr_weight_new ##### --> +<para> + +</para> + +@weight: +@Returns: + + +<!-- ##### FUNCTION pango_attr_size_new ##### --> +<para> + +</para> + +@size: +@Returns: + + +<!-- ##### FUNCTION pango_attr_foreground_new ##### --> +<para> + +</para> + +@red: +@green: +@blue: +@Returns: + + +<!-- ##### FUNCTION pango_attr_background_new ##### --> +<para> + +</para> + +@red: +@green: +@blue: +@Returns: + + +<!-- ##### FUNCTION pango_attr_strikethrough_new ##### --> +<para> + +</para> + +@strikethrough: +@Returns: + + +<!-- ##### FUNCTION pango_attr_underline_new ##### --> +<para> + +</para> + +@underline: +@Returns: + + +<!-- ##### FUNCTION pango_attr_rise_new ##### --> +<para> + +</para> + +@rise: +@Returns: + + +<!-- ##### STRUCT PangoAttrList ##### --> +<para> +The #PangoAttrList structure represents a list of attributes +that apply to a section of text. The attributes are, in general, +allowed to overlap in an arbitrary fashion, however, if the +attributes are manipulated only through pango_attr_list_change(), +the overlap between properties will meet stricter criteria. +</para> +<para> +Since the #PangoAttrList structure is stored as a linear list, +it is not suitable for storing attributes for large amounts +of text. In general, you should not use a single #PangoAttrList +for more than one paragraph of text. +</para> + + +<!-- ##### FUNCTION pango_attr_list_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION pango_attr_list_ref ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION pango_attr_list_unref ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION pango_attr_list_insert ##### --> +<para> + +</para> + +@list: +@attr: + + +<!-- ##### FUNCTION pango_attr_list_change ##### --> +<para> + +</para> + +@list: +@attr: + + +<!-- ##### FUNCTION pango_attr_list_get_iterator ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### STRUCT PangoAttrIterator ##### --> +<para> +The #PangoAttrIterator structure is used to represent an +iterator through a #PangoList. A new iterator is created +with pango_attr_list_get_iterator(). Once the iterator +is created, it can be advanced through the style changes +in the text using pango_attr_iterator_next(). At each +style change, the attributes currently in effect can +be queried. +</para> + + +<!-- ##### FUNCTION pango_attr_iterator_next ##### --> +<para> + +</para> + +@iterator: +@Returns: + + +<!-- ##### FUNCTION pango_attr_iterator_get ##### --> +<para> + +</para> + +@iterator: +@type: +@Returns: + + +<!-- ##### FUNCTION pango_attr_iterator_destroy ##### --> +<para> + +</para> + +@iterator: + + +<!-- ##### FUNCTION pango_attr_iterator_get_font ##### --> +<para> + +</para> + +@iterator: +@base: +@current: + + diff --git a/pango/Makefile.am b/pango/Makefile.am index 66fbe13a..b89cfd9e 100644 --- a/pango/Makefile.am +++ b/pango/Makefile.am @@ -5,21 +5,22 @@ INCLUDES=-DSYSCONFDIR=\"$(sysconfdir)\" -DLOCALSTATEDIR=\"$(localstatedir)\" lib_LTLIBRARIES = libpango.la libpangox.la bin_PROGRAMS = pango-querymodules -libpango_la_SOURCES = \ - break.c \ - fonts.c \ - glyphstring.c \ - mapping.c \ - modules.c \ - modules.h \ - pango-context.c \ - pango-coverage.c \ - reorder-items.c \ - shape.c \ - utils.c \ +libpango_la_SOURCES = \ + break.c \ + fonts.c \ + glyphstring.c \ + mapping.c \ + modules.c \ + modules.h \ + pango-attributes.c \ + pango-context.c \ + pango-coverage.c \ + reorder-items.c \ + shape.c \ + utils.c \ utils.h -libpangox_la_SOURCES = \ +libpangox_la_SOURCES = \ pangox.c # We use the -release flag for now until the API settles @@ -29,15 +30,16 @@ libpangox_la_SOURCES = \ libpango_la_LDFLAGS = -release $(VERSION) libpangox_la_LDFLAGS = -release $(VERSION) -include_HEADERS = \ - pango.h \ - pango-context.h \ - pango-coverage.h \ - pango-engine.h \ - pango-font.h \ - pango-glyph.h \ - pango-layout.h \ - pango-types.h \ +include_HEADERS = \ + pango.h \ + pango-attributes.h \ + pango-context.h \ + pango-coverage.h \ + pango-engine.h \ + pango-font.h \ + pango-glyph.h \ + pango-layout.h \ + pango-types.h \ pangox.h pango_querymodules_SOURCES = \ diff --git a/pango/pango-attributes.c b/pango/pango-attributes.c index 665d2f80..35f353db 100644 --- a/pango/pango-attributes.c +++ b/pango/pango-attributes.c @@ -23,7 +23,9 @@ struct _PangoAttrList { + guint ref_count; GSList *attributes; + GSList *attributes_tail; }; struct _PangoAttrIterator @@ -32,16 +34,25 @@ struct _PangoAttrIterator GList *attribute_stack; }; +static PangoAttribute *pango_attr_color_new (const PangoAttrClass *klass, + guint16 red, + guint16 green, + guint16 blue); +static PangoAttribute *pango_attr_string_new (const PangoAttrClass *klass, + const char *str); +static PangoAttribute *pango_attr_int_new (const PangoAttrClass *klass, + int value); + /** - * pango_attribute_register_type: + * pango_attr_type_register: * @name: an identifier for the type. (Currently unused.) * * Allocate a new attribute type ID. * * Return value: the new type ID. **/ -PangoAttributeType -pango_attribute_register_type (const gchar *name) +PangoAttrType +pango_attr_type_register (const gchar *name) { static guint current_type = 0x1000000; @@ -57,9 +68,9 @@ pango_attribute_register_type (const gchar *name) * Return value: a newly allocated #PangoAttribute. **/ PangoAttribute * -pango_attribute_copy (PangoAttribute *attr) +pango_attribute_copy (const PangoAttribute *attr) { - g_return_if_fail (attr != NULL); + g_return_val_if_fail (attr != NULL, NULL); return attr->klass->copy (attr); } @@ -75,7 +86,7 @@ pango_attribute_destroy (PangoAttribute *attr) { g_return_if_fail (attr != NULL); - attr->klass->free (attr); + attr->klass->destroy (attr); } /** @@ -90,11 +101,11 @@ pango_attribute_destroy (PangoAttribute *attr) * Return value: %TRUE if the two attributes have the same value. **/ gboolean -pango_attribute_compare (PangoAttribute *attr1, - PangoAttribute *attr2) +pango_attribute_compare (const PangoAttribute *attr1, + const PangoAttribute *attr2) { - g_return_if_fail (attr1 != NULL); - g_return_if_fail (attr2 != NULL); + g_return_val_if_fail (attr1 != NULL, FALSE); + g_return_val_if_fail (attr2 != NULL, FALSE); if (attr1->klass->type != attr2->klass->type) return FALSE; @@ -102,113 +113,605 @@ pango_attribute_compare (PangoAttribute *attr1, return attr1->klass->compare (attr1, attr2); } -static PangoAttribute -pango_attr_lang_copy (PangoAttribute *attr); +static PangoAttribute * +pango_attr_string_copy (const PangoAttribute *attr) { - return pango_attr_lang_new (((PangoAttrLang *)attr)->lang); + return pango_attr_string_new (attr->klass, ((PangoAttrString *)attr)->value); } -static gboolean -pango_attr_lang_destroy (PangoAttribute *attr); +static void +pango_attr_string_destroy (PangoAttribute *attr) { - g_free (((PangoAttrLang *)attr)->lang); + g_free (((PangoAttrString *)attr)->value); g_free (attr); } static gboolean -pango_attr_lang_compare (const PangoAttribute *attr1, - const PangoAttribute *attr2) +pango_attr_string_compare (const PangoAttribute *attr1, + const PangoAttribute *attr2) +{ + return strcmp (((PangoAttrString *)attr1)->value, ((PangoAttrString *)attr2)->value) == 0; +} + +static PangoAttribute * +pango_attr_string_new (const PangoAttrClass *klass, + const char *str) { - return strcmp (((PangoAttrLang *)attr1)->lang, ((PangoAttrLang *)attr2)->lang) == 0; + PangoAttrString *result = g_new (PangoAttrString, 1); + + result->attr.klass = klass; + result->value = g_strdup (str); + + return (PangoAttribute *)result; } +/** + * pango_attr_lang_new: + * @lang: language tag (in the form "en_US") + * + * Create a new language tag attribute. + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * pango_attr_lang_new (const char *lang) { - static const PangoAttributeClass klass = { - PANGO_ATTR_LANG - pango_attr_lang_copy, - pango_attr_lang_destroy, - pango_attr_lang_compare, + static const PangoAttrClass klass = { + PANGO_ATTR_LANG, + pango_attr_string_copy, + pango_attr_string_destroy, + pango_attr_string_compare + }; + + g_return_val_if_fail (lang != NULL, NULL); + + return pango_attr_string_new (&klass, lang); +} + +/** + * pango_attr_family_new: + * @family: the family or comma separated list of families + * + * Create a new font family attribute. + * + * Return value: the new #PangoAttribute. + **/ +PangoAttribute * +pango_attr_family_new (const char *family) +{ + static const PangoAttrClass klass = { + PANGO_ATTR_FAMILY, + pango_attr_string_copy, + pango_attr_string_destroy, + pango_attr_string_compare }; - PangoAttrLang *result = g_new (PangoAttrLang, 1); - result->lang = g_strdup (lang); + g_return_val_if_fail (family != NULL, NULL); + + return pango_attr_string_new (&klass, family); +} + +static PangoAttribute * +pango_attr_color_copy (const PangoAttribute *attr) +{ + const PangoAttrColor *color_attr = (PangoAttrColor *)attr; + + return pango_attr_color_new (attr->klass, + color_attr->red, color_attr->blue, color_attr->green); +} + +static void +pango_attr_color_destroy (PangoAttribute *attr) +{ + g_free (attr); +} + +static gboolean +pango_attr_color_compare (const PangoAttribute *attr1, + const PangoAttribute *attr2) +{ + const PangoAttrColor *color_attr1 = (const PangoAttrColor *)attr1; + const PangoAttrColor *color_attr2 = (const PangoAttrColor *)attr2; + + return (color_attr1->red == color_attr2->red && + color_attr1->blue == color_attr2->blue && + color_attr1->green == color_attr2->green); +} + +static PangoAttribute * +pango_attr_color_new (const PangoAttrClass *klass, + guint16 red, + guint16 green, + guint16 blue) +{ + PangoAttrColor *result = g_new (PangoAttrColor, 1); + result->attr.klass = klass; + result->red = red; + result->green = green; + result->blue = blue; return (PangoAttribute *)result; } -PangoAttribute *pango_attr_color_new (guint16 red, - guint16 green, - guint16 blue) +/** + * pango_attr_foreground_new: + * @red: the red value (ranging from 0 to 65535) + * @green: the green value + * @blue: the blue value + * + * Create a new foreground color attribute. + * + * Return value: the new #PangoAttribute. + **/ +PangoAttribute * +pango_attr_foreground_new (guint16 red, + guint16 green, + guint16 blue) { + static const PangoAttrClass klass = { + PANGO_ATTR_FOREGROUND, + pango_attr_color_copy, + pango_attr_color_destroy, + pango_attr_color_compare + }; + + return pango_attr_color_new (&klass, red, green, blue); } +/** + * pango_attr_background_new: + * @red: the red value (ranging from 0 to 65535) + * @green: the green value + * @blue: the blue value + * + * Create a new background color attribute. + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * -pango_attr_size_new (double size) +pango_attr_background_new (guint16 red, + guint16 green, + guint16 blue) { + static const PangoAttrClass klass = { + PANGO_ATTR_BACKGROUND, + pango_attr_color_copy, + pango_attr_color_destroy, + pango_attr_color_compare + }; + + return pango_attr_color_new (&klass, red, green, blue); } +static PangoAttribute * +pango_attr_int_copy (const PangoAttribute *attr) +{ + const PangoAttrInt *int_attr = (PangoAttrInt *)attr; + + return pango_attr_int_new (attr->klass, int_attr->value); +} + +static void +pango_attr_int_destroy (PangoAttribute *attr) +{ + g_free (attr); +} + +static gboolean +pango_attr_int_compare (const PangoAttribute *attr1, + const PangoAttribute *attr2) +{ + const PangoAttrInt *int_attr1 = (const PangoAttrInt *)attr1; + const PangoAttrInt *int_attr2 = (const PangoAttrInt *)attr2; + + return (int_attr1->value == int_attr2->value); +} + +static PangoAttribute * +pango_attr_int_new (const PangoAttrClass *klass, + int value) +{ + PangoAttrInt *result = g_new (PangoAttrInt, 1); + result->attr.klass = klass; + result->value = value; + + return (PangoAttribute *)result; +} + +/** + * pango_attr_size_new: + * @size: the font size, in 1000ths of a point. + * + * Create a new font-size attribute. + * + * Return value: the new #PangoAttribute. + **/ +PangoAttribute * +pango_attr_size_new (int size) +{ + static const PangoAttrClass klass = { + PANGO_ATTR_SIZE, + pango_attr_int_copy, + pango_attr_int_destroy, + pango_attr_int_compare + }; + + return pango_attr_int_new (&klass, size); +} + +/** + * pango_attr_style_new: + * @style: the slant style + * + * Create a new font slant style attribute. + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * pango_attr_style_new (PangoStyle style) { + static const PangoAttrClass klass = { + PANGO_ATTR_STYLE, + pango_attr_int_copy, + pango_attr_int_destroy, + pango_attr_int_compare + }; + + return pango_attr_int_new (&klass, (int)style); } +/** + * pango_attr_weight_new: + * @weight: the weight + * + * Create a new font weight attribute. + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * pango_attr_weight_new (PangoWeight weight) { + static const PangoAttrClass klass = { + PANGO_ATTR_WEIGHT, + pango_attr_int_copy, + pango_attr_int_destroy, + pango_attr_int_compare + }; + + return pango_attr_int_new (&klass, (int)weight); } +/** + * pango_attr_variant_new: + * @variant: the variant + * + * Create a new font variant attribute (normal or small caps) + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * pango_attr_variant_new (PangoVariant variant) { + static const PangoAttrClass klass = { + PANGO_ATTR_VARIANT, + pango_attr_int_copy, + pango_attr_int_destroy, + pango_attr_int_compare + }; + + return pango_attr_int_new (&klass, (int)variant); } +/** + * pango_attr_stretch_new: + * @stretch: the stretch + * + * Create a new font stretch attribute + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * pango_attr_stretch_new (PangoStretch stretch) { + static const PangoAttrClass klass = { + PANGO_ATTR_STRETCH, + pango_attr_int_copy, + pango_attr_int_destroy, + pango_attr_int_compare + }; + + return pango_attr_int_new (&klass, (int)stretch); } +/** + * pango_attr_underline_new: + * @underline: %TRUE if the text should be underlined + * + * Create a new underline-style object. + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * pango_attr_underline_new (gboolean underline) { + static const PangoAttrClass klass = { + PANGO_ATTR_UNDERLINE, + pango_attr_int_copy, + pango_attr_int_destroy, + pango_attr_int_compare + }; + + return pango_attr_int_new (&klass, (int)underline); } +/** + * pango_attr_strikethrough_new: + * @strikethrough: %TRUE if the text should be struck-through. + * + * Create a new font strike-through attribute. + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * pango_attr_strikethrough_new (gboolean strikethrough) { + static const PangoAttrClass klass = { + PANGO_ATTR_STRIKETHROUGH, + pango_attr_int_copy, + pango_attr_int_destroy, + pango_attr_int_compare + }; + + return pango_attr_int_new (&klass, (int)strikethrough); } +/** + * pango_attr_rise_new: + * @rise: the amount that the text should be displaced vertically, + * in 10'000ths of an em. Positive values displace the + * text upwards. + * + * Create a new baseline displacement attribute. + * + * Return value: the new #PangoAttribute. + **/ PangoAttribute * pango_attr_rise_new (int rise) { + static const PangoAttrClass klass = { + PANGO_ATTR_RISE, + pango_attr_int_copy, + pango_attr_int_destroy, + pango_attr_int_compare + }; + + return pango_attr_int_new (&klass, (int)rise); } +/** + * pango_attr_list_new: + * + * Create a new empty attribute list with a reference count of 1. + * + * Return value: the newly allocated #PangoAttrList. + **/ PangoAttrList * pango_attr_list_new (void) { + PangoAttrList *list = g_new (PangoAttrList, 1); + + list->ref_count = 1; + list->attributes = NULL; + list->attributes_tail = NULL; + + return list; } -PangoAttrList * +/** + * pango_attr_list_ref: + * @list: a #PangoAttrList + * + * Increase the reference count on the given attribute list by one. + **/ +void pango_attr_list_ref (PangoAttrList *list) { + g_return_if_fail (list != NULL); + + list->ref_count++; } -PangoAttrList * +/** + * pango_attr_list_unref: + * @list: a #PangoAttrList + * + * Decrease the reference count on the given attribute list by one. + * If the result is zero, free the attribute list and the attributes + * it contains. + **/ +void pango_attr_list_unref (PangoAttrList *list) { + GSList *tmp_list; + + g_return_if_fail (list != NULL); + g_return_if_fail (list->ref_count > 0); + + list->ref_count--; + if (list->ref_count == 0) + { + tmp_list = list->attributes; + while (tmp_list) + { + PangoAttribute *attr = tmp_list->data; + tmp_list = tmp_list->next; + + attr->klass->destroy (attr); + } + + g_slist_free (list->attributes); + } } -PangoAttrList * -pango_attr_list_append (PangoAttrList *list, +/** + * pango_attr_list_insert: + * @list: a #PangoAttrList + * @attr: the attribute to insert. Ownership of this value is + * assumed by the list. + * + * Insert the given attribute into the #PangoAttrList. It will + * be inserted after all other attributes with a matching + * @start_index. + **/ +void +pango_attr_list_insert (PangoAttrList *list, PangoAttribute *attr) { + GSList *tmp_list, *prev, *link; + gint start_index = attr->start_index; + + g_return_if_fail (list != NULL); + + if (!list->attributes) + { + list->attributes = g_slist_prepend (NULL, attr); + list->attributes_tail = list->attributes; + } + else if (((PangoAttribute *)list->attributes_tail->data)->start_index <= start_index) + { + g_slist_append (list->attributes_tail, attr); + } + else + { + prev = NULL; + tmp_list = list->attributes; + while (1) + { + PangoAttribute *tmp_attr = tmp_list->data; + + if (tmp_attr->start_index > start_index) + { + link = g_slist_alloc (); + link->next = tmp_list; + link->data = attr; + + if (prev) + prev->next = link; + else + list->attributes = link; + + if (!tmp_list) + list->attributes_tail = link; + } + + prev = tmp_list; + tmp_list = tmp_list->next; + } + } } -PangoAttrList * +/** + * pango_attr_list_change: + * @list: a #PangoAttrList + * @attr: the attribute to insert. Ownership of this value is + * assumed by the list. + * + * Insert the given attribute into the #PangoAttrList. It will + * replace any attributes of the same type on that segment + * and be merged with any adjoining attributes that are identical. + * + * This function is slower than pango_attr_list_insert() for + * creating a attribute list in order (potentially much slower + * for large lists). However, pango_attr_list_insert() is not + * suitable for continually changing a set of attributes + * since it never removes or combines existing attributes. + **/ +void pango_attr_list_change (PangoAttrList *list, - PangoAttribute *attr) + PangoAttribute *attr) { + GSList *tmp_list, *prev, *link; + gint start_index = attr->start_index; + gint end_index = attr->end_index; + + g_return_if_fail (list != NULL); + + tmp_list = list->attributes; + prev = NULL; + while (tmp_list) + { + PangoAttribute *tmp_attr; + + if (!tmp_list || + ((PangoAttribute *)tmp_list->data)->start_index > start_index) + { + /* We need to insert a new attribute + */ + link = g_slist_alloc (); + link->next = tmp_list; + link->data = attr; + + if (prev) + prev->next = link; + else + list->attributes = link; + + if (!tmp_list) + list->attributes_tail = link; + + prev = link; + } + + tmp_attr = tmp_list->data; + + if (tmp_attr->end_index >= start_index && + pango_attribute_compare (tmp_attr, attr)) + { + /* We can merge the new attribute with this attribute + */ + end_index = MAX (end_index, tmp_attr->end_index); + tmp_attr->end_index = end_index; + pango_attribute_destroy (attr); + + attr = tmp_attr; + + prev = tmp_list; + tmp_list = tmp_list->next; + + break; + } + + prev = tmp_list; + tmp_list = tmp_list->next; + } + + /* We now have the range inserted into the list one way or the + * other. Fix up the remainder + */ + while (tmp_list) + { + PangoAttribute *tmp_attr = tmp_list->data; + + if (tmp_attr->start_index > end_index) + break; + else if (pango_attribute_compare (tmp_attr, attr)) + { + /* We can merge the new attribute with this attribute + */ + attr->end_index = MAX (end_index, tmp_attr->end_index); + + pango_attribute_destroy (tmp_attr); + prev->next = tmp_list->next; + + g_slist_free_1 (tmp_list); + tmp_list = prev->next; + } + else + { + prev = tmp_list; + tmp_list = tmp_list->next; + } + } } /** @@ -225,7 +728,7 @@ pango_attr_list_get_iterator (PangoAttrList *list) { PangoAttrIterator *result; - g_return_if_fail (list != NULL); + g_return_val_if_fail (list != NULL, NULL); result = g_new (PangoAttrIterator, 1); result->next_attribute = list->attributes; @@ -237,6 +740,8 @@ pango_attr_list_get_iterator (PangoAttrList *list) result->attribute_stack = g_list_prepend (result->attribute_stack, result->next_attribute->data); result->next_attribute = result->next_attribute->next; } + + return result; } /** @@ -254,9 +759,12 @@ pango_attr_iterator_next (PangoAttrIterator *iterator) int next_index = G_MAXINT; GList *tmp_list; - g_return_if_fail (iterator != NULL); + g_return_val_if_fail (iterator != NULL, -1); - tmp_list = result->attribute_stack; + if (!iterator->next_attribute && !iterator->attribute_stack) + return -1; + + tmp_list = iterator->attribute_stack; while (tmp_list) { PangoAttribute *attr = tmp_list->data; @@ -264,21 +772,21 @@ pango_attr_iterator_next (PangoAttrIterator *iterator) next_index = attr->end_index; } - tmp_list = result->attribute_stack; + tmp_list = iterator->attribute_stack; - if (result->next_attribute) + if (iterator->next_attribute) { - int next_start = ((PangoAttribute *)result->next_attribute->data)->start_index; + int next_start = ((PangoAttribute *)iterator->next_attribute->data)->start_index; if (next_start <= next_index) { do { - result->attribute_stack = g_list_prepend (result->attribute_stack, result->next_attribute->data); - result->next_attribute = result->next_attribute->next; + iterator->attribute_stack = g_list_prepend (iterator->attribute_stack, iterator->next_attribute->data); + iterator->next_attribute = iterator->next_attribute->next; } - while (result->next_attribute && - ((PangoAttribute *)result->next_attribute->data)->start_index == next_start); + while (iterator->next_attribute && + ((PangoAttribute *)iterator->next_attribute->data)->start_index == next_start); } if (next_start < next_index) @@ -291,7 +799,7 @@ pango_attr_iterator_next (PangoAttrIterator *iterator) if (((PangoAttribute *)tmp_list->data)->start_index == next_index) { - result->attribute_stack = g_list_remove_link (result->attribute_stack, tmp_list); + iterator->attribute_stack = g_list_remove_link (iterator->attribute_stack, tmp_list); g_list_free_1 (tmp_list); } @@ -322,7 +830,9 @@ pango_attr_iterator_destroy (PangoAttrIterator *iterator) * @type: the type of attribute to find. * * Find the current attribute of a particular type at the iterator - * location. + * location. When multiple attributes of the same type overlap, + * the attribute whose range starts closest to the current location + * is used. * * Return value: the current attribute of the given type, or %NULL * if no attribute of that type applies to the current @@ -332,8 +842,11 @@ PangoAttribute * pango_attr_iterator_get (PangoAttrIterator *iterator, PangoAttrType type) { - GList *tmp_list = iterator->attribute_stack; + GList *tmp_list; + g_return_val_if_fail (iterator != NULL, NULL); + + tmp_list = iterator->attribute_stack; while (tmp_list) { PangoAttribute *attr = tmp_list->data; @@ -362,23 +875,26 @@ pango_attr_iterator_get_font (PangoAttrIterator *iterator, PangoFontDescription *base, PangoFontDescription *current) { - *current = *base; PangoAttribute *attr; + g_return_if_fail (iterator != NULL); + + *current = *base; + if ((attr = pango_attr_iterator_get (iterator, PANGO_ATTR_FAMILY))) - current->family = ((PangoAttrFamily *)attr)->family; + current->family_name = ((PangoAttrString *)attr)->value; if ((attr = pango_attr_iterator_get (iterator, PANGO_ATTR_STYLE))) - current->style = ((PangoAttrStyle *)attr)->style; + current->style = ((PangoAttrInt *)attr)->value; if ((attr = pango_attr_iterator_get (iterator, PANGO_ATTR_VARIANT))) - current->variant = ((PangoAttrVariant *)attr)->variant; + current->variant = ((PangoAttrInt *)attr)->value; if ((attr = pango_attr_iterator_get (iterator, PANGO_ATTR_WEIGHT))) - current->weight = ((PangoAttrWeight *)attr)->weight; + current->weight = ((PangoAttrInt *)attr)->value; if ((attr = pango_attr_iterator_get (iterator, PANGO_ATTR_STRETCH))) - current->stretch = ((PangoAttrStretch *)attr)->stretch; + current->stretch = ((PangoAttrInt *)attr)->value; } diff --git a/pango/pango-attributes.h b/pango/pango-attributes.h index 795a820b..322c5c75 100644 --- a/pango/pango-attributes.h +++ b/pango/pango-attributes.h @@ -28,134 +28,82 @@ extern "C" { #endif /* __cplusplus */ -typedef struct _PangoAttribute PangoAttribute; -typedef struct _PangoAttrClass PangoAttrClass; - -typedef struct _PangoAttrLang PangoAttrLang; -typedef struct _PangoAttrStyle PangoAttrStyle; -typedef struct _PangoAttrWeight PangoAttrWeight; -typedef struct _PangoAttrVariant PangoAttrVariant; -typedef struct _PangoAttrStretch PangoAttrStretch; -typedef struct _PangoAttrSize PangoAttrSize; -typedef struct _PangoAttrColor PangoAttrColor; -typedef struct _PangoAttrUnderline PangoAttrUnderline; -typedef struct _PangoAttrStrikethrough PangoAttrStrikethrough; -typedef struct _PangoAttrRise PangoAttrRise; - -typedef struct _PangoAttrList PangoAttribute; -typedef struct _PangoAttrIterator PangoAttrClass; - -typedef guint PangoAttributeType; +typedef struct _PangoAttribute PangoAttribute; +typedef struct _PangoAttrClass PangoAttrClass; + +typedef struct _PangoAttrString PangoAttrString; +typedef struct _PangoAttrInt PangoAttrInt; +typedef struct _PangoAttrColor PangoAttrColor; + +typedef struct _PangoAttrList PangoAttrList; +typedef struct _PangoAttrIterator PangoAttrIterator; typedef enum { - PANGO_ATTR_LANG, - PANGO_ATTR_FAMILY, - PANGO_ATTR_STYLE, - PANGO_ATTR_WEIGHT, - PANGO_ATTR_VARIANT, - PANGO_ATTR_STRETCH, - PANGO_ATTR_SIZE, - PANGO_ATTR_FOREGROUND, - PANGO_ATTR_BACKGROUND, - PANGO_ATTR_UNDERLINE, - PANGO_ATTR_STRIKETHROUGH, - PANGO_ATTR_RISE + PANGO_ATTR_LANG, /* PangoAttrString */ + PANGO_ATTR_FAMILY, /* PangoAttrString */ + PANGO_ATTR_STYLE, /* PangoAttrInt */ + PANGO_ATTR_WEIGHT, /* PangoAttrInt */ + PANGO_ATTR_VARIANT, /* PangoAttrInt */ + PANGO_ATTR_STRETCH, /* PangoAttrInt */ + PANGO_ATTR_SIZE, /* PangoAttrSize */ + PANGO_ATTR_FOREGROUND, /* PangoAttrColor */ + PANGO_ATTR_BACKGROUND, /* PangoAttrColor */ + PANGO_ATTR_UNDERLINE, /* PangoAttrInt */ + PANGO_ATTR_STRIKETHROUGH, /* PangoAttrInt */ + PANGO_ATTR_RISE /* PangoAttrInt */ } PangoAttrType; struct _PangoAttribute { - PangoAttrClass *klass; + const PangoAttrClass *klass; guint start_index; guint end_index; }; struct _PangoAttrClass { - PangoAttributeType type; + PangoAttrType type; PangoAttribute * (*copy) (const PangoAttribute *attr); void (*destroy) (PangoAttribute *attr); gboolean (*compare) (const PangoAttribute *attr1, const PangoAttribute *attr2); }; -struct _PangoAttrLang -{ - PangoAttribute attr; - char *lang; -}; - -struct _PangoAttrFamily -{ - PangoAttribute attr; - char *family_list; -}; - -struct _PangoAttrStyle -{ - PangoAttribute attr; - PangoStyle style; -}; - -struct _PangoAttrWeight -{ - PangoAttribute attr; - PangoWeight weight; -}; - -struct _PangoAttrVariant -{ - PangoAttribute attr; - PangoVariant variant; -}; - -struct _PangoAttrStretch +struct _PangoAttrString { PangoAttribute attr; - PangoStretch stretch; + char *value; }; -struct _PangoAttrSize +struct _PangoAttrInt { PangoAttribute attr; - double size; + int value; }; struct _PangoAttrColor { PangoAttribute attr; - guint16 r; - guint16 g; - guint16 b; -}; - -struct _PangoAttrUnderline -{ - PangoAttribute attr; - gboolean underline; + guint16 red; + guint16 green; + guint16 blue; }; -struct _PangoAttrStrikethrough -{ - PangoAttribute attr; - gboolean strikethrough; -}; +PangoAttrType pango_attr_type_register (const gchar *name); -struct _PangoAttrRise -{ - PangoAttribute attr; - int rise; -}; - -PangoAttributeType pango_attribute_register_type (const gchar *name); -PangoAttribute * pango_attribute_copy (const PangoAttribute *attr); -PangoAttribute * pango_attribute_destroy (PangoAttribute *attr); -gboolean pango_attribute_compare (const PangoAttribute *attr1, - const PangoAttribute *attr2); +PangoAttribute * pango_attribute_copy (const PangoAttribute *attr); +void pango_attribute_destroy (PangoAttribute *attr); +gboolean pango_attribute_compare (const PangoAttribute *attr1, + const PangoAttribute *attr2); PangoAttribute *pango_attr_lang_new (const char *lang); -PangoAttribute *pango_attr_color_new (guint16 red, +PangoAttribute *pango_attr_family_new (const char *family); +PangoAttribute *pango_attr_foreground_new (guint16 red, + guint16 green, + guint16 blue); +PangoAttribute *pango_attr_background_new (guint16 red, guint16 green, guint16 blue); -PangoAttribute *pango_attr_size_new (double size); +PangoAttribute *pango_attr_size_new (int size); PangoAttribute *pango_attr_style_new (PangoStyle style); PangoAttribute *pango_attr_weight_new (PangoWeight weight); PangoAttribute *pango_attr_variant_new (PangoVariant variant); @@ -164,20 +112,20 @@ PangoAttribute *pango_attr_underline_new (gboolean underline); PangoAttribute *pango_attr_strikethrough_new (gboolean strikethrough); PangoAttribute *pango_attr_rise_new (int rise); -PangoAttrList * pango_attr_list_new (void); -PangoAttrList * pango_attr_list_ref (PangoAttrList *list); -PangoAttrList * pango_attr_list_unref (PangoAttrList *list); -PangoAttrList * pango_attr_list_append (PangoAttrList *list, - PangoAttribute *attr); -PangoAttrList * pango_attr_list_change (PangoAttrList *list, - PangoAttribute *attr); -PangoAttrIterator *pango_attr_list_get_iterator (PangoAttrList *list); +PangoAttrList * pango_attr_list_new (void); +void pango_attr_list_ref (PangoAttrList *list); +void pango_attr_list_unref (PangoAttrList *list); +void pango_attr_list_insert (PangoAttrList *list, + PangoAttribute *attr); +void pango_attr_list_change (PangoAttrList *list, + PangoAttribute *attr); +PangoAttrIterator * pango_attr_list_get_iterator (PangoAttrList *list); int pango_attr_iterator_next (PangoAttrIterator *iterator); void pango_attr_iterator_destroy (PangoAttrIterator *iterator); PangoAttribute *pango_attr_iterator_get (PangoAttrIterator *iterator, PangoAttrType type); -void *pango_attr_iterator_get_font (PangoAttrIterator *iterator, +void pango_attr_iterator_get_font (PangoAttrIterator *iterator, PangoFontDescription *base, PangoFontDescription *current); |