oak-fsharp 0.0.11

High-performance incremental F# (F Sharp) parser for the oak ecosystem with flexible configuration, supporting functional programming and .NET ecosystem integration.
Documentation
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
use oak_core::{Source, Token, TokenType, UniversalElementRole, UniversalTokenRole};

pub type FSharpToken = Token<FSharpTokenType>;

/// F# token types
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum FSharpTokenType {
    /// Root node
    Root,
    /// Expression
    Expression,
    /// Whitespace
    Whitespace,
    /// Newline
    Newline,

    /// Identifier
    Identifier,
    /// Integer literal
    IntegerLiteral,
    /// Float literal
    FloatLiteral,
    /// String literal
    StringLiteral,
    /// Character literal
    CharLiteral,
    /// Boolean literal
    BooleanLiteral,
    /// Unit literal
    UnitLiteral,

    /// The 'let' keyword
    Let,
    /// The 'rec' keyword
    Rec,
    /// The 'and' keyword
    And,
    /// The 'in' keyword
    In,
    /// The 'if' keyword
    If,
    /// The 'then' keyword
    Then,
    /// The 'else' keyword
    Else,
    /// The 'elif' keyword
    Elif,
    /// The 'match' keyword
    Match,
    /// The 'with' keyword
    With,
    /// The 'when' keyword
    When,
    /// The 'function' keyword
    Function,
    /// The 'fun' keyword
    Fun,

    /// The 'type' keyword
    Type,
    /// The 'val' keyword
    Val,
    /// The 'mutable' keyword
    Mutable,
    /// The 'of' keyword
    Of,
    /// The 'as' keyword
    As,

    /// The 'module' keyword
    Module,
    /// The 'namespace' keyword
    Namespace,
    /// The 'open' keyword
    Open,

    /// The 'try' keyword
    Try,
    /// The 'finally' keyword
    Finally,
    /// The 'exception' keyword
    Exception,
    /// The 'raise' keyword
    Raise,
    /// The 'failwith' keyword
    Failwith,

    /// The 'for' keyword
    For,
    /// The 'to' keyword
    To,
    /// The 'downto' keyword
    Downto,
    /// The 'do' keyword
    Do,
    /// The 'done' keyword
    Done,
    /// The 'while' keyword
    While,
    /// The 'yield' keyword
    Yield,
    /// The 'return' keyword
    Return,

    /// The 'class' keyword
    Class,
    /// The 'interface' keyword
    Interface,
    /// The 'inherit' keyword
    Inherit,
    /// The 'abstract' keyword
    Abstract,
    /// The 'override' keyword
    Override,
    /// The 'default' keyword
    Default,
    /// The 'member' keyword
    Member,
    /// The 'static' keyword
    Static,
    /// The 'new' keyword
    New,

    /// The 'lazy' keyword
    Lazy,
    /// The 'async' keyword
    Async,
    /// The 'seq' keyword
    Seq,
    /// The 'use' keyword
    Use,
    /// The 'begin' keyword
    Begin,
    /// The 'end' keyword
    End,
    /// The 'struct' keyword
    Struct,
    /// The 'sig' keyword
    Sig,

    /// The 'true' keyword
    True,
    /// The 'false' keyword
    False,
    /// The 'null' keyword
    Null,
    /// The 'or' keyword
    Or,

    /// The 'public' keyword
    Public,
    /// The 'private' keyword
    Private,
    /// The 'internal' keyword
    Internal,

    /// The 'inline' keyword
    Inline,
    /// The 'extern' keyword
    Extern,
    /// The 'upcast' keyword
    Upcast,
    /// The 'downcast' keyword
    Downcast,
    /// The 'assert' keyword
    Assert,
    /// The 'global' keyword
    Global,
    /// The 'base' keyword
    Base,
    /// The 'this' keyword
    This,
    /// The 'void' keyword
    Void,
    /// The 'delegate' keyword
    Delegate,
    /// The 'select' keyword
    Select,

    /// The 'obj' keyword
    Obj,
    /// The 'unit' keyword
    Unit,
    /// The 'int' keyword
    Int,
    /// The 'float' keyword
    Float,
    /// The 'string' keyword
    String,
    /// The 'bool' keyword
    Bool,
    /// The 'char' keyword
    Char,
    /// The 'byte' keyword
    Byte,
    /// The 'sbyte' keyword
    SByte,
    /// The 'int16' keyword
    Int16,
    /// The 'uint16' keyword
    UInt16,
    /// The 'int32' keyword
    Int32,
    /// The 'uint32' keyword
    UInt32,
    /// The 'int64' keyword
    Int64,
    /// The 'uint64' keyword
    UInt64,
    /// The 'nativeint' keyword
    NativeInt,
    /// The 'unativeint' keyword
    UNativeInt,
    /// The 'decimal' keyword
    Decimal,
    /// The 'bigint' keyword
    BigInt,

    /// The '+' operator
    Plus,
    /// The '-' operator
    Minus,
    /// The '*' operator
    Star,
    /// The '/' operator
    Slash,
    /// The '%' operator
    Percent,
    /// The '**' operator
    StarStar,

    /// The '=' operator
    Equal,
    /// The '<>' operator
    NotEqual,
    /// The '<' operator
    LessThan,
    /// The '<=' operator
    LessEqual,
    /// The '>' operator
    GreaterThan,
    /// The '>=' operator
    GreaterEqual,

    /// The '&&' operator
    AndAnd,
    /// The '||' operator
    OrOr,
    /// The 'not' operator
    Not,

    /// The '&&&' operator
    BitwiseAnd,
    /// The '|||' operator
    BitwiseOr,
    /// The '^^^' operator
    BitwiseXor,
    /// The '~~~' operator
    BitwiseNot,
    /// The '<<<' operator
    LeftShift,
    /// The '>>>' operator
    RightShift,

    /// The '->' operator
    Arrow,
    /// The '=>' operator
    DoubleArrow,
    /// The '|' operator
    Pipe,
    /// The '|>' operator
    PipeRight,
    /// The '||' operator
    DoublePipe,
    /// The '::' operator
    Cons,
    /// The '@' operator
    At,
    /// The '>>' operator
    Compose,
    /// The '<<' operator
    ComposeBack,
    /// The '$' operator
    Dollar,
    /// The '|>' operator
    PipeForward,
    /// The '<|' operator
    PipeBackward,

    /// The '&&' logical operator
    LogicalAnd,
    /// The '||' logical operator
    LogicalOr,
    /// The '&' operator
    Ampersand,
    /// The '^' operator
    Caret,
    /// The '~' operator
    Tilde,
    /// The '<' operator
    Less,
    /// The '>' operator
    Greater,
    /// The '|>' operator
    PipeGreater,
    /// The '!' operator
    Exclamation,
    /// The ':=' operator
    ColonEqual,
    /// The '<-' operator
    LArrow,
    /// The '++' operator
    PlusPlus,
    /// The '--' operator
    MinusMinus,

    /// The '(' delimiter
    LeftParen,
    /// The ')' delimiter
    RightParen,
    /// The '[' delimiter
    LeftBracket,
    /// The ']' delimiter
    RightBracket,
    /// The '[|' delimiter
    LeftArrayBracket,
    /// The '|]' delimiter
    RightArrayBracket,
    /// The '[<' delimiter
    LeftBracketBar,
    /// The '>]' delimiter
    RightBracketBar,
    /// The '[ <' delimiter
    LeftBracketAngle,
    /// The '> ]' delimiter
    RightBracketAngle,
    /// The '{' delimiter
    LeftBrace,
    /// The '}' delimiter
    RightBrace,
    /// The '<' delimiter
    LeftAngle,
    /// The '>' delimiter
    RightAngle,

    /// The ',' punctuation
    Comma,
    /// The ';' punctuation
    Semicolon,
    /// The ':' punctuation
    Colon,
    /// The '::' punctuation
    DoubleColon,
    /// The '.' punctuation
    Dot,
    /// The '..' punctuation
    DotDot,
    /// The '?' punctuation
    Question,
    /// The '_' punctuation
    Underscore,
    /// The ''' punctuation
    Apostrophe,
    /// The '`' punctuation
    Backtick,
    /// The '#' punctuation
    Hash,

    /// Line comment
    LineComment,
    /// Block comment
    BlockComment,

    /// Error
    Error,
    /// End of file
    Eof,
}

