summaryrefslogtreecommitdiff
path: root/MLKReader.m
blob: edf682fd25f2b539dda0821d08ba9a8595543ca7 (plain)
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
/* -*- mode: objc; coding: utf-8 -*- */
/* Étoilisp/Mulklisp, a Common Lisp subset for the Étoilé runtime.
 * Copyright (C) 2008  Matthias Andreas Benkard.
 *
 * This program 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 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#import "MLKReader.h"
#import "MLKCharacter.h"
#import "MLKReadtable.h"
#import "MLKEndOfFileError.h"
#import "MLKReaderError.h"
#import "MLKDynamicContext.h"
#import "MLKEnvironment.h"
#import "MLKPackage.h"
#import "MLKFuncallable.h"
#import "MLKStream.h"
#import "MLKFloat.h"
#import "MLKInteger.h"
#import "MLKRatio.h"
#import "MLKStringInputStream.h"
#import "runtime-compatibility.h"

#import <Foundation/NSArray.h>
#import <Foundation/NSRange.h>
#import <Foundation/NSSet.h>
#import <Foundation/NSString.h>


@implementation MLKReader
+(id) readFromStream:(MLKStream *)stream
            eofError:(BOOL)eofError
            eofValue:(id)eofValue
           recursive:(BOOL)recursive
  preserveWhitespace:(BOOL)preserveWhitespace
{
  unichar ch;
  NSMutableString *token;
  MLKReadtable *readtable;
  BOOL escaped;
  BOOL ever_escaped;

  ever_escaped = NO;

  readtable = [[MLKDynamicContext currentContext]
                valueForBinding:[[MLKPackage findPackage:@"COMMON-LISP"]
                                  intern:@"*READTABLE*"]];

 start:
  if ([stream isEOF])
    {
      if (eofError)
        [[[MLKEndOfFileError alloc] initWithStream:stream] raise];
      else
        return eofValue;
    }

  ch = [stream readChar];
  if ([readtable isWhitespaceCharacter:ch])
    goto start;
  
  if ([readtable isMacroCharacter:ch])
    {
      NSArray *returnValues;
      MLKFuncallable *macrofun = [readtable macroFunctionForCharacter:ch];
      NSArray *args = [NSArray arrayWithObjects:
                                 stream,
                                 [MLKCharacter characterWithUnichar:ch],
                               nil];
      if ([args count] != 2)
        {
          args = [NSMutableArray arrayWithCapacity:2];
          [((NSMutableArray*)args) addObject:stream];
          [((NSMutableArray*)args) addObject:[MLKCharacter
                                               characterWithUnichar:ch]];
        }
      returnValues = [macrofun applyToArray:args];
      if ([returnValues count])
        return ([returnValues objectAtIndex:0] == [NSNull null]
                ? nil
                : [returnValues objectAtIndex:0]);
      else
        goto start;
    }
  
  escaped = NO;
  
  if ([readtable isSingleEscapeCharacter:ch])
    {
      if ([stream isEOF])
        [[[MLKEndOfFileError alloc] initWithStream:stream] raise];

      token = [NSMutableString stringWithCapacity:8];
      [token appendFormat:@"%C", [stream readChar]];
      ever_escaped = YES;
    }

  if ([readtable isMultipleEscapeCharacter:ch])
    {
      token = [NSMutableString stringWithCapacity:8];
      escaped = YES;
      ever_escaped = YES;
    }

  if ([readtable isConstituentCharacter:ch])
    {
      //NSLog (@"--> Constituent");
      token = [NSMutableString stringWithCapacity:8];
      [token appendFormat:@"%C", [readtable charWithReadtableCase:ch]];
    }

  while (![stream isEOF])
    {
      //NSLog (@"...");
      ch = [stream readChar];
      if ([readtable isConstituentCharacter:ch] ||
          [readtable isNonTerminatingMacroCharacter:ch] ||
          (escaped && (![readtable isMultipleEscapeCharacter:ch]
                       && ![readtable isSingleEscapeCharacter:ch])))
        {
          if (escaped)
            [token appendFormat:@"%C", ch];
          else
            [token appendFormat:@"%C", [readtable charWithReadtableCase:ch]];
        }
      else if ([readtable isSingleEscapeCharacter:ch])
        {
          if ([stream isEOF])
            [[[MLKEndOfFileError alloc] initWithStream:stream] raise];
          
          [token appendFormat:@"%C", [stream readChar]];
          ever_escaped = YES;
        }
      else if ([readtable isMultipleEscapeCharacter:ch])
        {
          ever_escaped = YES;
          escaped = !escaped;
        }
      else if ([readtable isTerminatingMacroCharacter:ch])
        {
          [stream unreadChar:ch];
          break;
        }
      else if ([readtable isConstituentCharacter:ch]
               && [readtable isInvalid:ch])
        {
          //[[[MLKReaderError alloc] initWithStream:stream] raise];
          [NSException raise:@"MLKReaderError"
                       format:@"'%c' is an invalid constituent character.", ch];
        }
      else if ([readtable isWhitespaceCharacter:ch])
        {
          if (preserveWhitespace)
            [stream unreadChar:ch];
          break;
        }
    }

  //NSLog (@"--> Interpret token: %@", token);
  return [self interpretToken:token
               readtable:readtable
               escaped:ever_escaped];
}

+(BOOL) isPotentialNumber:(NSString *)token
                readtable:(MLKReadtable *)readtable
                     base:(int)base
{
  // Check whether the token is a potential number.
  //
  // See CLHS 2.3.1.1.
  unsigned long i;
  unichar first;

  // 1. Does it consist solely of characters allowed in a potential
  // number?
  for (i = 0; i < [token length]; i++)
    {
      unichar ch = [token characterAtIndex:i];
      if (!([readtable isDigit:ch inBase:base]
            || [readtable isSign:ch]
            || [readtable isRatioMarker:ch]
            || [readtable isDecimalPoint:ch]
            || ch == '^'
            || ch == '_'
            || ([readtable isNumberMarker:ch]
                // Adjacent number markers aren't to be considered number
                // markers at all.
                && (i == 0
                    || ![readtable
                          isNumberMarker:[token characterAtIndex:(i-1)]]))))
        return NO;
    }

  // 2. Does the token contain a digit?
  for (i = 0; i < [token length]; i++)
    {
      unichar ch = [token characterAtIndex:i];
      if ([readtable isDigit:ch inBase:base])
        goto digitFound;
    }
  return NO;

 digitFound:
  // 3. Is the first character okay?
  first = [token characterAtIndex:0];
  if (!([readtable isDigit:first inBase:base]
        || [readtable isSign:first]
        || [readtable isDecimalPoint:first]
        || first == '^'
        || first == '_'))
    return NO;

  // 4. Does the token not end with a sign?
  if ([readtable isSign:[token characterAtIndex:([token length]-1)]])
    return NO;

  return YES;
}

+(id) interpretToken:(NSString *)token
           readtable:(MLKReadtable *)readtable
             escaped:(BOOL)escaped
{
  int base;
  
  base = [[[MLKDynamicContext currentContext]
            valueForBinding:[[MLKPackage findPackage:@"COMMON-LISP"]
                              intern:@"*READ-BASE*"]]
           intValue];

  if (!escaped && [self isPotentialNumber:token readtable:readtable base:base])
    {
      unsigned long i, firstNum, secondNum, exponent, exponentMarkerPos;
      unichar sign, exponentSign;
      unichar firstSeparator, exponentMarker;
      BOOL negative;


      // Read the sign (if present).
      if ([readtable isSign:[token characterAtIndex:0]])
        {
          sign = [token characterAtIndex:0];
          i = 1;
          firstNum = 1;
        }
      else
        {
          i = 0;
          firstNum = 0;
        }

      negative = (firstNum > 0 && [readtable isMinusSign:sign]);
 
      while ((i < [token length])
             && [readtable isDecimalDigit:[token characterAtIndex:i]])
        i++;

      if (i == [token length])
        {
          //NSLog (@"...");
          return [MLKInteger integerWithString:
                               [token substringWithRange:
                                        NSMakeRange (firstNum, [token length] - firstNum)]
                             negative:negative
                             base:10];
        }

      firstSeparator = [token characterAtIndex:i];

      if (!([readtable isDecimalPoint:firstSeparator]
            || [readtable isExponentMarker:[token characterAtIndex:i]]))
        goto digits;

      i++;
      secondNum = i;

      if (i == [token length] && [readtable isDecimalPoint:firstSeparator])
        {
          //NSLog (@"+++");
          return [MLKInteger integerWithString:
                               [token substringWithRange:
                                        NSMakeRange (firstNum, [token length] - firstNum - 1)]
                             negative:negative
                             base:10];
        }
      else
        {
          // We're dealing with a floating point number.  Bah.  I hate
          // floating point numbers.
          if ([readtable isExponentMarker:firstSeparator])
            {
              exponentMarkerPos = i;
              if ([readtable isSign:[token characterAtIndex:i]])
                {
                  exponentSign = [token characterAtIndex:i];
                  i++;
                }
              else
                exponentSign = '+';

              exponent = i;

              while ((i < [token length])
                     && [readtable isDecimalDigit:[token characterAtIndex:i]])
                i++;

              //NSLog (@"...2");
              //NSLog (@"%@, %@",
              //       [token substringWithRange:NSMakeRange (firstNum, exponentMarkerPos - firstNum - 1)],
              //       [token substringFromIndex:exponent]);
              return [MLKFloat floatWithExponentMarker:firstSeparator
                               integerPart:[token substringWithRange:NSMakeRange(firstNum, exponentMarkerPos - firstNum - 1)]
                               negative:negative
                               fractionalPart:@""
                               exponent:[token substringFromIndex:exponent]
                               exponentNegative:(exponentSign == '-')];
            }
          else
            {
              while ((i < [token length])
                     && [readtable isDecimalDigit:[token characterAtIndex:i]])
                i++;
              
              if (i == [token length])
                {
                  //NSLog (@"...3");
                  //NSLog (@"%@, %@",
                  //       [token substringWithRange:NSMakeRange (firstNum, secondNum - firstNum - 1)],
                  //       [token substringFromIndex:secondNum]);
                  return [MLKFloat floatWithExponentMarker:firstSeparator
                                   integerPart:[token substringWithRange:NSMakeRange (firstNum, secondNum - firstNum - 1)]
                                   negative:negative
                                   fractionalPart:[token substringFromIndex:secondNum]
                                   exponent:@""
                                   exponentNegative:NO];
                }

              // Assume token[i] is an exponent marker.
              exponentMarkerPos = i;
              exponentMarker = [token characterAtIndex:i];
              i++;

              if ([readtable isSign:[token characterAtIndex:i]])
                {
                  exponentSign = [token characterAtIndex:i];
                  i++;
                }
              else
                exponentSign = '+';

              exponent = i;

              while ((i < [token length])
                     && [readtable isDecimalDigit:[token characterAtIndex:i]])
                i++;

              //NSLog (@"...4");
              //NSLog (@"%@, %@, %@",
              //       [token substringWithRange:NSMakeRange (firstNum, secondNum - firstNum - 1)],
              //       [token substringWithRange:NSMakeRange (secondNum, exponentMarkerPos - secondNum)],
              //       [token substringFromIndex:exponent]);
              return [MLKFloat floatWithExponentMarker:exponentMarker
                               integerPart:[token substringWithRange:NSMakeRange (firstNum, secondNum - firstNum - 1)]
                               negative:negative
                               fractionalPart:[token substringWithRange:NSMakeRange (secondNum, exponentMarkerPos - secondNum)]
                               exponent:[token substringFromIndex:exponent]
                               exponentNegative:(exponentSign == '-')];              
            }
        }

    digits:
      i = firstNum;
      while ((i < [token length])
             && [readtable isDigit:[token characterAtIndex:i] inBase:base])
        i++;

      if (i == [token length])
        {
          //NSLog (@"###");
          return [MLKInteger integerWithString:
                               [token substringWithRange:
                                        NSMakeRange (firstNum, [token length] - firstNum)]
                             negative:negative
                             base:base];
        }

      // Assume token[i] is a slash.
      i++;
      secondNum = i;

      //NSLog (@"RRR");
      //NSLog (@"n: %@", [token substringWithRange:
      //                          NSMakeRange (firstNum,
      //                                       secondNum - firstNum - 1)]);
      //NSLog (@"d: %@", [token substringFromIndex:secondNum]);
      return [MLKRatio ratioWithNumeratorString:
                         [token substringWithRange:
                                  NSMakeRange (firstNum,
                                               secondNum - firstNum - 1)]
                       denominatorString:[token substringFromIndex:secondNum]
                       negative:negative
                       base:base];
    }
  else
    {
      unsigned long i, packageMarker;
      MLKPackage *package;
      NSString *symbolName;
      MLKSymbol *symbol;

      // Look for the package marker.
      packageMarker = -1;
      for (i = 0; i < [token length]; i++)
        {
          if ([readtable isPackageMarker:[token characterAtIndex:i]])
            {
              packageMarker = i;
              break;
            }
        }

      // Extract the package and symbol name.
      if (packageMarker == -1)
        {
          package = [[MLKDynamicContext currentContext]
                      valueForBinding:[[MLKPackage
                                         findPackage:@"COMMON-LISP"]
                                        intern:@"*PACKAGE*"]];
          symbolName = token;
        }
      else if (packageMarker == 0)
        {
          package = [MLKPackage findPackage:@"KEYWORD"];
          symbolName = [token substringFromIndex:1];
        }
      else
        {
          package = [MLKPackage
                      findPackage:[token substringToIndex:packageMarker]];
          if ([readtable isPackageMarker:[token characterAtIndex:(i+1)]])
            symbolName = [token substringFromIndex:(packageMarker+2)];
          else
            {
              // A single package marker means we have to check whether
              // the symbol is external in the package.
              symbolName = [token substringFromIndex:(packageMarker+1)];
              symbol = [package intern:symbolName];
              if (![[package exportedSymbols] containsObject:symbol])
                [NSException raise:@"MLKReaderError"
                             format:@"Package %@ does not export symbol %@.",
                                    package, symbol];
            }
        }

      symbol = [package intern:symbolName];
      
      if (packageMarker == 0)
        {
          // Make keyword symbols self-evaluate.
          [[MLKDynamicContext globalContext] addValue:symbol forBinding:symbol];
        }

      return symbol;
    }
}

+(id) readFromString:(NSString *)string
{
  return [self readFromStream:[[MLKStringInputStream alloc]
                                initWithString:string]
               eofError:YES
               eofValue:nil
               recursive:NO
               preserveWhitespace:NO];
}
@end