[r9524]: main / trunk / interpreter / runtime / RexxCore.h Maximize Restore History

Download this file

RexxCore.h    450 lines (363 with data), 19.5 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
/*----------------------------------------------------------------------------*/
/* */
/* Copyright (c) 1995, 2004 IBM Corporation. All rights reserved. */
/* Copyright (c) 2005-2009 Rexx Language Association. All rights reserved. */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the Common Public License v1.0 which accompanies this */
/* distribution. A copy is also available at the following address: */
/* http://www.oorexx.org/license.html */
/* */
/* Redistribution and use in source and binary forms, with or */
/* without modification, are permitted provided that the following */
/* conditions are met: */
/* */
/* Redistributions of source code must retain the above copyright */
/* notice, this list of conditions and the following disclaimer. */
/* Redistributions in binary form must reproduce the above copyright */
/* notice, this list of conditions and the following disclaimer in */
/* the documentation and/or other materials provided with the distribution. */
/* */
/* Neither the name of Rexx Language Association nor the names */
/* of its contributors may be used to endorse or promote products */
/* derived from this software without specific prior written permission. */
/* */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS */
/* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT */
/* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS */
/* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT */
/* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY */
/* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
/* */
/*----------------------------------------------------------------------------*/
/******************************************************************************/
/* REXX Kernel RexxCore.h */
/* */
/* Global Declarations */
/******************************************************************************/
/******************************************************************************/
/* Globally required include files */
/******************************************************************************/
#ifndef RexxCore_INCLUDED
#define RexxCore_INCLUDED
#include "oorexxapi.h" // this is the core to everything
/* ANSI C definitions */
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <ctype.h>
#include <limits.h>
/* REXX Library definitions */
#define OREF_NULL NULL /* definition of a NULL REXX object */
#include "RexxPlatformDefinitions.h"
/******************************************************************************/
/* Literal definitions */
/******************************************************************************/
#include "RexxConstants.hpp"
/******************************************************************************/
/* Kernel Internal Limits */
/******************************************************************************/
const int MAX_ERROR_NUMBER = 99999; /* maximum error code number */
const int MAX_SYMBOL_LENGTH = 250; /* length of a symbol name */
/******************************************************************************/
/* Defines for argument error reporting */
/******************************************************************************/
const int ARG_ONE = 1;
const int ARG_TWO = 2;
const int ARG_THREE = 3;
const int ARG_FOUR = 4;
const int ARG_FIVE = 5;
const int ARG_SIX = 6;
const int ARG_SEVEN = 7;
const int ARG_EIGHT = 8;
const int ARG_NINE = 9;
const int ARG_TEN = 10;
/* Object Reference Assignment */
#ifndef CHECKOREFS
#define OrefSet(o,r,v) ((o)->isOldSpace() ? memoryObject.setOref((void *)&(r),(RexxObject *)v) : (RexxObject *)(r=v))
#else
#define OrefSet(o,r,v) memoryObject.checkSetOref((RexxObject *)o, (RexxObject **)&(r), (RexxObject *)v, __FILE__, __LINE__)
#endif
// forward declaration of commonly used classes
class RexxExpressionStack;
class RexxActivation;
class RexxObject;
class RexxClass;
class RexxDirectory;
class RexxIntegerClass;
class RexxArray;
class RexxMemory;
class RexxString;
/******************************************************************************/
/* Change EXTERN definition if not already created by GDATA */
/******************************************************************************/
#ifndef INITGLOBALPTR // if not the global, this is a NOP.
#define INITGLOBALPTR
#endif
#ifndef EXTERN
#define EXTERN extern /* turn into external definition */
#endif
#ifndef EXTERNMEM
#define EXTERNMEM extern /* turn into external definition */
#endif
/******************************************************************************/
/* Primitive Method Type Definition Macros */
/******************************************************************************/
/* following two are used by OKINIT */
/* to build the VFT Array. */
#define CLASS_EXTERNAL(b,c)
#define CLASS_INTERNAL(b,c)
#define koper(name) RexxObject *name(RexxObject *);
/******************************************************************************/
/* Global Objects - General */
/******************************************************************************/
// this one is special, and is truly global.
EXTERNMEM RexxMemory memoryObject; /* memory object */
// TODO: make these into statics inside classes.
#define TheArrayClass RexxArray::classInstance
#define TheClassClass RexxClass::classInstance
#define TheDirectoryClass RexxDirectory::classInstance
#define TheIntegerClass RexxInteger::classInstance
#define TheListClass RexxList::classInstance
#define TheMessageClass RexxMessage::classInstance
#define TheMethodClass RexxMethod::classInstance
#define TheRoutineClass RoutineClass::classInstance
#define ThePackageClass PackageClass::classInstance
#define TheRexxContextClass RexxContext::classInstance
#define TheNumberStringClass RexxNumberString::classInstance
#define TheObjectClass RexxObject::classInstance
#define TheQueueClass RexxQueue::classInstance
#define TheStemClass RexxStem::classInstance
#define TheStringClass RexxString::classInstance
#define TheMutableBufferClass RexxMutableBuffer::classInstance
#define TheSupplierClass RexxSupplier::classInstance
#define TheTableClass RexxTable::classInstance
#define TheIdentityTableClass RexxIdentityTable::classInstance
#define TheRelationClass RexxRelation::classInstance
#define ThePointerClass RexxPointer::classInstance
#define TheBufferClass RexxBuffer::classInstance
#define TheWeakReferenceClass WeakReference::classInstance
#define TheStackFrameClass StackFrameClass::classInstance
#define TheEnvironment RexxMemory::environment
#define TheStaticRequires RexxMemory::staticRequires
#define TheFunctionsDirectory RexxMemory::functionsDir
#define TheCommonRetrievers RexxMemory::commonRetrievers
#define TheKernel RexxMemory::kernel
#define TheSystem RexxMemory::system
#define TheNilObject RexxNilObject::nilObject
#define TheNullArray RexxArray::nullArray
#define TheFalseObject RexxInteger::falseObject
#define TheTrueObject RexxInteger::trueObject
#define TheNullPointer RexxPointer::nullPointer
#define IntegerZero RexxInteger::integerZero
#define IntegerOne RexxInteger::integerOne
#define IntegerTwo RexxInteger::integerTwo
#define IntegerThree RexxInteger::integerThree
#define IntegerFour RexxInteger::integerFour
#define IntegerFive RexxInteger::integerFive
#define IntegerSix RexxInteger::integerSix
#define IntegerSeven RexxInteger::integerSeven
#define IntegerEight RexxInteger::integerEight
#define IntegerNine RexxInteger::integerNine
#define IntegerMinusOne RexxInteger::integerMinusOne
#include "ClassTypeCodes.h"
/******************************************************************************/
/* Utility Macros */
/******************************************************************************/
#define RXROUNDUP(n,to) ((((n)+(to-1))/(to))*to)
#define rounddown(n,to) (((n)/(to))*to)
#define isOfClass(t,r) (r)->isObjectType(The##t##Behaviour)
#define isOfClassType(t,r) (r)->isObjectType(T_##t)
/******************************************************************************/
/* Utility Functions */
/******************************************************************************/
/* find an environment symbol */
#define env_find(s) (TheEnvironment->entry(s))
/******************************************************************************/
/* Thread constants */
/******************************************************************************/
#define NO_THREAD -1
/******************************************************************************/
/* Global Objects - Names */
/******************************************************************************/
#undef GLOBAL_NAME
#define GLOBAL_NAME(name, value) EXTERN RexxString * OREF_##name INITGLOBALPTR;
#include "GlobalNames.h"
#include "ObjectClass.hpp" /* get real definition of Object */
#include "TableClass.hpp"
#include "StackClass.hpp"
#include "RexxMemory.hpp" /* memory next, to get OrefSet */
#include "RexxBehaviour.hpp" /* now behaviours and */
#include "ClassClass.hpp" /* classes, which everything needs */
#include "RexxEnvelope.hpp" /* envelope is needed for flattens */
#include "RexxActivity.hpp" /* activity is needed for errors */
#include "NumberStringClass.hpp" /* added to make 'number_digits()' */
/* in 'ArrayClass.c' visible */
/******************************************************************************/
/* Method arguments special codes */
/******************************************************************************/
const size_t A_COUNT = 127; /* pass arguments as pointer/count pair */
/******************************************************************************/
/* Return codes */
/******************************************************************************/
const int RC_OK = 0;
const int RC_LOGIC_ERROR = 2;
const int POSITIVE = 1; /* integer must be positive */
const int NONNEGATIVE = 2; /* integer must be non-negative */
const int WHOLE = 3; /* integer must be whole */
// some very common class tests
inline bool isString(RexxObject *o) { return isOfClass(String, o); }
inline bool isInteger(RexxObject *o) { return isOfClass(Integer, o); }
inline bool isArray(RexxObject *o) { return isOfClass(Array, o); }
inline bool isStem(RexxObject *o) { return isOfClass(Stem, o); }
inline bool isActivation(RexxObject *o) { return isOfClass(Activation, o); }
inline bool isMethod(RexxObject *o) { return isOfClass(Method, o); }
#include "ActivityManager.hpp"
/* The next macro is specifically for REQUESTing a STRING, since there are */
/* four primitive classes that are equivalents for strings. It will trap on */
/* OREF_NULL. */
inline RexxString *REQUEST_STRING(RexxObject *object)
{
return (isOfClass(String, object) ? (RexxString *)object : (object)->requestString());
}
// The next routine checks for required arguments and raises a missing argument
// error for the given position.
inline void requiredArgument(RexxObject *object, size_t position)
{
if (object == OREF_NULL) /* missing argument? */
{
missingArgument(position); /* raise an error */
}
}
/* The next routine is specifically for REQUESTing a STRING needed as a method*/
/* argument. This raises an error if the object cannot be converted to a */
/* string value. */
inline RexxString * stringArgument(RexxObject *object, size_t position)
{
if (object == OREF_NULL) /* missing argument? */
{
missingArgument(position); /* raise an error */
}
/* force to a string value */
return object->requiredString(position);
}
/* The next routine is specifically for REQUESTing a STRING needed as a method*/
/* argument. This raises an error if the object cannot be converted to a */
/* string value. */
inline RexxString * stringArgument(RexxObject *object, const char *name)
{
if (object == OREF_NULL) /* missing argument? */
{
reportException(Error_Invalid_argument_noarg, name);
}
/* force to a string value */
return object->requiredString(name);
}
inline RexxString *optionalStringArgument(RexxObject *o, RexxString *d, size_t p)
{
return (o == OREF_NULL ? d : stringArgument(o, p));
}
inline RexxString *optionalStringArgument(RexxObject *o, RexxString *d, const char *p)
{
return (o == OREF_NULL ? d : stringArgument(o, p));
}
// resides in the string class util
size_t lengthArgument(RexxObject *o, size_t p);
inline size_t optionalLengthArgument(RexxObject *o, size_t d, size_t p)
{
return (o == OREF_NULL ? d : lengthArgument(o, p));
}
// resides in the string class util
size_t positionArgument(RexxObject *o, size_t p);
inline size_t optionalPositionArgument(RexxObject *o, size_t d, size_t p)
{
return (o == OREF_NULL ? d : positionArgument(o, p));
}
char padArgument(RexxObject *o, size_t p);
inline char optionalPadArgument(RexxObject *o, char d, size_t p)
{
return (o == OREF_NULL ? d : padArgument(o, p));
}
char optionArgument(RexxObject *o, size_t p);
inline char optionalOptionArgument(RexxObject *o, char d, size_t p)
{
return (o == OREF_NULL ? d : optionArgument(o, p));
}
inline size_t optionalNonNegative(RexxObject *o, size_t d, size_t p)
{
return (o == OREF_NULL ? d : o->requiredNonNegative(p));
}
inline size_t optionalPositive(RexxObject *o, size_t d, size_t p)
{
return (o == OREF_NULL ? d : o->requiredPositive(p));
}
/* The next routine is specifically for REQUESTing an ARRAY needed as a method*/
/* argument. This raises an error if the object cannot be converted to a */
/* single dimensional array item */
inline RexxArray *arrayArgument(RexxObject *object, size_t position)
{
if (object == OREF_NULL) /* missing argument? */
{
missingArgument(position); /* raise an error */
}
/* force to array form */
RexxArray *array = object->requestArray();
/* not an array? */
if (array == TheNilObject || array->getDimension() != 1)
{
/* raise an error */
reportException(Error_Execution_noarray, object);
}
return array;
}
inline RexxArray * arrayArgument(RexxObject *object, const char *name)
{
if (object == OREF_NULL) /* missing argument? */
{
reportException(Error_Invalid_argument_noarg, name);
}
/* force to array form */
RexxArray *array = object->requestArray();
/* not an array? */
if (array == TheNilObject || array->getDimension() != 1)
{
/* raise an error */
reportException(Error_Invalid_argument_noarray, name);
}
return array;
}
/* The next routine is specifically for REQUESTing a STRING needed as a method*/
/* argument. This raises an error if the object cannot be converted to a */
/* string value. */
inline void classArgument(RexxObject *object, RexxClass *clazz, const char *name)
{
if (object == OREF_NULL) /* missing argument? */
{
reportException(Error_Invalid_argument_noarg, name);
}
if (!object->isInstanceOf(clazz))
{
reportException(Error_Invalid_argument_noclass, name, clazz->getId());
}
}
/* The next macro is specifically for REQUESTing an ARRAY, since there are */
/* six primitive classes that can produce array equivalents. It will trap on */
/* OREF_NULL. */
inline RexxArray * REQUEST_ARRAY(RexxObject *obj) { return ((obj)->requestArray()); }
/* The next macro is specifically for REQUESTing an INTEGER, */
inline RexxInteger * REQUEST_INTEGER(RexxObject *obj) { return ((obj)->requestInteger(Numerics::ARGUMENT_DIGITS));}
/******************************************************************************/
/* Typed method invocation macros */
/******************************************************************************/
inline RexxObject * callOperatorMethod(RexxObject *object, size_t methodOffset, RexxObject *argument) {
/* get the entry point */
PCPPM cppEntry = object->behaviour->getOperatorMethod(methodOffset);
/* go issue the method */
return (object->*((PCPPM1)cppEntry))(argument);
}
#endif