cr-term.h File Reference

Declaration of the #CRTem class. More...

#include <stdio.h>
#include <glib.h>
#include "cr-utils.h"
#include "cr-rgb.h"
#include "cr-num.h"

Go to the source code of this file.

Data Structures
struct	_CRTerm
	An abstraction of a css2 term as defined in the CSS2 spec in appendix D.1: term ::= [ NUMBER S* | PERCENTAGE S* | LENGTH S* | EMS S* | EXS S* | ANGLE S* | TIME S* | FREQ S* | function ] | STRING S* | IDENT S* | URI S* | RGB S* | UNICODERANGE S* | hexcolor. More...
Typedefs
typedef _CRTerm	CRTerm
Enumerations
enum	CRTermType {   TERM_NO_TYPE = 0, TERM_NUMBER, TERM_FUNCTION, TERM_STRING,   TERM_IDENT, TERM_URI, TERM_RGB, TERM_UNICODERANGE,   TERM_HASH }
enum	UnaryOperator { NO_UNARY_UOP = 0, PLUS_UOP, MINUS_UOP, EMPTY_UNARY_UOP }
enum	Operator { NO_OP = 0, DIVIDE, COMMA }
Functions
CRTerm *	cr_term_parse_expression_from_buf (const guchar *a_buf, enum CREncoding a_encoding)
	Parses an expresion as defined by the css2 spec and builds the expression as a list of terms.
CRTerm *	cr_term_new (void)
	Instanciate a CRTerm.
enum CRStatus	cr_term_set_number (CRTerm *a_this, CRNum *a_num)
enum CRStatus	cr_term_set_function (CRTerm *a_this, GString *a_func_name, CRTerm *a_func_param)
enum CRStatus	cr_term_set_string (CRTerm *a_this, GString *a_str)
enum CRStatus	cr_term_set_ident (CRTerm *a_this, GString *a_str)
enum CRStatus	cr_term_set_uri (CRTerm *a_this, GString *a_str)
enum CRStatus	cr_term_set_rgb (CRTerm *a_this, CRRgb *a_rgb)
enum CRStatus	cr_term_set_hash (CRTerm *a_this, GString *a_str)
CRTerm *	cr_term_append_term (CRTerm *a_this, CRTerm *a_new_term)
	Appends a new term to the current list of CRTerm.
CRTerm *	cr_term_prepend_term (CRTerm *a_this, CRTerm *a_new_term)
	Prepends a term to the list of terms represented by a_this.
guchar *	cr_term_to_string (CRTerm *a_this)
	Serializes the expression represented by the chained instances of #CRterm.
void	cr_term_dump (CRTerm *a_this, FILE *a_fp)
	Dumps the expression (a list of terms connected by operators) to a file.
int	cr_term_nr_values (CRTerm *a_this)
	Return the number of terms in the expression.
CRTerm *	cr_term_get_from_list (CRTerm *a_this, int itemnr)
	Use an index to get a CRTerm from the expression.
void	cr_term_ref (CRTerm *a_this)
	Increments the reference counter of the current instance of CRTerm.*.
gboolean	cr_term_unref (CRTerm *a_this)
	Decrements the ref count of the current instance of CRTerm.
void	cr_term_destroy (CRTerm *a_term)
	The destructor of the the CRTerm class.

---

Detailed Description

Declaration of the #CRTem class.

Definition in file cr-term.h.

---

Typedef Documentation

typedef struct _CRTerm CRTerm

Definition at line 73 of file cr-term.h. Referenced by cr_declaration_append2(), cr_declaration_new(), cr_declaration_parse_from_buf(), cr_declaration_parse_list_from_buf(), cr_parser_parse_declaration(), cr_parser_parse_expr(), cr_parser_parse_font_face(), cr_parser_parse_page(), cr_parser_parse_ruleset(), cr_parser_parse_term(), cr_rgb_parse_from_buf(), cr_statement_at_font_face_rule_add_decl(), cr_statement_ruleset_append_decl2(), cr_style_set_style_from_decl(), cr_term_append_term(), cr_term_destroy(), cr_term_dump(), cr_term_get_from_list(), cr_term_new(), cr_term_nr_values(), cr_term_parse_expression_from_buf(), cr_term_prepend_term(), cr_term_ref(), cr_term_set_function(), cr_term_set_hash(), cr_term_set_ident(), cr_term_set_number(), cr_term_set_rgb(), cr_term_set_string(), cr_term_set_uri(), cr_term_to_string(), and cr_term_unref().

