cr-style.c File Reference

The definition of the CRStyle class. More...

#include <string.h>
#include "cr-style.h"

Go to the source code of this file.

Data Structures
struct	_CRPropertyDesc
struct	CRBorderStylePropEnumDumpInfo
struct	CRNumPropEnumDumpInfo
struct	CRPropDisplayValPair
struct	CRPropPositionValPair
struct	CRRgbPropEnumDumpInfo
Typedefs
typedef _CRPropertyDesc	CRPropertyDesc
Enumerations
enum	CRPropertyID {   PROP_ID_NOT_KNOWN = 0, PROP_ID_PADDING_TOP, PROP_ID_PADDING_RIGHT, PROP_ID_PADDING_BOTTOM,   PROP_ID_PADDING_LEFT, PROP_ID_PADDING, PROP_ID_BORDER_TOP_WIDTH, PROP_ID_BORDER_RIGHT_WIDTH,   PROP_ID_BORDER_BOTTOM_WIDTH, PROP_ID_BORDER_LEFT_WIDTH, PROP_ID_BORDER_TOP_STYLE, PROP_ID_BORDER_RIGHT_STYLE,   PROP_ID_BORDER_BOTTOM_STYLE, PROP_ID_BORDER_LEFT_STYLE, PROP_ID_BORDER_TOP_COLOR, PROP_ID_BORDER_RIGHT_COLOR,   PROP_ID_BORDER_BOTTOM_COLOR, PROP_ID_BORDER_LEFT_COLOR, PROP_ID_BORDER_TOP, PROP_ID_BORDER_RIGHT,   PROP_ID_BORDER_BOTTOM, PROP_ID_BORDER_LEFT, PROP_ID_BORDER, PROP_ID_MARGIN_TOP,   PROP_ID_MARGIN_RIGHT, PROP_ID_MARGIN_BOTTOM, PROP_ID_MARGIN_LEFT, PROP_ID_MARGIN,   PROP_ID_DISPLAY, PROP_ID_POSITION, PROP_ID_TOP, PROP_ID_RIGHT,   PROP_ID_BOTTOM, PROP_ID_LEFT, PROP_ID_FLOAT, PROP_ID_WIDTH,   PROP_ID_COLOR, PROP_ID_BACKGROUND_COLOR, PROP_ID_FONT_FAMILY, PROP_ID_FONT_SIZE,   PROP_ID_FONT_STYLE, PROP_ID_FONT_WEIGHT, NB_PROP_IDS }
	A property ID. More...
enum	CRDirection {   DIR_TOP = 0, DIR_RIGHT, DIR_BOTTOM, DIR_LEFT,   NB_DIRS }
Functions
CRStyle *	cr_style_new (void)
	Default constructor of CRStyle.
enum CRStatus	cr_style_set_props_to_defaults (CRStyle *a_this)
	Sets the style properties to their default values according to the css2 spec.
enum CRStatus	cr_style_set_style_from_decl (CRStyle *a_this, CRDeclaration *a_decl)
	Walks through a css2 property declaration, and populated the according field(s) in the CRStyle structure.
enum CRStatus	cr_style_ref (CRStyle *a_this)
	Increases the reference count of the current instance of CRStyle.
gboolean	cr_style_unref (CRStyle *a_this)
	Decreases the reference count of the current instance of CRStyle.
CRStyle *	cr_style_dup (CRStyle *a_this)
	Duplicates the current instance of CRStyle .
enum CRStatus	cr_style_copy (CRStyle *a_dest, CRStyle *a_src)
	Copies a style data structure into another.
enum CRStatus	cr_style_num_prop_val_to_string (CRNumPropVal *a_prop_val, GString *a_str, guint a_nb_indent)
	dump a CRNumpPropVal in a string.
enum CRStatus	cr_style_rgb_prop_val_to_string (CRRgbPropVal *a_prop_val, GString *a_str, guint a_nb_indent)
enum CRStatus	cr_style_border_style_to_string (enum CRBorderStyle a_prop, GString *a_str, guint a_nb_indent)
enum CRStatus	cr_style_display_type_to_string (enum CRDisplayType a_code, GString *a_str, guint a_nb_indent)
enum CRStatus	cr_style_position_type_to_string (enum CRPositionType a_code, GString *a_str, guint a_nb_indent)
enum CRStatus	cr_style_float_type_to_string (enum CRFloatType a_code, GString *a_str, guint a_nb_indent)
enum CRStatus	cr_style_to_string (CRStyle *a_this, GString **a_str, guint a_nb_indent)
	Serializes in instance of CRStyle into a string.
void	cr_style_destroy (CRStyle *a_this)
	Destructor of the CRStyle class.

---

Detailed Description

The definition of the CRStyle class.

Definition in file cr-style.c.

---

Typedef Documentation

