update code style

AgoraIO · zhangtao1104 · Feb 23, 2024 · Nov 3, 2023 · Nov 13, 2023 · Nov 13, 2023
commit f2451d90bac5c138ea37fb1fec9790119734467d
diff --git a/iOS/APIExample/.swiftlint.yml b/iOS/APIExample/.swiftlint.yml
@@ -0,0 +1,40 @@
+disabled_rules: # 禁用指定的规则
+  - todo  #去做
+  - trailing_whitespace # 行末尾不加空格
+  - unneeded_override # 不需要的重写函数
+  - identifier_name #  参数变量命名规则
+  - class_delegate_protocol #delegate protocol 应该被设定为 class-only,才能被弱引用
+  - type_body_length # 类型体行数限制
+  - cyclomatic_complexity # 不应该存在太复杂的函数（判断语句过多）
+
+opt_in_rules: # 启用指定的规则
+  - empty_count # 空数
+  - missing_docs # 缺少文档
+  - closure_end_indentation #闭合端压痕
+  - empty_parentheses_with_trailing_closure #带尾随闭包的空括号
+  - duplicate_imports  #重复导入
+  - force_unwrapping # 强制解包
+  - nesting #嵌套
+  - operator_whitespace # 运算符 函数 空白
+  - switch_case_alignment #Switch 和 Case 语句对齐
+
+excluded: # 执行 linting 时忽略的路径。 优先级比 `included` 更高。
+  - Carthage
+  - Pods
+
+# rules that have both warning and error levels, can set just the warning level
+line_length: 145  # 一行的字符长度不超过120个，否则会有warning
+
+large_tuple: 4
+
+# error #函数体长度 默认超过40行warning,超过100行直接报错
+function_body_length:
+   warning: 60
+   error: 100
+
+file_length:  # 文件行数超过500行会有warning，超过1200行会有error
+  warning: 800
+  error: 1200
+
+force_unwrapping:
+  severity: error
diff --git a/iOS/APIExample/APIExample.xcodeproj/project.pbxproj b/iOS/APIExample/APIExample.xcodeproj/project.pbxproj
@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 51;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -1501,6 +1501,7 @@
 				03D13BCA2448758900B599B3 /* Resources */,
 				1B6F6CF9B678035E221EAFDE /* [CP] Embed Pods Frameworks */,
 				0339BEBA25205B80007D4FDD /* Embed App Extensions */,
+				E76F80122AF0A7A200CCB9D6 /* ShellScript */,
 			);
 			buildRules = (
 			);
@@ -1760,6 +1761,23 @@
 			shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n    # print error to STDERR\n    echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n    exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n";
 			showEnvVarsInLog = 0;
 		};
+		E76F80122AF0A7A200CCB9D6 /* ShellScript */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputFileListPaths = (
+			);
+			inputPaths = (
+			);
+			outputFileListPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "\"${PODS_ROOT}/SwiftLint/swiftlint\" \n";
+		};
 /* End PBXShellScriptBuildPhase section */
 
 /* Begin PBXSourcesBuildPhase section */

diff --git a/iOS/APIExample/APIExample/AppDelegate.swift b/iOS/APIExample/APIExample/AppDelegate.swift
@@ -17,7 +17,4 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         // Override point for customization after application launch.
         return true
     }
-
-
 }
-
diff --git a/iOS/APIExample/APIExample/Common/ARKit/ARVideoRenderer.swift b/iOS/APIExample/APIExample/Common/ARKit/ARVideoRenderer.swift
@@ -11,7 +11,7 @@ import MetalKit
 import SceneKit
 import AgoraRtcKit
 
