/home/doxygen/libascend/compiler/childinfo.h

Go to the documentation of this file.

/*
 *  Atom Child Description List
 *  by Tom Epperly
 *  Version: $Revision: 1.10 $
 *  Version control file: $RCSfile: childinfo.h,v $
 *  Date last modified: $Date: 1998/02/05 16:35:41 $
 *  Last modified by: $Author: ballan $
 *
 *  This file is part of the Ascend Language Interpreter.
 *
 *  Copyright (C) 1990, 1993, 1994 Thomas Guthrie Epperly
 *
 *  The Ascend Language Interpreter is free software; you can redistribute
 *  it and/or modify it under the terms of the GNU General Public License as
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version.
 *
 *  The Ascend Language Interpreter is distributed in hope that it will be
 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with the program; if not, write to the Free Software Foundation,
 *  Inc., 675 Mass Ave, Cambridge, MA 02139 USA.  Check the file named
 *  COPYING.
 *
 *  These routines provide a list for storing descriptions of children of
 *  atoms.
 */

#ifndef ASC_CHILDINFO_H
#define ASC_CHILDINFO_H

#include "dimen.h"

struct ChildDescR {
  double value;
  CONST dim_type *dims;
};

struct ChildDescI {
  long value;     
};

struct ChildDescS{
  struct set_t *slist;  
  unsigned is_int;      
};

union ChildDescUnion {
  int bvalue;               
  struct ChildDescS s;      
  struct ChildDescI ivalue; 
  struct ChildDescR rvalue; 
  symchar *svalue;          
};

enum ChildDescT {
  bad_child,       
  real_child,     
  integer_child,  
  boolean_child,  
  set_child,      
  symbol_child    
};

struct ChildDesc {
  enum ChildDescT t;      
  unsigned assigned;      
  union ChildDescUnion u; 
};

#ifdef NDEBUG

#define ICDESC(x)

#define ICDESCPTR(y)
#else

#define ICDESC(x) CDescInit(&(x))

#define ICDESCPTR(y) CDescInit(y)
#endif

extern void CDescInit(struct ChildDesc *c);
extern struct ChildDesc *CreateChildDescArray(unsigned long l);
extern struct ChildDesc *CreateEmptyChildDescArray(void);
extern void DestroyChildDescArray(struct ChildDesc *c,
                                  unsigned long l);
#ifdef NDEBUG
#define AssignChildArrayElement(a,n,e) (a)[(n)-1] = (e)
#else
#define AssignChildArrayElement(a,n,e) AssignChildArrayElementF((a),(n),(e))
#endif

extern void AssignChildArrayElementF(struct ChildDesc *a,
                                     unsigned long n,
                                     struct ChildDesc e);
#ifdef NDEBUG
#define GetChildArrayElement(a,n) ((a)[n-1])
#else
#define GetChildArrayElement(a,n) GetChildArrayElementF((a),(n))
#endif

extern struct ChildDesc GetChildArrayElementF(CONST struct ChildDesc *a,
                                              unsigned long n);
#ifdef NDEBUG
#define ChildDescType(e) ((e).t)
#else
#define ChildDescType(e) ChildDescTypeF(e)
#endif

extern enum ChildDescT ChildDescTypeF(struct ChildDesc e);
#ifdef NDEBUG
#define ValueAssigned(e) ((e).assigned)
#else
#define ValueAssigned(e) ValueAssignedF(e)
#endif

extern int ValueAssignedF(struct ChildDesc e);
#ifdef NDEBUG
#define IntegerDefault(e) ((e).u.ivalue.value)
#else
#define IntegerDefault(e) IntegerDefaultF(e)
#endif

extern long IntegerDefaultF(struct ChildDesc e);
#ifdef NDEBUG
#define BooleanDefault(e) ((e).u.bvalue)
#else
#define BooleanDefault(e) BooleanDefaultF(e)
#endif

extern int BooleanDefaultF(struct ChildDesc e);
#ifdef NDEBUG
#define SetDefault(e) ((e).u.s.slist)
#else
#define SetDefault(e) SetDefaultF(e)
#endif

extern CONST struct set_t *SetDefaultF(struct ChildDesc e);
#ifdef NDEBUG
#define SetIsIntegerSet(e) ((e).u.s.is_int)
#else
#define SetIsIntegerSet(e) SetIsIntegerSetF(e)
#endif

extern int SetIsIntegerSetF(struct ChildDesc e);
#ifdef NDEBUG
#define SymbolDefault(e) ((e).u.svalue)
#else
#define SymbolDefault(e) SymbolDefaultF(e)
#endif

extern symchar *SymbolDefaultF(struct ChildDesc e);
#ifdef NDEBUG
#define RealDefaultValue(e) ((e).u.rvalue.value)
#else
#define RealDefaultValue(e) RealDefaultValueF(e)
#endif

extern double RealDefaultValueF(struct ChildDesc e);
#ifdef NDEBUG
#define RealDimensions(e) ((e).u.rvalue.dims)
#else
#define RealDimensions(e) RealDimensionsF(e)
#endif

extern CONST dim_type *RealDimensionsF(struct ChildDesc e);
extern struct ChildDesc MakeRealDesc(int assigned,
                                     double v,
                                     CONST dim_type *dims);
extern struct ChildDesc MakeIntegerDesc(int assigned, long i);
extern struct ChildDesc MakeBooleanDesc(int assigned, int b);
extern struct ChildDesc MakeSetDesc(int assigned, int intset, struct set_t *s);
extern struct ChildDesc MakeSymbolDesc(int assigned, symchar *str);
/* @} */

#endif  /* ASC_CHILDINFO_H */

---