Merge pull request #146 from Comcast/add-spm-support

Mamba 2.0 SPM Support

Author: rmigneco

Package.swift

@@ -0,0 +1,71 @@
+// swift-tools-version:5.3
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+//
+//  Package.swift
+//  mamba
+//
+//  Copyright © 2020 Comcast Cable Communications Management, LLC
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import PackageDescription
+
+let package = Package(
+    name: "mamba",
+    products: [
+        .library(
+            name: "mamba",
+            targets: ["mamba"]
+        )
+    ],
+    targets: [
+        .target(
+            name: "mamba",
+            dependencies: [.target(name: "HLSObjectiveC")],
+            path: "mambaSharedFramework",
+            exclude: [
+                "HLS ObjectiveC",
+                "PlaylistParserError",
+                "mamba.h"
+            ],
+            resources: [
+                .process("Resources")
+            ]
+        ),
+        .target(
+            name: "PlaylistParserError",
+            path: "mambaSharedFramework/PlaylistParserError"
+        ),
+        .target(
+            name: "HLSObjectiveC",
+            dependencies: ["PlaylistParserError"],
+            path: "mambaSharedFramework/HLS ObjectiveC",
+            exclude: [
+                "PrototypeRapidParseArray.include",
+                "RapidParser_LookingForEForEXTINFState_ParseArray.include",
+                "RapidParser_LookingForEForEXTState_ParseArray.include",
+                "RapidParser_LookingForHashForEXTINFState_ParseArray.include",
+                "RapidParser_LookingForHashForEXTState_ParseArray.include",
+                "RapidParser_LookingForIForEXTINFState_ParseArray.include",
+                "RapidParser_LookingForNewlineForEXTINFState_ParseArray.include",
+                "RapidParser_LookingForNewLineForEXTState_ParseArray.include",
+                "RapidParser_LookingForNewLineForHashState_ParseArray.include",
+                "RapidParser_LookingForNForEXTINFState_ParseArray.include",
+                "RapidParser_LookingForTForEXTINFState_ParseArray.include",
+                "RapidParser_LookingForXForEXTINFState_ParseArray.include",
+                "RapidParser_LookingForXForEXTState_ParseArray.include",
+                "RapidParser_ScanningState_ParseArray.include",
+            ]
+        )
+    ]
+)

mamba.xcodeproj/project.pbxproj

