Rhea

Requirements

Basic Usage

import RheaExtension#rhea(time:.customEvent, priority:.veryLow, repeatable:true, func:{ _inprint("~~~~ customEvent in main")})#rhea(time:.homePageDidAppear,async:true, func:{ contextin    // This will run on a background threadprint("~~~~ homepageDidAppear")})#rhea(time:.load){ _inprint("load with trailing closure")}#load{print("use load directly")}#premain{print("use premain directly")}#appDidFinishLaunching{print("use appDidFinishLaunching directly")}class ViewController:UIViewController{        #load{DispatchQueue.global().async{print("~~~~ load nested in main")}}    #rhea(time:.homePageDidAppear){ contextinprint("homePageDidAppear with trailing closure\(context.param)")}overridefunc viewDidAppear(_ animated:Bool){        super.viewDidAppear(animated)Rhea.trigger(event:.homePageDidAppear, param:self)}}

/// Registers a callback function for a specific Rhea event.////// This macro is used to register a callback function to a section in the binary,/// associating it with a specific event time, priority, and repeatability.////// - Parameters:///   - time: A `RheaEvent` representing the timing or event name for the callback.///           This parameter also supports direct string input, which will be///           processed by the framework as an event identifier.///   - priority: A `RheaPriority` value indicating the execution priority of the callback.///               Default is `.normal`. Predefined values include `.veryLow`, `.low`,///               `.normal`, `.high`, and `.veryHigh`. Custom integer priorities are also///               supported. Callbacks for the same event are sorted and executed based///               on this priority.///   - repeatable: A boolean flag indicating whether the callback can be triggered multiple times.///                 If `false` (default), the callback will only be executed once.///                 If `true`, the callback can be re-triggered on subsequent event occurrences.///   - async: A boolean flag indicating whether the callback should be executed asynchronously.///            If `false` (default), the callback will be executed on the main thread.///            If `true`, the callback will be executed on a background thread. Note that when///            `async` is `true`, the execution order based on `priority` may not be guaranteed.///            Even when `async` is set to `false`, users can still choose to dispatch their tasks///            to a background queue within the callback function if needed. This provides///            flexibility for handling both quick, main thread operations and longer-running///            background tasks.///   - func: The callback function of type `RheaFunction`. This function receives a `RheaContext`///           parameter, which includes `launchOptions` and an optional `Any?` parameter.////// - Note: When triggering an event externally using `Rhea.trigger(event:param:)`, you can include///         an additional parameter that will be passed to the callback via the `RheaContext`.////// ```swift/// #rhea(time: .load, priority: .veryLow, repeatable: true, func: { _ in///     print("~~~~ load in Account Module")/// })////// #rhea(time: .registerRoute, func: { _ in///     print("~~~~ registerRoute in Account Module")/// })////// // Use a StaticString as event directly/// #rhea(time: "ACustomEventString", func: { _ in///     print("~~~~ custom event")/// })////// // Example of using async execution/// #rhea(time: .load, async: true, func: { _ in///     // This will run on a background thread///     performHeavyTask()/// })////// // Example of manually dispatching to background queue when async is false/// #rhea(time: .load, func: { _ in///     DispatchQueue.global().async {///         // Perform background task///     }/// })/// ```/// - Note: ⚠️⚠️⚠️ When extending ``RheaEvent`` with static constants, ensure that///   the constant name exactly matches the string literal value. This practice///   maintains consistency and prevents confusion.///@freestanding(declaration)public macro rhea(    time:RheaEvent,    priority:RheaPriority=.normal,    repeatable:Bool=false,async:Bool=false,    func:RheaFunction)= #externalMacro(module:"RheaTimeMacros", type:"WriteTimeToSectionMacro")

Performance

Usage