---

Enumeration Type Documentation

enum CRTermType

Enumeration values: TERM_NO_TYPE  TERM_NUMBER  TERM_FUNCTION  TERM_STRING  TERM_IDENT  TERM_URI  TERM_RGB  TERM_UNICODERANGE  TERM_HASH  Definition at line 43 of file cr-term.h.

enum Operator

Enumeration values: NO_OP  DIVIDE  COMMA  Definition at line 65 of file cr-term.h.

enum UnaryOperator

Enumeration values: NO_UNARY_UOP  PLUS_UOP  MINUS_UOP  EMPTY_UNARY_UOP  Definition at line 57 of file cr-term.h.

---

Function Documentation

CRTerm* cr_term_append_term (  CRTerm *  a_this, CRTerm *  a_new_term )

Appends a new term to the current list of CRTerm. Parameters: a_this  the "this pointer" of the current instance of CRTerm . a_new_term  the term to append. Returns: the list of terms with the a_new_term appended to it. Definition at line 237 of file cr-term.c. References CRTerm, _CRTerm::next, and _CRTerm::prev. Referenced by cr_parser_parse_declaration(), cr_parser_parse_expr(), and cr_parser_parse_term().

void cr_term_destroy (  CRTerm *  a_this  )

The destructor of the the CRTerm class. Parameters: a_this  the "this pointer" of the current instance of CRTerm. Definition at line 584 of file cr-term.c. References CRTerm, and _CRTerm::next. Referenced by cr_declaration_destroy(), cr_declaration_parse_from_buf(), cr_declaration_parse_list_from_buf(), cr_parser_parse_declaration(), cr_parser_parse_expr(), cr_parser_parse_font_face(), cr_parser_parse_page(), cr_parser_parse_term(), cr_rgb_parse_from_buf(), cr_term_parse_expression_from_buf(), and cr_term_unref().

void cr_term_dump (  CRTerm *  a_this, FILE *  a_fp )

Dumps the expression (a list of terms connected by operators) to a file. TODO: finish the dump. The dump of some type of terms have not yet been implemented. Parameters: a_this  the current instance of CRTerm. a_fp  the destination file pointer. Definition at line 488 of file cr-term.c. References cr_term_to_string(), and CRTerm.

CRTerm* cr_term_get_from_list (  CRTerm *  a_this, int  itemnr )

Use an index to get a CRTerm from the expression. Parameters: a_this  the current instance of CRTerm. itemnr  the index into the expression. Returns: CRTerm at position itemnr, if itemnr > number of terms - 1, it will return NULL. Definition at line 528 of file cr-term.c. References CRTerm, and _CRTerm::next.

CRTerm* cr_term_new (  void   )

Instanciate a CRTerm. Returns: the newly build instance of CRTerm. Definition at line 87 of file cr-term.c. References cr_utils_trace_info, and CRTerm. Referenced by cr_parser_parse_term().

int cr_term_nr_values (  CRTerm *  a_this  )

Return the number of terms in the expression. Parameters: a_this  the current instance of CRTerm. Returns: number of terms in the expression. Definition at line 508 of file cr-term.c. References CRTerm, and _CRTerm::next.

CRTerm* cr_term_parse_expression_from_buf (  const guchar *  a_buf, enum CREncoding  a_encoding )

Parses an expresion as defined by the css2 spec and builds the expression as a list of terms. Parameters: a_buf  the buffer to parse. Returns: a pointer to the first term of the expression or NULL if parsing failed. Definition at line 108 of file cr-term.c. References CR_OK, cr_parser_destroy(), cr_parser_new_from_buf(), cr_parser_parse_expr(), cr_parser_try_to_skip_spaces_and_comments(), cr_term_destroy(), CRParser, CRStatus, and CRTerm.

CRTerm* cr_term_prepend_term (  CRTerm *  a_this, CRTerm *  a_new_term )

Prepends a term to the list of terms represented by a_this. Parameters: a_this  the "this pointer" of the current instance of CRTerm . a_new_term  the term to prepend. Returns: the head of the new list. Definition at line 263 of file cr-term.c. References CRTerm, and _CRTerm::prev.