-class ARVideoRenderer : NSObject {
+class ARVideoRenderer: NSObject {
     fileprivate var yTexture: MTLTexture?
     fileprivate var uTexture: MTLTexture?
     fileprivate var vTexture: MTLTexture?

diff --git a/iOS/APIExample/APIExample/Common/AgoraExtension.swift b/iOS/APIExample/APIExample/Common/AgoraExtension.swift
@@ -119,161 +119,121 @@ extension AgoraEncryptionMode {
     }
 }
 
-//extension AgoraAudioVoiceChanger {
-//    func description() -> String {
-//        switch self {
-//        case .voiceChangerOff:return "Off".localized
-//        case .generalBeautyVoiceFemaleFresh:return "FemaleFresh".localized
-//        case .generalBeautyVoiceFemaleVitality:return "FemaleVitality".localized
-//        case .generalBeautyVoiceMaleMagnetic:return "MaleMagnetic".localized
-//        case .voiceBeautyVigorous:return "Vigorous".localized
-//        case .voiceBeautyDeep:return "Deep".localized
-//        case .voiceBeautyMellow:return "Mellow".localized
-//        case .voiceBeautyFalsetto:return "Falsetto".localized
-//        case .voiceBeautyFull:return "Full".localized
-//        case .voiceBeautyClear:return "Clear".localized
-//        case .voiceBeautyResounding:return "Resounding".localized
-//        case .voiceBeautyRinging:return "Ringing".localized
-//        case .voiceBeautySpacial:return "Spacial".localized
-//        case .voiceChangerEthereal:return "Ethereal".localized
-//        case .voiceChangerOldMan:return "Old Man".localized
-//        case .voiceChangerBabyBoy:return "Baby Boy".localized
-//        case .voiceChangerBabyGirl:return "Baby Girl".localized
-//        case .voiceChangerZhuBaJie:return "ZhuBaJie".localized
-//        case .voiceChangerHulk:return "Hulk".localized
-//        default:
-//            return "\(self.rawValue)"
-//        }
-//    }
-//}
-
-extension AgoraVoiceBeautifierPreset{
+extension AgoraVoiceBeautifierPreset {
     func description() -> String {
         switch self {
-        case .presetOff:return "Off".localized
-        case .presetChatBeautifierFresh:return "FemaleFresh".localized
-        case .presetChatBeautifierMagnetic:return "MaleMagnetic".localized
-        case .presetChatBeautifierVitality:return "FemaleVitality".localized
-        case .timbreTransformationVigorous:return "Vigorous".localized
-        case .timbreTransformationDeep:return "Deep".localized
-        case .timbreTransformationMellow:return "Mellow".localized
-        case .timbreTransformationFalsetto:return "Falsetto".localized
-        case .timbreTransformationFull:return "Full".localized
-        case .timbreTransformationClear:return "Clear".localized
-        case .timbreTransformationResounding:return "Resounding".localized
-        case .timbreTransformatRinging:return "Ringing".localized
-        default:
-            return "\(self.rawValue)"
+        case .presetOff: return "Off".localized
+        case .presetChatBeautifierFresh: return "FemaleFresh".localized
+        case .presetChatBeautifierMagnetic: return "MaleMagnetic".localized
+        case .presetChatBeautifierVitality: return "FemaleVitality".localized
+        case .timbreTransformationVigorous: return "Vigorous".localized
+        case .timbreTransformationDeep: return "Deep".localized
+        case .timbreTransformationMellow: return "Mellow".localized
+        case .timbreTransformationFalsetto: return "Falsetto".localized
+        case .timbreTransformationFull: return "Full".localized
+        case .timbreTransformationClear: return "Clear".localized
+        case .timbreTransformationResounding: return "Resounding".localized
+        case .timbreTransformatRinging: return "Ringing".localized
+        default: return "\(self.rawValue)"
         }
     }
 }
 
 extension AgoraAudioReverbPreset {
     func description() -> String {
         switch self {
-        case .off:return "Off".localized
-        case .fxUncle:return "FxUncle".localized
-        case .fxSister:return "FxSister".localized
-        case .fxPopular:return "Pop".localized
-        case .fxRNB:return "R&B".localized
-        case .fxVocalConcert:return "Vocal Concert".localized
-        case .fxKTV:return "KTV".localized
-        case .fxStudio:return "Studio".localized
-        case .fxPhonograph:return "Phonograph".localized
-        default:
-            return "\(self.rawValue)"
+        case .off: return "Off".localized
+        case .fxUncle: return "FxUncle".localized
+        case .fxSister: return "FxSister".localized
+        case .fxPopular: return "Pop".localized
+        case .fxRNB: return "R&B".localized
+        case .fxVocalConcert: return "Vocal Concert".localized
+        case .fxKTV: return "KTV".localized
+        case .fxStudio: return "Studio".localized
+        case .fxPhonograph: return "Phonograph".localized
+        default: return "\(self.rawValue)"
         }
     }
 }
 
 extension AgoraAudioEffectPreset {
     func description() -> String {
         switch self {
-        case .off:return "Off".localized
-        case .voiceChangerEffectUncle:return "FxUncle".localized
-        case .voiceChangerEffectOldMan:return "Old Man".localized
-        case .voiceChangerEffectBoy:return "Baby Boy".localized
-        case .voiceChangerEffectSister:return "FxSister".localized
-        case .voiceChangerEffectGirl:return "Baby Girl".localized
-        case .voiceChangerEffectPigKin:return "ZhuBaJie".localized
-        case .voiceChangerEffectHulk:return "Hulk".localized
-        case .styleTransformationRnb:return "R&B".localized
-        case .styleTransformationPopular:return "Pop".localized
-        case .roomAcousticsKTV:return "KTV".localized
-        case .roomAcousVocalConcer:return "Vocal Concert".localized
-        case .roomAcousStudio:return "Studio".localized
-        case .roomAcousPhonograph:return "Phonograph".localized
-        case .roomAcousVirtualStereo:return "Virtual Stereo".localized
-        case .roomAcousSpatial:return "Spacial".localized
-        case .roomAcousEthereal:return "Ethereal".localized
-        case .roomAcous3DVoice:return "3D Voice".localized
-        case .pitchCorrection:return "Pitch Correction".localized
-        default:
-            return "\(self.rawValue)"
+        case .off: return "Off".localized
+        case .voiceChangerEffectUncle: return "FxUncle".localized
+        case .voiceChangerEffectOldMan: return "Old Man".localized
+        case .voiceChangerEffectBoy: return "Baby Boy".localized
+        case .voiceChangerEffectSister: return "FxSister".localized
+        case .voiceChangerEffectGirl: return "Baby Girl".localized
+        case .voiceChangerEffectPigKin: return "ZhuBaJie".localized
+        case .voiceChangerEffectHulk: return "Hulk".localized
+        case .styleTransformationRnb: return "R&B".localized
+        case .styleTransformationPopular: return "Pop".localized
+        case .roomAcousticsKTV: return "KTV".localized
+        case .roomAcousVocalConcer: return "Vocal Concert".localized
+        case .roomAcousStudio: return "Studio".localized
+        case .roomAcousPhonograph: return "Phonograph".localized
+        case .roomAcousVirtualStereo: return "Virtual Stereo".localized
+        case .roomAcousSpatial: return "Spacial".localized
+        case .roomAcousEthereal: return "Ethereal".localized
+        case .roomAcous3DVoice: return "3D Voice".localized
+        case .pitchCorrection: return "Pitch Correction".localized
+        default: return "\(self.rawValue)"
         }
     }
 }
 
 extension AgoraAudioEqualizationBandFrequency {
     func description() -> String {
         switch self {
-        case .band31:     return "31Hz"
-        case .band62:     return "62Hz"
-        case .band125:     return "125Hz"
-        case .band250:     return "250Hz"
-        case .band500:     return "500Hz"
-        case .band1K:     return "1kHz"
-        case .band2K:     return "2kHz"
-        case .band4K:     return "4kHz"
-        case .band8K:     return "8kHz"
-        case .band16K:     return "16kHz"
-        @unknown default:
-            return "\(self.rawValue)"
+        case .band31: return "31Hz"
+        case .band62: return "62Hz"
+        case .band125: return "125Hz"
+        case .band250: return "250Hz"
+        case .band500: return "500Hz"
+        case .band1K: return "1kHz"
+        case .band2K: return "2kHz"
+        case .band4K: return "4kHz"
+        case .band8K: return "8kHz"
+        case .band16K: return "16kHz"
+        default: return "\(self.rawValue)"
         }
     }
 }
 
 extension AgoraAudioReverbType {
     func description() -> String {
         switch self {
-        case .dryLevel:     return "Dry Level".localized
-        case .wetLevel:     return "Wet Level".localized
-        case .roomSize:     return "Room Size".localized
-        case .wetDelay:     return "Wet Delay".localized
-        case .strength:     return "Strength".localized
-        @unknown default:
-            return "\(self.rawValue)"
+        case .dryLevel: return "Dry Level".localized
+        case .wetLevel: return "Wet Level".localized
+        case .roomSize: return "Room Size".localized
+        case .wetDelay: return "Wet Delay".localized
+        case .strength: return "Strength".localized
+        @unknown default: return "\(self.rawValue)"
         }
     }
 }
 
 extension AUDIO_AINS_MODE {
     func description() -> String {
         switch self {
-        case .AINS_MODE_AGGRESSIVE:         return "AGGRESSIVE".localized
-        case .AINS_MODE_BALANCED:           return "BALANCED".localized
-        case .AINS_MODE_ULTRALOWLATENCY:    return "ULTRALOWLATENCY".localized
-        @unknown default:
-            return "\(self.rawValue)"
+        case .AINS_MODE_AGGRESSIVE: return "AGGRESSIVE".localized
+        case .AINS_MODE_BALANCED: return "BALANCED".localized
+        case .AINS_MODE_ULTRALOWLATENCY: return "ULTRALOWLATENCY".localized
+        @unknown default: return "\(self.rawValue)"
         }
     }
 }
 
 extension AgoraVoiceConversionPreset {
     func description() -> String {
         switch self {
-        case .off:
-            return "Off".localized
-        case .neutral:
-            return "Neutral".localized
-        case .sweet:
-            return "Sweet".localized
-        case .changerSolid:
-            return "Solid".localized
-        case .changerBass:
-            return "Bass".localized
-        @unknown default:
-            return "\(self.rawValue)"
+        case .off: return "Off".localized
+        case .neutral: return "Neutral".localized
+        case .sweet: return "Sweet".localized
+        case .changerSolid: return "Solid".localized
+        case .changerBass: return "Bass".localized
+        default: return "\(self.rawValue)"
         }
     }
 }
@@ -315,18 +275,14 @@ extension OutputStream {
     /// - parameter allowLossyConversion:  Whether to permit lossy conversion when writing the string. Defaults to `false`.
     ///
     /// - returns:                         Return total number of bytes written upon success. Return `-1` upon failure.
-
     func write(_ string: String, encoding: String.Encoding = .utf8, allowLossyConversion: Bool = false) -> Int {
 
         if let data = string.data(using: encoding, allowLossyConversion: allowLossyConversion) {
-            let ret = data.withUnsafeBytes {
-                write($0, maxLength: data.count)
-            }
-            if(ret < 0) {
-                print("write fail: \(streamError.debugDescription)")
+            let bytes = data.withUnsafeBytes({ $0 })
+            if let address = bytes.baseAddress {
+                write(address, maxLength: bytes.count)
             }
         }
-
         return -1
     }
 
@@ -339,4 +295,3 @@ extension Date {
         return dateformat.string(from: self)
     }
 }
-
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,7 +17,4 @@ class AppDelegate: UIResponder, UIApplicationDelegate { @@
             // Override point for customization after application launch.
             return true
         }
     }