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.

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

#236: Update grammar to support Swift 2.1 #237

Merged
merged 5 commits into from
Nov 8, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 47 additions & 27 deletions src/main/antlr/com/sleekbyte/tailor/antlr/Swift.g4
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ statement
| controlTransferStatement ';'?
| deferStatement ';' ?
| doStatement ':'?
| compilerControlStatement ';'?
| expression ';'? // Keep expression last to handle ambiguity
;

Expand Down Expand Up @@ -176,7 +177,8 @@ whereExpression: expression ;
availabilityCondition: '#available' '(' availabilityArguments ')' ;
availabilityArguments: availabilityArgument (',' availabilityArguments)? ;
availabilityArgument: platformName platformVersion | '*' ;
platformName: 'iOS' | 'iOSApplicationExtension' | 'OSX' | 'OSXApplicationExtension­' | 'watchOS' ;
platformName: 'iOS' | 'iOSApplicationExtension' | 'OSX' | 'OSXApplicationExtension' | 'watchOS'
| 'watchOSApplicationExtension' | 'tvOS' | 'tvOSApplicationExtension' ;
platformVersion: VersionLiteral | DecimalLiteral | FloatingPointLiteral ; // TODO: Find a way to make this only VersionLiteral

// Generic Parameters and Arguments
Expand Down Expand Up @@ -217,7 +219,8 @@ declaration
| extensionDeclaration ';'?
| subscriptDeclaration ';'?
| operatorDeclaration ';'?
| macroDeclaration
// compiler-control-statement not in Swift Language Reference
| compilerControlStatement ';'?
;

declarations : declaration declarations? ;
Expand Down Expand Up @@ -285,7 +288,13 @@ typealiasAssignment : '=' sType ;

// GRAMMAR OF A FUNCTION DECLARATION

functionDeclaration : functionHead functionName genericParameterClause? functionSignature functionBody ;
/* HACK: functionBody? is intentionally not used to force the parser to try and match a functionBody first
* This can be removed once we figure out how to enforce that statements are either separated by semi colons or new line characters
*/
functionDeclaration : functionHead functionName genericParameterClause? functionSignature functionBody
| functionHead functionName genericParameterClause? functionSignature
;

functionHead : attributes? declarationModifiers? 'func' ;
functionName : identifier | operator ;
// rethrows is not marked as optional in the Swift Language Reference
Expand All @@ -295,7 +304,8 @@ functionBody : codeBlock ;
parameterClauses : parameterClause parameterClauses? ;
parameterClause : '(' ')' | '(' parameterList '...'? ')' ;
parameterList : parameter | parameter ',' parameterList ;
parameter : 'inout'? 'let'? '#'? externalParameterName? localParameterName typeAnnotation? defaultArgumentClause?
// Parameters don't have attributes in the Swift Language Reference
parameter : attributes? 'inout'? 'let'? '#'? externalParameterName? localParameterName typeAnnotation? defaultArgumentClause?
| 'inout'? 'var' '#'? externalParameterName? localParameterName typeAnnotation? defaultArgumentClause?
| attributes? sType
;
Expand All @@ -305,18 +315,18 @@ defaultArgumentClause : '=' expression ;

// GRAMMAR OF AN ENUMERATION DECLARATION

enumDeclaration : attributes? accessLevelModifier? 'enum' enumDef ;
enumDeclaration : attributes? accessLevelModifier? enumDef ;
enumDef: unionStyleEnum | rawValueStyleEnum ;
unionStyleEnum : enumName genericParameterClause? typeInheritanceClause? '{' unionStyleEnumMembers?'}' ;
unionStyleEnum : 'indirect'? 'enum' enumName genericParameterClause? typeInheritanceClause? '{' unionStyleEnumMembers?'}' ;
unionStyleEnumMembers : unionStyleEnumMember unionStyleEnumMembers? ;
unionStyleEnumMember : declaration | unionStyleEnumCaseClause ';'? ;
unionStyleEnumCaseClause : attributes? 'case' unionStyleEnumCaseList ;
unionStyleEnumCaseClause : attributes? 'indirect'? 'case' unionStyleEnumCaseList ;
unionStyleEnumCaseList : unionStyleEnumCase | unionStyleEnumCase ',' unionStyleEnumCaseList ;
unionStyleEnumCase : enumCaseName tupleType? ;
enumName : identifier ;
enumCaseName : identifier ;
// typeInheritanceClause is not optional in the Swift Language Reference
rawValueStyleEnum : enumName genericParameterClause? typeInheritanceClause? '{' rawValueStyleEnumMembers?'}' ;
rawValueStyleEnum : 'enum' enumName genericParameterClause? typeInheritanceClause? '{' rawValueStyleEnumMembers?'}' ;
rawValueStyleEnumMembers : rawValueStyleEnumMember rawValueStyleEnumMembers? ;
rawValueStyleEnumMember : declaration | rawValueStyleEnumCaseClause ;
rawValueStyleEnumCaseClause : attributes? 'case' rawValueStyleEnumCaseList ;
Expand Down Expand Up @@ -360,7 +370,7 @@ protocolMethodDeclaration : functionHead functionName genericParameterClause? fu

