/[ascend]/trunk/base/generic/compiler/exprio.h
ViewVC logotype

Contents of /trunk/base/generic/compiler/exprio.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 33 - (show annotations) (download) (as text)
Sun Dec 26 20:06:01 2004 UTC (19 years, 10 months ago) by ben.allan
File MIME type: text/x-chdr
File size: 2482 byte(s)
First pass at doxygenation -- mechanically putting in ** and where
most likely needed **< using sed. Lots of cleanup needed to
be really useful, including grouping data types and their
member methods into class-like documentation.
1 /**<
2 * Expression Input/Output
3 * by Tom Epperly
4 * Version: $Revision: 1.6 $
5 * Version control file: $RCSfile: exprio.h,v $
6 * Date last modified: $Date: 1998/02/05 16:35:57 $
7 * Last modified by: $Author: ballan $
8 *
9 * This file is part of the Ascend Language Interpreter.
10 *
11 * Copyright (C) 1990, 1993, 1994 Thomas Guthrie Epperly
12 *
13 * The Ascend Language Interpreter is free software; you can redistribute
14 * it and/or modify it under the terms of the GNU General Public License as
15 * published by the Free Software Foundation; either version 2 of the
16 * License, or (at your option) any later version.
17 *
18 * The Ascend Language Interpreter is distributed in hope that it will be
19 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with the program; if not, write to the Free Software Foundation,
25 * Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
26 * COPYING.
27 */
28
29 #ifndef __EXPRIO_H_SEEN__
30 #define __EXPRIO_H_SEEN__
31
32
33 /**<
34 * When #including exprio.h, make sure these files are #included first:
35 * #include "fractions.h"
36 * #include "compiler.h"
37 * #include "dimen.h"
38 * #include "types.h"
39 * #include "symtab.h"
40 */
41
42
43 extern CONST char *ExprEnumName(CONST enum Expr_enum);
44 /**<
45 * CONST char *ExprEnumName(t);
46 * CONST enum Expr_enum t;
47 * Returns a pointer to a string containing the name of the Expr term
48 * given. Do not free this string under any circumstances.
49 * This string is not in the symbol table.
50 */
51
52 extern void WriteExprNode(FILE *,CONST struct Expr *);
53 /**<
54 * void WriteExprNode(f,e)
55 * FILE *f;
56 * const struct Expr *e;
57 */
58
59 extern void WriteExpr(FILE *,CONST struct Expr *);
60 /**<
61 * void WriteExpr(f,e)
62 * FILE *f;
63 * const struct Expr *e;
64 * Write the expression with no leading or trailing white space.
65 */
66
67 extern void WriteExprNode2Str(Asc_DString *,CONST struct Expr *);
68 /**<
69 * void WriteExprNode2Str(dstring,e)
70 * Asc_DString *dstring;
71 * const struct Expr *e;
72 */
73
74 extern void WriteExpr2Str(Asc_DString *,CONST struct Expr *);
75 /**<
76 * void WriteExpr2Str(dstring,e)
77 * Asc_DString *dstring;
78 * const struct Expr *e;
79 * Write the expression with no leading or trailing white space.
80 */
81 #endif /**< __EXPRIO_H_SEEN__ */
82
83
84
85
86

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22