File: PrettyPrinter.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 (166 lines) | stat: -rw-r--r-- 4,891 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
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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

/// State used when to pretty-printing regex ASTs.
public struct PrettyPrinter {
  // Configuration

  /// The maximum number number of levels, from the root of the tree,
  /// at which to perform pattern conversion.
  ///
  /// A `nil` value indicates that there is no maximum,
  /// and pattern conversion always takes place.
  public var maxTopDownLevels: Int?

  /// The maximum number number of levels, from the leaf nodes of the tree,
  /// at which to perform pattern conversion.
  ///
  /// A `nil` value indicates that there is no maximum,
  /// and pattern conversion always takes place.
  public var minBottomUpLevels: Int?

  /// The number of spaces used for indentation.
  public var indentWidth = 2

  // Internal state

  // The output string we're building up
  fileprivate var result = ""

  // Whether next print needs to indent
  fileprivate var startOfLine = true

  // The indentation level
  fileprivate var indentLevel = 0
  
  // The current default quantification behavior
  public var quantificationBehavior: AST.Quantification.Kind = .eager

  // A stack of the current added inline matching options, e.g. (?s) and a
  // boolean indicating true = added (?s) and false = removed (?-s).
  public var inlineMatchingOptions: [([AST.MatchingOption], Bool)] = []
}

// MARK: - Raw interface
extension PrettyPrinter {
  // This might be necessary if `fileprivate` above suppresses
  // default struct inits.
  public init(
    maxTopDownLevels: Int? = nil,
    minBottomUpLevels: Int? = nil
  ) {
    self.maxTopDownLevels = maxTopDownLevels
    self.minBottomUpLevels = minBottomUpLevels
  }

  /// Outputs a string directly, without termination or
  /// indentation, and without updating any internal state.
  ///
  /// This is the low-level interface to the pretty printer.
  ///
  /// - Note: If `s` includes a newline, even at the end,
  ///   this method does not update any tracking state.
  public mutating func output(_ s: String) {
    result += s
  }

  /// Terminates a line, updating any relevant state.
  public mutating func terminateLine() {
    output("\n")
    startOfLine = true
  }

  /// Indents a new line, if at the start of a line, otherwise
  /// does nothing.
  ///
  /// This function updates internal state.
  public mutating func indent() {
    guard startOfLine else { return }
    let numCols = indentLevel * indentWidth
    output(String(repeating: " ", count: numCols))
    startOfLine = false
  }

  // Finish, flush, and clear.
  //
  // - Returns: The rendered output.
  public mutating func finish() -> String {
    defer { result = "" }
    return result
  }

  public var depth: Int { indentLevel }
}

// MARK: - Pretty-print interface
extension PrettyPrinter {
  /// Print out a new entry.
  ///
  /// This method indents `s`, updates any internal state,
  /// and terminates the current line.
  public mutating func print(_ s: String) {
    indent()
    output("\(s)")
    terminateLine()
  }

  /// Prints out a new entry by invoking `f` until it returns `nil`.
  ///
  /// This method indents `s`, updates any internal state,
  /// and terminates the current line.
  public mutating func printLine(_ f: () -> String?) {
    // TODO: What should we do if `f` never returns non-nil?
    indent()
    while let s = f() {
      output(s)
    }
    terminateLine()
  }

  /// Executes `f` at one increased level of indentation.
  public mutating func printIndented(
    _ f: (inout Self) -> ()
  ) {
    self.indentLevel += 1
    f(&self)
    self.indentLevel -= 1
  }

  /// Executes `f` inside an indented block, which has a header
  /// and delimiters.
  public mutating func printBlock(
    _ header: String,
    startDelimiter: String = "{",
    endDelimiter: String = "}",
    _ f: (inout Self) -> ()
  ) {
    print("\(header) \(startDelimiter)")
    printIndented(f)
    print(endDelimiter)
  }

  /// Pushes the list of matching options to the current stack of other matching
  /// options and increases the indentation level by 1.
  public mutating func pushMatchingOptions(
    _ options: [AST.MatchingOption],
    isAdded: Bool
  ) {
    indentLevel += 1
    inlineMatchingOptions.append((options, isAdded))
  }

  /// Pops the most recent list of matching options from the printer and
  /// decreases the indentation level by 1.
  public mutating func popMatchingOptions() -> ([AST.MatchingOption], Bool) {
    indentLevel -= 1
    return inlineMatchingOptions.removeLast()
  }
}