// GRAMMAR OF A PROTOCOL INITIALIZER DECLARATION

protocolInitializerDeclaration : initializerHead genericParameterClause? parameterClause ;
protocolInitializerDeclaration : initializerHead genericParameterClause? parameterClause ('throws' | 'rethrows')? ;

// GRAMMAR OF A PROTOCOL SUBSCRIPT DECLARATION

Expand All @@ -372,7 +382,7 @@ protocolAssociatedTypeDeclaration : typealiasHead typeInheritanceClause? typeali

// GRAMMAR OF AN INITIALIZER DECLARATION

initializerDeclaration : initializerHead genericParameterClause? parameterClause initializerBody ;
initializerDeclaration : initializerHead genericParameterClause? parameterClause ('throws' | 'rethrows')? initializerBody ;
initializerHead : attributes? declarationModifiers? 'init' ('?' | '!')? ;
initializerBody : codeBlock ;

Expand Down Expand Up @@ -538,7 +548,7 @@ assignmentOperator : '=' ;

// GRAMMAR OF A CONDITIONAL OPERATOR

conditionalOperator : '?' expression ':' ;
conditionalOperator : '?' tryOperator? expression ':' ;

// GRAMMAR OF A TYPE_CASTING OPERATOR

Expand Down Expand Up @@ -584,7 +594,7 @@ dictionaryLiteralItem : expression ':' expression ;
selfExpression
: 'self'
| 'self' '.' identifier
| 'self' '[' expression ']'
| 'self' '[' expressionList ']'
| 'self' '.' 'init'
;

Expand All @@ -597,7 +607,7 @@ superclassExpression
;

superclassMethodExpression : 'super' '.' identifier ;
superclassSubscriptExpression : 'super' '[' expression ']' ;
superclassSubscriptExpression : 'super' '[' expressionList ']' ;
superclassInitializerExpression : 'super' '.' 'init' ;

// GRAMMAR OF A CLOSURE EXPRESSION
Expand All @@ -612,9 +622,9 @@ closureSignature
| captureList 'in'
;

// The Swift Language Reference only allows one captureSpecifier expression pair
captureList : '[' captureSpecifier expression (',' captureSpecifier expression)* ']' ;

captureList : '[' captureListItems ']' ;
captureListItems: captureListItem (',' captureListItem)? ;
captureListItem: captureSpecifier? expression ;
captureSpecifier : 'weak' | 'unowned' | 'unowned(safe)' | 'unowned(unsafe)' ;

// GRAMMAR OF A IMPLICIT MEMBER EXPRESSION
Expand Down Expand Up @@ -808,17 +818,26 @@ typeInheritanceList : typeIdentifier (',' typeIdentifier)* ;
classRequirement: 'class' ;

// ------ Build Configurations (Macros) -------
// Used http://apple.co/1M4GNVf as reference

macroDeclaration: '#if' macroConditional statements? macroElseIfClause* macroElseClause? '#endif' ;
macroElseIfClause: '#elseif' macroConditional statements? ;
macroElseClause: '#else' statements? ;
macroConditional: buildConfigurations | conditionClause ; // currently unclear exactly what a macro conditional could be
buildConfigurations: buildConfiguration (('&&' | '||') buildConfigurations)? ;
buildConfiguration: '!'? macroFunction '(' macroArguments ')' ;
macroFunction: 'os' | 'arch' ;
macroArguments: macroArgument (',' macroArgument)* ;
macroArgument: 'OSX' | 'iOS' | 'watchOS' | 'x86_64' | 'arm' | 'arm64' | 'i386' ;

compilerControlStatement: buildConfigurationStatement | lineControlStatement ;
buildConfigurationStatement: '#if' buildConfiguration statements? buildConfigurationElseIfClauses? buildConfigurationElseClause? '#endif' ;
buildConfigurationElseIfClauses: buildConfigurationElseIfClause+ ;
buildConfigurationElseIfClause: '#elseif' buildConfiguration statements? ;
buildConfigurationElseClause: '#else' statements? ;

