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.
 */

/** 
 *  When #including procio.h, make sure these files are #included first:
 *         #include "compiler.h"
 *         #include "proc.h"
 */


#ifndef __PROCIO_H_SEEN__
#define __PROCIO_H_SEEN__
/** requires
# #include<stdio.h>
# #include"proc.h"
*/

/** 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 *, char *);
extern  void WriteInitErr(struct procFrame *, char *);

/** 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 *, int, int);

/** 
 * ProcWriteForError(fm);
 * write error encountered while evaluating FOR/DO.
 */
extern void ProcWriteForError(struct procFrame *);

/** 
 * ProcWriteAssignmentError(fm);
 * write error encountered while evaluating := assignment.
 */
extern void ProcWriteAssignmentError(struct procFrame *);

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

/** 
 * ProcWriteRunError(fm);
 * write error encountered while evaluating RUN arguments.
 */
extern void ProcWriteRunError(struct procFrame *);

/** 
 * ProcWriteExtError(fm,funcname,err,pos);
 */
extern void ProcWriteExtError(struct procFrame *, CONST char *,
                              enum ProcExtError, int);


/** backtrace output functions. **/

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

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

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

1	ben.allan	33	/**
2	aw0a	1	* 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	ben.allan	33	/**
30	aw0a	1	* When #including procio.h, make sure these files are #included first:
31			* #include "compiler.h"
32			* #include "proc.h"
33			*/
34
35
36			#ifndef __PROCIO_H_SEEN__
37			#define __PROCIO_H_SEEN__
38	ben.allan	33	/** requires
39	aw0a	1	# #include<stdio.h>
40			# #include"proc.h"
41			*/
42
43	ben.allan	33	/** codes for old-style external call messaging */
44	aw0a	1	enum ProcExtError {
45			PE_unloaded,
46			PE_nulleval,
47			PE_argswrong,
48			PE_badarg,
49			PE_evalerr
50			};
51
52	ben.allan	33	/** METHODs equivalent of WSEM. should go away soon. */
53	aw0a	1	extern void WriteInitWarn(struct procFrame , char );
54			extern void WriteInitErr(struct procFrame , char );
55
56			/ error message services /
57	ben.allan	33	/**
58	aw0a	1	* ProcWriteCaseError(fm,arm,pos);
59			* write error encountered while evaluating SWITCH.
60			* arm gives the number of the case in question. pos
61			* gives the position of the error in the var list.
62			*/
63			extern void ProcWriteCaseError(struct procFrame *, int, int);
64
65	ben.allan	33	/**
66	aw0a	1	* ProcWriteForError(fm);
67			* write error encountered while evaluating FOR/DO.
68			*/
69			extern void ProcWriteForError(struct procFrame *);
70
71	ben.allan	33	/**
72	aw0a	1	* ProcWriteAssignmentError(fm);
73			* write error encountered while evaluating := assignment.
74			*/
75			extern void ProcWriteAssignmentError(struct procFrame *);
76
77	ben.allan	33	/**
78	aw0a	1	* ProcWriteIfError(fm,cname);
79			* write error encountered while evaluating boolean flow control.
80			* cname is normally "IF" or "WHILE".
81			*/
82			extern void ProcWriteIfError(struct procFrame , CONST char );
83
84	ben.allan	33	/**
85	aw0a	1	* ProcWriteRunError(fm);
86			* write error encountered while evaluating RUN arguments.
87			*/
88			extern void ProcWriteRunError(struct procFrame *);
89
90	ben.allan	33	/**
91	aw0a	1	* ProcWriteExtError(fm,funcname,err,pos);
92			*/
93			extern void ProcWriteExtError(struct procFrame , CONST char ,
94			enum ProcExtError, int);
95
96
97			/ backtrace output functions. /
98
99	ben.allan	33	/**
100	aw0a	1	* Issue a message if we blew the stack limit or are
101			* unwinding the stack.
102			*/
103			extern void ProcWriteStackCheck(struct procFrame *,
104			struct Name , struct Name );
105
106	ben.allan	33	/**
107	aw0a	1	* WriteProcedureBlock(fp,initstack,str);
108			* Writes a line to file fp in a format resembling:
109			* ("%s %s in %s\n",str,stack->last->proc,stack->last->context)
110			* For example: WriteProcedureBlock(ASCERR,stack,"Entering ");
111			* --> "Entering METHOD myproc in mysim.myinstance[3]"
112			* str may be empty or NULL.
113			* The format is subject to change as this feature is in development.
114			*/
115			extern void WriteProcedureBlock(FILE , struct gl_list_t initstack,
116			CONST char *);
117
118	ben.allan	33	/**
119	aw0a	1	* WriteProcedureLine(fp,initstack,str);
120			* Writes a line to file fp in a format resembling:
121			* ("%s %d: %s in %s\n",str,line,proc,context)
122			* For example: WriteProcedureLine(ASCERR,initstack,"Executing line ");
123			* --> "Executing line 137 of myprocname in mysim.myinstance[3]"
124			* The format is subject to change as this feature is in development.
125			*/
126			extern void WriteProcedureLine(FILE , struct gl_list_t initstack,
127			CONST char *);
128	ben.allan	33	#endif /** __PROCIO_H_SEEN__ */
129	aw0a	1