[Commands] Factor out common helper for version information.

 - This also normalizes exactly what version information can be overridden by
   the bootstrap script.

Author: ddunbar

Sources/Commands/SwiftBuildTool.swift

@@ -15,10 +15,6 @@ import PackageLoading
 import PackageModel
 import Utility
 
-#if HasCustomVersionString
-import VersionInfo
-#endif
-
 import enum Build.Configuration
 import enum Utility.ColorWrap
 import protocol Build.Toolchain
@@ -135,11 +131,7 @@ public struct SwiftBuildTool: SwiftTool {
                 usage()
 
             case .version:
-                #if HasCustomVersionString
-                    print(String(cString: VersionInfo.DisplayString()))
-                #else
-                    print("Swift Package Manager – Swift 3.0")
-                #endif
+                print(Versioning.currentVersion.completeDisplayString)
 
             case .build(let conf, let toolchain):
                 let graph = try loadPackage(at: opts.path.root, ignoreDependencies: opts.ignoreDependencies)

Sources/Commands/SwiftPackageTool.swift

@@ -16,10 +16,6 @@ import PackageModel
 import Utility
 import Xcodeproj
 
-#if HasCustomVersionString
-import VersionInfo
-#endif
-
 import enum Build.Configuration
 import enum Utility.ColorWrap
 import protocol Build.Toolchain
@@ -168,11 +164,7 @@ public struct SwiftPackageTool: SwiftTool {
                 usage()
 
             case .version:
-                #if HasCustomVersionString
-                    print(String(cString: VersionInfo.DisplayString()))
-                #else
-                    print("Swift Package Manager – Swift 3.0")
-                #endif
+                print(Versioning.currentVersion.completeDisplayString)
 
             case .initPackage:
                 let initPackage = try InitPackage(mode: opts.initMode)

Sources/Commands/SwiftTestTool.swift

@@ -14,10 +14,6 @@ import Basic
 import Build
 import Utility
 
-#if HasCustomVersionString
-import VersionInfo
-#endif
-
 import func POSIX.chdir
 import func POSIX.exit
 
@@ -158,11 +154,7 @@ public struct SwiftTestTool: SwiftTool {
                 usage()
 
             case .version:
-                #if HasCustomVersionString
-                    print(String(cString: VersionInfo.DisplayString()))
-                #else
-                    print("Swift Package Manager – Swift 3.0")
-                #endif
+                print(Versioning.currentVersion.completeDisplayString)
 
             case .listTests:
                 let testPath = try buildTestsIfNeeded(opts)

Sources/Utility/Versioning.swift

@@ -0,0 +1,67 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright 2016 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See http://swift.org/LICENSE.txt for license information
+ See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+// Import the custom version string (generated via the bootstrap script), if
+// available.
+#if HasCustomVersionString
+import VersionInfo
+#endif
+
+/// A Swift version number.
+///
+/// Note that these are *NOT* semantically versioned numbers.
+public struct SwiftVersion {
+    /// The version number.
+    public var version: (major: Int, minor: Int, patch: Int)
+
+    /// Whether or not this is a development version.
+    public var isDevelopment: Bool
+
+    /// Build information, as an unstructured string.
+    public var buildIdentifier: String?
+
+    /// The version as a readable string.
+    public var displayString: String {
+        var result = "\(version.major).\(version.minor).\(version.patch)"
+        if isDevelopment {
+            result += "-dev"
+        }
+        if let buildIdentifier = self.buildIdentifier {
+            result += " (" + buildIdentifier + ")"
+        }
+        return result
+    }
+
+    /// The complete product version display string (including the name).
+    public var completeDisplayString: String {
+        var vendorPrefix = ""
+#if HasCustomVersionString
+        vendorPrefix += String(cString: VersionInfo.VendorNameString()) + " "
+#endif
+        return vendorPrefix + "Swift Package Manager - Swift " + displayString
+    }
+}
+
+private func getBuildIdentifier() -> String? {
+#if HasCustomVersionString
+    return String(cString: VersionInfo.BuildIdentifierString())
+#else
+    return nil
+#endif
+}
+
+/// Version support for the package manager.
+public struct Versioning {
+    /// The current version of the package manager.
+    public static let currentVersion = SwiftVersion(
+        version: (3, 0, 0),
+        isDevelopment: true,
+        buildIdentifier: getBuildIdentifier())
+}

Utilities/bootstrap

@@ -354,22 +354,28 @@ def make_xml_string_literal(str):
 
 
 # Write out a header containing version information, and a module map for it.
-def write_bootstrap_version_info(include_path, version_str):
+def write_bootstrap_version_info(include_path, vendor_name, build_identifier):
     # Construct the header and write it out if it's changed.
     output = StringIO()
-    print("static inline const char * DisplayString() {", file=output)
-    print("    return " + make_c_string_literal(version_str) + ";", file=output)
-    print("}", file=output)
-    write_file_if_changed(os.path.join(include_path, "VersionInfo.h"),
-                          output.getvalue())
+    vendor_name_literal = make_c_string_literal(vendor_name)
+    build_identifier_literal = make_c_string_literal(build_identifier)
+    contents = """
+static inline const char* VendorNameString() {
+    return %(vendor_name_literal)s;
+}
+static inline const char* BuildIdentifierString() {
+    return %(build_identifier_literal)s;
+}
+""" % locals()
+    write_file_if_changed(os.path.join(include_path, "VersionInfo.h"), contents)
 
     # Also construct the module map and write it out if it's changed.
-    output = StringIO()
-    print("module VersionInfo [extern_c] {", file=output)
-    print("    header \"VersionInfo.h\"", file=output)
-    print("}", file=output)
-    write_file_if_changed(os.path.join(include_path, "module.map"),
-                          output.getvalue())
+    contents = """\
+module VersionInfo [extern_c] {
+    header \"VersionInfo.h\"
+}
+"""
+    write_file_if_changed(os.path.join(include_path, "module.map"), contents)
 
 
 def create_bootstrap_files(sandbox_path, args):
@@ -521,8 +527,11 @@ def create_bootstrap_files(sandbox_path, args):
                           output.getvalue())
 
     # Write out the version info header and module map file, if appropriate.
-    if args.version_str:
-        write_bootstrap_version_info(inc_dir, args.version_str)
+    if args.vendor_name or args.build_identifier:
+        if not args.vendor_name or not args.build_identifier:
+            error("--build-identifier is required with --vendor-name")
+        write_bootstrap_version_info(inc_dir, args.vendor_name,
+                                     args.build_identifier)
 
 
 def process_runtime_libraries(build_path, args, bootstrap=False):
@@ -690,8 +699,10 @@ def main():
                         help="Build stage 2 for release")
     parser.add_argument("--generate-xcodeproj", action="store_true",
                         help="Also generate an Xcode project for SwiftPM")
-    parser.add_argument("--version-string", dest="version_str",
-                        help="version string to display for --version")
+    parser.add_argument("--vendor-name", dest="vendor_name",
+                        help="vendor name for use in --version")
+    parser.add_argument("--build-identifier", dest="build_identifier",
+                        help="build identifier for use in --version")
     args = parser.parse_args()
 
     if not args.swiftc_path:
@@ -793,7 +804,7 @@ def main():
         build_flags.append("-v")
 
     # If appropriate, add flags for a custom version string:
-    if args.version_str:
+    if args.vendor_name or args.build_identifier:
         incdir = os.path.join(sandbox_path, "inc")
         build_flags.extend(["-Xswiftc", "-I{}".format(incdir)])
         build_flags.extend(["-Xswiftc", "-DHasCustomVersionString"])