libcomps  ..
comps_docenv.h
Go to the documentation of this file.
1 #ifndef COMPS_DOCENV_H
2 #define COMPS_DOCENV_H
3 
4 #include <stddef.h>
5 #include <assert.h>
6 
7 #include "comps_utils.h"
8 #include "comps_obj.h"
9 #include "comps_objdict.h"
10 #include "comps_objlist.h"
11 #include "comps_docgroupid.h"
12 #include "comps_validate.h"
13 #include "comps_radix.h"
14 #include "comps_log.h"
15 #include "comps_default.h"
16 
18 typedef struct {
20  COMPS_ObjDict *properties;
22  COMPS_ObjDict *name_by_lang;
24  COMPS_ObjDict *desc_by_lang;
30 } COMPS_DocEnv;
31 
32 //HEAD_COMPS_CREATE_u(docenv, COMPS_DocEnv) /*comps_utils.h macro*/
33 //HEAD_COMPS_COPY_u(docenv, COMPS_DocEnv) /*comps_utils.h macro*/
34 //HEAD_COMPS_DESTROY_u(docenv, COMPS_DocEnv) /*comps_utils.h macro*/
35 
58 HEAD_COMPS_STRPROP_SETTER(env, COMPS_DocEnv, id) /*comps_utils.h macro*/
59 
60 
65 HEAD_COMPS_STRPROP_SETTER(env, COMPS_DocEnv, name) /*comps_utils.h macro*/
66 
72 HEAD_COMPS_STRPROP_SETTER(env, COMPS_DocEnv, desc) /*comps_utils.h macro*/
73 
79 HEAD_COMPS_NUMPROP_SETTER(env, COMPS_DocEnv, display_order) /*comps_utils.h macro*/
92 HEAD_COMPS_PROP_GETTER(env, COMPS_DocEnv, id) /*comps_utils.h macro*/
93 HEAD_COMPS_PROP_GETTER_OBJ(env, id) /*comps_utils.h macro*/
94 
100 HEAD_COMPS_PROP_GETTER(env, COMPS_DocEnv, name) /*comps_utils.h macro*/
101 
107 HEAD_COMPS_PROP_GETTER(env, COMPS_DocEnv, desc) /*comps_utils.h macro*/
108 
114 HEAD_COMPS_PROP_GETTER(env, COMPS_DocEnv, display_order) /*comps_utils.h macro*/
127 HEAD_COMPS_DOCOBJ_GETOBJLIST(docenv, COMPS_DocEnv, group_list, group_list)
128 
134 HEAD_COMPS_DOCOBJ_GETOBJLIST(docenv, COMPS_DocEnv, option_list, option_list)
148 HEAD_COMPS_DOCOBJ_SETOBJLIST(docenv, COMPS_DocEnv, group_list, group_list)
149 
156 HEAD_COMPS_DOCOBJ_SETOBJLIST(docenv, COMPS_DocEnv, option_list, option_list)
159 HEAD_COMPS_DOCOBJ_GETARCHES(docenv, COMPS_DocEnv)
160 HEAD_COMPS_DOCOBJ_SETARCHES(docenv, COMPS_DocEnv)
161 
162 char __comps_docenv_idcmp(void *e1, void *e2);
163 
169 void comps_docenv_add_groupid(COMPS_DocEnv *env,
170  COMPS_DocGroupId *gid);
171 
177 void comps_docenv_add_optionid(COMPS_DocEnv *env,
178  COMPS_DocGroupId *gid);
179 
185 COMPS_DocEnv* comps_docenv_union(COMPS_DocEnv *e1, COMPS_DocEnv *e2);
186 
192 COMPS_DocEnv* comps_docenv_intersect(COMPS_DocEnv *e1, COMPS_DocEnv *e2);
193 
194 signed char comps_docenv_xml(COMPS_DocEnv *env, xmlTextWriterPtr writer,
195  COMPS_Log *log, COMPS_XMLOptions *xml_options,
196  COMPS_DefaultsOptions *def_options);
197 COMPS_DocEnv* comps_docenv_arch_filter(COMPS_DocEnv *source,
198  COMPS_ObjList *arches);
199 
200 extern COMPS_ObjectInfo COMPS_DocEnv_ObjInfo;
201 extern COMPS_ValRuleGeneric* COMPS_DocEnv_ValidateRules[];
202 
203 #endif
204 
COMPS_DocEnv * comps_docenv_intersect(COMPS_DocEnv *e1, COMPS_DocEnv *e2)
COMPS_ObjDict * name_by_lang
Definition: comps_docenv.h:22
COMPS_DocGroupId header file.
#define COMPS_Object_HEAD
Definition: comps_obj.h:86
COMPS_Object header file.
COMPS_DocEnv * comps_docenv_union(COMPS_DocEnv *e1, COMPS_DocEnv *e2)
COMPS_ObjDict * desc_by_lang
Definition: comps_docenv.h:24
Definition: comps_objlist.h:41
void comps_docenv_add_groupid(COMPS_DocEnv *env, COMPS_DocGroupId *gid)
COMPS_ObjList * group_list
Definition: comps_docenv.h:26
COMPS_ObjList * option_list
Definition: comps_docenv.h:28
Definition: comps_docenv.h:18
Libcomps dictionary and multi-dictionary. COMPS_ObjDict and COMPS_ObjMDict are both derivates of COMP...
A Documented file. Details.
Definition: comps_obj.h:102
void comps_docenv_add_optionid(COMPS_DocEnv *env, COMPS_DocGroupId *gid)
COMPS_ObjDict * properties
Definition: comps_docenv.h:20
Definition: comps_docgroupid.h:36