cr-doc-handler: Libcroco Reference Manual

## cr-doc-handler cr-doc-handler |

## Functions

CRDocHandler * | cr_doc_handler_new ()
enum CRStatus | cr_doc_handler_set_result ()
enum CRStatus | cr_doc_handler_get_result ()
enum CRStatus | cr_doc_handler_set_ctxt ()
enum CRStatus | cr_doc_handler_get_ctxt ()
enum CRStatus | cr_doc_handler_set_default_sac_handler ()
void | cr_doc_handler_associate_a_parser ()
void | cr_doc_handler_ref ()
gboolean | cr_doc_handler_unref ()
void | cr_doc_handler_destroy ()

## Types and Values

struct | CRDocHandler
| CRDocHandlerPriv

## Description

## Functions

### cr_doc_handler_new ()

    CRDocHandler *
    cr_doc_handler_new (void);

Returns the newly built instance of CRDocHandler

### cr_doc_handler_set_result ()

    enum CRStatus
    cr_doc_handler_set_result (CRDocHandler *a_this,
                               gpointer a_result);

Sets the private parsing context. This is used by libcroco only.

Returns CR_OK upon successfull completion, an error code otherwise.

#### Parameters

a_this | the current instance of CRDocHandler |
a_result | the new result. |

### cr_doc_handler_get_result ()

    enum CRStatus
    cr_doc_handler_get_result (CRDocHandler const *a_this,
                               gpointer *a_result);

Gets the private parsing result. The private parsing result is used by libcroco only.

Returns CR_OK upon successfull completion, an error code otherwise.

#### Parameters

a_this | the current instance of CRDocHandler |
a_result | out parameter. The returned result. |

### cr_doc_handler_set_ctxt ()

    enum CRStatus
    cr_doc_handler_set_ctxt (CRDocHandler *a_this,
                             gpointer a_ctxt);

Sets the private parsing context. This is used by libcroco only. Returns CR_OK upon successfull completion, an error code otherwise.

#### Parameters

a_this | the current instance of CRDocHandler |
a_ctxt | a pointer to the parsing context. |

### cr_doc_handler_get_ctxt ()

    enum CRStatus
    cr_doc_handler_get_ctxt (CRDocHandler const *a_this,
                             gpointer *a_ctxt);

Gets the private parsing context associated to the document handler The private parsing context is used by libcroco only.

Returns CR_OK upon successfull completion, an error code otherwise.

#### Parameters

a_this | the current instance of CRDocHandler. |
a_ctxt | out parameter. The new parsing context. |

### cr_doc_handler_set_default_sac_handler ()

    enum CRStatus
    cr_doc_handler_set_default_sac_handler
                                   (CRDocHandler *a_this);

Sets the sac handlers contained in the current instance of DocHandler to the default handlers. For the time being the default handlers are test handlers. This is expected to change in a near future, when the libcroco gets a bit debugged.

Returns CR_OK upon successfull completion, an error code otherwise.

#### Parameters

a_this | a pointer to the current instance of CRDocHandler. |

### cr_doc_handler_associate_a_parser ()

    void
    cr_doc_handler_associate_a_parser (CRDocHandler *a_this,
                                       gpointer a_parser);

`a_this` : the current instance of document handler. `a_parser` : the parser to associate.

### cr_doc_handler_ref ()

    void
    cr_doc_handler_ref (CRDocHandler *a_this);

#### Parameters

a_this | the current instance of CRDocHandler. |

### cr_doc_handler_unref ()

    gboolean
    cr_doc_handler_unref (CRDocHandler *a_this);

Decreases the ref count of the current instance of CRDocHandler. If the ref count reaches '0' then, destroys the instance.

Returns TRUE if the instance as been destroyed, FALSE otherwise.

#### Parameters

a_this | the currrent instance of CRDocHandler. |

### cr_doc_handler_destroy ()

    void
    cr_doc_handler_destroy (CRDocHandler *a_this);

The destructor of the CRDocHandler class.

#### Parameters

