mirror of
https://github.com/Mercury-Language/mercury.git
synced 2026-04-21 12:23:44 +00:00
8520a4c88c
Estimated hours taken: 6
A general cleanup of the code in the runtime directory, aimed at
formulating a more coherent header file inclusion policy. This change
fixes a couple of bugs that prevented the runtime from compiling in
certain configurations (e.g. on muse) due to missing #includes, and
also fixes a few minor unrelated things such as the use of `size_t'
instead of `unsigned'.
Our header file inclusion policy is that every header file should
#include any other header files needed by the declarations or by the
macros it defines. Cyclic interface dependencies, where two header
files each #include the other, must be avoided (by splitting up header
files into smaller indepdent units, if necessary).
At some stage in the future we should rename all the header files to
`mercury_*.h', to avoid any possible name clashes with system or user
header files.
runtime/Mmake:
Add a new target `check_headers' to check that each
header file is syntactically valid in isolation.
runtime/imp.h:
runtime/mercury_float.h:
runtime/mercury_string.h:
runtime/mercury_types.h:
runtime/calls.h:
Move the code in "imp.h" into new header files.
"imp.h" now contains nothing but #includes.
runtime/conf.h.in:
runtime/*.h:
runtime/{label,prof,prof_mem}.c:
runtime/*.mod:
Update the #includes to reflect the new header file structure.
Add some missing header guards. Add some comments.
Put the correct years in most of the copyright notices.
runtime/heap.h:
Fix a bug: add #include "context.h", needed for
min_heap_reclamation_point.
runtime/context.h:
Fix a bug: add #include "memory.h", needed for MemoryZone.
Move the general description comment to the top of the file.
Fix the indentation of some comments. Add a couple of new comments.
runtime/context.mod:
Delete a couple of unnecessary declarations.
runtime/wrapper.mod:
Change the type used for memory sizes from `unsigned' to `size_t'.
Change the `-p' (primary cache size) option so that it is always
a size in kilobytes, rather than being schitzophrenic about
whether it is bytes or kilobytes.
runtime/regorder_base.h:
Removed, since it not used (and constitutes a
double-maintenance problem).
61 lines
1.6 KiB
C
61 lines
1.6 KiB
C
/*
|
|
** Copyright (C) 1995-1997 University of Melbourne.
|
|
** This file may only be copied under the terms of the GNU Library General
|
|
** Public License - see the file COPYING.LIB in the Mercury distribution.
|
|
*/
|
|
|
|
/*
|
|
** engine.h - definitions for the Mercury runtime engine.
|
|
**
|
|
** For documentation, see the comments in engine.mod.
|
|
*/
|
|
|
|
#ifndef ENGINE_H
|
|
#define ENGINE_H
|
|
|
|
#include "std.h" /* for `bool' */
|
|
#include "mercury_types.h" /* for `Code *' */
|
|
#include "goto.h" /* for `Define_entry()' */
|
|
|
|
#define PROGFLAG 0
|
|
#define GOTOFLAG 1
|
|
#define CALLFLAG 2
|
|
#define HEAPFLAG 3
|
|
#define DETSTACKFLAG 4
|
|
#define NONDSTACKFLAG 5
|
|
#define FINALFLAG 6
|
|
#define MEMFLAG 7
|
|
#define SREGFLAG 8
|
|
#define TRACEFLAG 9
|
|
#define DETAILFLAG 10
|
|
#define MAXFLAG 11
|
|
/* DETAILFLAG should be the last real flag */
|
|
|
|
#define progdebug debugflag[PROGFLAG]
|
|
#define gotodebug debugflag[GOTOFLAG]
|
|
#define calldebug debugflag[CALLFLAG]
|
|
#define heapdebug debugflag[HEAPFLAG]
|
|
#define detstackdebug debugflag[DETSTACKFLAG]
|
|
#define nondstackdebug debugflag[NONDSTACKFLAG]
|
|
#define finaldebug debugflag[FINALFLAG]
|
|
#define memdebug debugflag[MEMFLAG]
|
|
#define sregdebug debugflag[SREGFLAG]
|
|
#define tracedebug debugflag[TRACEFLAG]
|
|
#define detaildebug debugflag[DETAILFLAG]
|
|
|
|
extern bool debugflag[];
|
|
|
|
extern void init_engine(void);
|
|
extern void start_mercury_engine(Code *entry_point);
|
|
extern void call_engine(Code *entry_point);
|
|
extern void dump_prev_locations(void);
|
|
|
|
Declare_entry(do_redo);
|
|
Declare_entry(do_fail);
|
|
Declare_entry(do_reset_hp_fail);
|
|
Declare_entry(do_reset_framevar0_fail);
|
|
Declare_entry(do_succeed);
|
|
Declare_entry(do_not_reached);
|
|
|
|
#endif
|