func complexFunction(context:RheaContext){    // Complex business logicperformComplexTask()handleMultipleOperations()}#rhea(time:.load){ contextincomplexFunction(context: context)}

Project Integration

Example Project:https://github.com/Asura19/RheaExample

extensionRheaEvent{publicstaticlethomePageDidAppear:RheaEvent="homePageDidAppear"publicstaticletregisterRoute:RheaEvent="registerRoute"publicstaticletdidEnterBackground:RheaEvent="didEnterBackground"}

BusinessA    BusinessB    ↓           ↓RheaExtension     ↓  RheaTime

#rhea(time: .appDidFinishLaunching, func: { _ in    NotificationCenter.default.addObserver(        forName: UIApplication.didEnterBackgroundNotification,        object: nil,        queue: .main    ) { _ in        Rhea.trigger(event: .didEnterBackground)    }})

#rhea(time: .didEnterBackground, repeatable: true, func: { _ in    print("~~~~ app did enter background")})

Swift Package Manager

// Package.swiftletpackage=Package(    name:"RheaExtension",    platforms:[.iOS(.v13)],    products:[.library(name:"RheaExtension", targets:["RheaExtension"]),],    dependencies:[.package(url:"https://github.com/reers/Rhea.git", from:"2.2.7")],    targets:[.target(            name:"RheaExtension",            dependencies:[.product(name:"RheaTime",package:"Rhea")],            // Add experimental feature enable here            swiftSettings:[.enableExperimentalFeature("SymbolLinkageMarkers")]),])// RheaExtension.swift// After @_exported, other business modules and main target only need to import RheaExtension@_exportedimport RheaTimeextensionRheaEvent{publicstaticlethomePageDidAppear:RheaEvent="homePageDidAppear"publicstaticletregisterRoute:RheaEvent="registerRoute"publicstaticletdidEnterBackground:RheaEvent="didEnterBackground"}

// Business Module Account// Package.swiftletpackage=Package(    name:"Account",    platforms:[.iOS(.v13)],    products:[.library(            name:"Account",            targets:["Account"]),],    dependencies:[.package(name:"RheaExtension", path:"../RheaExtension")],    targets:[.target(            name:"Account",            dependencies:[.product(name:"RheaExtension",package:"RheaExtension")],            // Add experimental feature enable here            swiftSettings:[.enableExperimentalFeature("SymbolLinkageMarkers")]),])// Business Module Account usageimport RheaExtension#rhea(time:.homePageDidAppear, func:{ contextinprint("~~~~ homepageDidAppear in main")})

// Main target usageimport RheaExtension#rhea(time:.premain, func:{ _inRhea.trigger(event:.registerRoute)})

#rhea(time: "ACustomEventString", func: { _ in    print("~~~~ custom event")})

CocoaPods

pod'RheaTime'

// RheaExtension podspecPod::Spec.newdo |s|  s.name= 'RheaExtension'  s.version= '0.1.0'  s.summary= 'A short description of RheaExtension.'  s.description=<<-DESCTODO: Add long description of the pod here.                       DESC  s.homepage= 'https://github.com/bjwoodman/RheaExtension'  s.license={:type => 'MIT',:file => 'LICENSE'}  s.author={ 'bjwoodman'=> 'x.rhythm@qq.com'}  s.source={:git => 'https://github.com/bjwoodman/RheaExtension.git', :tag => s.version.to_s }  s.ios.deployment_target= '13.0'  s.source_files= 'RheaExtension/Classes/**/*'  s.dependency 'RheaTime', '2.2.7'  # Copy following config to your pod  s.pod_target_xcconfig={    'OTHER_SWIFT_FLAGS'=> '-enable-experimental-feature SymbolLinkageMarkers-Xfrontend-load-plugin-executable-Xfrontend ${PODS_ROOT}/RheaTime/MacroPlugin/RheaTimeMacros#RheaTimeMacros'}end

Pod::Spec.newdo |s|  s.name= 'Account'  s.version= '0.1.0'  s.summary= 'A short description of Account.'  s.description=<<-DESCTODO: Add long description of the pod here.                       DESC  s.homepage= 'https://github.com/bjwoodman/Account'  s.license={:type => 'MIT',:file => 'LICENSE'}  s.author={ 'bjwoodman'=> 'x.rhythm@qq.com'}  s.source={:git => 'https://github.com/bjwoodman/Account.git', :tag => s.version.to_s }  s.ios.deployment_target= '13.0'  s.source_files= 'Account/Classes/**/*'  s.dependency 'RheaExtension'    # Copy following config to your pod  s.pod_target_xcconfig={    'OTHER_SWIFT_FLAGS'=> '-enable-experimental-feature SymbolLinkageMarkers-Xfrontend-load-plugin-executable-Xfrontend ${PODS_ROOT}/RheaTime/MacroPlugin/RheaTimeMacros#RheaTimeMacros'}end

post_installdo |installer|installer.pods_project.targets.eachdo |target|rhea_dependency=target.dependencies.find{ |d|['RheaTime','RheaExtension'].include?(d.name)}ifrhea_dependencyputs"Adding Rhea Swift flags to target:#{target.name}"target.build_configurations.eachdo |config|swift_flags=config.build_settings['OTHER_SWIFT_FLAGS'] ||=['$(inherited)']plugin_flag='-Xfrontend -load-plugin-executable -Xfrontend ${PODS_ROOT}/RheaTime/MacroPlugin/RheaTimeMacros#RheaTimeMacros'unlessswift_flags.join(' ').include?(plugin_flag)swift_flags.concat(plugin_flag.split)end# Add SymbolLinkageMarkers experimental feature flagsymbol_linkage_flag='-enable-experimental-feature SymbolLinkageMarkers'unlessswift_flags.join(' ').include?(symbol_linkage_flag)swift_flags.concat(symbol_linkage_flag.split)endconfig.build_settings['OTHER_SWIFT_FLAGS']=swift_flagsendendendend

Note

Author

License