[Xcodeproj] Add a Plist enum

Also, moves Build settings to use this new type respecting proper
quoting rules.

Author: aciidgh

Sources/Xcodeproj/Module+PBXProj.swift

@@ -155,7 +155,7 @@ extension Module  {
         }
     }
 
-    var headerSearchPaths: (key: String, value: String)? {
+    var headerSearchPaths: (key: String, value: Plist)? {
         let headerPathKey = "HEADER_SEARCH_PATHS"
         var headerPaths = dependencies.flatMap { module -> AbsolutePath? in
             switch module {
@@ -174,36 +174,28 @@ extension Module  {
         }
 
         guard !headerPaths.isEmpty else { return nil }
-
-        if headerPaths.count == 1, let first = headerPaths.first {
-            return (headerPathKey, first.asString)
-        }
-
-        let headerPathValue = headerPaths.map{ $0.asString }.joined(separator: " ")
 
-        return (headerPathKey, headerPathValue)
+        return (headerPathKey, .array(headerPaths.map { .string($0.asString) }) )
     }
 
     func getDebugBuildSettings(_ options: XcodeprojOptions, xcodeProjectPath: AbsolutePath) throws -> String {
         var buildSettings = try getCommonBuildSettings(options, xcodeProjectPath: xcodeProjectPath)
         if let headerSearchPaths = headerSearchPaths {
             buildSettings[headerSearchPaths.key] = headerSearchPaths.value
         }
-        // FIXME: Need to honor actual quoting rules here.
-        return buildSettings.map{ "\($0) = '\($1)';" }.joined(separator: " ")
+        return Plist.dictionary(buildSettings).quoteStrings().serialize()
     }
 
     func getReleaseBuildSettings(_ options: XcodeprojOptions, xcodeProjectPath: AbsolutePath) throws -> String {
         var buildSettings = try getCommonBuildSettings(options, xcodeProjectPath: xcodeProjectPath)
         if let headerSearchPaths = headerSearchPaths {
             buildSettings[headerSearchPaths.key] = headerSearchPaths.value
         }
-        // FIXME: Need to honor actual quoting rules here.
-        return buildSettings.map{ "\($0) = '\($1)';" }.joined(separator: " ")
+        return Plist.dictionary(buildSettings).quoteStrings().serialize()
     }
 
-    private func getCommonBuildSettings(_ options: XcodeprojOptions, xcodeProjectPath: AbsolutePath) throws -> [String: String] {
-        var buildSettings = [String: String]()
+    private func getCommonBuildSettings(_ options: XcodeprojOptions, xcodeProjectPath: AbsolutePath) throws -> [String: Plist] {
+        var buildSettings = [String: Plist]()
         let plistPath = xcodeProjectPath.appending(component: infoPlistFileName)
 
         if isTest {
@@ -212,15 +204,15 @@ extension Module  {
             //FIXME this should not be required
             buildSettings["LD_RUNPATH_SEARCH_PATHS"] = "@loader_path/../Frameworks"
 
-            buildSettings["INFOPLIST_FILE"] = plistPath.relative(to: xcodeProjectPath.parentDirectory).asString
+            buildSettings["INFOPLIST_FILE"] = .string(plistPath.relative(to: xcodeProjectPath.parentDirectory).asString)
         } else {
             // We currently force a search path to the toolchain, since we
             // cannot establish an expected location for the Swift standard
             // libraries.
             //
             // This means the built binaries are not suitable for distribution,
             // among other things.
-            buildSettings["LD_RUNPATH_SEARCH_PATHS"] = "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx"
+            let toolchainPath = "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx"
             if isLibrary {
                 buildSettings["ENABLE_TESTABILITY"] = "YES"
 
@@ -239,12 +231,13 @@ extension Module  {
                 // default behavior on all packages.
 
                 buildSettings["PRODUCT_NAME"] = "$(TARGET_NAME:c99extidentifier)"
-                buildSettings["INFOPLIST_FILE"] = plistPath.relative(to: xcodeProjectPath.parentDirectory).asString
+                buildSettings["INFOPLIST_FILE"] = .string(plistPath.relative(to: xcodeProjectPath.parentDirectory).asString)
 
                 buildSettings["PRODUCT_MODULE_NAME"] = "$(TARGET_NAME:c99extidentifier)"
 
                 // FIXME: This should be user speficiable
-                buildSettings["PRODUCT_BUNDLE_IDENTIFIER"] = c99name
+                buildSettings["PRODUCT_BUNDLE_IDENTIFIER"] = .string(c99name)
+                buildSettings["LD_RUNPATH_SEARCH_PATHS"] = .string(toolchainPath)
             } else {
                 // override default behavior, instead link dynamically
                 buildSettings["SWIFT_FORCE_STATIC_LINK_STDLIB"] = "NO"
@@ -259,13 +252,13 @@ extension Module  {
                 // example would be `@executable_path/../lib` but there are
                 // other problems to solve first, e.g. how to deal with the
                 // Swift standard library paths).
-                buildSettings["LD_RUNPATH_SEARCH_PATHS"] = buildSettings["LD_RUNPATH_SEARCH_PATHS"]! + " @executable_path"
+                buildSettings["LD_RUNPATH_SEARCH_PATHS"] = .array([.string(toolchainPath), "@executable_path"])
             }
         }
 
         if let pkgArgs = try? self.pkgConfigArgs() {
-            buildSettings["OTHER_LDFLAGS"] = (["$(inherited)"] + pkgArgs.libs).joined(separator: " ")
-            buildSettings["OTHER_SWIFT_FLAGS"] = (["$(inherited)"] + pkgArgs.cFlags).joined(separator: " ")
+            buildSettings["OTHER_LDFLAGS"] = .array(["$(inherited)"] + pkgArgs.libs.map(Plist.string))
+            buildSettings["OTHER_SWIFT_FLAGS"] = .array(["$(inherited)"] + pkgArgs.cFlags.map(Plist.string))
         }
 
         // Add framework search path to build settings.
@@ -286,7 +279,7 @@ extension Module  {
                 moduleMapPath = path.appending(component: moduleMapFilename)
             }
 
-            buildSettings["MODULEMAP_FILE"] = moduleMapPath.relative(to: xcodeProjectPath.parentDirectory).asString
+            buildSettings["MODULEMAP_FILE"] = .string(moduleMapPath.relative(to: xcodeProjectPath.parentDirectory).asString)
         }
 
         // At the moment, set the Swift version to 3 (we will need to make this dynamic), but for now this is necessary.
@@ -298,3 +291,25 @@ extension Module  {
         return buildSettings
     }
 }
+
+extension Plist {
+    // FIXME: This is only internal for unit testing.
+    /// Quotes the strings in the Plist.
+    func quoteStrings() -> Plist {
+        switch self {
+        case .string(let str):
+            // Only quote if string has a space character.
+            guard str.utf8.contains(UInt8(ascii: " ")) else {
+                return .string(str)
+            }
+            return .string("\"" + str + "\"")
+        case .array(let items):
+            return .array(items.map { $0.quoteStrings() })
+        case .dictionary(var items):
+            for (k,v) in items {
+                items[k] = v.quoteStrings()
+            }
+            return .dictionary(items)
+        }
+    }
+}

Sources/Xcodeproj/Plist.swift

@@ -0,0 +1,68 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright 2015 - 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
+*/
+
+/// A enum representing data types for legacy Plist type.
+/// see: https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html
+enum Plist {
+    case string(String)
+    case array([Plist])
+    case dictionary([String: Plist])
+}
+
+extension Plist: ExpressibleByStringLiteral {
+    public typealias UnicodeScalarLiteralType = StringLiteralType
+    public typealias ExtendedGraphemeClusterLiteralType = StringLiteralType
+
+    public init(unicodeScalarLiteral value: UnicodeScalarLiteralType) {
+        self = .string(value)
+    }
+    public init(extendedGraphemeClusterLiteral value: ExtendedGraphemeClusterLiteralType) {
+        self = .string(value)
+    }
+    public init(stringLiteral value: StringLiteralType) {
+        self = .string(value)
+    }
+}
+
+private let escapedQuote = "\\\""
+
+extension Plist {
+    /// Serializes the Plist enum to string.
+    func serialize() -> String {
+        switch self {
+        case .string(let str):
+            return "\"" + escape(string: str) + "\""
+        case .array(let items):
+            return "(" + items.map { $0.serialize() }.joined(separator: ", ") + ")"
+        case .dictionary(let items):
+            return "{" + items.map { " \($0) = \($1.serialize()) " }.joined(separator: "; ") + "; };"
+        }
+    }
+
+    /// Escapes the string for plist.
+    /// Finds the instances of quote (") and backward slash (\) and prepends
+    /// the escape character backward slash (\).
+    private func escape(string: String) -> String {
+        guard let pos = string.utf8.index(where: { $0 == UInt8(ascii: "\\") || $0 == UInt8(ascii: "\"") }) else {
+            return string
+        }
+        var newString = String(string.utf8[string.utf8.startIndex..<pos])!
+        for char in string.utf8[pos..<string.utf8.endIndex] {
+            switch char {
+            case UInt8(ascii: "\\"): fallthrough
+            case UInt8(ascii: "\""):
+                newString += "\\"
+            default: break
+            }
+            newString += String(UnicodeScalar(char))
+        }
+        return newString
+    }
+}

Sources/Xcodeproj/pbxproj().swift

@@ -234,12 +234,12 @@ public func pbxproj(srcroot: AbsolutePath, projectRoot: AbsolutePath, xcodeprojP
         print("        };")
         print("        \(module.debugConfigurationReference) = {")
         print("            isa = XCBuildConfiguration;")
-        print("            buildSettings = { \(try module.getDebugBuildSettings(options, xcodeProjectPath: xcodeprojPath)) };")
+        print("            buildSettings = \(try module.getDebugBuildSettings(options, xcodeProjectPath: xcodeprojPath))")
         print("            name = Debug;")
         print("        };")
         print("        \(module.releaseConfigurationReference) = {")
         print("            isa = XCBuildConfiguration;")
-        print("            buildSettings = { \(try module.getReleaseBuildSettings(options, xcodeProjectPath: xcodeprojPath)) };")
+        print("            buildSettings = \(try module.getReleaseBuildSettings(options, xcodeProjectPath: xcodeprojPath))")
         print("            name = Release;")
         print("        };")
 

Tests/XcodeprojTests/PlistTests.swift

@@ -0,0 +1,25 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright 2015 - 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 XCTest
+@testable import Xcodeproj
+
+class PlistTests: XCTestCase {
+    func testBasics() {
+        XCTAssertEqual("\"hello \\\" world\"", Plist.string("hello \" world").serialize())
+        XCTAssertEqual("(\"hello world\", \"cool\")", Plist.array([.string("hello world"), .string("cool")]).serialize())
+        XCTAssertEqual("{ user = \"cool\" ;  polo = (\"hello \\\" world\", \"cool\") ; };", Plist.dictionary(["user": .string("cool"), "polo": Plist.array([.string("hello \" world"), .string("cool")])]).serialize())
+    }
+
+    func testBuildSettingStringQuoting() {
+        XCTAssertEqual("\"\\\"hello world\\\"\"", Plist.string("hello world").quoteStrings().serialize())
+        XCTAssertEqual("(\"\\\"hello world\\\"\", \"cool\")", Plist.array([.string("hello world"), .string("cool")]).quoteStrings().serialize())
+    }
+}