typedef struct _CRPropertyDesc CRPropertyDesc

Definition at line 91 of file cr-style.c.

---

Enumeration Type Documentation

enum CRDirection

Enumeration values: DIR_TOP  DIR_RIGHT  DIR_BOTTOM  DIR_LEFT  NB_DIRS  Definition at line 216 of file cr-style.c.

enum CRPropertyID

A property ID. Each supported css property has an ID which is an entry into a property "population" jump table. each entry of the property population jump table contains code to tranform the literal form of a property value into a strongly typed value. Enumeration values: PROP_ID_NOT_KNOWN  PROP_ID_PADDING_TOP  PROP_ID_PADDING_RIGHT  PROP_ID_PADDING_BOTTOM  PROP_ID_PADDING_LEFT  PROP_ID_PADDING  PROP_ID_BORDER_TOP_WIDTH  PROP_ID_BORDER_RIGHT_WIDTH  PROP_ID_BORDER_BOTTOM_WIDTH  PROP_ID_BORDER_LEFT_WIDTH  PROP_ID_BORDER_TOP_STYLE  PROP_ID_BORDER_RIGHT_STYLE  PROP_ID_BORDER_BOTTOM_STYLE  PROP_ID_BORDER_LEFT_STYLE  PROP_ID_BORDER_TOP_COLOR  PROP_ID_BORDER_RIGHT_COLOR  PROP_ID_BORDER_BOTTOM_COLOR  PROP_ID_BORDER_LEFT_COLOR  PROP_ID_BORDER_TOP  PROP_ID_BORDER_RIGHT  PROP_ID_BORDER_BOTTOM  PROP_ID_BORDER_LEFT  PROP_ID_BORDER  PROP_ID_MARGIN_TOP  PROP_ID_MARGIN_RIGHT  PROP_ID_MARGIN_BOTTOM  PROP_ID_MARGIN_LEFT  PROP_ID_MARGIN  PROP_ID_DISPLAY  PROP_ID_POSITION  PROP_ID_TOP  PROP_ID_RIGHT  PROP_ID_BOTTOM  PROP_ID_LEFT  PROP_ID_FLOAT  PROP_ID_WIDTH  PROP_ID_COLOR  PROP_ID_BACKGROUND_COLOR  PROP_ID_FONT_FAMILY  PROP_ID_FONT_SIZE  PROP_ID_FONT_STYLE  PROP_ID_FONT_WEIGHT  NB_PROP_IDS  Definition at line 44 of file cr-style.c. Referenced by cr_style_set_style_from_decl().

---

Function Documentation

enum CRStatus cr_style_border_style_to_string (  enum CRBorderStyle  a_prop, GString *  a_str, guint  a_nb_indent )

Definition at line 2092 of file cr-style.c. References BORDER_STYLE_DASHED, BORDER_STYLE_DOTTED, BORDER_STYLE_DOUBLE, BORDER_STYLE_GROOVE, BORDER_STYLE_HIDDEN, BORDER_STYLE_INSET, BORDER_STYLE_NONE, BORDER_STYLE_OUTSET, BORDER_STYLE_RIDGE, BORDER_STYLE_SOLID, CR_BAD_PARAM_ERROR, CR_OK, and cr_utils_dump_n_chars2(). Referenced by cr_style_to_string().

enum CRStatus cr_style_copy (  CRStyle *  a_dest, CRStyle *  a_src )

Copies a style data structure into another. TODO: this is actually broken because it's based on memcpy although some data stuctures of CRStyle should be properly duplicated. Parameters: a_dest  the destination style datastructure a_src  the source style datastructure. Returns: CR_OK upon succesfull completion, an error code otherwise Definition at line 1978 of file cr-style.c. References CR_BAD_PARAM_ERROR, CR_OK, and CRStyle. Referenced by cr_style_dup().

void cr_style_destroy (  CRStyle *  a_this  )

Destructor of the CRStyle class. Parameters: a_this  the instance to destroy. Definition at line 2449 of file cr-style.c. Referenced by cr_style_unref().

enum CRStatus cr_style_display_type_to_string (  enum CRDisplayType  a_code, GString *  a_str, guint  a_nb_indent )

Definition at line 2140 of file cr-style.c. References CR_BAD_PARAM_ERROR, CR_OK, cr_utils_dump_n_chars2(), DISPLAY_BLOCK, DISPLAY_COMPACT, DISPLAY_INHERIT, DISPLAY_INLINE, DISPLAY_INLINE_TABLE, DISPLAY_LIST_ITEM, DISPLAY_MARKER, DISPLAY_NONE, DISPLAY_RUN_IN, DISPLAY_TABLE, DISPLAY_TABLE_CAPTION, DISPLAY_TABLE_CELL, DISPLAY_TABLE_COLUMN, DISPLAY_TABLE_COLUMN_GROUP, DISPLAY_TABLE_FOOTER_GROUP, DISPLAY_TABLE_HEADER_GROUP, DISPLAY_TABLE_ROW, and DISPLAY_TABLE_ROW_GROUP. Referenced by cr_style_to_string().

