// SPDX-License-Identifier: GPL-3.0-or-later import Foundation /// Resolves explicit Quick Help requests without interpreting or changing a /// program. Offsets use NSTextView's UTF-16 convention, just like editor spans. enum BASICReferenceContext { private struct Token { var keyword: String var range: NSRange } static func keyword(in source: String, at offset: Int) -> String? { let text = source as NSString guard source.utf8.count <= BASICLanguage.maximumSourceBytes, offset >= 0, offset <= text.length, text.length > 0 else { return nil } let spans = BASICLanguage.spans(source) let opaque = spans.filter { [.string, .comment, .data].contains($0.kind) } // In literals, comments and DATA values, words are data rather than // commands. An unfinished literal at EOF remains opaque at its end. for span in opaque { if NSLocationInRange(offset, span.range) { return nil } if span.range.length > 0 && offset == text.length && offset == NSMaxRange(span.range) { if span.kind != .string || text.character(at: text.length - 1) != 34 { return nil } } } let line = text.lineRange(for: NSRange(location: offset, length: 0)) let units = Array(source.utf16) func isOpaque(_ at: Int) -> Bool { opaque.contains { NSLocationInRange(at, $0.range) } } func whitespace(_ at: Int) -> Bool { units[at] == 32 || units[at] == 9 } var start = line.location, end = NSMaxRange(line) while end > start && [10, 13].contains(units[end - 1]) { end -= 1 } guard start < end else { return nil } for at in start..= start && $0.range.location < end } .map { Token(keyword: $0.word, range: $0.range) } // Several public command spellings are composed from shorter ROM // tokens. Keep their reference entries distinct from their prefixes. var merged: [Token] = [], index = 0 let pairs = ["GO TO": "GOTO", "GO SUB": "GOSUB", "LINE INPUT": "LINE INPUT", "DEF FN": "DEF FN", "ON ERR": "ON ERR", "PRINT USING": "PRINT USING"] while index < tokens.count { var token = tokens[index] if index + 1 < tokens.count { let next = tokens[index + 1], gap = NSMaxRange(token.range)..= statementStart else { return nil } if let first = tokens.first(where: { $0.range.location >= statementStart }), first.range.location == statementStart { return first.keyword } // Assignment statements can omit LET; an argument position within one // still has a useful help topic. A function name itself wins above. let prefix = text.substring(with: NSRange(location: statementStart, length: min(offset, end) - statementStart)) return prefix.contains("=") ? "LET" : nil } }