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 ASC_PROCIO_H
#define ASC_PROCIO_H

/** addtogroup compiler Compiler
    @{
*/

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

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