/builddir/build/BUILD/libcomps-libcomps-0.1.8/libcomps/src/comps_docenv.h File Reference

COMPS_DocEnv header file. More...

#include <stddef.h>
#include <assert.h>
#include "comps_utils.h"
#include "comps_obj.h"
#include "comps_objdict.h"
#include "comps_objlist.h"
#include "comps_docgroupid.h"
#include "comps_validate.h"
#include "comps_radix.h"
#include "comps_log.h"
#include "comps_default.h"

Go to the source code of this file.

Data Structures

struct  COMPS_DocEnv

Functions

 HEAD_COMPS_STRPROP_SETTER (env, COMPS_DocEnv, id) HEAD_COMPS_STRPROP_SETTER(env
name HEAD_COMPS_STRPROP_SETTER (env, COMPS_DocEnv, desc) HEAD_COMPS_NUMPROP_SETTER(env
 HEAD_COMPS_PROP_GETTER (env, COMPS_DocEnv, id) HEAD_COMPS_PROP_GETTER_OBJ(env
id HEAD_COMPS_PROP_GETTER (env, COMPS_DocEnv, name) HEAD_COMPS_PROP_GETTER(env
void comps_docenv_add_groupid (COMPS_DocEnv *env, COMPS_DocGroupId *gid)
void comps_docenv_add_optionid (COMPS_DocEnv *env, COMPS_DocGroupId *gid)
COMPS_DocEnvcomps_docenv_union (COMPS_DocEnv *e1, COMPS_DocEnv *e2)
COMPS_DocEnvcomps_docenv_intersect (COMPS_DocEnv *e1, COMPS_DocEnv *e2)

Detailed Description

COMPS_DocEnv header file.

See also:
COMPS_DocEnv properties setters
COMPS_DocEnv properties getters
COMPS_DocEnv list setters
COMPS_DocEnv list getters

COMPS_DocEnv object support union operation. Read more about Libcomps objects unioning


Function Documentation

void comps_docenv_add_groupid ( COMPS_DocEnv env,
COMPS_DocGroupId gid 
)

add group_id to group_ids list in environment

Parameters:
env COMPS_DocEnv object
gid COMPS_DocGroupId object
Warning:
COMPS_DocGroupId reference counter isn't incremented
void comps_docenv_add_optionid ( COMPS_DocEnv env,
COMPS_DocGroupId gid 
)

add group_id to option list in environment

Parameters:
env COMPS_DocEnv object
gid COMPS_DocGroupId object
Warning:
COMPS_DocGroupId reference counter isn't incremented
COMPS_DocEnv* comps_docenv_intersect ( COMPS_DocEnv e1,
COMPS_DocEnv e2 
)

intersect two environments into one and return new COMPS_DocEnv object

Parameters:
e1 COMPS_DocEnv object
e2 COMPS_DocEnv object
Returns:
new COMPS_DocEnv object
COMPS_DocEnv* comps_docenv_union ( COMPS_DocEnv e1,
COMPS_DocEnv e2 
)

union two environments into one and return new COMPS_DocEnv object

Parameters:
e1 COMPS_DocEnv object
e2 COMPS_DocEnv object
Returns:
new COMPS_DocEnv object
 All Data Structures Files Functions Variables Enumerations Defines

Generated on 1 Mar 2019 for libcomps by  doxygen 1.6.1