cr-sel-eng.h File Reference

The declaration of the CRSelEng class. More...

#include "cr-utils.h"
#include "cr-stylesheet.h"
#include "cr-cascade.h"
#include "cr-style.h"
#include "cr-prop-list.h"
#include <libxml/tree.h>

Go to the source code of this file.

Data Structures
struct	_CRSelEng
	The Selection engine class. More...
Defines
#define	NEW_PROPERTIES_GETTER   1
Typedefs
typedef _CRSelEngPriv	CRSelEngPriv
typedef gboolean(*	CRPseudoClassSelectorHandler )(CRSelEng *a_this, CRAdditionalSel *a_add_sel, xmlNode *a_node)
Functions
CRSelEng *	cr_sel_eng_new (void)
	Creates a new instance of CRSelEng.
enum CRStatus	cr_sel_eng_register_pseudo_class_sel_handler (CRSelEng *a_this, guchar *a_pseudo_class_sel_name, enum CRPseudoType a_pseudo_class_type, CRPseudoClassSelectorHandler a_handler)
	Adds a new handler entry in the handlers entry table.
enum CRStatus	cr_sel_eng_unregister_pseudo_class_sel_handler (CRSelEng *a_this, guchar *a_pseudo_class_sel_name, enum CRPseudoType a_pseudo_class_type)
enum CRStatus	cr_sel_eng_unregister_all_pseudo_class_sel_handlers (CRSelEng *a_this)
	Unregisters all the pseudo class sel handlers and frees all the associated allocated datastructures.
enum CRStatus	cr_sel_eng_get_pseudo_class_selector_handler (CRSelEng *a_this, guchar *a_pseudo_class_sel_name, enum CRPseudoType a_pseudo_class_type, CRPseudoClassSelectorHandler *a_handler)
enum CRStatus	cr_sel_eng_matches_node (CRSelEng *a_this, CRSimpleSel *a_sel, xmlNode *a_node, gboolean *a_result)
	Evaluates a chained list of simple selectors (known as a css2 selector).
enum CRStatus	cr_sel_eng_get_matched_rulesets (CRSelEng *a_this, CRStyleSheet *a_sheet, xmlNode *a_node, CRStatement ***a_rulesets, gulong *a_len)
	Returns an array of pointers to selectors that matches the xml node given in parameter.
enum CRStatus	cr_sel_eng_get_matched_properties_from_cascade (CRSelEng *a_this, CRCascade *a_cascade, xmlNode *a_node, CRPropList **a_props)
enum CRStatus	cr_sel_eng_get_matched_style (CRSelEng *a_this, CRCascade *a_cascade, xmlNode *a_node, CRStyle *a_parent_style, CRStyle **a_style)
void	cr_sel_eng_destroy (CRSelEng *a_this)
	The destructor of CRSelEng.
Variables
typedefG_BEGIN_DECLS struct _CRSelEng	CRSelEng

---

Detailed Description

The declaration of the CRSelEng class.

The CRSelEng is actually the "Selection Engine" class.

Definition in file cr-sel-eng.h.

---

Define Documentation

#define NEW_PROPERTIES_GETTER   1

Definition at line 26 of file cr-sel-eng.h.

---

Typedef Documentation

typedef gboolean(* CRPseudoClassSelectorHandler)(CRSelEng* a_this, CRAdditionalSel *a_add_sel, xmlNode *a_node)

Definition at line 67 of file cr-sel-eng.h. Referenced by cr_sel_eng_get_pseudo_class_selector_handler(), cr_sel_eng_new(), and cr_sel_eng_register_pseudo_class_sel_handler().

typedef struct _CRSelEngPriv CRSelEngPriv

Definition at line 52 of file cr-sel-eng.h. Referenced by cr_sel_eng_new().

---

Function Documentation

void cr_sel_eng_destroy (  CRSelEng *  a_this  )

The destructor of CRSelEng. Parameters: a_this  the current instance of the selection engine. Definition at line 1758 of file cr-sel-eng.c. References cr_sel_eng_unregister_all_pseudo_class_sel_handlers(), and PRIVATE.

enum CRStatus cr_sel_eng_get_matched_properties_from_cascade (  CRSelEng *  a_this, CRCascade *  a_cascade, xmlNode *  a_node, CRPropList **  a_props )

Definition at line 1587 of file cr-sel-eng.c. References CR_BAD_PARAM_ERROR, cr_cascade_get_sheet(), CR_ERROR, CR_OK, CR_OUTPUT_TOO_SHORT_ERROR, cr_utils_trace_info, CRCascade, CRStatement, CRStatus, CRStyleOrigin, CRStyleSheet, NB_ORIGINS, ORIGIN_UA, _CRStatement::parent_sheet, RULESET_STMT, and _CRStatement::type. Referenced by cr_sel_eng_get_matched_style().

enum CRStatus cr_sel_eng_get_matched_rulesets (  CRSelEng *  a_this, CRStyleSheet *  a_sheet, xmlNode *  a_node, CRStatement ***  a_rulesets, gulong *  a_len )

