File: SyntaxOptions.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (87 lines) | stat: -rw-r--r-- 2,770 bytes parent folder | download
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2021-2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//


public struct SyntaxOptions: OptionSet {
  public var rawValue: UInt
  public init(rawValue: UInt) { self.rawValue = rawValue }

  private init(_ rawValue: UInt) {
    self.init(rawValue: rawValue)
  }

  public init() { self.init(0) }

  /// `'a \. b' == '/a\.b/'`
  public static var nonSemanticWhitespace: Self { Self(1 << 0) }

  /// `abc # comment`
  public static var endOfLineComments: Self { Self(1 << 1) }

  /// `(?x)` `(?xx)`
  public static var extendedSyntax: Self {
    [.endOfLineComments, .nonSemanticWhitespace]
  }

  // NOTE: Currently, this means we have raw quotes.
  // Better would be to have real Swift string delimiter parsing logic.

  /// `'a "." b' == '/a\Q.\Eb/'`
  public static var experimentalQuotes: Self { Self(1 << 2) }

  // NOTE: traditional comments are not nested. Currently, we are neither.
  // Traditional comments can't have `)`, not even escaped in them either, we
  // can. Traditional comments can have `*/` in them, we can't without
  // escaping. We don't currently do escaping.

  /// `'a /* comment */ b' == '/a(?#. comment )b/'`
  public static var experimentalComments: Self { Self(1 << 3) }

  /// ```
  /// 'a{n...m}' == '/a{n,m}/'
  /// 'a{n..<m}' == '/a{n,m-1}/'
  /// 'a{n...}'  == '/a{n,}/'
  /// 'a{...m}'  == '/a{,m}/'
  /// 'a{..<m}'  == '/a{,m-1}/'
  /// ```
  public static var experimentalRanges: Self { Self(1 << 4) }

  /// `(name: .*)` == `(?<name>.*)`
  /// `(_: .*)` == `(?:.*)`
  public static var experimentalCaptures: Self { Self(1 << 5) }

  /// The syntax kind of a multi-line literal. This will always be set when
  /// parsing a multi-line `#/.../#` literal. Note this does not imply extended
  /// syntax, as that may be temporarily disabled while parsing.
  public static var multilineCompilerLiteral: Self { Self(1 << 6) }

  /// `(?n)`
  public static var namedCapturesOnly: Self { Self(1 << 7) }

  /*

    /// `<digit>*` == `[[:digit:]]*` == `\d*`
    public static var experimentalConsumers

  */

  public static var traditional: Self { Self(0) }

  public static var experimental: Self {
    [.nonSemanticWhitespace, .experimentalQuotes, .experimentalComments,
     .experimentalRanges, .experimentalCaptures]
  }

  // TODO: Probably want to model strict-PCRE etc. options too.
  // E.g. [abc&&b] is [b] in Oniguruma/UTS18 or [abc&] in PCRE
}