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.20 $
  11  * $Date: 2000/03/10 14:53:00 $
  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  * Various table sizes
  83  * ------------------------------------------------------------------------*/
  84
  85 #define NUM_SYNTAX         100
  86 #define NUM_TUPLES         37
  87 #define NUM_OFFSETS        1024
  88 #define NUM_CHARS          256
  89 #if TREX
  90 #define NUM_EXT            100
  91 #endif
  92 #define CHAR_MASK          0xff
  93
  94 #define MINIMUMHEAP        19000
  95 #define MAXIMUMHEAP        0
  96 #define DEFAULTHEAP        350000
  97
  98 #define NUM_SCRIPTS        100
  99 #define NUM_MODULE         NUM_SCRIPTS
 100 #define NUM_TYCON          400
 101 #define NUM_NAME           16000
 102 #define NUM_CLASSES        80
 103 #define NUM_INSTS          600
 104 #define NUM_TEXT           100000
 105 #define NUM_TEXTH          10
 106 #define NUM_TYVARS         4000
 107 #define NUM_STACK          16000
 108 #define NUM_DTUPLES        5
 109
 110 #define MAXPOSINT          0x7fffffff
 111 #define MINNEGINT          (-MAXPOSINT-1)
 112 #define MAXHUGSWORD        0xffffffffU
 113
 114 #define minRecovery        1000
 115 #define bitsPerWord        32
 116 #define wordShift          5
 117 #define wordMask           31
 118
 119 /* Define to force a fixed size (NUM_TYVARS) for the current substitution.
 120  * Setting this flag places a limit on the maximum complexity of
 121  * expressions handled by the typechecker.  It is normally turned off
 122  * but may be required for small machines/configurations.
 123  */
 124 #define FIXED_SUBST 0
 125
 126 /* Define this to allocate tables dynamically.
 127  * This is currently just a memory saving trick, but this may be
 128  * extended at a later stage to allow at least some of the tables
 129  * to be extended dynamically at run-time to avoid exhausted space errors.
 130  */
 131 #define DYN_TABLES 0
 132
 133 /* Should quantifiers be displayed in error messages.
 134  * Warning: not consistently used.
 135  */
 136 #define DISPLAY_QUANTIFIERS 0
 137
 138 /* Flags to determine which raw representations and operations are available
 139  * Notes:
 140  * o if you turn everything on, you might end up with more then 256
 141  *   bytecodes: check the value of i_ccall (the lst bytecode) to check
 142  * (JRS), 22apr99: I don't think any of the #undef'd ones will work
 143  * without attention.  However, standard Haskell 98 is supported
 144  * is supported without needing them.
 145  */
 146 #undef  PROVIDE_STABLE
 147 #undef  PROVIDE_FOREIGN
 148 #undef  PROVIDE_WEAK
 149 #undef  PROVIDE_CONCURRENT
 150 #undef  PROVIDE_PTREQUALITY
 151 #undef  PROVIDE_COERCE
 152
 153 #define  PROVIDE_COERCE     1
 154 #define PROVIDE_PTREQUALITY 1
 155
 156 /* Set to 1 to use a non-GMP implementation of integer, in the
 157    standalone Hugs.  Set to 0 in the combined GHC-Hugs system,
 158    in which case GNU MP will be used.
 159 */
 160 #define STANDALONE_INTEGER 1
 161
 162 /* Enable a crude profiler which counts BCO entries, bytes allocated
 163    and bytecode insns executed on a per-fn basis.  Used for assessing
 164    the effect of the simplifier/optimiser.
 165 */
 166 #undef CRUDE_PROFILING
 167
 168
 169 /* Is the default default (Int,Double) or (Integer,Double)?
 170  */
 171 #define DEFAULT_BIGNUM 1
 172
 173 /* Turn bytecode interpreter support on/off.
 174  */
 175 #define INTERPRETER 1
 176
 177 /* Turn on debugging output and some sanity checks
 178  */
 179 /*#define DEBUG*/
 180
 181 /* NB: LAZY_BLACKHOLING has been moved up to Stg.h where both Hugs and GHC can see it,
 182  * and EAGER_BLACKHOLING has been introduced also.  KSW 1999-01.
 183  */
 184
 185 /* Turn miniinterpreter on/off.
 186  *
 187  * The mininterpreter is portable but slow - if you turn it off,
 188  * you'll probably need to provide some assembly language support
 189  * for your architecture.
 190  */
 191 #define USE_MINIINTERPRETER 1
 192
 193 /* Turn registerisation on/off.
 194  *
 195  * If you turn this off, you'll probably need to provide some
 196  * assembly language support for your architecture.
 197  */
 198 #define NO_REGS
 199
 200
 201 /* --------------------------------------------------------------------------
 202  * Fancy features
 203  * ------------------------------------------------------------------------*/
 204
 205 /* Define if T-REX; Typed Rows and EXtension should be enabled             */
 206 /* Doesn't work in current system - I don't know what the primops do       */
 207 #define TREX 0
 208
 209 /* Define if :xplain should be enabled                                     */
 210 #define EXPLAIN_INSTANCE_RESOLUTION 0
 211
 212
 213 /* Define if you want to run Haskell code through a preprocessor
 214  *
 215  * Note that the :reload command doesn't know about any dependencies
 216  * introduced by using #include so you must :load (not :reload) if
 217  * you change any #included files (such as configuration files).
 218  */
 219 #define USE_PREPROCESSOR 1
 220
 221 /* Define if you want to time every evaluation.
 222  *
 223  * Timing is included in the Hugs distribution for the purpose of benchmarking
 224  * the Hugs interpreter, comparing its performance across a variety of
 225  * different machines, and with other systems for similar languages.
 226  *
 227  * It would be somewhat foolish to try to use the timings produced in this
 228  * way for any other purpose.  In particular, using timings to compare the
 229  * performance of different versions of an algorithm is likely to give very
 230  * misleading results.  The current implementation of Hugs as an interpreter,
 231  * without any significant optimizations, means that there are much more
 232  * significant overheads than can be accounted for by small variations in
 233  * Hugs code.
 234  */
 235 /* #undef WANT_TIMER */
 236
 237
 238 /* --------------------------------------------------------------------------
 239  * Desugaring options
 240  *
 241  * These options are mostly used for developing/debugging the system.
 242  * Since they turn off required parts of the Haskell language, you'll
 243  * probably need to modify Prelude.hs and the libraries if you change
 244  * these flags.
 245  * ------------------------------------------------------------------------*/
 246
 247 /* Define if single-element dictionaries are implemented by newtype.
 248  * Should be turned on.  Mostly used to make it easier to find which
 249  * bits of code implement this optimisation and as a way of documenting
 250  * them.
 251  */
 252 #define USE_NEWTYPE_FOR_DICTS 1
 253
 254 /* Define if strings should be represented as normal C strings.
 255  * Note that this doesn't work if the string contains '\0'
 256  * and makes persistence problematic.
 257  * Intended as a stop-gap measure until mutable byte arrays are available.
 258  */
 259 #define USE_ADDR_FOR_STRINGS 1
 260
 261
 262 /* --------------------------------------------------------------------------
 263  * Debugging options (intended for use by maintainers)
 264  * ------------------------------------------------------------------------*/
 265
 266 /* Define if debugging generated bytecodes or the bytecode interpreter     */
 267 #define DEBUG_CODE 1
 268
 269 /* --------------------------------------------------------------------------
 270  * Experimental features
 271  * These are likely to disappear/change in future versions and should not
 272  * be used by most people..
 273  * ------------------------------------------------------------------------*/
 274
 275 /* In a plain Hugs system, most signals (SIGBUS, SIGTERM, etc) indicate
 276  * some kind of error in Hugs - or maybe a stack overflow.  Rather than
 277  * just crash, Hugs catches these errors and returns to the main loop.
 278  * It does this by calling a function "panic" which longjmp's back to the
 279  * main loop.
 280  * If you're developing a GreenCard library, this may not be the right
 281  * behaviour - it's better if Hugs leaves them for your debugger to
 282  * catch rather than trapping them and "panicking".
 283  */
 284 #define DONT_PANIC 1
 285
 286
 287 /* ----------------------------------------------------------------------- */