Returns an array of pointers to selectors that matches the xml node given in parameter. Parameters: a_this  the current instance of the selection engine. a_sheet  the stylesheet that holds the selectors. a_node  the xml node to consider during the walk thru the stylesheet. a_rulesets  out parameter. A pointer to an array of rulesets statement pointers. *a_rulesets is allocated by this function and must be freed by the caller. However, the caller must not alter the rulesets statements pointer because they point to statements that are still in the css stylesheet. a_len  the length of *a_ruleset. Returns: CR_OK upon sucessfull completion, an error code otherwise. Definition at line 1414 of file cr-sel-eng.c. References CR_BAD_PARAM_ERROR, CR_ERROR, CR_OK, CR_OUTPUT_TOO_SHORT_ERROR, cr_utils_trace_info, CRStatement, CRStatus, and CRStyleSheet.

enum CRStatus cr_sel_eng_get_matched_style (  CRSelEng *  a_this, CRCascade *  a_cascade, xmlNode *  a_node, CRStyle *  a_parent_style, CRStyle **  a_style )

Definition at line 1689 of file cr-sel-eng.c. References CR_BAD_PARAM_ERROR, CR_ERROR, CR_OK, cr_prop_list_destroy(), cr_sel_eng_get_matched_properties_from_cascade(), cr_style_new(), cr_style_set_props_to_defaults(), CRCascade, CRPropList, and CRStatus.

enum CRStatus cr_sel_eng_get_pseudo_class_selector_handler (  CRSelEng *  a_this, guchar *  a_pseudo_class_sel_name, enum CRPseudoType  a_pseudo_class_type, CRPseudoClassSelectorHandler *  a_handler )

Definition at line 1339 of file cr-sel-eng.c. References CR_BAD_PARAM_ERROR, CR_OK, CR_PSEUDO_CLASS_SEL_HANDLER_NOT_FOUND_ERROR, CRPseudoClassSelectorHandler, and PRIVATE.

enum CRStatus cr_sel_eng_matches_node (  CRSelEng *  a_this, CRSimpleSel *  a_sel, xmlNode *  a_node, gboolean *  a_result )

Evaluates a chained list of simple selectors (known as a css2 selector). Says wheter if this selector matches the xml node given in parameter or not. Parameters: a_this  the selection engine. a_sel  the simple selector against which the xml node is going to be matched. a_node  the node against which the selector is going to be matched. a_result  out parameter. The result of the match. Is set to TRUE if the selector matches the node, FALSE otherwise. This value is considered if and only if this functions returns CR_OK. Returns: the CR_OK if the selection ran correctly, an error code otherwise. Definition at line 1382 of file cr-sel-eng.c. References CR_BAD_PARAM_ERROR, CR_OK, CRSimpleSel, and PRIVATE.

CRSelEng* cr_sel_eng_new (  void   )

Creates a new instance of CRSelEng. Returns: the newly built instance of CRSelEng of NULL if an error occurs. Definition at line 1200 of file cr-sel-eng.c. References cr_sel_eng_register_pseudo_class_sel_handler(), cr_utils_trace_info, CRPseudoClassSelectorHandler, CRSelEng, CRSelEngPriv, FUNCTION_PSEUDO, IDENT_PSEUDO, and PRIVATE.

enum CRStatus cr_sel_eng_register_pseudo_class_sel_handler (  CRSelEng *  a_this, guchar *  a_name, enum CRPseudoType  a_type, CRPseudoClassSelectorHandler  a_handler )

Adds a new handler entry in the handlers entry table. Parameters: a_this  the current instance of CRSelEng a_pseudo_class_sel_name  the name of the pseudo class selector. a_pseudo_class_type  the type of the pseudo class selector. a_handler  the actual handler or callback to be called during the selector evaluation process. Returns: CR_OK, upon successful completion, an error code otherwise. Definition at line 1240 of file cr-sel-eng.c. References CR_BAD_PARAM_ERROR, CR_OK, CR_OUT_OF_MEMORY_ERROR, CRPseudoClassSelectorHandler, and PRIVATE. Referenced by cr_sel_eng_new().

enum CRStatus cr_sel_eng_unregister_all_pseudo_class_sel_handlers (  CRSelEng *  a_this  )

Unregisters all the pseudo class sel handlers and frees all the associated allocated datastructures. Parameters: a_this  the current instance of CRSelEng . Returns: CR_OK upon succesful completion, an error code otherwise. Definition at line 1312 of file cr-sel-eng.c. References CR_BAD_PARAM_ERROR, CR_OK, and PRIVATE. Referenced by cr_sel_eng_destroy().

enum CRStatus cr_sel_eng_unregister_pseudo_class_sel_handler (  CRSelEng *  a_this, guchar *  a_pseudo_class_sel_name, enum CRPseudoType  a_pseudo_class_type )

Definition at line 1271 of file cr-sel-eng.c. References CR_BAD_PARAM_ERROR, CR_OK, CR_PSEUDO_CLASS_SEL_HANDLER_NOT_FOUND_ERROR, and PRIVATE.

---

Variable Documentation

typedefG_BEGIN_DECLS struct _CRSelEng CRSelEng

Definition at line 51 of file cr-sel-eng.h. Referenced by cr_sel_eng_new().

---