void cr_term_ref (  CRTerm *  a_this  )

Increments the reference counter of the current instance of CRTerm.*. Parameters: a_this  the current instance of CRTerm. Definition at line 547 of file cr-term.c. References CRTerm, and _CRTerm::ref_count. Referenced by cr_declaration_new(), cr_parser_parse_font_face(), cr_parser_parse_page(), and cr_parser_parse_ruleset().

enum CRStatus cr_term_set_function (  CRTerm *  a_this, GString *  a_func_name, CRTerm *  a_func_param )

Definition at line 155 of file cr-term.c. References _CRTerm::content, CR_BAD_PARAM_ERROR, CR_OK, CRTerm, _CRTerm::ext_content, TERM_FUNCTION, and _CRTerm::type. Referenced by cr_parser_parse_term().

enum CRStatus cr_term_set_hash (  CRTerm *  a_this, GString *  a_str )

Definition at line 217 of file cr-term.c. References _CRTerm::content, CR_BAD_PARAM_ERROR, CR_OK, CRTerm, TERM_HASH, and _CRTerm::type. Referenced by cr_parser_parse_term().

enum CRStatus cr_term_set_ident (  CRTerm *  a_this, GString *  a_str )

Definition at line 181 of file cr-term.c. References _CRTerm::content, CR_BAD_PARAM_ERROR, CR_OK, CRTerm, TERM_IDENT, and _CRTerm::type. Referenced by cr_parser_parse_term().

enum CRStatus cr_term_set_number (  CRTerm *  a_this, CRNum *  a_num )

Definition at line 143 of file cr-term.c. References _CRTerm::content, CR_BAD_PARAM_ERROR, CR_OK, CRNum, CRTerm, TERM_NUMBER, and _CRTerm::type. Referenced by cr_parser_parse_term().

enum CRStatus cr_term_set_rgb (  CRTerm *  a_this, CRRgb *  a_rgb )

Definition at line 205 of file cr-term.c. References _CRTerm::content, CR_BAD_PARAM_ERROR, CR_OK, CRTerm, TERM_RGB, and _CRTerm::type. Referenced by cr_parser_parse_term().

enum CRStatus cr_term_set_string (  CRTerm *  a_this, GString *  a_str )

Definition at line 169 of file cr-term.c. References _CRTerm::content, CR_BAD_PARAM_ERROR, CR_OK, CRTerm, TERM_STRING, and _CRTerm::type. Referenced by cr_parser_parse_term().

enum CRStatus cr_term_set_uri (  CRTerm *  a_this, GString *  a_str )

Definition at line 193 of file cr-term.c. References _CRTerm::content, CR_BAD_PARAM_ERROR, CR_OK, CRTerm, TERM_URI, and _CRTerm::type. Referenced by cr_parser_parse_term().

guchar* cr_term_to_string (  CRTerm *  a_this  )

Serializes the expression represented by the chained instances of #CRterm. Parameters: a_this  the current instance of CRTerm Returns: the zero terminated string containing the serialized form of CRTerm. MUST BE FREED BY THE CALLER using g_free(). Definition at line 281 of file cr-term.c. References COMMA, _CRTerm::content, cr_num_to_string(), cr_rgb_to_string(), cr_term_to_string(), CRTerm, DIVIDE, MINUS_UOP, _CRTerm::next, NO_OP, PLUS_UOP, _CRTerm::prev, TERM_FUNCTION, TERM_HASH, TERM_IDENT, TERM_NUMBER, TERM_RGB, TERM_STRING, TERM_UNICODERANGE, TERM_URI, _CRTerm::the_operator, _CRTerm::type, and _CRTerm::unary_op. Referenced by cr_declaration_to_string(), cr_term_dump(), and cr_term_to_string().

gboolean cr_term_unref (  CRTerm *  a_this  )

Decrements the ref count of the current instance of CRTerm. If the ref count reaches zero, the instance is destroyed. Parameters: a_this  the current instance of CRTerm. Returns: TRUE if the current instance has been destroyed, FALSE otherwise. Definition at line 562 of file cr-term.c. References cr_term_destroy(), CRTerm, and _CRTerm::ref_count. Referenced by cr_parser_parse_font_face(), cr_parser_parse_page(), and cr_parser_parse_ruleset().

---