/home/doxygen/libascend/compiler/child.h File Reference

---

Detailed Description

This is a package of routines to process child lists.

Requires include "utilities/ascConfig.h" include "fractions.h" include "compiler.h" include "dimen.h" include "list.h"

#include <utilities/ascConfig.h>
#include <general/list.h>
#include "compiler.h"

Include dependency graph for child.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ChildListEntry
Defines
#define	origin_ERR   0
#define	origin_ALI   1
#define	origin_ARR   2
#define	origin_ISA   3
#define	origin_WB   4
#define	origin_PALI   5
#define	origin_PARR   6
#define	origin_PISA   7
#define	origin_PWB   8
#define	origin_EXT   9
#define	origin_PARAMETER_OFFSET   (origin_PALI - origin_ALI)
#define	CBF_VISIBLE   0x1
#define	CBF_SUPPORTED   0x2
#define	CBF_PASSED   0x4
#define	AliasingOrigin(ori)
#define	ParametricOrigin(ori)   ((ori) >= origin_PALI && (ori) <= origin_PWB)
#define	ChildVisible(cl, n)   ((ChildGetBooleans((cl),(n)) & CBF_VISIBLE)!=0)
#define	ChildSupported(cl, n)   ((ChildGetBooleans((cl),(n)) & CBF_SUPPORTED)!=0)
#define	ChildPassed(cl, n)   ((ChildGetBooleans((cl),(n)) & CBF_PASSED) !=0)
#define	ChildHide(cl, n)   ChildSetBoolean((cl),(n),CBF_VISIBLE,0)
#define	ChildShow(cl, n)   ChildSetBoolean((cl),(n),CBF_VISIBLE,1)
Typedefs
typedef CONST struct ChildListStructure *	ChildListPtr
Functions
int	CmpChildListEntries (CONST struct ChildListEntry *e1, CONST struct ChildListEntry *e2)
ChildListPtr	CreateChildList (struct gl_list_t *l)
void	DestroyChildList (ChildListPtr cl)
ChildListPtr	AppendChildList (ChildListPtr cl, struct gl_list_t *l)
ASC_DLLSPEC unsigned long	ChildListLen (ChildListPtr cl)
ASC_DLLSPEC symchar *	ChildStrPtr (ChildListPtr cl, unsigned long n)
unsigned int	ChildIsArray (ChildListPtr cl, unsigned long n)
unsigned int	ChildOrigin (ChildListPtr cl, unsigned long n)
unsigned int	ChildAliasing (ChildListPtr cl, unsigned long n)
unsigned int	ChildParametric (ChildListPtr cl, unsigned long n)
CONST struct Statement *	ChildStatement (ChildListPtr cl, unsigned long n)
ASC_DLLSPEC unsigned	ChildGetBooleans (ChildListPtr cl, unsigned long n)
ASC_DLLSPEC void	ChildSetBoolean (ChildListPtr cl, unsigned long n, unsigned cbfname, unsigned val)
CONST struct TypeDescription *	ChildBaseTypePtr (ChildListPtr cl, unsigned long n)
ASC_DLLSPEC unsigned long	ChildPos (ChildListPtr cl, symchar *s)
int	CompareChildLists (ChildListPtr cl, ChildListPtr c2, unsigned long *diff)
void	WriteChildList (FILE *fp, ChildListPtr cl)

---

Define Documentation

#define CBF_PASSED   0x4

child is argument to another child. Note that because of arrays, CBF_PASSED is approximate. If a[1] is passed, a gets marked passed, but if a.b is passed, a is not.

#define CBF_SUPPORTED   0x2

child is a '$upported' attribute

#define CBF_VISIBLE   0x1

child to be shown in UI among lists

#define origin_ALI   1

Origin code - ALIASES.

#define origin_ARR   2

Origin code - ARR.

#define origin_ERR   0

Origin code - invalid origin.

#define origin_EXT   9

Origin code - EXT statement

#define origin_ISA   3

Origin code - IS_A.

#define origin_PALI   5

Origin code - P-ALIASES.

#define origin_PARAMETER_OFFSET   (origin_PALI - origin_ALI)

Distance between corresponding origin and the parametric version. If you mess with these origin defines, fix the macro LegalOrigin in child.c

#define origin_PARR   6

Origin code - P-ARR.

#define origin_PISA   7

Origin code - P-IS_A.

#define origin_PWB   8

Origin code - P-WILL_BE.

#define origin_WB   4

Origin code - WILL_BE.

---