/[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 54 - (show annotations) (download) (as text)
Tue Aug 2 11:20:09 2005 UTC (14 years, 6 months ago) by jds
File MIME type: text/x-chdr
File size: 3454 byte(s)
Manual rework of doxygen comments in all headers.
- Added @file comment to all headers.
- Added parameter names to all function declarations in headers.
- Corrected comment referencing where necessary.
- Split some comments which documented blocks of declarations.
- Converted notes about required work into @todo comments so doxygen can generate a todo list.
Minor bug fixes.
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 /** @file
30 * Expression Input/Output
31 * <pre>
32 * When #including exprio.h, make sure these files are #included first:
33 * #include "utilities/ascConfig.h"
34 * #include "fractions.h"
35 * #include "compiler.h"
36 * #include "dimen.h"
37 * #include "types.h"
38 * #include "symtab.h"
39 * </pre>
40 */
41
42 #ifndef __EXPRIO_H_SEEN__
43 #define __EXPRIO_H_SEEN__
44
45 extern CONST char *ExprEnumName(CONST enum Expr_enum t);
46 /**<
47 * <!-- CONST char *ExprEnumName(t); -->
48 * <!-- CONST enum Expr_enum t; -->
49 * Returns a pointer to a string containing the name of the Expr term
50 * given. Do not free this string under any circumstances.
51 * This string is not in the symbol table.
52 */
53
54 extern void WriteExprNode(FILE *f, CONST struct Expr *e);
55 /**<
56 * <!-- void WriteExprNode(f,e) -->
57 * <!-- FILE *f; -->
58 * <!-- const struct Expr *e; -->
59 * Write a single expression node with no leading or trailing white space.
60 */
61
62 extern void WriteExpr(FILE *f, CONST struct Expr *e);
63 /**<
64 * <!-- void WriteExpr(f,e) -->
65 * <!-- FILE *f; -->
66 * <!-- const struct Expr *e; -->
67 * Write the expression with no leading or trailing white space.
68 */
69
70 extern void WriteExprNode2Str(Asc_DString *dstring, CONST struct Expr *e);
71 /**<
72 * <!-- void WriteExprNode2Str(dstring,e) -->
73 * <!-- Asc_DString *dstring; -->
74 * <!-- const struct Expr *e; -->
75 * Write a single expression node to a string with no leading
76 * or trailing white space.
77 */
78
79 extern void WriteExpr2Str(Asc_DString *dstring, CONST struct Expr *e);
80 /**<
81 * <!-- void WriteExpr2Str(dstring,e) -->
82 * <!-- Asc_DString *dstring; -->
83 * <!-- const struct Expr *e; -->
84 * Write the expression to a string with no leading or trailing white space.
85 */
86
87 #endif /* __EXPRIO_H_SEEN__ */
88

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