ecd8f55b5eb5a755362228d6a09c6478d5172ffc
[ghc-hetmet.git] / ghc / includes / options.h
1
2 /* --------------------------------------------------------------------------
3  * Configuration options
4  *
5  * Copyright (c) The University of Nottingham and Yale University, 1994-1997.
6  * All rights reserved. See NOTICE for details and conditions of use etc...
7  * Hugs version 1.4, December 1997
8  *
9  * $RCSfile: options.h,v $
10  * $Revision: 1.21 $
11  * $Date: 2000/03/10 17:30:36 $
12  * ------------------------------------------------------------------------*/
13
14
15 /* --------------------------------------------------------------------------
16  * Hugs paths and directories
17  * ------------------------------------------------------------------------*/
18
19 /* Define this as the default setting of HUGSPATH.                        
20  * Value may contain string "{Hugs}" (for which we will substitute the
21  * value of HUGSDIR) and should be either colon-separated (Unix)
22  * or semicolon-separated (Macintosh, Windows, DOS).  Escape
23  * characters in the path string are interpreted according to normal
24  * Haskell conventions.
25  *
26  * This value can be overridden from the command line by setting the
27  * HUGSFLAGS environment variable or by storing an appropriate value
28  * for HUGSFLAGS in the registry (Win32 only).  In all cases, use a 
29  * string of the form -P"...".  
30  */
31 #define HUGSPATH "."
32
33 /* The directory name which is substituted for the string "{Hugs}"
34  * in a path variable.  This normally points to where the Hugs libraries
35  * are installed - ie so that the file HUGSDIR/lib/Prelude.hs exists    
36  * Typical values are:                                  
37  *    "/usr/local/lib/hugs"                             
38  *    "/usr/homes/JFHaskell/hugs"                       
39  *    ".."      
40  *
41  * This value is ignored on Windows and Macintosh versions since
42  * it is assumed that the binary is installed in HUGSDIR.
43  *
44  * This value cannot be overridden from the command line or by using 
45  * environment variables.  This isn't quite as limiting as you'd think
46  * since you can always choose _not_ to use the {Hugs} variable - however,
47  * it's obviously _nicer_ to have it set correctly.
48  */
49 #ifndef HUGSDIR
50 #define HUGSDIR "."
51 #endif
52
53
54 /* --------------------------------------------------------------------------
55  * User interface options
56  * ------------------------------------------------------------------------*/
57
58 /* Define if you want to use the "Hugs for Windows" GUI.
59  * (Windows 3.1 and compatibles only)
60  */
61 #define HUGS_FOR_WINDOWS 0
62
63 /* Define if you want filenames to be converted to normal form by:
64  * o replacing relative pathnames with absolute pathnames and
65  *   eliminating .. and . where possible.
66  * o converting to lower case (only in case-insensitive filesystems)
67  */
68 #define PATH_CANONICALIZATION 0
69
70 /* Define if you want the small startup banner.
71  */
72 #define SMALL_BANNER 0
73
74 /* Define if you want to be able to redirect stdout/stderr to a buffer.
75  * Only necessary for the Hugs server interface (which is used in the
76  * Netscape plugin and the standalone evaluator "runhugs"). 
77  */
78 #define REDIRECT_OUTPUT (!HUGS_FOR_WINDOWS)
79
80
81 /* --------------------------------------------------------------------------
82  * Language extensions
83  * ------------------------------------------------------------------------*/
84
85 /* Define if T-REX; Typed Rows and EXtension should be enabled             */
86 /* Doesn't work in current system - I don't know what the primops do       */
87 #define TREX            0
88
89 /* Implicit Parameters                                                     */
90 #define IPARAM          1
91
92 /* Multi-instance resolution                                               */
93 #define MULTI_INST      0
94
95
96 /* --------------------------------------------------------------------------
97  * Various table sizes
98  * ------------------------------------------------------------------------*/
99
100 #define NUM_SYNTAX         100
101 #define NUM_TUPLES         37
102 #define NUM_OFFSETS        1024
103 #define NUM_CHARS          256
104 #if TREX
105 #define NUM_EXT            100
106 #endif
107 #define CHAR_MASK          0xff
108
109 #define MINIMUMHEAP        19000
110 #define MAXIMUMHEAP        0
111 #define DEFAULTHEAP        350000
112
113 #define NUM_SCRIPTS        100
114 #define NUM_MODULE         NUM_SCRIPTS
115 #define NUM_TYCON          400
116 #define NUM_NAME           16000
117 #define NUM_CLASSES        80
118 #define NUM_INSTS          600
119 #define NUM_TEXT           100000
120 #define NUM_TEXTH          10
121 #define NUM_TYVARS         4000
122 #define NUM_STACK          16000
123 #define NUM_DTUPLES        5
124
125 #define MAXPOSINT          0x7fffffff
126 #define MINNEGINT          (-MAXPOSINT-1)
127 #define MAXHUGSWORD        0xffffffffU
128
129 #define minRecovery        1000
130 #define bitsPerWord        32
131 #define wordShift          5
132 #define wordMask           31
133
134 /* Define to force a fixed size (NUM_TYVARS) for the current substitution.
135  * Setting this flag places a limit on the maximum complexity of
136  * expressions handled by the typechecker.  It is normally turned off
137  * but may be required for small machines/configurations.
138  */
139 #define FIXED_SUBST 0 
140
141 /* Define this to allocate tables dynamically.
142  * This is currently just a memory saving trick, but this may be
143  * extended at a later stage to allow at least some of the tables
144  * to be extended dynamically at run-time to avoid exhausted space errors.
145  */
146 #define DYN_TABLES 0
147
148 /* Should quantifiers be displayed in error messages.
149  * Warning: not consistently used.
150  */
151 #define DISPLAY_QUANTIFIERS 0
152
153 /* Flags to determine which raw representations and operations are available
154  * Notes:
155  * o if you turn everything on, you might end up with more then 256
156  *   bytecodes: check the value of i_ccall (the lst bytecode) to check
157  * (JRS), 22apr99: I don't think any of the #undef'd ones will work
158  * without attention.  However, standard Haskell 98 is supported 
159  * is supported without needing them.
160  */
161 #undef  PROVIDE_STABLE
162 #undef  PROVIDE_FOREIGN
163 #undef  PROVIDE_WEAK
164 #undef  PROVIDE_CONCURRENT
165 #undef  PROVIDE_PTREQUALITY
166 #undef  PROVIDE_COERCE
167
168 #define  PROVIDE_COERCE     1
169 #define PROVIDE_PTREQUALITY 1
170
171 /* Set to 1 to use a non-GMP implementation of integer, in the
172    standalone Hugs.  Set to 0 in the combined GHC-Hugs system,
173    in which case GNU MP will be used.
174 */
175 #define STANDALONE_INTEGER 1
176
177 /* Enable a crude profiler which counts BCO entries, bytes allocated
178    and bytecode insns executed on a per-fn basis.  Used for assessing
179    the effect of the simplifier/optimiser.
180 */
181 #undef CRUDE_PROFILING
182
183
184 /* Is the default default (Int,Double) or (Integer,Double)?
185  */
186 #define DEFAULT_BIGNUM 1
187
188 /* Turn bytecode interpreter support on/off.
189  */
190 #define INTERPRETER 1 
191
192 /* Turn on debugging output and some sanity checks
193  */
194 /*#define DEBUG*/
195
196 /* NB: LAZY_BLACKHOLING has been moved up to Stg.h where both Hugs and GHC can see it,
197  * and EAGER_BLACKHOLING has been introduced also.  KSW 1999-01.
198  */
199
200 /* Turn miniinterpreter on/off.
201  * 
202  * The mininterpreter is portable but slow - if you turn it off, 
203  * you'll probably need to provide some assembly language support
204  * for your architecture.
205  */
206 #define USE_MINIINTERPRETER 1
207
208 /* Turn registerisation on/off.
209  * 
210  * If you turn this off, you'll probably need to provide some
211  * assembly language support for your architecture.
212  */
213 #define NO_REGS
214
215
216 /* --------------------------------------------------------------------------
217  * Fancy features
218  * ------------------------------------------------------------------------*/
219
220 /* Define if :xplain should be enabled                                     */
221 #define EXPLAIN_INSTANCE_RESOLUTION 0
222
223
224 /* Define if you want to run Haskell code through a preprocessor
225  * 
226  * Note that the :reload command doesn't know about any dependencies
227  * introduced by using #include so you must :load (not :reload) if
228  * you change any #included files (such as configuration files).
229  */
230 #define USE_PREPROCESSOR 1
231
232 /* Define if you want to time every evaluation. 
233  *
234  * Timing is included in the Hugs distribution for the purpose of benchmarking
235  * the Hugs interpreter, comparing its performance across a variety of
236  * different machines, and with other systems for similar languages.
237  *
238  * It would be somewhat foolish to try to use the timings produced in this
239  * way for any other purpose.  In particular, using timings to compare the
240  * performance of different versions of an algorithm is likely to give very
241  * misleading results.  The current implementation of Hugs as an interpreter,
242  * without any significant optimizations, means that there are much more
243  * significant overheads than can be accounted for by small variations in
244  * Hugs code.
245  */
246 /* #undef WANT_TIMER */
247
248
249 /* --------------------------------------------------------------------------
250  * Desugaring options
251  * 
252  * These options are mostly used for developing/debugging the system.
253  * Since they turn off required parts of the Haskell language, you'll
254  * probably need to modify Prelude.hs and the libraries if you change
255  * these flags.
256  * ------------------------------------------------------------------------*/
257
258 /* Define if single-element dictionaries are implemented by newtype.
259  * Should be turned on.  Mostly used to make it easier to find which
260  * bits of code implement this optimisation and as a way of documenting
261  * them.
262  */
263 #define USE_NEWTYPE_FOR_DICTS 1
264
265 /* Define if strings should be represented as normal C strings.
266  * Note that this doesn't work if the string contains '\0'
267  * and makes persistence problematic.
268  * Intended as a stop-gap measure until mutable byte arrays are available.
269  */
270 #define USE_ADDR_FOR_STRINGS 1
271
272
273 /* --------------------------------------------------------------------------
274  * Debugging options (intended for use by maintainers)
275  * ------------------------------------------------------------------------*/
276
277 /* Define if debugging generated bytecodes or the bytecode interpreter     */
278 #define DEBUG_CODE 1
279
280 /* --------------------------------------------------------------------------
281  * Experimental features
282  * These are likely to disappear/change in future versions and should not
283  * be used by most people..
284  * ------------------------------------------------------------------------*/
285
286 /* In a plain Hugs system, most signals (SIGBUS, SIGTERM, etc) indicate
287  * some kind of error in Hugs - or maybe a stack overflow.  Rather than
288  * just crash, Hugs catches these errors and returns to the main loop.
289  * It does this by calling a function "panic" which longjmp's back to the
290  * main loop.
291  * If you're developing a GreenCard library, this may not be the right
292  * behaviour - it's better if Hugs leaves them for your debugger to
293  * catch rather than trapping them and "panicking".
294  */
295 #define DONT_PANIC 1
296
297
298 /* ----------------------------------------------------------------------- */