a_this | the instance of CRDocHandler to destroy. |

## Types and Values

### struct CRDocHandler

    struct CRDocHandler {
    	CRDocHandlerPriv *priv ;

    	/**
    	 *This pointer is to be used by the application for
    	 *it custom needs. It is there to extend the doc handler.
    	 */
    	gpointer app_data ;

    	/**
    	 *Is called at the beginning of the parsing of the document.
    	 *@param a_this a pointer to the current instance of
    	 *#CRDocHandler.
    	 */
    	void (*start_document) (CRDocHandler *a_this) ;

    	/**
    	 *Is called to notify the end of the parsing of the document.
    	 *@param a_this a pointer to the current instance of
    	 *#CRDocHandler.
    	 */
    	void (*end_document) (CRDocHandler *a_this) ;

    	/**
    	 *Is called to notify an at charset rule.
    	 *@param a_this the document handler.
    	 *@param a_charset the declared charset.
    	 */
    	void (*charset) (CRDocHandler *a_this,
    			 CRString *a_charset,
    			 CRParsingLocation *a_charset_sym_location) ;

    	/**
    	 *Is called to notify an import statement in
    	 *the stylesheet.
    	 *@param a_this the current instance of #CRDocHandler.
    	 *@param a_media_list a doubly linked list of GString objects.
    	 *Each GString object contains a string which is the
    	 *destination media for style information.
    	 *@param a_uri the uri of the imported style sheet.
    	 *@param a_uri_default_ns the default namespace of URI
    	 *@param a_location the parsing location of the '\@import'
    	 *keyword.
    	 *of the imported style sheet.
    	 */
    	void (*import_style) (CRDocHandler *a_this,
    			      GList *a_media_list,
    			      CRString *a_uri,
    			      CRString *a_uri_default_ns,
    			      CRParsingLocation *a_location) ;

    	void (*import_style_result) (CRDocHandler *a_this,
    				     GList *a_media_list,
    				     CRString *a_uri,
    				     CRString *a_uri_default_ns,
    				     CRStyleSheet *a_sheet) ;

    	/**
    	 *Is called to notify a namespace declaration.
    	 *Not used yet.
    	 *@param a_this the current instance of #CRDocHandler.
    	 *@param a_prefix the prefix of the namespace.
    	 *@param a_uri the uri of the namespace.
    	 *@param a_location the location of the "@namespace" keyword.
    	 */
    	void (*namespace_declaration) (CRDocHandler *a_this,
    				       CRString *a_prefix,
    				       CRString *a_uri,
    				       CRParsingLocation *a_location) ;

    	/**
    	 *Is called to notify a comment.
    	 *@param a_this a pointer to the current instance
    	 *of #CRDocHandler.
    	 *@param a_comment the comment.
    	 */
    	void (*comment) (CRDocHandler *a_this,
    			 CRString *a_comment) ;

    	/**
    	 *Is called to notify the beginning of a rule
    	 *statement.
    	 *@param a_this the current instance of #CRDocHandler.
    	 *@param a_selector_list the list of selectors that precedes
    	 *the rule declarations.
    	 */
    	void (*start_selector) (CRDocHandler * a_this,
    				CRSelector *a_selector_list) ;

    	/**
    	 *Is called to notify the end of a rule statement.
    	 *@param a_this the current instance of #CRDocHandler.
    	 *@param a_selector_list the list of selectors that precedes
    	 *the rule declarations. This pointer is the same as
    	 *the one passed to start_selector() ;
    	 */
    	void (*end_selector) (CRDocHandler *a_this,
    			      CRSelector *a_selector_list) ;

    	/**
    	 *Is called to notify a declaration.
    	 *@param a_this a pointer to the current instance
    	 *of #CRDocHandler.
    	 *@param a_name the name of the parsed property.
    	 *@param a_expression a css expression that represents
    	 *the value of the property. A css expression is
    	 *actually a linked list of 'terms'. Each term can
    	 *be linked to other using operators.
    	 *
    	 */
    	void (*property) (CRDocHandler *a_this,
    			  CRString *a_name,
    			  CRTerm *a_expression,
    			  gboolean a_is_important) ;
    	/**
    	 *Is called to notify the start of a font face statement.
    	 *The parser invokes this method at the beginning of every
    	 *font face statement in the style sheet. There will
    	 *be a corresponding end_font_face () event for every
    	 *start_font_face () event.
    	 *
    	 *@param a_this a pointer to the current instance of
    	 *#CRDocHandler.
    	 *@param a_location the parsing location of the "\@font-face"
    	 *keyword.
    	 */
    	void (*start_font_face) (CRDocHandler *a_this,
    				 CRParsingLocation *a_location) ;

    	/**
    	 *Is called to notify the end of a font face statement.
    	 *@param a_this a pointer to the current instance of
    	 *#CRDocHandler.
    	 */
    	void (*end_font_face) (CRDocHandler *a_this) ;

    	/**
    	 *Is called to notify the beginning of a media statement.
    	 *The parser will invoke this method at the beginning of
    	 *every media statement in the style sheet. There will be
    	 *a corresponding end_media() event for every start_media()
    	 *event.
    	 *@param a_this a pointer to the current instance of
    	 *#CRDocHandler.
    	 *@param a_media_list a double linked list of
    	 #CRString * objects.
    	 *Each CRString objects is actually a destination media for
    	 *the style information.
    	 */
    	void (*start_media) (CRDocHandler *a_this,
    			     GList *a_media_list,
    			     CRParsingLocation *a_location) ;

    	/**
    	 *Is called to notify the end of a media statement.
    	 *@param a_this a pointer to the current instance
    	 *of #CRDocHandler.
    	 *@param a_media_list a double linked list of GString * objects.
    	 *Each GString objects is actually a destination media for
    	 *the style information.
    	 */
    	void (*end_media) (CRDocHandler *a_this,
    			   GList *a_media_list) ;

    	/**
    	 *Is called to notify the beginning of a page statement.
    	 *The parser invokes this function at the beginning of
    	 *every page statement in the style sheet. There will be
    	 *a corresponding end_page() event for every single
    	 *start_page() event.
    	 *@param a_this a pointer to the current instance of
    	 *#CRDocHandler.
    	 *@param a_name the name of the page (if any, null otherwise).
    	 *@param a_pseudo_page the pseudo page (if any, null otherwise).
    	 *@param a_location the parsing location of the "\@page" keyword.
    	 */
    	void (*start_page) (CRDocHandler *a_this,
    			    CRString *a_name,
    			    CRString *a_pseudo_page,
    			    CRParsingLocation *a_location) ;

    	/**
    	 *Is called to notify the end of a page statement.
    	 *@param a_this a pointer to the current instance of
    	 *#CRDocHandler.
    	 *@param a_name the name of the page (if any, null otherwise).
    	 *@param a_pseudo_page the pseudo page (if any, null otherwise).
    	 */
    	void (*end_page) (CRDocHandler *a_this,
    			  CRString *a_name,
    			  CRString *pseudo_page) ;

    	/**
    	 *Is Called to notify an unknown at-rule not supported
    	 *by this parser.
    	 */
    	void (*ignorable_at_rule) (CRDocHandler *a_this,
    				   CRString *a_name) ;

    	/**
    	 *Is called to notify a parsing error. After this error
    	 *the application must ignore the rule being parsed, if
    	 *any. After completion of this callback,
    	 *the parser will then try to resume the parsing,
    	 *ignoring the current error.
    	 */
    	void (*error) (CRDocHandler *a_this) ;

    	/**
    	 *Is called to notify an unrecoverable parsing error.
    	 *This is the place to put emergency routines that free allocated
    	 *resources.
    	 */
    	void (*unrecoverable_error) (CRDocHandler *a_this) ;

    	gboolean resolve_import ;
    	gulong ref_count ;
    };

### CRDocHandlerPriv

    typedef struct _CRDocHandlerPriv CRDocHandlerPriv;