buildConfiguration: platformTestingFunction | identifier | booleanLiteral
| '(' buildConfiguration ')'
| '!' buildConfiguration
| buildConfiguration ('&&' | '||') buildConfiguration
;

platformTestingFunction: 'os' '(' operatingSystem ')' | 'arch' '(' architecture ')' ;
operatingSystem: 'OSX' | 'iOS' | 'watchOS' | 'tvOS' ;
architecture: 'i386' | 'x86_64' | 'arm' | 'arm64' ;

lineControlStatement: '#line' (lineNumber fileName)? ;
lineNumber: integerLiteral ;
fileName: StringLiteral ;

// ---------- Lexical Structure -----------

Expand Down Expand Up @@ -907,6 +926,7 @@ ImplicitParameterName : '$' DecimalLiteral ; // TODO: don't allow '_' here

// GRAMMAR OF A LITERAL

booleanLiteral: BooleanLiteral ;
literal : numericLiteral | StringLiteral | BooleanLiteral | NilLiteral ;

// GRAMMAR OF AN INTEGER LITERAL
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,9 @@ private void verifyElseClauseBraceStyle(SwiftParser.ElseClauseContext ctx) {
}

private void verifyFunctionBraceStyle(SwiftParser.FunctionDeclarationContext ctx) {
if (ctx.functionBody() == null) {
return;
}
verifyCodeBlockOpenBraceStyle(ctx.functionBody().codeBlock(), ctx.functionSignature().getStop(),
Messages.FUNCTION);
verifyBodyCloseBraceStyle(ctx.functionBody().codeBlock(), Messages.FUNCTION);
Expand Down Expand Up @@ -228,7 +231,7 @@ private void verifyProtocolBraceStyle(SwiftParser.ProtocolBodyContext ctx) {

private void verifyEnumBraceStyle(ParserRuleContext ctx) {
for (ParseTree child : ctx.children) {
if (child instanceof TerminalNodeImpl) {
if (child instanceof TerminalNodeImpl && child.getText().equals("{")) {
Token openBrace = ((TerminalNodeImpl) child).getSymbol();
Location openBraceLocation = ListenerUtil.getTokenLocation(openBrace);
ParserRuleContext leftSibling = (ParserRuleContext) ParseTreeUtil.getLeftSibling(child);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,8 @@ public enum Code: Int {
case JSONSerializationFailed = -6006
case PropertyListSerializationFailed = -6007
}

internal indirect enum Either<L, R> {
case Left(L)
case Right(R)
}
11 changes: 11 additions & 0 deletions src/test/swift/com/sleekbyte/tailor/grammar/Functions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,14 @@ public init(path: String = ".swiftlint.yml", optional: Bool = true) {}
public func beforeEach(closure: BeforeExampleWithMetadataClosure) {
exampleHooks.appendBefore(closure)
}

public func success(@noescape closure: T -> Void) {
switch self {
case .Value(let value): closure(value)
default: break
}
}

public prefix func <-<R: FallibleSendable>(channel: R) throws -> R.T? {
Copy link
Member

Choose a reason for hiding this comment

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

Wow prefix operators are next level stuff.

return try channel.send()
}
12 changes: 12 additions & 0 deletions src/test/swift/com/sleekbyte/tailor/grammar/Initialization.swift
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,15 @@ class SomeSubclass: SomeClass {
// subclass implementation of the required initializer goes here
}
}

struct Celsius {
var temperatureInCelsius: Double

init(fromFahrenheit fahrenheit: Double) throws {
temperatureInCelsius = (fahrenheit - 32.0) / 1.8
}

init(_: (Int) throws -> Bool) rethrows {
temperatureInCelsius = 2;
}
}
18 changes: 18 additions & 0 deletions src/test/swift/com/sleekbyte/tailor/grammar/Subscripts.swift
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,21 @@ matrix[1, 0] = 3.2
func indexIsValidForRow(row: Int, column: Int) -> Bool {
return row >= 0 && row < rows && column >= 0 && column < columns
}

struct Celsius {
var temperatureInCelsius: Double = 4
var temperatureInKelvin: Double = 5

func doSomething() {
self[temperatureInCelsius, temperatureInKelvin]
}

subscript(celsius: Double, farenheit: Double) -> Int {
get {
return 2
}
set(newValue) {
// perform a suitable setting action here
}
}
}