CRStyle* cr_style_dup (  CRStyle *  a_this  )

Duplicates the current instance of CRStyle . The newly created instance of CRStyle must be freed using cr_style_destroy (). Parameters: a_this  the current instance of CRStyle. Returns: the newly duplicated instance of CRStyle. Definition at line 1953 of file cr-style.c. References cr_style_copy(), cr_style_new(), cr_utils_trace_info, and CRStyle.

enum CRStatus cr_style_float_type_to_string (  enum CRFloatType  a_code, GString *  a_str, guint  a_nb_indent )

Definition at line 2245 of file cr-style.c. References CR_BAD_PARAM_ERROR, CR_OK, FLOAT_INHERIT, FLOAT_LEFT, FLOAT_NONE, and FLOAT_RIGHT. Referenced by cr_style_to_string().

CRStyle* cr_style_new (  void   )

Default constructor of CRStyle. Definition at line 1584 of file cr-style.c. References cr_style_set_props_to_defaults(), cr_utils_trace_info, and CRStyle. Referenced by cr_sel_eng_get_matched_style(), and cr_style_dup().

enum CRStatus cr_style_num_prop_val_to_string (  CRNumPropVal *  a_prop_val, GString *  a_str, guint  a_nb_indent )

dump a CRNumpPropVal in a string. Parameters: a_prop_val  the numerical property value to dump a_str  the string to dump the numerical propertie into. Note that the string value is appended to a_str. a_nb_indent  the number white chars of indentation. Definition at line 1994 of file cr-style.c. References CR_BAD_PARAM_ERROR, CR_ERROR, cr_num_to_string(), CR_OK, cr_utils_dump_n_chars2(), CRNumPropVal, CRStatus, _CRNumPropVal::cv, and _CRNumPropVal::sv. Referenced by cr_style_to_string().

enum CRStatus cr_style_position_type_to_string (  enum CRPositionType  a_code, GString *  a_str, guint  a_nb_indent )

Definition at line 2213 of file cr-style.c. References CR_BAD_PARAM_ERROR, CR_OK, cr_utils_dump_n_chars2(), POSITION_ABSOLUTE, POSITION_FIXED, POSITION_INHERIT, POSITION_RELATIVE, and POSITION_STATIC. Referenced by cr_style_to_string().

enum CRStatus cr_style_ref (  CRStyle *  a_this  )

Increases the reference count of the current instance of CRStyle. Parameters: a_this  the current instance of CRStyle. Returns: CR_OK upon successfull completion, an error code otherwise. Definition at line 1912 of file cr-style.c. References CR_BAD_PARAM_ERROR, and CR_OK.

enum CRStatus cr_style_rgb_prop_val_to_string (  CRRgbPropVal *  a_prop_val, GString *  a_str, guint  a_nb_indent )

Definition at line 2038 of file cr-style.c. References _CRRgbPropVal::av, CR_BAD_PARAM_ERROR, CR_ERROR, CR_OK, cr_rgb_to_string(), cr_utils_dump_n_chars2(), CRRgbPropVal, CRStatus, _CRRgbPropVal::cv, and _CRRgbPropVal::sv. Referenced by cr_style_to_string().

enum CRStatus cr_style_set_props_to_defaults (  CRStyle *  a_this  )

Sets the style properties to their default values according to the css2 spec. Parameters: a_this  the current instance of CRStyle. Returns: CR_OK upon successfull completion, an error code otherwise. Definition at line 1609 of file cr-style.c. References BORDER_STYLE_NONE, CR_BAD_PARAM_ERROR, cr_num_set(), CR_OK, cr_rgb_set(), cr_utils_trace_info, DISPLAY_BLOCK, FLOAT_NONE, FONT_STRETCH_NORMAL, FONT_STYLE_NORMAL, FONT_VARIANT_NORMAL, FONT_WEIGHT_NORMAL, NB_BORDER_STYLE_PROPS, NB_NUM_PROPS, NB_RGB_PROPS, NUM_AUTO, NUM_LENGTH_PX, NUM_PROP_BORDER_BOTTOM, NUM_PROP_BORDER_LEFT, NUM_PROP_BORDER_RIGHT, NUM_PROP_BORDER_TOP, NUM_PROP_BOTTOM, NUM_PROP_LEFT, NUM_PROP_MARGIN_BOTTOM, NUM_PROP_MARGIN_LEFT, NUM_PROP_MARGIN_RIGHT, NUM_PROP_MARGIN_TOP, NUM_PROP_PADDING_BOTTOM, NUM_PROP_PADDING_LEFT, NUM_PROP_PADDING_RIGHT, NUM_PROP_PADDING_TOP, NUM_PROP_RIGHT, NUM_PROP_TOP, NUM_PROP_WIDTH, POSITION_STATIC, RGB_PROP_BACKGROUND_COLOR, and RGB_PROP_COLOR. Referenced by cr_sel_eng_get_matched_style(), and cr_style_new().

