Merge pull request #1862 from hanjoes/swift-py-script

Supporting Script for Swift Runtime
2017-05-31 10:19:19 -07:00 · 2017-05-31 10:19:19 -07:00 · 7ce775dcaa
parent c97abe5bc2 834f1ede27
commit 7ce775dcaa
7 changed files with 192 additions and 1997 deletions
--- a/runtime/Swift/Antlr4.xcodeproj/project.pbxproj
+++ b/runtime/Swift/Antlr4.xcodeproj/project.pbxproj
--- a/runtime/Swift/Antlr4.xcodeproj/project.xcworkspace/contents.xcworkspacedata
+++ b/runtime/Swift/Antlr4.xcodeproj/project.xcworkspace/contents.xcworkspacedata
@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
-   version = "1.0">
-   <FileRef
-      location = "self:">
-   </FileRef>
-</Workspace>
--- a/runtime/Swift/Antlr4.xcodeproj/project.xcworkspace/xcshareddata/Antlr4.xcscmblueprint
+++ b/runtime/Swift/Antlr4.xcodeproj/project.xcworkspace/xcshareddata/Antlr4.xcscmblueprint
@ -1,30 +0,0 @@
-{
-  "DVTSourceControlWorkspaceBlueprintPrimaryRemoteRepositoryKey" : "F87DC9FBC9E282B88EC1892E49DCE765631D3152",
-  "DVTSourceControlWorkspaceBlueprintWorkingCopyRepositoryLocationsKey" : {
-
-  },
-  "DVTSourceControlWorkspaceBlueprintWorkingCopyStatesKey" : {
-    "481D6A1A63AAA84E22CA41443AC34F2761E57E20" : 9223372036854775807,
-    "F87DC9FBC9E282B88EC1892E49DCE765631D3152" : 9223372036854775807
-  },
-  "DVTSourceControlWorkspaceBlueprintIdentifierKey" : "194AE0A2-18FF-4519-BB3D-2C7F6F175940",
-  "DVTSourceControlWorkspaceBlueprintWorkingCopyPathsKey" : {
-    "481D6A1A63AAA84E22CA41443AC34F2761E57E20" : "..",
-    "F87DC9FBC9E282B88EC1892E49DCE765631D3152" : "Swift\/"
-  },
-  "DVTSourceControlWorkspaceBlueprintNameKey" : "Antlr4",
-  "DVTSourceControlWorkspaceBlueprintVersion" : 204,
-  "DVTSourceControlWorkspaceBlueprintRelativePathToProjectKey" : "Antlr4.xcodeproj",
-  "DVTSourceControlWorkspaceBlueprintRemoteRepositoriesKey" : [
-    {
-      "DVTSourceControlWorkspaceBlueprintRemoteRepositoryURLKey" : "https:\/\/github.com\/hanjoes\/antlr4.git",
-      "DVTSourceControlWorkspaceBlueprintRemoteRepositorySystemKey" : "com.apple.dt.Xcode.sourcecontrol.Git",
-      "DVTSourceControlWorkspaceBlueprintRemoteRepositoryIdentifierKey" : "481D6A1A63AAA84E22CA41443AC34F2761E57E20"
-    },
-    {
-      "DVTSourceControlWorkspaceBlueprintRemoteRepositoryURLKey" : "https:\/\/github.com\/hanjoes\/antlr4-swift-runtime.git",
-      "DVTSourceControlWorkspaceBlueprintRemoteRepositorySystemKey" : "com.apple.dt.Xcode.sourcecontrol.Git",
-      "DVTSourceControlWorkspaceBlueprintRemoteRepositoryIdentifierKey" : "F87DC9FBC9E282B88EC1892E49DCE765631D3152"
-    }
-  ]
-}
--- a/runtime/Swift/Antlr4.xcodeproj/xcshareddata/xcschemes/Antlr4
+++ b/runtime/Swift/Antlr4.xcodeproj/xcshareddata/xcschemes/Antlr4
@ -1,80 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
-   LastUpgradeVersion = "0820"
-   version = "1.3">
-   <BuildAction
-      parallelizeBuildables = "YES"
-      buildImplicitDependencies = "YES">
-      <BuildActionEntries>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "YES"
-            buildForArchiving = "YES"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "F9A422F71BCCD47300A9CD35"
-               BuildableName = "Antlr4.framework"
-               BlueprintName = "Antlr4 IOS"
-               ReferencedContainer = "container:Antlr4.xcodeproj">
-            </BuildableReference>
-         </BuildActionEntry>
-      </BuildActionEntries>
-   </BuildAction>
-   <TestAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
-      <Testables>
-      </Testables>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </TestAction>
-   <LaunchAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      launchStyle = "0"
-      useCustomWorkingDirectory = "NO"
-      ignoresPersistentStateOnLaunch = "NO"
-      debugDocumentVersioning = "YES"
-      debugServiceExtension = "internal"
-      allowLocationSimulation = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "F9A422F71BCCD47300A9CD35"
-            BuildableName = "Antlr4.framework"
-            BlueprintName = "Antlr4 IOS"
-            ReferencedContainer = "container:Antlr4.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </LaunchAction>
-   <ProfileAction
-      buildConfiguration = "Release"
-      shouldUseLaunchSchemeArgsEnv = "YES"
-      savedToolIdentifier = ""
-      useCustomWorkingDirectory = "NO"
-      debugDocumentVersioning = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "F9A422F71BCCD47300A9CD35"
-            BuildableName = "Antlr4.framework"
-            BlueprintName = "Antlr4 IOS"
-            ReferencedContainer = "container:Antlr4.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-   </ProfileAction>
-   <AnalyzeAction
-      buildConfiguration = "Debug">
-   </AnalyzeAction>
-   <ArchiveAction
-      buildConfiguration = "Release"
-      revealArchiveInOrganizer = "YES">
-   </ArchiveAction>
-</Scheme>
--- a/runtime/Swift/Antlr4.xcodeproj/xcshareddata/xcschemes/Antlr4
+++ b/runtime/Swift/Antlr4.xcodeproj/xcshareddata/xcschemes/Antlr4
@ -1,103 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
-   LastUpgradeVersion = "0820"
-   version = "1.7">
-   <BuildAction
-      parallelizeBuildables = "YES"
-      buildImplicitDependencies = "YES">
-      <BuildActionEntries>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "YES"
-            buildForArchiving = "YES"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "F9A4211B1BCCC35000A9CD35"
-               BuildableName = "Antlr4.framework"
-               BlueprintName = "Antlr4 OSX"
-               ReferencedContainer = "container:Antlr4.xcodeproj">
-            </BuildableReference>
-         </BuildActionEntry>
-      </BuildActionEntries>
-   </BuildAction>
-   <TestAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
-      <Testables>
-         <TestableReference
-            skipped = "NO">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "F9A424A71BCD348C00A9CD35"
-               BuildableName = "Antlr4Tests.xctest"
-               BlueprintName = "Antlr4Tests"
-               ReferencedContainer = "container:Antlr4.xcodeproj">
-            </BuildableReference>
-            <LocationScenarioReference
-               identifier = "com.apple.dt.IDEFoundation.CurrentLocationScenarioIdentifier"
-               referenceType = "1">
-            </LocationScenarioReference>
-         </TestableReference>
-      </Testables>
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "F9A4211B1BCCC35000A9CD35"
-            BuildableName = "Antlr4.framework"
-            BlueprintName = "Antlr4 OSX"
-            ReferencedContainer = "container:Antlr4.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </TestAction>
-   <LaunchAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      launchStyle = "0"
-      useCustomWorkingDirectory = "NO"
-      ignoresPersistentStateOnLaunch = "NO"
-      debugDocumentVersioning = "YES"
-      debugServiceExtension = "internal"
-      allowLocationSimulation = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "F9A4211B1BCCC35000A9CD35"
-            BuildableName = "Antlr4.framework"
-            BlueprintName = "Antlr4 OSX"
-            ReferencedContainer = "container:Antlr4.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </LaunchAction>
-   <ProfileAction
-      buildConfiguration = "Release"
-      shouldUseLaunchSchemeArgsEnv = "YES"
-      savedToolIdentifier = ""
-      useCustomWorkingDirectory = "NO"
-      debugDocumentVersioning = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "F9A4211B1BCCC35000A9CD35"
-            BuildableName = "Antlr4.framework"
-            BlueprintName = "Antlr4 OSX"
-            ReferencedContainer = "container:Antlr4.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-   </ProfileAction>
-   <AnalyzeAction
-      buildConfiguration = "Debug">
-   </AnalyzeAction>
-   <ArchiveAction
-      buildConfiguration = "Release"
-      revealArchiveInOrganizer = "YES">
-   </ArchiveAction>
-</Scheme>
--- a/runtime/Swift/boot.py
+++ b/runtime/Swift/boot.py
@ -0,0 +1,192 @@
+#! /usr/bin/python
+
+"""
+Find all .g4 files and generate parsers in the same directory.
+the antlr used should be the one located at user's mvn directory
+the filename is antlr4-ANTLR_VERSION-SNAPSHOT.jar. You can get it
+by running: "mvn install"
+
+NOTE: In case of customized location of .m2 folder, you can change the
+USER_M2 constant below.
+
+the java version is used according to environment variable $JAVA_HOME.
+"""
+import glob
+import shutil
+import argparse
+import fnmatch
+import os.path
+import time
+from subprocess import call
+
+
+# ANTLR Version, here we only care about major version.
+MAJOR_VERSION = "4"
+
+# Note: User defines their own M2_HOME should change this variable.
+USER_M2 = os.path.expanduser("~") + "/.m2"
+TMP_FOLDER = "/tmp/"
+
+# The directory contains this script.
+DIR = os.path.dirname(os.path.realpath(__file__))
+
+# The following two are using glob syntax.
+ANTLR4_FOLDER = USER_M2 + "/repository/org/antlr/antlr4/*-SNAPSHOT"
+ANTLR4 = ANTLR4_FOLDER + "/antlr4-*-SNAPSHOT-complete.jar"
+
+# Colors
+RED = "\033[91;1m"
+GREEN = "\033[32;1m"
+YELLOW = "\033[93;1m"
+CYAN = "\033[36;1m"
+GREY = "\033[38;2;127;127;127m"
+RESET = "\033[0m"
+
+
+def find_a4_jar():
+    """
+    Finds the antlr4 jar.
+    """
+    matches = glob.glob(ANTLR4)
+    if len(matches) == 0:
+        return None
+    sorted(matches, reverse=True)
+    return matches[0]
+
+
+def find_g4():
+    """
+    Find all g4 files and return a list of them.
+    The recursive search starts from the directory containing
+    this python file.
+    """
+    file_path = os.path.realpath(__file__)
+    parent_folder = file_path[0:file_path.rindex("/") + 1]
+    res = []
+    for cur, _, filenames in os.walk(parent_folder):
+        cur_files = fnmatch.filter(filenames, "*.g4")
+        res += [cur + "/" + cur_file for cur_file in cur_files]
+    return res
+
+
+def gen_parser(grammar, a4):
+    """
+    Generate parser for the input g4 file.
+    :param grammar: grammar file
+    :param a4: antlr4 runtime
+    :return: None
+    """
+    grammar_folder = grammar[0:grammar.rindex("/") + 1]
+    java_home = os.environ["JAVA_HOME"]
+    java = java_home + "/bin/java"
+    if not os.path.exists(java):
+        antlr_complains("Cannot find java. Check your JAVA_HOME setting.")
+        return
+
+    call([java, "-jar", a4,
+          "-Dlanguage=Swift", grammar, "-visitor",
+          "-o", grammar_folder + "/gen"])
+
+
+def swift_test():
+    """
+    Run unit tests.
+    """
+    generate_parser()
+    call(["swift", "test"])
+
+
+def get_argument_parser():
+    """
+    Initialize argument parser.
+    :return: the argument parser
+    """
+    p = argparse.ArgumentParser(description="Helper script for ANTLR4 Swift target. "
+                                            "<DEVELOPER> flag means the command is mostly used by a developer. "
+                                            "<USER> flag means the command should be used by user. ")
+    p.add_argument("--gen-spm-module",
+                   action="store_true",
+                   help="<USER> Generates a Swift Package Manager flavored module. "
+                        "Use this command if you want to include ANTLR4 as SPM dependency.", )
+    p.add_argument("--gen-xcodeproj",
+                   action="store_true",
+                   help="<DEVELOPER> Generates an Xcode project for ANTLR4 Swift runtime. "
+                        "This directive will generate all the required parsers for the project. "
+                        "Feel free to re-run whenever you updated the test grammar files.")
+    p.add_argument("--test",
+                   action="store_true",
+                   help="<DEVELOPER> Run unit tests.")
+    return p
+
+
+def generate_spm_module(in_folder=TMP_FOLDER):
+    """
+    Generate spm module in the specified folder, default
+    to the system's tmp folder.
+
+    After generation, user can simply use the prompt SPM
+    code to include the ANTLR4 Swift runtime package.
+    :param in_folder: the folder where we generate the SPM module.
+    :return: None
+    """
+
+    tmp_antlr_folder = in_folder + "Antlr4-tmp-" + str(int(time.time()))
+    os.mkdir(tmp_antlr_folder)
+
+    # Copy folders and SPM manifest file.
+    dirs_to_copy = ["Sources", "Tests"]
+    for dir_to_copy in dirs_to_copy:
+        shutil.copytree(DIR + "/" + dir_to_copy, tmp_antlr_folder + "/" + dir_to_copy)
+
+    shutil.copy("Package.swift", tmp_antlr_folder)
+
+    os.chdir(tmp_antlr_folder)
+    call(["git", "init"])
+    call(["git", "add", "*"])
+    call(["git", "commit", "-m", "Initial commit."])
+    call(["git", "tag", "{}.0.0".format(MAJOR_VERSION)])
+
+    antlr_says("Created local repository.")
+    antlr_says("Put .Package(url: \"{}\", majorVersion: {}) in Package.swift.".format(os.getcwd(), MAJOR_VERSION))
+
+
+def generate_xcodeproj():
+    """
+    Generates the ANTLR4 Swift runtime Xcode project.
+
+    This method will also generate parsers required by
+    the runtime tests.
+    :return:
+    """
+    generate_parser()
+    call(["swift", "package", "generate-xcodeproj"])
+
+
+def generate_parser():
+    antlr = find_a4_jar()
+    if antlr is None:
+        antlr_complains("Run \"mvn install\" in antlr4 project root first or check mvn settings")
+        exit()
+
+    _ = [gen_parser(f, antlr) for f in find_g4()]
+
+
+def antlr_says(msg):
+    print GREEN + "[ANTLR] " + msg + RESET
+
+
+def antlr_complains(msg):
+    print RED + "[ANTLR] " + msg + RESET
+
+
+if __name__ == "__main__":
+    parser = get_argument_parser()
+    args = parser.parse_args()
+    if args.gen_spm_module:
+        generate_spm_module()
+    elif args.gen_xcodeproj:
+        generate_xcodeproj()
+    elif args.test:
+        swift_test()
+    else:
+        parser.print_help()
--- a/runtime/Swift/test.py
+++ b/runtime/Swift/test.py
@ -1,77 +0,0 @@
-#! /usr/bin/python
-
-"""
-Find all .g4 files and generate parsers in the same directory.
-the antlr used should be the one located at user's mvn directory
-the filename is antlr4-ANTLR_VERSION-SNAPSHOT.jar. You can get it
-by running: "mvn install"
-
-NOTE: In case of customized location of .m2 folder, you can change the
-USER_M2 constant below.
-
-the java version is used according to environment variable $JAVA_HOME.
-"""
-
-import fnmatch
-import os.path
-from subprocess import call
-
-ANTLR_VERSION = '4.7'
-USER_M2 = os.path.expanduser('~') + '/.m2/'
-ANTLR4_FOLDER = USER_M2 + 'repository/org/antlr/antlr4/' + ANTLR_VERSION + '-SNAPSHOT/'
-ANTLR4_JAR = ANTLR4_FOLDER + 'antlr4-' + ANTLR_VERSION + '-SNAPSHOT-complete.jar'
-
-
-def jar_exists():
-    """
-    Finds the antlr4 jar.
-    """
-    return os.path.exists(ANTLR4_JAR)
-
-
-def find_g4():
-    """
-    Find all g4 files and return a list of them.
-    The recursive search starts from the directory containing
-    this python file.
-    """
-    file_path = os.path.realpath(__file__)
-    parent_folder = file_path[0:file_path.rindex('/')+1]
-    res = []
-    for cur, _, filenames in os.walk(parent_folder):
-        cur_files = fnmatch.filter(filenames, "*.g4")
-        res += [cur+'/'+cur_file for cur_file in cur_files]
-    return res
-
-
-def gen_parser(grammar):
-    """
-    Generate parser for the input g4 file.
-    """
-    grammar_folder = grammar[0:grammar.rindex('/')+1]
-    java_home = os.environ['JAVA_HOME']
-    java = java_home + '/bin/java'
-    if not os.path.exists(java):
-        print 'Cannot find java. Check your JAVA_HOME setting.'
-        return
-
-    call([java, '-jar', ANTLR4_JAR,\
-          '-Dlanguage=Swift', grammar, '-visitor',\
-          '-o', grammar_folder + '/gen'])
-
-
-def swift_test():
-    """
-    Run unit tests.
-    """
-    call(['swift', 'test'])
-
-
-if __name__ == '__main__':
-    if not jar_exists():
-        print 'Run "mvn install" in antlr4 project root' + \
-                'first or check mvn settings'
-        exit()
-
-    _ = [gen_parser(f) for f in find_g4()]
-    swift_test()