source: launchers/macosx/README.md @ c3b8317

Last change on this file since c3b8317 was 8e988c39, checked in by meeh <meeh@…>, 22 months ago

OSX Launcher: Updated build instructions in readme

  • Property mode set to 100644
File size: 3.1 KB
Line 
1# The Mac OS X Launcher
2
3## The Event Manager
4
5This is some Swift code which makes the application use events to signal the different compoents of the application. This seems to be the cleanest way since we're doing java subprocesses and so on. This can also be named a publish-subscribe system as well. If you're familiar with Javascript it would be a handy skill.
6
7### Event Overview
8
9| Event name | Details sent as arguments | Description |
10| ------------- | ------------- | ------------- |
11| router_start | nothing | This event get triggered when the router starts |
12| router_exception | exception message | This will be triggered in case something within the functions that start the java (router) subprocess throws an exception |
13| java_found | the location | This will be triggered once the DetectJava swift class has found java |
14| router_must_upgrade | nothing | This will be triggered if no I2P is found, or if it's failing to get the version from the jar file |
15| extract_completed | nothing | This is triggered when the deployment process is done extracting I2P to it's directory |
16| router_can_start | nothing | This event will be triggered when I2P is found and a version number has been found, router won't start before this event |
17| router_stop | error if any | Triggered when the router subprocess exits |
18| router_pid | the pid number as string | Triggered when we know the pid of the router subprocess |
19| router_version | the version string | Triggered when we have successfully extracted current I2P version |
20| extract_errored | the error message | Triggered if the process didn't exit correctly |
21| router_already_running | an error message | Triggered if any processes containing i2p.jar in name/arguments already exists upon router launch |
22
23## Misc
24
25**Note** this project is WIP, cause Meeh has yet to merge in Obj-C/Swift code for GUI stuff in OSX.
26
27However, this is a thin wrapper launching both Mac OS X trayicon and the I2P router - and make them talk together.
28
29More code will be merged in, it's just a f* mess which Meeh needs to clean up and move into repo.
30
31### Java Auto Downloader
32
33We got a quite reliable source regarding the download url,
34https://github.com/Homebrew/homebrew-cask/raw/master/Casks/java.rb
35
36Homebrew is quite well maintained on OSX and any updates at Oracle should quickly reflect to brew, which again will be noticed upon builds.
37
38## Howto build
39
40You can both build the project from the Xcode UI or you can build it from command line.
41
42An example build command:
43`REPACK_I2P=1 xcodebuild -target I2PLauncher -sdk /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk`
44
45**Note** you don't need REPACK_I2P except for the first build, and each time you wish to repack the zip file containing i2p.
46
47## Objective-C / Swift Links
48
49* https://nshipster.com/at-compiler-directives/
50* https://developer.apple.com/documentation/swift/cocoa_design_patterns/handling_cocoa_errors_in_swift
51* https://content.pivotal.io/blog/rails-to-ios-what-the-are-these-symbols-in-my-code
52* https://mackuba.eu/2008/10/05/learn-objective-c-in-30-minutes/
53* https://en.wikipedia.org/wiki/Objective-C
54* http://cocoadevcentral.com/d/learn_objectivec/
55
Note: See TracBrowser for help on using the repository browser.