-
Notifications
You must be signed in to change notification settings - Fork 632
/
Copy pathocaml.c
2084 lines (1837 loc) · 45.2 KB
/
ocaml.c
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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2009, Vincent Berthoux
*
* This source code is released for free distribution under the terms of the
* GNU General Public License version 2 or (at your option) any later version.
*
* This module contains functions for generating tags for Objective Caml
* language files.
*/
/*
* INCLUDE FILES
*/
#include "general.h" /* must always come first */
#include <string.h>
#include "debug.h"
#include "entry.h"
#include "keyword.h"
#include "options.h"
#include "parse.h"
#include "read.h"
#include "routines.h"
#include "vstring.h"
#define OCAML_MAX_STACK_SIZE 256
typedef enum {
K_CLASS, /* OCaml class, relatively rare */
K_METHOD, /* class method */
K_MODULE, /* OCaml module OR functor */
K_VARIABLE,
K_VAL,
K_TYPE, /* name of an OCaml type */
K_FUNCTION,
K_CONSTRUCTOR, /* Constructor of a sum type */
K_RECORDFIELD,
K_EXCEPTION,
} ocamlKind;
static kindDefinition OcamlKinds[] = {
{true, 'c', "class", "classes"},
{true, 'm', "method", "Object's method"},
{true, 'M', "module", "Module or functor"},
{true, 'v', "var", "Global variable"},
{true, 'p', "val", "Signature item"},
{true, 't', "type", "Type name"},
{true, 'f', "function", "A function"},
{true, 'C', "Constructor", "A constructor"},
{true, 'r', "RecordField", "A 'structure' field"},
{true, 'e', "Exception", "An exception"},
};
typedef enum {
OcaKEYWORD_and,
OcaKEYWORD_begin,
OcaKEYWORD_class,
OcaKEYWORD_do,
OcaKEYWORD_done,
OcaKEYWORD_else,
OcaKEYWORD_end,
OcaKEYWORD_exception,
OcaKEYWORD_for,
OcaKEYWORD_functor,
OcaKEYWORD_fun,
OcaKEYWORD_function,
OcaKEYWORD_if,
OcaKEYWORD_in,
OcaKEYWORD_let,
OcaKEYWORD_value,
OcaKEYWORD_match,
OcaKEYWORD_method,
OcaKEYWORD_module,
OcaKEYWORD_mutable,
OcaKEYWORD_object,
OcaKEYWORD_of,
OcaKEYWORD_rec,
OcaKEYWORD_sig,
OcaKEYWORD_struct,
OcaKEYWORD_then,
OcaKEYWORD_try,
OcaKEYWORD_type,
OcaKEYWORD_val,
OcaKEYWORD_virtual,
OcaKEYWORD_while,
OcaKEYWORD_with,
OcaIDENTIFIER,
Tok_PARL, /* '(' */
Tok_PARR, /* ')' */
Tok_BRL, /* '[' */
Tok_BRR, /* ']' */
Tok_CurlL, /* '{' */
Tok_CurlR, /* '}' */
Tok_Prime, /* '\'' */
Tok_Pipe, /* '|' */
Tok_EQ, /* '=' */
Tok_Val, /* string/number/poo */
Tok_Op, /* any operator recognized by the language */
Tok_semi, /* ';' */
Tok_comma, /* ',' */
Tok_To, /* '->' */
Tok_Of, /* ':' */
Tok_Sharp, /* '#' */
Tok_Backslash, /* '\\' */
Tok_EOF /* END of file */
} ocamlKeyword;
typedef struct sOcaKeywordDesc {
const char *name;
ocamlKeyword id;
} ocaKeywordDesc;
typedef ocamlKeyword ocaToken;
static const keywordTable OcamlKeywordTable[] = {
{ "and" , OcaKEYWORD_and },
{ "begin" , OcaKEYWORD_begin },
{ "class" , OcaKEYWORD_class },
{ "do" , OcaKEYWORD_do },
{ "done" , OcaKEYWORD_done },
{ "else" , OcaKEYWORD_else },
{ "end" , OcaKEYWORD_end },
{ "exception" , OcaKEYWORD_exception },
{ "for" , OcaKEYWORD_for },
{ "fun" , OcaKEYWORD_fun },
{ "function" , OcaKEYWORD_fun },
{ "functor" , OcaKEYWORD_functor },
{ "if" , OcaKEYWORD_if },
{ "in" , OcaKEYWORD_in },
{ "let" , OcaKEYWORD_let },
{ "match" , OcaKEYWORD_match },
{ "method" , OcaKEYWORD_method },
{ "module" , OcaKEYWORD_module },
{ "mutable" , OcaKEYWORD_mutable },
{ "object" , OcaKEYWORD_object },
{ "of" , OcaKEYWORD_of },
{ "rec" , OcaKEYWORD_rec },
{ "sig" , OcaKEYWORD_sig },
{ "struct" , OcaKEYWORD_struct },
{ "then" , OcaKEYWORD_then },
{ "try" , OcaKEYWORD_try },
{ "type" , OcaKEYWORD_type },
{ "val" , OcaKEYWORD_val },
{ "value" , OcaKEYWORD_value }, /* just to handle revised syntax */
{ "virtual" , OcaKEYWORD_virtual },
{ "while" , OcaKEYWORD_while },
{ "with" , OcaKEYWORD_with },
{ "or" , Tok_Op },
{ "mod " , Tok_Op },
{ "land " , Tok_Op },
{ "lor " , Tok_Op },
{ "lxor " , Tok_Op },
{ "lsl " , Tok_Op },
{ "lsr " , Tok_Op },
{ "asr" , Tok_Op },
{ "->" , Tok_To },
{ ":" , Tok_Of },
{ "true" , Tok_Val },
{ "false" , Tok_Val }
};
static langType Lang_Ocaml;
static bool exportLocalInfo = false;
/*//////////////////////////////////////////////////////////////////
//// lexingInit */
typedef struct _lexingState {
vString *name; /* current parsed identifier/operator */
const unsigned char *cp; /* position in stream */
} lexingState;
/* array of the size of all possible value for a char */
static bool isOperator[1 << (8 * sizeof (char))] = { false };
/* definition of all the operator in OCaml,
* /!\ certain operator get special treatment
* in regards of their role in OCaml grammar :
* '|' ':' '=' '~' and '?' */
static void initOperatorTable ( void )
{
isOperator['!'] = true;
isOperator['$'] = true;
isOperator['%'] = true;
isOperator['&'] = true;
isOperator['*'] = true;
isOperator['+'] = true;
isOperator['-'] = true;
isOperator['.'] = true;
isOperator['/'] = true;
isOperator[':'] = true;
isOperator['<'] = true;
isOperator['='] = true;
isOperator['>'] = true;
isOperator['?'] = true;
isOperator['@'] = true;
isOperator['^'] = true;
isOperator['~'] = true;
isOperator['|'] = true;
}
/*//////////////////////////////////////////////////////////////////////
//// Lexing */
static bool isNum (char c)
{
return c >= '0' && c <= '9';
}
static bool isLowerAlpha (char c)
{
return c >= 'a' && c <= 'z';
}
static bool isUpperAlpha (char c)
{
return c >= 'A' && c <= 'Z';
}
static bool isAlpha (char c)
{
return isLowerAlpha (c) || isUpperAlpha (c);
}
static bool isIdent (char c)
{
return isNum (c) || isAlpha (c) || c == '_' || c == '\'';
}
static bool isSpace (char c)
{
return c == ' ' || c == '\t' || c == '\r' || c == '\n';
}
static void eatWhiteSpace (lexingState * st)
{
const unsigned char *cp = st->cp;
while (isSpace (*cp))
cp++;
st->cp = cp;
}
static void eatString (lexingState * st)
{
bool lastIsBackSlash = false;
bool unfinished = true;
const unsigned char *c = st->cp + 1;
while (unfinished)
{
/* end of line should never happen.
* we tolerate it */
if (c == NULL || c[0] == '\0')
break;
else if (*c == '"' && !lastIsBackSlash)
unfinished = false;
else
lastIsBackSlash = *c == '\\';
c++;
}
st->cp = c;
}
static void eatComment (lexingState * st)
{
bool unfinished = true;
bool lastIsStar = false;
const unsigned char *c = st->cp + 2;
while (unfinished)
{
/* we've reached the end of the line..
* so we have to reload a line... */
if (c == NULL || *c == '\0')
{
st->cp = readLineFromInputFile ();
/* WOOPS... no more input...
* we return, next lexing read
* will be null and ok */
if (st->cp == NULL)
return;
c = st->cp;
}
/* we've reached the end of the comment */
else if (*c == ')' && lastIsStar)
{
unfinished = false;
c++;
}
/* here we deal with imbricated comment, which
* are allowed in OCaml */
else if (c[0] == '(' && c[1] == '*')
{
st->cp = c;
eatComment (st);
c = st->cp;
if (c == NULL)
return;
lastIsStar = false;
c++;
}
/* OCaml has a rule which says :
*
* "Comments do not occur inside string or character literals.
* Nested comments are handled correctly."
*
* So if we encounter a string beginning, we must parse it to
* get a good comment nesting (bug ID: 3117537)
*/
else if (*c == '"')
{
st->cp = c;
eatString (st);
c = st->cp;
}
else
{
lastIsStar = '*' == *c;
c++;
}
}
st->cp = c;
}
static void readIdentifier (lexingState * st)
{
const unsigned char *p;
vStringClear (st->name);
/* first char is a simple letter */
if (isAlpha (*st->cp) || *st->cp == '_')
vStringPut (st->name, *st->cp);
/* Go till you get identifier chars */
for (p = st->cp + 1; isIdent (*p); p++)
vStringPut (st->name, *p);
st->cp = p;
}
static ocamlKeyword eatNumber (lexingState * st)
{
while (isNum (*st->cp))
st->cp++;
return Tok_Val;
}
/* Operator can be defined in OCaml as a function
* so we must be ample enough to parse them normally */
static ocamlKeyword eatOperator (lexingState * st)
{
int count = 0;
const unsigned char *root = st->cp;
vStringClear (st->name);
while (isOperator[st->cp[count]])
{
vStringPut (st->name, st->cp[count]);
count++;
}
st->cp += count;
if (count <= 1)
{
switch (root[0])
{
case '|':
return Tok_Pipe;
case '=':
return Tok_EQ;
case ':':
return Tok_Of;
default:
return Tok_Op;
}
}
else if (count == 2 && root[0] == '-' && root[1] == '>')
return Tok_To;
else if (count == 2 && root[0] == '|' && root[1] == '>')
return Tok_Op;
else
return Tok_Op;
}
/* The lexer is in charge of reading the file.
* Some of sub-lexer (like eatComment) also read file.
* lexing is finished when the lexer return Tok_EOF */
static ocamlKeyword lex (lexingState * st)
{
int retType;
/* handling data input here */
while (st->cp == NULL || st->cp[0] == '\0')
{
st->cp = readLineFromInputFile ();
if (st->cp == NULL)
return Tok_EOF;
}
if (isAlpha (*st->cp))
{
readIdentifier (st);
retType = lookupKeyword (vStringValue (st->name), Lang_Ocaml);
if (retType == -1) /* If it's not a keyword */
{
return OcaIDENTIFIER;
}
else
{
return retType;
}
}
else if (isNum (*st->cp))
return eatNumber (st);
else if (isSpace (*st->cp))
{
eatWhiteSpace (st);
return lex (st);
}
else if (*st->cp == '_')
{ // special
readIdentifier (st);
return Tok_Val;
}
/* OCaml permit the definition of our own operators
* so here we check all the consecutive chars which
* are operators to discard them. */
else if (isOperator[*st->cp])
return eatOperator (st);
else
{
switch (*st->cp)
{
case '(':
if (st->cp[1] == '*') /* ergl, a comment */
{
eatComment (st);
return lex (st);
}
else
{
st->cp++;
return Tok_PARL;
}
case ')':
st->cp++;
return Tok_PARR;
case '[':
st->cp++;
return Tok_BRL;
case ']':
st->cp++;
return Tok_BRR;
case '{':
st->cp++;
return Tok_CurlL;
case '}':
st->cp++;
return Tok_CurlR;
case '\'':
st->cp++;
return Tok_Prime;
case ',':
st->cp++;
return Tok_comma;
case '=':
st->cp++;
return Tok_EQ;
case ';':
st->cp++;
return Tok_semi;
case '"':
eatString (st);
return Tok_Val;
case '#':
st->cp++;
return Tok_Sharp;
case '\\':
st->cp++;
return Tok_Backslash;
default:
st->cp++;
break;
}
}
/* default return if nothing is recognized,
* shouldn't happen, but at least, it will
* be handled without destroying the parsing. */
return Tok_Val;
}
/*//////////////////////////////////////////////////////////////////////
//// Parsing */
typedef void (*parseNext) (vString * const ident, ocaToken what, ocaToken whatNext);
/********** Helpers */
/* This variable hold the 'parser' which is going to
* handle the next token */
static parseNext toDoNext;
/* Special variable used by parser eater to
* determine which action to put after their
* job is finished. */
static parseNext comeAfter;
/* If a token put an end to current declaration/
* statement */
static ocaToken terminatingToken;
/* Token to be searched by the different
* parser eater. */
static ocaToken waitedToken;
/* name of the last class, used for
* context stacking. */
static vString *lastClass;
typedef enum _sContextKind {
ContextStrong,
ContextSoft
} contextKind;
typedef enum _sContextType {
ContextType,
ContextModule,
ContextClass,
ContextValue,
ContextFunction,
ContextMethod,
ContextBlock,
ContextMatch
} contextType;
typedef struct _sOcamlContext {
contextKind kind; /* well if the context is strong or not */
contextType type;
parseNext callback; /* what to do when a context is pop'd */
vString *contextName; /* name, if any, of the surrounding context */
} ocamlContext;
/* context stack, can be used to output scope information
* into the tag file. */
static ocamlContext stack[OCAML_MAX_STACK_SIZE];
/* current position in the tag */
static int stackIndex;
/* special function, often recalled, so putting it here */
static void globalScope (vString * const ident, ocaToken what, ocaToken whatNext);
/* Return : index of the last named context if one
* is found, -1 otherwise */
static int getLastNamedIndex ( void )
{
int i;
for (i = stackIndex - 1; i >= 0; --i)
{
if (vStringLength (stack[i].contextName) > 0)
{
return i;
}
}
return -1;
}
static int contextDescription (contextType t)
{
switch (t)
{
case ContextFunction:
return K_FUNCTION;
case ContextMethod:
return K_METHOD;
case ContextValue:
return K_VAL;
case ContextModule:
return K_MODULE;
case ContextType:
return K_TYPE;
case ContextClass:
return K_CLASS;
default:
AssertNotReached();
return KIND_GHOST_INDEX;
}
}
static char contextTypeSuffix (contextType t)
{
switch (t)
{
case ContextFunction:
case ContextMethod:
case ContextValue:
case ContextModule:
return '/';
case ContextType:
return '.';
case ContextClass:
return '#';
case ContextBlock:
return ' ';
case ContextMatch:
return '|';
default:
return '$';
}
}
/* Push a new context, handle null string */
static void pushContext (contextKind kind, contextType type, parseNext after,
vString const *contextName)
{
int parentIndex;
if (stackIndex >= OCAML_MAX_STACK_SIZE)
{
verbose ("OCaml Maximum depth reached");
return;
}
stack[stackIndex].kind = kind;
stack[stackIndex].type = type;
stack[stackIndex].callback = after;
parentIndex = getLastNamedIndex ();
if (contextName == NULL)
{
vStringClear (stack[stackIndex++].contextName);
return;
}
if (parentIndex >= 0)
{
vStringCopy (stack[stackIndex].contextName,
stack[parentIndex].contextName);
vStringPut (stack[stackIndex].contextName,
contextTypeSuffix (stack[parentIndex].type));
vStringCat (stack[stackIndex].contextName, contextName);
}
else
vStringCopy (stack[stackIndex].contextName, contextName);
stackIndex++;
}
static void pushStrongContext (vString * name, contextType type)
{
pushContext (ContextStrong, type, &globalScope, name);
}
static void pushSoftContext (parseNext continuation,
vString * name, contextType type)
{
pushContext (ContextSoft, type, continuation, name);
}
static void pushEmptyContext (parseNext continuation)
{
pushContext (ContextSoft, ContextValue, continuation, NULL);
}
/* unroll the stack until the last named context.
* then discard it. Used to handle the :
* let f x y = ...
* in ...
* where the context is reseted after the in. Context may have
* been really nested before that. */
static void popLastNamed ( void )
{
int i = getLastNamedIndex ();
if (i >= 0)
{
stackIndex = i;
toDoNext = stack[i].callback;
vStringClear (stack[i].contextName);
}
else
{
/* ok, no named context found...
* (should not happen). */
stackIndex = 0;
toDoNext = &globalScope;
}
}
/* pop a context without regarding it's content
* (beside handling empty stack case) */
static void popSoftContext ( void )
{
if (stackIndex <= 0)
{
toDoNext = &globalScope;
}
else
{
stackIndex--;
toDoNext = stack[stackIndex].callback;
vStringClear (stack[stackIndex].contextName);
}
}
/* Reset everything until the last global space.
* a strong context can be :
* - module
* - class definition
* - the initial global space
* - a _global_ declaration (let at global scope or in a module).
* Created to exit quickly deeply nested context */
static contextType popStrongContext ( void )
{
int i;
for (i = stackIndex - 1; i >= 0; --i)
{
if (stack[i].kind == ContextStrong)
{
stackIndex = i;
toDoNext = stack[i].callback;
vStringClear (stack[i].contextName);
return stack[i].type;
}
}
/* ok, no strong context found... */
stackIndex = 0;
toDoNext = &globalScope;
return -1;
}
/* Reset everything before the last match. */
static void jumpToMatchContext ( void )
{
int i;
for (i = stackIndex - 1; i >= 0; --i)
{
if (stack[i].type == ContextMatch)
{
stackIndex = i + 1;
toDoNext = stack[i].callback; // this should always be
// matchPattern
stack[i + 1].callback = NULL;
vStringClear (stack[i + 1].contextName);
return;
}
}
}
/* Ignore everything till waitedToken and jump to comeAfter.
* If the "end" keyword is encountered break, doesn't remember
* why though. */
static void tillToken (vString * const ident CTAGS_ATTR_UNUSED, ocaToken what, ocaToken whatNext CTAGS_ATTR_UNUSED)
{
if (what == waitedToken)
toDoNext = comeAfter;
else if (what == OcaKEYWORD_end)
{
popStrongContext ();
toDoNext = &globalScope;
}
}
/* Ignore everything till a waitedToken is seen, but
* take care of balanced parentheses/bracket use */
static void contextualTillToken (vString * const ident, ocaToken what, ocaToken whatNext)
{
static int parentheses = 0;
static int bracket = 0;
static int curly = 0;
switch (what)
{
case Tok_PARL:
parentheses--;
break;
case Tok_PARR:
parentheses++;
break;
case Tok_CurlL:
curly--;
break;
case Tok_CurlR:
curly++;
break;
case Tok_BRL:
bracket--;
break;
case Tok_BRR:
bracket++;
break;
default: /* other token are ignored */
break;
}
if (what == waitedToken && parentheses == 0 && bracket == 0 && curly == 0)
toDoNext = comeAfter;
else if (what == OcaKEYWORD_end)
globalScope (ident, what, whatNext);
}
/* Wait for waitedToken and jump to comeAfter or let
* the globalScope handle declarations */
static void tillTokenOrFallback (vString * const ident, ocaToken what, ocaToken whatNext)
{
if (what == waitedToken)
toDoNext = comeAfter;
else
globalScope (ident, what, whatNext);
}
/* ignore token till waitedToken, or give up if find
* terminatingToken. Use globalScope to handle new
* declarations. */
static void tillTokenOrTerminatingOrFallback (vString * const ident, ocaToken what, ocaToken whatNext)
{
if (what == waitedToken)
toDoNext = comeAfter;
else if (what == terminatingToken)
toDoNext = globalScope;
else
globalScope (ident, what, whatNext);
}
/* ignore the next token in the stream and jump to the
* given comeAfter state */
static void ignoreToken (vString * const ident CTAGS_ATTR_UNUSED, ocaToken what CTAGS_ATTR_UNUSED, ocaToken whatNext CTAGS_ATTR_UNUSED)
{
toDoNext = comeAfter;
}
/********** Grammar */
/* the purpose of each function is detailed near their
* implementation */
static contextType killCurrentState ( void )
{
contextType popped = popStrongContext ();
/* Tracking the kind of previous strong
* context, if it doesn't match with a
* really strong entity, repop */
switch (popped)
{
case ContextValue:
popped = popStrongContext ();
break;
case ContextFunction:
popped = popStrongContext ();
break;
case ContextMethod:
popped = popStrongContext ();
break;
case ContextType:
popped = popStrongContext ();
break;
case ContextMatch:
popped = popStrongContext ();
break;
case ContextBlock:
break;
case ContextModule:
break;
case ContextClass:
break;
default:
/* nothing more */
break;
}
return popped;
}
/* Keep track of our _true_ line number and file pos,
* as the lookahead token gives us false values. */
static unsigned long ocaLineNumber;
static MIOPos ocaFilePosition;
/* Used to prepare an OCaml tag, just in case there is a need to
* add additional information to the tag. */
static void prepareTag (tagEntryInfo * tag, vString const *name, int kind)
{
int parentIndex;
initTagEntry (tag, vStringValue (name), kind);
/* Ripped out of read.h initTagEntry, because of line number
* shenanigans.
* Ugh. Lookahead is harder than I expected. */
updateTagLine(tag, ocaLineNumber, ocaFilePosition);
parentIndex = getLastNamedIndex ();
if (parentIndex >= 0)
{
tag->extensionFields.scopeKindIndex =
contextDescription (stack[parentIndex].type);
tag->extensionFields.scopeName =
vStringValue (stack[parentIndex].contextName);
}
}
/* Used to centralise tag creation, and be able to add
* more information to it in the future */
static void addTag (vString * const ident, int kind)
{
if (OcamlKinds [kind].enabled && ident != NULL && vStringLength (ident) > 0)
{
tagEntryInfo toCreate;
prepareTag (&toCreate, ident, kind);
makeTagEntry (&toCreate);
}
}
static bool needStrongPoping = false;
static void requestStrongPoping ( void )
{
needStrongPoping = true;
}
static void cleanupPreviousParser ( void )
{
if (needStrongPoping)
{
needStrongPoping = false;
popStrongContext ();
}
}
/* Due to some circular dependencies, the following functions
* must be forward-declared. */
static void letParam (vString * const ident, ocaToken what, ocaToken whatNext);
static void localScope (vString * const ident, ocaToken what, ocaToken whatNext);
static void mayRedeclare (vString * const ident, ocaToken what, ocaToken whatNext);
static void typeSpecification (vString * const ident, ocaToken what, ocaToken whatNext);
/*
* Parse a record type
* type ident = // parsed previously
* {
* ident1: type1;
* ident2: type2;
* }
*/
static void typeRecord (vString * const ident, ocaToken what, ocaToken whatNext CTAGS_ATTR_UNUSED)
{
switch (what)
{
case OcaIDENTIFIER:
addTag (ident, K_RECORDFIELD);
terminatingToken = Tok_CurlR;
waitedToken = Tok_semi;
comeAfter = &typeRecord;
toDoNext = &tillTokenOrTerminatingOrFallback;
break;
case OcaKEYWORD_mutable:
/* ignore it */
break;
case Tok_CurlR:
popStrongContext ();
// don't pop the module context when going to another expression
needStrongPoping = false;
toDoNext = &globalScope;
break;
default: /* don't care */
break;
}
}
/* handle :
* exception ExceptionName of ... */
static void exceptionDecl (vString * const ident, ocaToken what, ocaToken whatNext)
{
if (what == OcaIDENTIFIER)
{
addTag (ident, K_EXCEPTION);
}
else /* probably ill-formed, give back to global scope */
{
globalScope (ident, what, whatNext);
}
toDoNext = &globalScope;
}
static tagEntryInfo tempTag;
static vString *tempIdent;