generic/compiler/childio.h

/*  ASCEND modelling environment
    Copyright (C) 1998 Carnegie Mellon University
    Copyright (C) 2006 Carnegie Mellon University

    This program 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, or (at your option)
    any later version.

    This program is distributed in the 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 this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*//** @file
    This is a package of routines to process child list I/O.

    Requires:
    #include "utilities/ascConfig.h"
    #include "compiler.h"
    #include "list.h"
    #include "child.h"
*//*
    by Ben Allan
    Version: $Revision: 1.3 $
    Version control file: $RCSfile: childio.h,v $
    Date last modified: $Date: 1998/06/11 17:36:23 $
    Last modified by: $Author: ballan $
*/

#ifndef ASC_CHILDIO_H
#define ASC_CHILDIO_H

/** addtogroup compiler Compiler
    @{
*/

#include <utilities/ascConfig.h>

/*
 *  WriteChildList(fp,cl)
 */
/**
 *  Write what is known at parse time about the children in the child list
 *  given.  What is known may be surprising. It may be only mildly
 *  accurate.
 */
extern void WriteChildList(FILE *fp, ChildListPtr cl);

/**
 * Return a string containing buckets o'stuff about the nth child in list.
 * The string will make use of braces as necessary to delimit
 * items. What each item is will be subject to change according
 * to the meta-data given by WriteChildMetaDetails.
 * Items are booleans, integers or strings as explained below.<br><br>
 *
 * The string returned is the caller's responsibility.
 */
ASC_DLLSPEC char *WriteChildDetails(ChildListPtr cl, unsigned long n);

/**
 * Returns a string with fields brace delimited. Each field
 * describes the corresponding field of a WriteChildDetails
 * return string. The ordering and size may be expected to shift as
 * ASCEND evolves. The hope is that the contents of metas individual
 * fields will shift much more slowly than the ordering, number of
 * fields and so forth. Using metas, one can expect to write code
 * which survives changes in plain s.<br><br>
 *
 * The returned string is NOT yours to free. (safe to keep, though).
 * The format is one or more elements in braces like:  <br>
 * "{data} {data} {data}"                              <br>
 * where data is a triplet separated by - "name-ctype-{explanation}"
 * Name is a single string with no blanks,
 * ctype is boolean, integer, or string.
 * explanation is for human consumption and explains the field.
 */
ASC_DLLSPEC CONST char *WriteChildMetaDetails(void);

/**
 * Issues a child missing error to file if the same childname/scope
 * has not been missing since the last call with any NULL argument.
 */
ASC_DLLSPEC void WriteChildMissing(FILE *fp, char *scope, symchar *childname);

/* @} */

#endif  /* ASC_CHILDIO_H */

1	/* ASCEND modelling environment
2	Copyright (C) 1998 Carnegie Mellon University
3	Copyright (C) 2006 Carnegie Mellon University
4
5	This program is free software; you can redistribute it and/or modify
6	it under the terms of the GNU General Public License as published by
7	the Free Software Foundation; either version 2, or (at your option)
8	any later version.
9
10	This program is distributed in the hope that it will be useful,
11	but WITHOUT ANY WARRANTY; without even the implied warranty of
12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	GNU General Public License for more details.
14
15	You should have received a copy of the GNU General Public License
16	along with this program; if not, write to the Free Software
17	Foundation, Inc., 59 Temple Place - Suite 330,
18	Boston, MA 02111-1307, USA.
19	//* @file
20	This is a package of routines to process child list I/O.
21
22	Requires:
23	#include "utilities/ascConfig.h"
24	#include "compiler.h"
25	#include "list.h"
26	#include "child.h"
27	//
28	by Ben Allan
29	Version: $Revision: 1.3 $
30	Version control file: $RCSfile: childio.h,v $
31	Date last modified: $Date: 1998/06/11 17:36:23 $
32	Last modified by: $Author: ballan $
33	*/
34
35	#ifndef ASC_CHILDIO_H
36	#define ASC_CHILDIO_H
37
38	/** addtogroup compiler Compiler
39	@{
40	*/
41
42	#include <utilities/ascConfig.h>
43
44	/*
45	* WriteChildList(fp,cl)
46	*/
47	/**
48	* Write what is known at parse time about the children in the child list
49	* given. What is known may be surprising. It may be only mildly
50	* accurate.
51	*/
52	extern void WriteChildList(FILE *fp, ChildListPtr cl);
53
54	/**
55	* Return a string containing buckets o'stuff about the nth child in list.
56	* The string will make use of braces as necessary to delimit
57	* items. What each item is will be subject to change according
58	* to the meta-data given by WriteChildMetaDetails.
59	* Items are booleans, integers or strings as explained below.<br><br>
60	*
61	* The string returned is the caller's responsibility.
62	*/
63	ASC_DLLSPEC char *WriteChildDetails(ChildListPtr cl, unsigned long n);
64
65	/**
66	* Returns a string with fields brace delimited. Each field
67	* describes the corresponding field of a WriteChildDetails
68	* return string. The ordering and size may be expected to shift as
69	* ASCEND evolves. The hope is that the contents of metas individual
70	* fields will shift much more slowly than the ordering, number of
71	* fields and so forth. Using metas, one can expect to write code
72	* which survives changes in plain s.<br><br>
73	*
74	* The returned string is NOT yours to free. (safe to keep, though).
75	* The format is one or more elements in braces like: <br>
76	* "{data} {data} {data}" <br>
77	* where data is a triplet separated by - "name-ctype-{explanation}"
78	* Name is a single string with no blanks,
79	* ctype is boolean, integer, or string.
80	* explanation is for human consumption and explains the field.
81	*/
82	ASC_DLLSPEC CONST char *WriteChildMetaDetails(void);
83
84	/**
85	* Issues a child missing error to file if the same childname/scope
86	* has not been missing since the last call with any NULL argument.
87	*/
88	ASC_DLLSPEC void WriteChildMissing(FILE fp, char scope, symchar *childname);
89
90	/* @} */
91
92	#endif /* ASC_CHILDIO_H */
93