splash/Sources/Splash/Tokenizing/Segment.swift

/**
 *  Splash
 *  Copyright (c) John Sundell 2018
 *  MIT license - see LICENSE.md
 */

import Foundation

/// A representation of a segment of code, used to determine the type
/// of a given token when passed to a `SyntaxRule` implementation.
public struct Segment {
    /// The code that prefixes this segment, that is all the characters
    /// up to where the segment's current token begins.
    public var prefix: Substring
    /// The collection of tokens that the segment includes
    public var tokens: Tokens
    /// Any whitespace that immediately follows the segment's current token
    public var trailingWhitespace: String?

    internal let currentTokenIsDelimiter: Bool
    internal var isLastOnLine: Bool
}

public extension Segment {
    /// A collection of tokens included in a code segment
    struct Tokens {
        /// All tokens that have been found so far (excluding the current one)
        public var all: [String]
        /// The number of times a given token has been found up until this point
        public var counts: [String: Int]
        /// The tokens that were previously found on the same line as the current one
        public var onSameLine: [String]
        /// The token that was previously found (may be on a different line)
        public var previous: String?
        /// The current token which is currently being evaluated
        public var current: String
        /// Any upcoming token that will follow the current one
        public var next: String?
    }
}

public extension Segment.Tokens {
    /// Return the number of times a given token has been found up until this point.
    /// This is a convenience API over the `counts` dictionary.
    func count(of token: String) -> Int {
        return counts[token] ?? 0
    }
}