generic/compiler/procio.h

/*
 *  Procedure Output
 *  by Benjamin Allan
 *  Created: 3/12/98
 *  Version: $Revision: 1.6 $
 *  Version control file: $RCSfile: procio.h,v $
 *  Date last modified: $Date: 1998/03/17 22:09:21 $
 *  Last modified by: $Author: ballan $
 *
 *  This file is part of the Ascend Language Interpreter.
 *
 *  Copyright (C) 1998 Carnegie Mellon University
 *
 *  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.
 */

/** @file
 *  Procedure Output.
 *  <pre>
 *  When #including procio.h, make sure these files are #included first:
 *         #include <stdio.h>
 *         #include "utilities/ascConfig.h"
 *         #include "compiler.h"
 *         #include "proc.h"
 *  </pre>
 */

#ifndef __PROCIO_H_SEEN__
#define __PROCIO_H_SEEN__

/** Codes for old-style external call messaging. */
enum ProcExtError {
  PE_unloaded,
  PE_nulleval,
  PE_argswrong,
  PE_badarg,
  PE_evalerr
};

/** METHODs equivalent of WSEM. Should go away soon. */
extern void WriteInitWarn(struct procFrame *fm, char *str);
/** METHODs equivalent of WSEM. Should go away soon. */
extern void WriteInitErr(struct procFrame *fm, char *str);

/* error message services */

/**
 * <!--  ProcWriteCaseError(fm,arm,pos);                               -->
 * Write error encountered while evaluating SWITCH.
 * arm gives the number of the case in question. pos
 * gives the position of the error in the var list.
 */
extern void ProcWriteCaseError(struct procFrame *fm, int arm, int pos);

/**
 * <!--  ProcWriteForError(fm);                                        -->
 * Write error encountered while evaluating FOR/DO.
 */
extern void ProcWriteForError(struct procFrame *fm);

/**
 * <!--  ProcWriteAssignmentError(fm);                                 -->
 * Write error encountered while evaluating := assignment.
 */
extern void ProcWriteAssignmentError(struct procFrame *fm);

/**
 * <!--  ProcWriteFixError(fm,var);                                 -->
 * Write error encountered while evaluating var.fixed assignment.
 */
extern void ProcWriteFixError(struct procFrame *fm, CONST struct Name *var);


/**
 * <!--  ProcWriteIfError(fm,cname);                                   -->
 * Write error encountered while evaluating boolean flow control.
 * cname is normally "IF" or "WHILE".
 */
extern void ProcWriteIfError(struct procFrame *fm, CONST char *cname);

/**
 * <!--  ProcWriteRunError(fm);                                        -->
 * Write error encountered while evaluating RUN arguments.
 */
extern void ProcWriteRunError(struct procFrame *fm);

/**
 * <!--  ProcWriteExtError(fm,funcname,err,pos);                       -->
 * Write error encountered while evaluating Ext arguments.
 */
extern void ProcWriteExtError(struct procFrame *fm,
                              CONST char *funcmane,
                              enum ProcExtError err,
                              int pos);

/* backtrace output functions. */

/**
 * Issue a message if we blew the stack limit or are
 * unwinding the stack.
 */
extern void ProcWriteStackCheck(struct procFrame *fm,
                                struct Name *class,
                                struct Name *name);

/**
 * <!--  WriteProcedureBlock(fp,initstack,str);                        -->
 * Writes a line to file fp.  Write format resembles:
 * ("%s %s in %s\n",str,stack->last->proc,stack->last->context)
 * For example: 
 * <pre>
 * WriteProcedureBlock(ASCERR,stack,"Entering ");
 *    --> "Entering METHOD myproc in mysim.myinstance[3]"
 * </pre>
 * str may be empty or NULL.
 * The format is subject to change as this feature is in development.
 */
extern void WriteProcedureBlock(FILE *fp,
                                struct gl_list_t *initstack,
                                CONST char *str);

/**
 * <!--  WriteProcedureLine(fp,initstack,str);                         -->
 * Writes a line to file fp.  Write format resembles:
 * ("%s %d: %s in %s\n",str,line,proc,context)
 * For example:
 * <pre>
 * WriteProcedureLine(ASCERR,initstack,"Executing line ");
 *    --> "Executing line 137 of myprocname in mysim.myinstance[3]"
 * </pre>
 * The format is subject to change as this feature is in development.
 */
extern void WriteProcedureLine(FILE *fp,
                               struct gl_list_t *initstack,
                               CONST char *str);

#endif  /* __PROCIO_H_SEEN__ */