@@ -25,12 +25,22 @@ public enum FrameworkInfo {
     /// returns the version of the mamba framework
     public static var version: String {
 
+        /// When exporting a framework on SPM, there is no way to access the info dictionary, so the version should be provided differently
+        #if SWIFT_PACKAGE
+        guard let versionFilePathUrl = Bundle.module.url(forResource: "version", withExtension: "txt"),
+              let version = try? String(contentsOf: versionFilePathUrl, encoding: .utf8)
+                .trimmingCharacters(in: .whitespacesAndNewlines)
+        else {
+            assertionFailure("Unable to find version string in framework bundle")
+            return "Error: Unable to find version string in framework bundle"
+        }
+        #else
         let bundle = Bundle(for: PlaylistParser.self)
-        
         guard let version = bundle.object(forInfoDictionaryKey: "CFBundleShortVersionString") as? String else {
             assertionFailure("Unable to find version string in framework bundle")
             return "Error: Unable to find version string in framework bundle"
         }
+        #endif
 
         return version
     }

mambaSharedFramework/FrameworkInfo.swift

@@ -17,7 +17,7 @@
 //  limitations under the License.
 //
 
-#import <mamba/mamba.h>
+#import "MambaStringRef.h"
 
 @interface MambaStringRefFactory : MambaStringRef
 

mambaSharedFramework/Utils/String Util/CMTimeMakeFromString.c mambaSharedFramework/HLS ObjectiveC/CMTimeMakeFromString.c

@@ -17,7 +17,7 @@
 //  limitations under the License.
 //
 
-#import <mamba/mamba.h>
+#import "MambaStringRef.h"
 
 @interface MambaStringRef_ConcreteNSData : MambaStringRef
 

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRef.m mambaSharedFramework/HLS ObjectiveC/MambaStringRef.m

@@ -17,7 +17,7 @@
 //  limitations under the License.
 //
 
-#import <mamba/mamba.h>
+#import "MambaStringRef.h"
 
 @interface MambaStringRef_ConcreteNSString : MambaStringRef
 

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRefFactory.h mambaSharedFramework/HLS ObjectiveC/MambaStringRefFactory.h

@@ -17,7 +17,7 @@
 //  limitations under the License.
 //
 
-#import <mamba/mamba.h>
+#import "MambaStringRef.h"
 
 @interface MambaStringRef_ConcreteUnownedBytes : MambaStringRef
 

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRefFactory.m mambaSharedFramework/HLS ObjectiveC/MambaStringRefFactory.m

@@ -18,10 +18,13 @@
 //
 
 #include "RapidParserError.h"
-#if __has_include("mamba-Swift.h")
-    #import "mamba-Swift.h"
+// Module mamba-Swift is not available in Swift Package Manager.
+// In order to import 'HLSParserError.swift' a new module in Package.swift was created.
+// This is needed to access HLSParserInternalErrorCode enum.
+#if SWIFT_PACKAGE
+@import PlaylistParserError;
 #else
-    #import <mamba/mamba-Swift.h>
+#import <mamba/mamba-Swift.h>
 #endif
 
 const uint32_t RapidParserErrorMissingTagData = PlaylistParserInternalErrorCodeMissingTagData;

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRef_ConcreteNSData.h mambaSharedFramework/HLS ObjectiveC/MambaStringRef_ConcreteNSData.h

@@ -19,6 +19,10 @@
 
 import Foundation
 
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
+
 public extension MambaStringRef {
 
     convenience init(descriptor: PlaylistTagDescriptor) {

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRef_ConcreteNSData.m mambaSharedFramework/HLS ObjectiveC/MambaStringRef_ConcreteNSData.m

@@ -17,6 +17,10 @@
 //  limitations under the License.
 //
 
+#if SWIFT_PACKAGE
+import PlaylistParserError
+#endif
+
 import Foundation
 
 /// Class for generically parsing tags in the form of `#EXT-X-TARGETDURATION:10`, where there is a tag with a one and only one value associated with it

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRef_ConcreteNSString.h mambaSharedFramework/HLS ObjectiveC/MambaStringRef_ConcreteNSString.h

@@ -18,6 +18,7 @@
 //
 
 import Foundation
+import CoreMedia
 
 // Specialized validator for EXTINF tags
 class EXTINFValidator: PlaylistTagValidator {

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRef_ConcreteNSString.m mambaSharedFramework/HLS ObjectiveC/MambaStringRef_ConcreteNSString.m

@@ -19,6 +19,10 @@
 
 import Foundation
 
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
+
 /**
  enum describing all playlist tags that mamba understands from the Pantos HLS specification
 

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRef_ConcreteUnownedBytes.h mambaSharedFramework/HLS ObjectiveC/MambaStringRef_ConcreteUnownedBytes.h

@@ -18,6 +18,7 @@
 //
 
 import Foundation
+import CoreMedia
 
 /**
  `VariantPlaylist` is a struct that represents a variant-style HLS playlist.

mambaSharedFramework/Rapid Parser/MambaStringRef/MambaStringRef_ConcreteUnownedBytes.m mambaSharedFramework/HLS ObjectiveC/MambaStringRef_ConcreteUnownedBytes.m

@@ -18,6 +18,8 @@
 //
 
 import Foundation
+import CoreMedia
+
 
 public protocol PlaylistSegmentMatcher {
     /**

mambaSharedFramework/Rapid Parser/Master Parse Array/PrototypeRapidParseArray.include mambaSharedFramework/HLS ObjectiveC/PrototypeRapidParseArray.include

@@ -18,6 +18,8 @@
 //
 
 import Foundation
+import CoreMedia
+
 
 public final class PlaylistStructureCore<PSD: PlaylistStructureDelegate>: PlaylistStructureInterface {
 

mambaSharedFramework/Rapid Parser/RapidParser.m mambaSharedFramework/HLS ObjectiveC/RapidParser.m

@@ -18,6 +18,7 @@
 //
 
 import Foundation
+import CoreMedia
 
 /**
  This protocol defines a minimal interface of a object that represents HLS playlist structure.

mambaSharedFramework/Rapid Parser/RapidParserDebug.h mambaSharedFramework/HLS ObjectiveC/RapidParserDebug.h

@@ -18,6 +18,11 @@
 //
 
 import Foundation
+import CoreMedia
+
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
 
 /**
  This object is responsible for maintaining a HLS playlist structure, including a array of tags and

mambaSharedFramework/Rapid Parser/RapidParserError.m mambaSharedFramework/HLS ObjectiveC/RapidParserError.m

@@ -18,9 +18,12 @@
 //
 
 import Foundation
-
 import CoreMedia
 
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
+
 /**
  A structure representing a HLS playlist in easy to edit form.
 

mambaSharedFramework/Rapid Parser/RapidParserLineState.c mambaSharedFramework/HLS ObjectiveC/RapidParserLineState.c

@@ -18,6 +18,11 @@
 //
 
 import Foundation
+import CoreMedia
+
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
 
 /**
  A struct representing a single tag line from a HLS playlist.

mambaSharedFramework/Rapid Parser/RapidParserLineState.h mambaSharedFramework/HLS ObjectiveC/RapidParserLineState.h

@@ -18,6 +18,11 @@
 //
 
 import Foundation
+import QuartzCore
+
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
 
 /// Specialized custom data modifier for VariantPlaylist and MasterPlaylist
 public struct PlaylistURLData {

mambaSharedFramework/Rapid Parser/Master Parse Array/RapidParserMasterParseArray.c mambaSharedFramework/HLS ObjectiveC/RapidParserMasterParseArray.c

@@ -18,6 +18,12 @@
 //
 
 import Foundation
+import QuartzCore
+
+#if SWIFT_PACKAGE
+import PlaylistParserError
+import HLSObjectiveC
+#endif
 
 /**
  A performant parser for HLS playlists.

mambaSharedFramework/Rapid Parser/Master Parse Array/RapidParserMasterParseArray.h mambaSharedFramework/HLS ObjectiveC/RapidParserMasterParseArray.h

@@ -17,6 +17,10 @@
 //  limitations under the License.
 //
 
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
+
 import Foundation
 
 /// Protocol that describes the behavior of a playlist tag descriptor.

mambaSharedFramework/Rapid Parser/RapidParserNewTagCallbacks.h mambaSharedFramework/HLS ObjectiveC/RapidParserNewTagCallbacks.h

@@ -0,0 +1 @@
+    2.3.0

mambaSharedFramework/Rapid Parser/RapidParserState.h mambaSharedFramework/HLS ObjectiveC/RapidParserState.h

@@ -18,6 +18,11 @@
 //
 
 import Foundation
+import CoreMedia
+
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
 
 /// A protocol for objects that can be constructed from a string, but might fail.
 public protocol FailableStringLiteralConvertible {

mambaSharedFramework/Rapid Parser/RapidParserStateHandlers.c mambaSharedFramework/HLS ObjectiveC/RapidParserStateHandlers.c

@@ -19,6 +19,10 @@
 
 import Foundation
 
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
+
 public enum OutputStreamError: Error {
     case couldNotWriteToStream(NSError?)
     case invalidData(description: String?)

mambaSharedFramework/Rapid Parser/RapidParserStateHandlers.h mambaSharedFramework/HLS ObjectiveC/RapidParserStateHandlers.h

@@ -19,6 +19,10 @@
 
 import Foundation
 
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
+
 /**
  This struct is the mechanism to register and deregister arbitrary PlaylistTagDescriptor and
  PlaylistTagValueIdentifier objects to support arbitrary playlist tag types.

mambaSharedFramework/Rapid Parser/Master Parse Array/RapidParser_LookingForEForEXTINFState_ParseArray.include mambaSharedFramework/HLS ObjectiveC/RapidParser_LookingForEForEXTINFState_ParseArray.include

@@ -19,6 +19,11 @@
 
 import Foundation
 
+#if SWIFT_PACKAGE
+import HLSObjectiveC
+#endif
+
+
 extension String {
 
     public init(tagDescriptor: PlaylistTagDescriptor) {

mambaSharedFramework/Rapid Parser/Master Parse Array/RapidParser_LookingForEForEXTState_ParseArray.include mambaSharedFramework/HLS ObjectiveC/RapidParser_LookingForEForEXTState_ParseArray.include

@@ -17,6 +17,10 @@
 //  limitations under the License.
 //
 
+#if SWIFT_PACKAGE
+import PlaylistParserError
+#endif
+
 import Foundation
 
 struct GenericDictionaryTagParserHelper {

mambaSharedFramework/Rapid Parser/Master Parse Array/RapidParser_LookingForHashForEXTINFState_ParseArray.include mambaSharedFramework/HLS ObjectiveC/RapidParser_LookingForHashForEXTINFState_ParseArray.include

@@ -32,9 +32,8 @@ FOUNDATION_EXPORT double mambaVersionNumber;
 FOUNDATION_EXPORT const unsigned char mambaVersionString[];
 
 // In this header, you should import all the public headers of your framework using statements like #import <mamba/PublicHeader.h>
-
-#import <mamba/MambaStringRef.h>
-#import <mamba/RapidParser.h>
-#import <mamba/RapidParserCallback.h>
-#import <mamba/CMTimeMakeFromString.h>
-#import <mamba/StaticMemoryStorage.h>
+#import "MambaStringRef.h"
+#import "RapidParser.h"
+#import "RapidParserCallback.h"
+#import "CMTimeMakeFromString.h"
+#import "StaticMemoryStorage.h"