cr-prop-list.h File Reference

#include "cr-utils.h"
#include "cr-declaration.h"

Go to the source code of this file.

Data Structures
struct	_CRPropList
Typedefs
typedef _CRPropListPriv	CRPropListPriv
Functions
CRPropList *	cr_prop_list_append (CRPropList *a_this, CRPropList *a_to_append)
	Appends a property list to the current one.
CRPropList *	cr_prop_list_append2 (CRPropList *a_this, GString *a_prop, CRDeclaration *a_decl)
	Appends a pair of prop/declaration to the current prop list.
CRPropList *	cr_prop_list_prepend (CRPropList *a_this, CRPropList *a_to_append)
	Prepends a list to the current list.
CRPropList *	cr_prop_list_prepend2 (CRPropList *a_this, GString *a_prop, CRDeclaration *a_decl)
	Prepends a list to the current list.
enum CRStatus	cr_prop_list_set_prop (CRPropList *a_this, GString *a_prop)
	Sets the property of a CRPropList.
enum CRStatus	cr_prop_list_get_prop (CRPropList *a_this, GString **a_prop)
	Getter of the property associated to the current instance of CRPropList.
enum CRStatus	cr_prop_list_lookup_prop (CRPropList *a_this, GString *a_prop, CRPropList **a_pair)
	Lookup a given property/declaration pair.
CRPropList *	cr_prop_list_get_next (CRPropList *a_this)
	Gets the next prop/decl pair in the list.
CRPropList *	cr_prop_list_get_prev (CRPropList *a_this)
	Gets the previous prop/decl pair in the list.
enum CRStatus	cr_prop_list_set_decl (CRPropList *a_this, CRDeclaration *a_decl)
enum CRStatus	cr_prop_list_get_decl (CRPropList *a_this, CRDeclaration **a_decl)
CRPropList *	cr_prop_list_unlink (CRPropList *a_this, CRPropList *a_pair)
	Unlinks a prop/decl pair from the list.
void	cr_prop_list_destroy (CRPropList *a_this)
Variables
typedefG_BEGIN_DECLS struct _CRPropList	CRPropList

---

Typedef Documentation

typedef struct _CRPropListPriv CRPropListPriv

Definition at line 30 of file cr-prop-list.h.

---

Function Documentation

CRPropList* cr_prop_list_append (  CRPropList *  a_this, CRPropList *  a_to_append )

Appends a property list to the current one. Parameters: a_this  the current instance of CRPropList a_to_append  the property list to append Returns: the resulting prop list, or NULL if an error occured Definition at line 73 of file cr-prop-list.c. References CRPropList, and PRIVATE. Referenced by cr_prop_list_append2().

CRPropList* cr_prop_list_append2 (  CRPropList *  a_this, GString *  a_prop, CRDeclaration *  a_decl )

Appends a pair of prop/declaration to the current prop list. Parameters: a_this  the current instance of CRPropList a_prop  the property to consider a_decl  the declaration to consider Returns: the resulting property list, or NULL in case of an error. Definition at line 102 of file cr-prop-list.c. References cr_prop_list_append(), CRDeclaration, CRPropList, and PRIVATE.

void cr_prop_list_destroy (  CRPropList *  a_this  )

Definition at line 331 of file cr-prop-list.c. References cr_prop_list_get_next(), CRPropList, and PRIVATE. Referenced by cr_sel_eng_get_matched_style().

enum CRStatus cr_prop_list_get_decl (  CRPropList *  a_this, CRDeclaration **  a_decl )

Definition at line 210 of file cr-prop-list.c. References CR_BAD_PARAM_ERROR, CR_OK, CRDeclaration, and PRIVATE.

CRPropList* cr_prop_list_get_next (  CRPropList *  a_this  )