1	/*
2	* Procedure Output
3	* by Benjamin Allan
4	* Created: 3/12/98
5	* Version: $Revision: 1.6 $
6	* Version control file: $RCSfile: procio.h,v $
7	* Date last modified: $Date: 1998/03/17 22:09:21 $
8	* Last modified by: $Author: ballan $
9	*
10	* This file is part of the Ascend Language Interpreter.
11	*
12	* Copyright (C) 1998 Carnegie Mellon University
13	*
14	* The Ascend Language Interpreter is free software; you can redistribute
15	* it and/or modify it under the terms of the GNU General Public License as
16	* published by the Free Software Foundation; either version 2 of the
17	* License, or (at your option) any later version.
18	*
19	* The Ascend Language Interpreter is distributed in hope that it will be
20	* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22	* General Public License for more details.
23	*
24	* You should have received a copy of the GNU General Public License along
25	* with the program; if not, write to the Free Software Foundation, Inc., 675
26	* Mass Ave, Cambridge, MA 02139 USA. Check the file named COPYING.
27	*/
28
29	/** @file
30	* Procedure Output.
31	* <pre>
32	* When #including procio.h, make sure these files are #included first:
33	* #include <stdio.h>
34	* #include "utilities/ascConfig.h"
35	* #include "compiler.h"
36	* #include "proc.h"
37	* </pre>
38	*/
39
40	#ifndef __PROCIO_H_SEEN__
41	#define __PROCIO_H_SEEN__
42
43	/** Codes for old-style external call messaging. */
44	enum ProcExtError {
45	PE_unloaded,
46	PE_nulleval,
47	PE_argswrong,
48	PE_badarg,
49	PE_evalerr
50	};
51
52	/** METHODs equivalent of WSEM. Should go away soon. */
53	extern void WriteInitWarn(struct procFrame fm, char str);
54	/** METHODs equivalent of WSEM. Should go away soon. */
55	extern void WriteInitErr(struct procFrame fm, char str);
56
57	/* error message services */
58
59	/**
60	* <!-- ProcWriteCaseError(fm,arm,pos); -->
61	* Write error encountered while evaluating SWITCH.
62	* arm gives the number of the case in question. pos
63	* gives the position of the error in the var list.
64	*/
65	extern void ProcWriteCaseError(struct procFrame *fm, int arm, int pos);
66
67	/**
68	* <!-- ProcWriteForError(fm); -->
69	* Write error encountered while evaluating FOR/DO.
70	*/
71	extern void ProcWriteForError(struct procFrame *fm);
72
73	/**
74	* <!-- ProcWriteAssignmentError(fm); -->
75	* Write error encountered while evaluating := assignment.
76	*/
77	extern void ProcWriteAssignmentError(struct procFrame *fm);
78
79	/**
80	* <!-- ProcWriteFixError(fm,var); -->
81	* Write error encountered while evaluating var.fixed assignment.
82	*/
83	extern void ProcWriteFixError(struct procFrame fm, CONST struct Name var);
84
85
86	/**
87	* <!-- ProcWriteIfError(fm,cname); -->
88	* Write error encountered while evaluating boolean flow control.
89	* cname is normally "IF" or "WHILE".
90	*/
91	extern void ProcWriteIfError(struct procFrame fm, CONST char cname);
92
93	/**
94	* <!-- ProcWriteRunError(fm); -->
95	* Write error encountered while evaluating RUN arguments.
96	*/
97	extern void ProcWriteRunError(struct procFrame *fm);
98
99	/**
100	* <!-- ProcWriteExtError(fm,funcname,err,pos); -->
101	* Write error encountered while evaluating Ext arguments.
102	*/
103	extern void ProcWriteExtError(struct procFrame *fm,
104	CONST char *funcmane,
105	enum ProcExtError err,
106	int pos);
107
108	/* backtrace output functions. */
109
110	/**
111	* Issue a message if we blew the stack limit or are
112	* unwinding the stack.
113	*/
114	extern void ProcWriteStackCheck(struct procFrame *fm,
115	struct Name *class,
116	struct Name *name);
117
118	/**
119	* <!-- WriteProcedureBlock(fp,initstack,str); -->
120	* Writes a line to file fp. Write format resembles:
121	* ("%s %s in %s\n",str,stack->last->proc,stack->last->context)
122	* For example:
123	* <pre>
124	* WriteProcedureBlock(ASCERR,stack,"Entering ");
125	* --> "Entering METHOD myproc in mysim.myinstance[3]"
126	* </pre>
127	* str may be empty or NULL.
128	* The format is subject to change as this feature is in development.
129	*/
130	extern void WriteProcedureBlock(FILE *fp,
131	struct gl_list_t *initstack,
132	CONST char *str);
133
134	/**
135	* <!-- WriteProcedureLine(fp,initstack,str); -->
136	* Writes a line to file fp. Write format resembles:
137	* ("%s %d: %s in %s\n",str,line,proc,context)
138	* For example:
139	* <pre>
140	* WriteProcedureLine(ASCERR,initstack,"Executing line ");
141	* --> "Executing line 137 of myprocname in mysim.myinstance[3]"
142	* </pre>
143	* The format is subject to change as this feature is in development.
144	*/
145	extern void WriteProcedureLine(FILE *fp,
146	struct gl_list_t *initstack,
147	CONST char *str);
148
149	#endif /* __PROCIO_H_SEEN__ */
150