impl FSharpTokenType {
    /// Checks if it is a keyword
    pub fn is_keyword(&self) -> bool {
        matches!(
            self,
            Self::Let
                | Self::Rec
                | Self::And
                | Self::In
                | Self::If
                | Self::Then
                | Self::Else
                | Self::Elif
                | Self::Match
                | Self::With
                | Self::When
                | Self::Function
                | Self::Fun
                | Self::Type
                | Self::Val
                | Self::Mutable
                | Self::Of
                | Self::As
                | Self::Module
                | Self::Namespace
                | Self::Open
                | Self::Try
                | Self::Finally
                | Self::Exception
                | Self::Raise
                | Self::Failwith
                | Self::For
                | Self::To
                | Self::Downto
                | Self::Do
                | Self::Done
                | Self::While
                | Self::Yield
                | Self::Return
                | Self::Class
                | Self::Interface
                | Self::Inherit
                | Self::Abstract
                | Self::Override
                | Self::Default
                | Self::Member
                | Self::Static
                | Self::New
                | Self::Lazy
                | Self::Async
                | Self::Seq
                | Self::Use
                | Self::Begin
                | Self::End
                | Self::Struct
                | Self::Sig
                | Self::True
                | Self::False
                | Self::Null
                | Self::Or
                | Self::Public
                | Self::Private
                | Self::Internal
                | Self::Inline
                | Self::Extern
                | Self::Upcast
                | Self::Downcast
                | Self::Assert
                | Self::Delegate
                | Self::Select
        )
    }
}

impl TokenType for FSharpTokenType {
    type Role = UniversalTokenRole;
    const END_OF_STREAM: Self = Self::Eof;

    fn is_ignored(&self) -> bool {
        matches!(self, Self::Whitespace | Self::Newline | Self::LineComment | Self::BlockComment)
    }

    fn role(&self) -> Self::Role {
        match self {
            Self::Error => UniversalTokenRole::Error,
            _ if self.is_keyword() => UniversalTokenRole::Keyword,
            Self::Identifier => UniversalTokenRole::Name,
            Self::IntegerLiteral | Self::FloatLiteral | Self::StringLiteral | Self::CharLiteral | Self::BooleanLiteral => UniversalTokenRole::Literal,
            _ => UniversalTokenRole::None,
        }
    }
}