Gets the next prop/decl pair in the list. Parameters: a_this  the current instance of CRPropList the  next prop/decl pair, or NULL if we reached the end of the list. Returns: the next prop/declaration pair of the list, or NULL if we reached end of list (or if an error occurs) Definition at line 267 of file cr-prop-list.c. References PRIVATE. Referenced by cr_prop_list_destroy().

CRPropList* cr_prop_list_get_prev (  CRPropList *  a_this  )

Gets the previous prop/decl pair in the list. Parameters: a_this  the current instance of CRPropList the  previous prop/decl pair, or NULL if we reached the end of the list. Returns: the previous prop/declaration pair of the list, or NULL if we reached end of list (or if an error occurs) Definition at line 283 of file cr-prop-list.c. References PRIVATE.

enum CRStatus cr_prop_list_get_prop (  CRPropList *  a_this, GString **  a_prop )

Getter of the property associated to the current instance of CRPropList. Parameters: a_this  the current instance of CRPropList a_prop  out parameter. The returned property Returns: CR_OK upon successful completion, an error code otherwise. Definition at line 190 of file cr-prop-list.c. References CR_BAD_PARAM_ERROR, CR_OK, and PRIVATE.

enum CRStatus cr_prop_list_lookup_prop (  CRPropList *  a_this, GString *  a_prop, CRPropList **  a_pair )

Lookup a given property/declaration pair. Parameters: a_this  the current instance of CRPropList a_prop  the property to lookup a_prop_list  out parameter. The property/declaration pair found (if and only if the function returned code if CR_OK) Returns: CR_OK if a prop/decl pair has been found, CR_VALUE_NOT_FOUND_ERROR if not, or an error code if something bad happens. Definition at line 230 of file cr-prop-list.c. References CR_BAD_PARAM_ERROR, CR_OK, CR_VALUE_NOT_FOUND_ERROR, CRPropList, and PRIVATE.

CRPropList* cr_prop_list_prepend (  CRPropList *  a_this, CRPropList *  a_to_prepend )

Prepends a list to the current list. Parameters: a_this  the current instance of CRPropList the  new list to prepend. Definition at line 126 of file cr-prop-list.c. References CRPropList, and PRIVATE. Referenced by cr_prop_list_prepend2().

CRPropList* cr_prop_list_prepend2 (  CRPropList *  a_this, GString *  a_prop, CRDeclaration *  a_decl )

Prepends a list to the current list. Parameters: a_this  the current instance of CRPropList the  new list to prepend. Definition at line 149 of file cr-prop-list.c. References cr_prop_list_prepend(), CRDeclaration, CRPropList, and PRIVATE.

enum CRStatus cr_prop_list_set_decl (  CRPropList *  a_this, CRDeclaration *  a_decl )

Definition at line 200 of file cr-prop-list.c. References CR_BAD_PARAM_ERROR, CR_OK, CRDeclaration, and PRIVATE.

enum CRStatus cr_prop_list_set_prop (  CRPropList *  a_this, GString *  a_prop )

Sets the property of a CRPropList. Parameters: a_this  the current instance of CRPropList a_prop  the property to set Definition at line 172 of file cr-prop-list.c. References CR_BAD_PARAM_ERROR, CR_OK, and PRIVATE.

CRPropList* cr_prop_list_unlink (  CRPropList *  a_this, CRPropList *  a_pair )

Unlinks a prop/decl pair from the list. Parameters: a_this  the current list of prop/decl pairs a_pair  the prop/decl pair to unlink. Returns: the new list or NULL in case of an error. Definition at line 297 of file cr-prop-list.c. References CRPropList, and PRIVATE.

---

Variable Documentation

typedefG_BEGIN_DECLS struct _CRPropList CRPropList

Definition at line 29 of file cr-prop-list.h. Referenced by cr_prop_list_append(), cr_prop_list_append2(), cr_prop_list_destroy(), cr_prop_list_lookup_prop(), cr_prop_list_prepend(), cr_prop_list_prepend2(), cr_prop_list_unlink(), and cr_sel_eng_get_matched_style().

---