From fa0cd6038794ded5d649dac93bbbd14f701a511b Mon Sep 17 00:00:00 2001 From: Stuart Carnie Date: Sat, 18 May 2019 08:40:36 -0700 Subject: [PATCH] style: Swift + objc naming conventions --- OpenEmuShaders.xcodeproj/project.pbxproj | 28 +++++++++++-------- ...serTests.swift => SourceParserTests.swift} | 10 +++---- ...rParameter.swift => ShaderParameter.swift} | 9 +++--- ...ESourceParser.swift => SourceParser.swift} | 26 ++++++++--------- 4 files changed, 39 insertions(+), 34 deletions(-) rename OpenEmuShadersTests/{OESourceParserTests.swift => SourceParserTests.swift} (95%) rename Source/{OEShaderParameter.swift => ShaderParameter.swift} (91%) rename Source/{OESourceParser.swift => SourceParser.swift} (92%) diff --git a/OpenEmuShaders.xcodeproj/project.pbxproj b/OpenEmuShaders.xcodeproj/project.pbxproj index 6e789d7..42e9916 100644 --- a/OpenEmuShaders.xcodeproj/project.pbxproj +++ b/OpenEmuShaders.xcodeproj/project.pbxproj @@ -7,12 +7,12 @@ objects = { /* Begin PBXBuildFile section */ - 052BE009228D184600942C12 /* OESourceParserTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 052BE008228D184600942C12 /* OESourceParserTests.swift */; }; + 052BE009228D184600942C12 /* SourceParserTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 052BE008228D184600942C12 /* SourceParserTests.swift */; }; 052BE020228D187E00942C12 /* TestHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 052BE01F228D187E00942C12 /* TestHelpers.swift */; }; 056AC35B228BA11E005018DA /* OEEnums.h in Headers */ = {isa = PBXBuildFile; fileRef = 056AC35A228BA11E005018DA /* OEEnums.h */; settings = {ATTRIBUTES = (Public, ); }; }; 056AC372228BA144005018DA /* OEEnums.m in Sources */ = {isa = PBXBuildFile; fileRef = 056AC371228BA144005018DA /* OEEnums.m */; }; - 056AC379228BA8D9005018DA /* OEShaderParameter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 056AC378228BA8D9005018DA /* OEShaderParameter.swift */; }; - 056AC3A7228BB3E9005018DA /* OESourceParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 056AC3A6228BB3E9005018DA /* OESourceParser.swift */; }; + 056AC379228BA8D9005018DA /* ShaderParameter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 056AC378228BA8D9005018DA /* ShaderParameter.swift */; }; + 056AC3A7228BB3E9005018DA /* SourceParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 056AC3A6228BB3E9005018DA /* SourceParser.swift */; }; 056AC3A9228BD73F005018DA /* NSScanner+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 056AC3A8228BD73F005018DA /* NSScanner+Extensions.swift */; }; 05EEE342227CC35D007D011B /* OpenEmuShaders.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 05EEE338227CC35D007D011B /* OpenEmuShaders.framework */; }; 05EEE349227CC35D007D011B /* OpenEmuShaders.h in Headers */ = {isa = PBXBuildFile; fileRef = 05EEE33B227CC35D007D011B /* OpenEmuShaders.h */; settings = {ATTRIBUTES = (Public, ); }; }; @@ -39,6 +39,7 @@ A9020AE1BBCE1F965F5F8436 /* Config.swift in Sources */ = {isa = PBXBuildFile; fileRef = A90203E4FFF77BAF2B3ECC24 /* Config.swift */; }; A9020CDAE9B375337B23CB35 /* SlangCompiler.mm in Sources */ = {isa = PBXBuildFile; fileRef = A90202C8B35052F56549FB38 /* SlangCompiler.mm */; }; A9020D05FC6DD9399E7EFBC2 /* SlangCompiler.h in Headers */ = {isa = PBXBuildFile; fileRef = A90203C72A8A32B7143EB579 /* SlangCompiler.h */; }; + A9020F2040CF7431E9847211 /* custom.modulemap in Sources */ = {isa = PBXBuildFile; fileRef = A9020B85A151ED5BE833F125 /* custom.modulemap */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ @@ -115,12 +116,12 @@ /* End PBXContainerItemProxy section */ /* Begin PBXFileReference section */ - 052BE008228D184600942C12 /* OESourceParserTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OESourceParserTests.swift; sourceTree = ""; }; + 052BE008228D184600942C12 /* SourceParserTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SourceParserTests.swift; sourceTree = ""; }; 052BE01F228D187E00942C12 /* TestHelpers.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestHelpers.swift; sourceTree = ""; }; 056AC35A228BA11E005018DA /* OEEnums.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OEEnums.h; sourceTree = ""; }; 056AC371228BA144005018DA /* OEEnums.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OEEnums.m; sourceTree = ""; }; - 056AC378228BA8D9005018DA /* OEShaderParameter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OEShaderParameter.swift; sourceTree = ""; }; - 056AC3A6228BB3E9005018DA /* OESourceParser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OESourceParser.swift; sourceTree = ""; }; + 056AC378228BA8D9005018DA /* ShaderParameter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShaderParameter.swift; sourceTree = ""; }; + 056AC3A6228BB3E9005018DA /* SourceParser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SourceParser.swift; sourceTree = ""; }; 056AC3A8228BD73F005018DA /* NSScanner+Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "NSScanner+Extensions.swift"; sourceTree = ""; }; 05EEE338227CC35D007D011B /* OpenEmuShaders.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = OpenEmuShaders.framework; sourceTree = BUILT_PRODUCTS_DIR; }; 05EEE33B227CC35D007D011B /* OpenEmuShaders.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OpenEmuShaders.h; sourceTree = ""; }; @@ -151,6 +152,7 @@ A90209158C7B9B4C8306CD0D /* OEShaderPassCompiler.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OEShaderPassCompiler.h; sourceTree = ""; }; A902093DEC93994FE062176F /* OEShaderPassCompiler.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OEShaderPassCompiler.m; sourceTree = ""; }; A9020B45B7562A79B4BCF645 /* ShaderReflection.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ShaderReflection.h; sourceTree = ""; }; + A9020B85A151ED5BE833F125 /* custom.modulemap */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = "sourcecode.module-map"; path = custom.modulemap; sourceTree = ""; }; A9020BF6D6C3253BE8395A68 /* ShaderPassSemantics.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ShaderPassSemantics.h; sourceTree = ""; }; A9020E619BC7ACEF5904D318 /* ConfigTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ConfigTests.swift; sourceTree = ""; }; /* End PBXFileReference section */ @@ -217,7 +219,7 @@ children = ( 05EEE3AB227D6904007D011B /* SlangShaderTests.m */, 05EEE348227CC35D007D011B /* Info.plist */, - 052BE008228D184600942C12 /* OESourceParserTests.swift */, + 052BE008228D184600942C12 /* SourceParserTests.swift */, 052BE01F228D187E00942C12 /* TestHelpers.swift */, 05F5BB1022875C0B004D713C /* OpenEmuShadersTests-Bridging-Header.h */, A902023035423BDAFACA21E6 /* NSScannerTests.swift */, @@ -231,8 +233,8 @@ children = ( 05EEE39F227D5DF4007D011B /* SlangShader.h */, 05EEE3A0227D5DF4007D011B /* SlangShader.m */, - 056AC378228BA8D9005018DA /* OEShaderParameter.swift */, - 056AC3A6228BB3E9005018DA /* OESourceParser.swift */, + 056AC378228BA8D9005018DA /* ShaderParameter.swift */, + 056AC3A6228BB3E9005018DA /* SourceParser.swift */, 056AC3A8228BD73F005018DA /* NSScanner+Extensions.swift */, A90202C8B35052F56549FB38 /* SlangCompiler.mm */, A90203C72A8A32B7143EB579 /* SlangCompiler.h */, @@ -246,6 +248,7 @@ A902093DEC93994FE062176F /* OEShaderPassCompiler.m */, A90209158C7B9B4C8306CD0D /* OEShaderPassCompiler.h */, A90200FD5FAAA6164A305470 /* OESourceParser+Private.h */, + A9020B85A151ED5BE833F125 /* custom.modulemap */, ); path = Source; sourceTree = ""; @@ -493,13 +496,14 @@ 056AC372228BA144005018DA /* OEEnums.m in Sources */, 05EEE3AA227D625F007D011B /* SlangShader.m in Sources */, 056AC3A9228BD73F005018DA /* NSScanner+Extensions.swift in Sources */, - 056AC3A7228BB3E9005018DA /* OESourceParser.swift in Sources */, - 056AC379228BA8D9005018DA /* OEShaderParameter.swift in Sources */, + 056AC3A7228BB3E9005018DA /* SourceParser.swift in Sources */, + 056AC379228BA8D9005018DA /* ShaderParameter.swift in Sources */, A9020CDAE9B375337B23CB35 /* SlangCompiler.mm in Sources */, A90206302FA906B0B42F2CF2 /* ShaderPassSemantics.m in Sources */, A90205F1433179AFFF015F07 /* ShaderReflection.m in Sources */, A9020AE1BBCE1F965F5F8436 /* Config.swift in Sources */, A90209064B397A0A2B1BFDC0 /* OEShaderPassCompiler.m in Sources */, + A9020F2040CF7431E9847211 /* custom.modulemap in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -509,7 +513,7 @@ files = ( 05EEE3AC227D6904007D011B /* SlangShaderTests.m in Sources */, 052BE020228D187E00942C12 /* TestHelpers.swift in Sources */, - 052BE009228D184600942C12 /* OESourceParserTests.swift in Sources */, + 052BE009228D184600942C12 /* SourceParserTests.swift in Sources */, A90203772A0E044990C034EA /* NSScannerTests.swift in Sources */, A9020051FEB9717E8F2ABA14 /* ConfigTests.swift in Sources */, ); diff --git a/OpenEmuShadersTests/OESourceParserTests.swift b/OpenEmuShadersTests/SourceParserTests.swift similarity index 95% rename from OpenEmuShadersTests/OESourceParserTests.swift rename to OpenEmuShadersTests/SourceParserTests.swift index 34f7cc4..397b164 100644 --- a/OpenEmuShadersTests/OESourceParserTests.swift +++ b/OpenEmuShadersTests/SourceParserTests.swift @@ -26,7 +26,7 @@ import XCTest @testable import OpenEmuShaders -class OESourceParserTests: XCTestCase { +class SourceParserTests: XCTestCase { override func setUp() { InMemProtocol.requests = [:] } @@ -67,7 +67,7 @@ class OESourceParserTests: XCTestCase { do { let url = URL(string: "mem://foo.slang")! - let p = try OESourceParser(fromURL: url) + let p = try SourceParser(fromURL: url) XCTAssertEqual(p.vertexSource, expected[0]) XCTAssertEqual(p.fragmentSource, expected[1]) @@ -94,14 +94,14 @@ class OESourceParserTests: XCTestCase { do { let url = URL(string: "mem://foo.slang")! - let p = try OESourceParser(fromURL: url) + let p = try SourceParser(fromURL: url) XCTAssertEqual(p.name, "this_is_the_name") XCTAssertEqual(p.format, SlangFormat.r8Unorm) let pp = p.parameters["FrameColor_R"] XCTAssertNotNil(pp) let p1 = pp! - let p2 = OEShaderParameter(name: "FrameColor_R", desc: "Frame Color R") + let p2 = ShaderParameter(name: "FrameColor_R", desc: "Frame Color R") p2.initial = 0.2 p2.minimum = 0.4 p2.maximum = 0.6 @@ -175,7 +175,7 @@ class OESourceParserTests: XCTestCase { do { let url = URL(string: "mem:///root/foo.slang")! - let p = try OESourceParser(fromURL: url) + let p = try SourceParser(fromURL: url) XCTAssertEqual(p.name, "this_is_the_name") XCTAssertEqual(p.vertexSource, expected[0]) XCTAssertEqual(p.fragmentSource, expected[1]) diff --git a/Source/OEShaderParameter.swift b/Source/ShaderParameter.swift similarity index 91% rename from Source/OEShaderParameter.swift rename to Source/ShaderParameter.swift index 48deb3c..1e96f11 100644 --- a/Source/OEShaderParameter.swift +++ b/Source/ShaderParameter.swift @@ -24,8 +24,9 @@ import Foundation +@objc(OEShaderParameter) @objcMembers -public class OEShaderParameter : NSObject { +public class ShaderParameter: NSObject { public var name: String public var desc: String public var value: Float = 0.0 @@ -44,15 +45,15 @@ public class OEShaderParameter : NSObject { } public override func isEqual(_ object: Any?) -> Bool { - guard let other = object as? OEShaderParameter else { + guard let other = object as? ShaderParameter else { return false } return self == other } } -extension OEShaderParameter { - static func == (lhs: OEShaderParameter, rhs: OEShaderParameter) -> Bool { +extension ShaderParameter { + static func == (lhs: ShaderParameter, rhs: ShaderParameter) -> Bool { return lhs.name == rhs.name && lhs.desc == rhs.desc && lhs.initial == rhs.initial && diff --git a/Source/OESourceParser.swift b/Source/SourceParser.swift similarity index 92% rename from Source/OESourceParser.swift rename to Source/SourceParser.swift index 979bb8e..87d451f 100644 --- a/Source/OESourceParser.swift +++ b/Source/SourceParser.swift @@ -24,7 +24,7 @@ import Foundation -enum OESourceParserError: LocalizedError { +enum SourceParserError: LocalizedError { case missingVersion case multipleFormatPragma case multipleNamePragma @@ -59,13 +59,13 @@ enum OESourceParserError: LocalizedError { * Valid `#pragma` directives include `name`, `format` and `parameter`. */ @objc(OESourceParser) -class OESourceParser: NSObject { +class SourceParser: NSObject { private var buffer: [String] @objc private(set) var name: String? - @objc var parameters: [String: OEShaderParameter] + @objc var parameters: [String: ShaderParameter] @objc var format: SlangFormat @@ -142,7 +142,7 @@ class OESourceParser: NSObject { let line = oe.next() switch line?.hasPrefix(Prefixes.version) { case .some(false), .none: - throw OESourceParserError.missingVersion + throw SourceParserError.missingVersion default: buffer.append(line!) buffer.append("#extension GL_GOOGLE_cpp_style_line_directive : require") @@ -157,7 +157,7 @@ class OESourceParser: NSObject { let s = Scanner(string: line) s.scanString(Prefixes.include, into: nil) guard let filepath = s.scanQuotedString() else { - throw OESourceParserError.includeNotFound + throw SourceParserError.includeNotFound } let file = URL(string: filepath, relativeTo: url.deletingLastPathComponent())! try self.load(file, isRoot: false) @@ -190,7 +190,7 @@ class OESourceParser: NSObject { fileprivate func processPragma(line: String) throws { if line.hasPrefix(Prefixes.pragmaName) { if name != nil { - throw OESourceParserError.multipleNamePragma + throw SourceParserError.multipleNamePragma } name = String(line.dropFirst(Prefixes.pragmaName.count)) @@ -203,11 +203,11 @@ class OESourceParser: NSObject { count += s.scanCharacters(from: .identifierCharacters, into: &tmp) ? 1 : 0 guard let name = tmp as String? else { - throw OESourceParserError.invalidParameterPragma + throw SourceParserError.invalidParameterPragma } guard let desc = s.scanQuotedString() else { - throw OESourceParserError.invalidParameterPragma + throw SourceParserError.invalidParameterPragma } count += 1 var initial: Float = 0, minimum: Float = 0, maximum: Float = 0, step: Float = 0 @@ -222,7 +222,7 @@ class OESourceParser: NSObject { } if count == 6 { - let param = OEShaderParameter(name: name, desc: desc) + let param = ShaderParameter(name: name, desc: desc) param.initial = initial; param.value = initial; param.minimum = minimum; @@ -230,16 +230,16 @@ class OESourceParser: NSObject { param.step = step; if let existing = parameters[name], param == existing { - throw OESourceParserError.duplicateParameterPragma + throw SourceParserError.duplicateParameterPragma } parameters[name] = param } else { - throw OESourceParserError.invalidParameterPragma + throw SourceParserError.invalidParameterPragma } } else if line.hasPrefix(Prefixes.pragmaFormat) { if format != .unknown { - throw OESourceParserError.invalidParameterPragma + throw SourceParserError.invalidParameterPragma } let s = Scanner(string: line) @@ -250,7 +250,7 @@ class OESourceParser: NSObject { format = SlangFormatFromGLSlangNSString(fmt); } if format == .unknown { - throw OESourceParserError.invalidFormatPragma + throw SourceParserError.invalidFormatPragma } } }