enum CRStatus cr_style_set_style_from_decl (  CRStyle *  a_this, CRDeclaration *  a_decl )

Walks through a css2 property declaration, and populated the according field(s) in the CRStyle structure. If the properties or their value(s) are/is not known, sets the corresponding field(s) of CRStyle to its/their default value(s) Parameters: a_this  the instance of CRStyle to set. a_decl  the declaration from which the CRStyle fields are set. Returns: CR_OK upon successfull completion, an error code otherwise. Definition at line 1693 of file cr-style.c. References CR_BAD_PARAM_ERROR, CR_OK, CR_UNKNOWN_TYPE_ERROR, CRDeclaration, CRPropertyID, CRStatus, CRTerm, DIR_BOTTOM, DIR_LEFT, DIR_RIGHT, DIR_TOP, PROP_ID_BACKGROUND_COLOR, PROP_ID_BORDER, PROP_ID_BORDER_BOTTOM, PROP_ID_BORDER_BOTTOM_COLOR, PROP_ID_BORDER_BOTTOM_STYLE, PROP_ID_BORDER_BOTTOM_WIDTH, PROP_ID_BORDER_LEFT, PROP_ID_BORDER_LEFT_COLOR, PROP_ID_BORDER_LEFT_STYLE, PROP_ID_BORDER_LEFT_WIDTH, PROP_ID_BORDER_RIGHT, PROP_ID_BORDER_RIGHT_COLOR, PROP_ID_BORDER_RIGHT_STYLE, PROP_ID_BORDER_RIGHT_WIDTH, PROP_ID_BORDER_TOP, PROP_ID_BORDER_TOP_COLOR, PROP_ID_BORDER_TOP_STYLE, PROP_ID_BORDER_TOP_WIDTH, PROP_ID_BOTTOM, PROP_ID_COLOR, PROP_ID_DISPLAY, PROP_ID_FLOAT, PROP_ID_FONT_FAMILY, PROP_ID_FONT_SIZE, PROP_ID_FONT_STYLE, PROP_ID_FONT_WEIGHT, PROP_ID_LEFT, PROP_ID_MARGIN, PROP_ID_MARGIN_BOTTOM, PROP_ID_MARGIN_LEFT, PROP_ID_MARGIN_RIGHT, PROP_ID_MARGIN_TOP, PROP_ID_NOT_KNOWN, PROP_ID_PADDING, PROP_ID_PADDING_BOTTOM, PROP_ID_PADDING_LEFT, PROP_ID_PADDING_RIGHT, PROP_ID_PADDING_TOP, PROP_ID_POSITION, PROP_ID_RIGHT, PROP_ID_TOP, PROP_ID_WIDTH, and _CRDeclaration::property.

enum CRStatus cr_style_to_string (  CRStyle *  a_this, GString **  a_str, guint  a_nb_indent )

Serializes in instance of CRStyle into a string. Parameters: a_this  the instance of CRStyle to serialize a_str  the string to serialise the style into. if *a_str is NULL, a new GString is instanciated, otherwise the style serialisation is appended to the existed *a_str the  number of white space char to use for indentation. Returns: CR_OK upon successful completion, an error code otherwise. Definition at line 2283 of file cr-style.c. References BORDER_STYLE_PROP_TOP, CR_BAD_PARAM_ERROR, cr_font_family_to_string(), cr_font_size_adjust_to_string(), cr_font_size_to_string(), cr_font_stretch_to_string(), cr_font_style_to_string(), cr_font_variant_to_string(), cr_font_weight_to_string(), CR_OK, cr_style_border_style_to_string(), cr_style_display_type_to_string(), cr_style_float_type_to_string(), cr_style_num_prop_val_to_string(), cr_style_position_type_to_string(), cr_style_rgb_prop_val_to_string(), cr_utils_dump_n_chars2(), NB_BORDER_STYLE_PROPS, NB_NUM_PROPS, NB_RGB_PROPS, NUM_PROP_TOP, and RGB_PROP_BORDER_TOP_COLOR.

gboolean cr_style_unref (  CRStyle *  a_this  )

Decreases the reference count of the current instance of CRStyle. If the reference count reaches 0, the instance of CRStyle is destoyed. Parameters: a_this  the current instance of CRStyle. Returns: TRUE if the instance has been destroyed, FALSE otherwise. Definition at line 1930 of file cr-style.c. References cr_style_destroy().

---