Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(swift) Revamped keywords and added support for operators #2908

Merged
merged 20 commits into from Dec 15, 2020
Merged

(swift) Revamped keywords and added support for operators #2908

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
60a32b2
(swift) Revamped keywords and added support for operators. Also fixes…
svanimpe Dec 4, 2020
5d1e17c
Update changelog.
svanimpe Dec 4, 2020
4adf9ed
(swift) Small fix for when the input starts with a try!? operator.
svanimpe Dec 5, 2020
2bb4994
(swift) Small fix for when the input starts with a try!? operator (pa…
svanimpe Dec 5, 2020
8a7c3f9
Merge branch 'master' into swift-operators
svanimpe Dec 5, 2020
86b7c81
(swift) Big grammar improvements.
svanimpe Dec 10, 2020
09be110
(swift) Update author and changelog.
svanimpe Dec 10, 2020
1026ac0
Linter fixes
svanimpe Dec 11, 2020
da01153
Highlight literals as literals again.
svanimpe Dec 11, 2020
2a1163e
More keyword fixes.
svanimpe Dec 11, 2020
f8510bd
Remove returnBegin and fix relevances
svanimpe Dec 11, 2020
b5e2767
Small move
svanimpe Dec 12, 2020
71ce42e
explain dot operators
joshgoebel Dec 13, 2020
d249413
use built in keywords functionality
joshgoebel Dec 15, 2020
0d679d1
avoid two files with same name
joshgoebel Dec 15, 2020
f5f3043
remove kw? case as it is handled by modes
joshgoebel Dec 15, 2020
1e2c56d
simplify available rule
joshgoebel Dec 15, 2020
1e55113
existing keywords are sufficient
joshgoebel Dec 15, 2020
821d247
Merge branch 'master' into swift-operators
joshgoebel Dec 15, 2020
ea6d8df
Merge branch 'master' into swift-operators
joshgoebel Dec 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion CHANGES.md
View file
Open in desktop
Expand Up @@ -7,7 +7,12 @@ New Languages:
Language improvements:

- enh(makefile): Add `make` as an alias (#2883) [tripleee][]
- enh(swift) Improved grammar for strings (#2819) [Steven Van Impe][]
- enh(swift) Grammar improvements (#2908) [Steven Van Impe][]
- New grammar for keywords and built-ins
- Added support for operator highlighting
- New grammar for attributes
- Added support for quoted identifiers, implicit parameters, and property wrapper projections
- Support for more complex expressions in string interpolation
- fix(asciidoc): Handle section titles level 5 (#2868) [Vaibhav Chanana][]

Grammar improvements:
Expand Down
285 changes: 285 additions & 0 deletions src/languages/lib/swift.js
View file
Open in desktop
@@ -0,0 +1,285 @@
import { concat, either } from '../../lib/regex';

// Keywords that require a leading dot.
export const dotKeywords = [
/Protocol\b/, // contextual
/Type\b/, // contextual
];

// Keywords that may have a leading dot.
export const optionalDotKeywords = [
/init\b/,
/self\b/
];

// Regular keywords and literals.
export const keywords = [
/\bAny\b/,
joshgoebel marked this conversation as resolved.
Show resolved Hide resolved
/\bSelf\b/,
/\b_\b/, // pattern
joshgoebel marked this conversation as resolved.
Show resolved Hide resolved
/\bassociatedtype\b/,
/\bas\?\B/, // operator
/\bas!\B/, // operator
/\bas\b/, // operator
/\bbreak\b/,
/\bcase\b/,
/\bcatch\b/,
/\bclass\b/,
/\bcontinue\b/,
/\bconvenience\b/, // contextual
/\bdefault\b/,
/\bdefer\b/,
/\bdeinit\b/,
/\bdidSet\b/, // contextual
/\bdo\b/,
/\bdynamic\b/, // contextual
/\belse\b/,
/\benum\b/,
/\bextension\b/,
/\bfallthrough\b/,
/\bfalse\b/, // literal
/\bfileprivate\(set\)\B/,
/\bfileprivate\b/,
/\bfinal\b/, // contextual
/\bfor\b/,
/\bfunc\b/,
/\bget\b/, // contextual
/\bguard\b/,
/\bif\b/,
/\bimport\b/,
/\bindirect\b/, // contextual
/\binfix\b/, // contextual
/\binit\?\B/,
/\binit!\B/,
/\binout\b/,
/\binternal\(set\)\B/,
/\binternal\b/,
/\bin\b/,
/\bis\b/, // operator
/\blazy\b/, // contextual
/\blet\b/,
/\bmutating\b/, // contextual
/\bnil\b/, // literal
joshgoebel marked this conversation as resolved.
Show resolved Hide resolved
/\bnonmutating\b/, // contextual
/\bopen\(set\)\B/, // contextual
/\bopen\b/, // contextual
/\boperator\b/,
/\boptional\b/, // contextual
/\boverride\b/, // contextual
/\bpostfix\b/, // contextual
/\bprecedencegroup\b/,
/\bprefix\b/, // contextual
/\bprivate\(set\)\B/,
/\bprivate\b/,
/\bprotocol\b/,
/\bpublic\(set\)\B/,
/\bpublic\b/,
/\brepeat\b/,
/\brequired\b/, // contextual
/\brethrows\b/,
/\breturn\b/,
/\bset\b/, // contextual
/\bsome\b/, // contextual
/\bstatic\b/,
/\bstruct\b/,
/\bsubscript\b/,
/\bsuper\b/,
/\bswitch\b/,
/\bthrows\b/,
/\bthrow\b/,
/\btrue\b/, // literal
/\btry\?\B/, // operator
/\btry!\B/, // operator
/\btry\b/, // operator
/\btypealias\b/,
/\bunowned\(safe\)\B/, // contextual
/\bunowned\(unsafe\)\B/, // contextual
/\bunowned\b/, // contextual
/\bvar\b/,
/\bweak\b/, // contextual
/\bwhere\b/,
/\bwhile\b/,
/\bwillSet\b/, // contextual
];

// NOTE: Contextual keywords are reserved only in specific contexts.
// Ideally, these should be matched using modes to avoid false positives.

// TODO: Create a PRECEDENCE_GROUP mode to match the remaining contextual keywords:
// assignment associativity higherThan left lowerThan none right
// These aren't included in the list because they result in mostly false positives.

// Keywords that start with a number character (#).
// #available is handled separately.
export const numberKeywords = [
joshgoebel marked this conversation as resolved.
Show resolved Hide resolved
'colorLiteral',
'column',
'dsohandle',
'else',
'elseif',
'endif',
'error',
'file',
'fileID',
'fileLiteral',
'filePath',
'function',
'if',
'imageLiteral',
'keyPath',
'line',
'selector',
'sourceLocation',
'warn_unqualified_access',
'warning',
];

// Global functions in the Standard Library.
export const builtIns = [
'abs',
'all',
'any',
'assert',
'assertionFailure',
'debugPrint',
'dump',
'fatalError',
'getVaList',
'isKnownUniquelyReferenced',
'max',
'min',
'numericCast',
'pointwiseMax',
'pointwiseMin',
'precondition',
'preconditionFailure',
'print',
'readLine',
'repeatElement',
'sequence',
'stride',
'swap',
'swift_unboxFromSwiftValueWithType',
'transcode',
'type',
'unsafeBitCast',
'unsafeDowncast',
'withExtendedLifetime',
'withUnsafeMutablePointer',
'withUnsafePointer',
'withVaList',
'withoutActuallyEscaping',
'zip',
];

// Valid first characters for operators.
export const operatorHead = either(
/[/=\-+!*%<>&|^~?]/,
/[\u00A1–\u00A7]/,
/[\u00A9\u00AB]/,
/[\u00AC\u00AE]/,
/[\u00B0\u00B1]/,
/[\u00B6\u00BB\u00BF\u00D7\u00F7]/,
/[\u2016–\u2017]/,
/[\u2020–\u2027]/,
/[\u2030–\u203E]/,
/[\u2041–\u2053]/,
/[\u2055–\u205E]/,
/[\u2190–\u23FF]/,
/[\u2500–\u2775]/,
/[\u2794–\u2BFF]/,
/[\u2E00–\u2E7F]/,
/[\u3001–\u3003]/,
/[\u3008–\u3020]/,
/[\u3030]/
);

// Valid characters for operators.
export const operatorCharacter = either(
operatorHead,
/[\u0300–\u036F]/,
/[\u1DC0–\u1DFF]/,
/[\u20D0–\u20FF]/,
/[\uFE00–\uFE0F]/,
/[\uFE20–\uFE2F]/,
// TODO: The following characters are also allowed, but the regex isn't supported yet.
// /[\u{E0100}–\u{E01EF}]/u
);

// Valid first characters for identifiers.
export const identifierHead = either(
/[a-zA-Z_]/,
/[\u00A8\u00AA\u00AD\u00AF\u00B2–\u00B5\u00B7–\u00BA]/,
/[\u00BC–\u00BE\u00C0–\u00D6\u00D8–\u00F6\u00F8–\u00FF]/,
/[\u0100–\u02FF\u0370–\u167F\u1681–\u180D\u180F–\u1DBF]/,
/[\u1E00–\u1FFF]/,
/[\u200B–\u200D\u202A–\u202E\u203F–\u2040\u2054\u2060–\u206F]/,
joshgoebel marked this conversation as resolved.
Show resolved Hide resolved
/[\u2070–\u20CF\u2100–\u218F\u2460–\u24FF\u2776–\u2793]/,
/[\u2C00–\u2DFF\u2E80–\u2FFF]/,
/[\u3004–\u3007\u3021–\u302F\u3031–\u303F\u3040–\uD7FF]/,
/[\uF900–\uFD3D\uFD40–\uFDCF\uFDF0–\uFE1F\uFE30–\uFE44]/,
/[\uFE47–\uFFFD]/,
// The following characters are also allowed, but the regexes aren't supported yet.
// /[\u{10000}–\u{1FFFD}\u{20000–\u{2FFFD}\u{30000}–\u{3FFFD}\u{40000}–\u{4FFFD}]/u,
// /[\u{50000}–\u{5FFFD}\u{60000–\u{6FFFD}\u{70000}–\u{7FFFD}\u{80000}–\u{8FFFD}]/u,
// /[\u{90000}–\u{9FFFD}\u{A0000–\u{AFFFD}\u{B0000}–\u{BFFFD}\u{C0000}–\u{CFFFD}]/u,
// /[\u{D0000}–\u{DFFFD}\u{E0000–\u{EFFFD}]/u
);

// Valid characters for identifiers.
export const identifierCharacter = either(
identifierHead,
/\d/,
/[\u0300–\u036F\u1DC0–\u1DFF\u20D0–\u20FF\uFE20–\uFE2F]/
);

// Valid identifier.
export const identifier = concat(identifierHead, identifierCharacter, '*');

// Built-in attributes, which are highlighted as keywords.
// @available is handled separately.
export const keywordAttributes = [
/autoclosure/,
concat(/convention\(/, either('swift', 'block', 'c'), /\)/),
/discardableResult/,
/dynamicCallable/,
/dynamicMemberLookup/,
/escaping/,
/frozen/,
/GKInspectable/,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If they (in the context of the list) are literal strings, then prefer normal quoting not //. This would apply to almost all these.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I mix strings and regexes in the same array, will that work?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mixing isn't a problem. The underlying utility stuff and compiler usually handles strings and regex interchangeably without any issue. It's only an issue when doing something like a+b or string interpolation, which mostly we're trying to get away from.

/IBAction/,
/IBDesignable/,
/IBInspectable/,
/IBOutlet/,
/IBSegueAction/,
/inlinable/,
/main/,
/nonobjc/,
/NSApplicationMain/,
/NSCopying/,
/NSManaged/,
concat(/objc\(/, identifier, /\)/),
/objc/,
/objcMembers/,
/propertyWrapper/,
/requires_stored_property_inits/,
/testable/,
/UIApplicationMain/,
/unknown/,
/usableFromInline/,
];

// Contextual keywords used in @available and #available.
export const availabilityKeywords = [
'iOS',
'iOSApplicationExtension',
'macOS',
'macOSApplicationExtension',
'macCatalyst',
'macCatalystApplicationExtension',
'watchOS',
'watchOSApplicationExtension',
'tvOS',
'tvOSApplicationExtension',
'swift',
];