RFKit Document
*English 🇺🇸* [简体中文 🇨🇳](README~zh-hans.md)RFKit was a useful toolkit for daily iOS development.
Install
CocoaPods
To install using CocoaPods, add the following to your project Podfile:
pod 'RFKit'
Specify develop branch to install the lastest version:
pod 'RFKit', :git => 'https://github.com/BB9z/RFKit.git', :branch => 'develop'
RFKit support subspec, to install all RFKit components:
pod 'RFKit/ALL', :git => 'https://github.com/BB9z/RFKit.git'
Manual
You can always import RFKit by adding source code into your project. Just copy any files you needs.
dout
dout contains a set of convenient log toolcha, which was designed for debugging.
Features:
-
Out out format is better than NSLog(), and more faster.
-
Auto add expression before the results.
e.g.:
int a = 10; dout_int(101+a) // Output: 101+a = 111
* Optimized for multiple threads debugging, you can easily find the output come from which thread.
* Support add position information in log output to help tracking location of log statements. Set `DOUT_FALG_TRACE` as `1` to active.
* Special log methods for warning and error. Can change theirs behave to throw exception or assert fail.
* Behavior can be highly customizable through the switch.
* As macro, usually no performance loss.
Details: [dout Document(in Chinese)](doc/dout.md)
RFRuntime
-------------
Handle build or runtime differences. Provides an unified and simple interface for upper components. Contains：debugging switch define, default header file, RFARC and language extensions.
### Debugging switch
`RFDEBUG`, RFKit debug mode switch. Set as `1` to active. If it´s not defined, will defined as `1` when `DEBUG` is true and `NDEBUG` not defined.
`RFDebugLevel`, controlling debugging behavior. If it´s not defined, will be defined as `2` if `RFDEBUG` is true, otherwise `1`.
### Default header file
UIKit and Foundation header is included in RFRuntime by default.
### RFARC
Dedicated to processing the ARC's compatible. One can write code which is compatible with the ARC and non-ARC environment with `RF_STRONG` and `RF_WEAK`. As ARC support GCD after iOS 6, `RF_dispatch_retain`, `RF_dispatch_release`, `RF_GCD_STRONG` and `RF_GCD_WEAK` were added.
### RFFeatureSupport
Defined some fake protocols for declaring a class support something or not.
### RFDispatch
Some helper function for GCD.
### Language extensions
Include some components from [libextobjc](https://github.com/jspahrsummers/libextobjc):
* metamacros.h, macros for metaprogramming.
* EXTKeyPathCoding, allows compile-time verification of key paths.
* EXTScope, several tools relative to scope.
@keypathClassInstance is similar with @keypath, but accept a class as parameter instead of a instance variable.
UIKit & Foundation Categories
-------------
Important part of RFKit. They contains many useful methods.
`RFKitDefaultCategories.h` defends which extension is imported by default.
See each header file to know the specific features.
RFGeometry
-------------
Add new methods and constants for geometry structures: `CGPoint`, `CGSize`, `CGRect`. Add an new `CGAngle` angle structure.
`RFResizeAnchor` and `RFAlignmentAnchor` provides a reference for resizing and aligning.
RFPerformance & doutkit
-------
Performance toolkit.
Others
-------------
Some external components were placed under `external` folder.
UncaughtExceptionHandler, generally used for internal testing. Call `InstallUncaughtExceptionHandler()` to active. It catch errors at runtime to determine problems in non-debug environment.
Change log: https://github.com/BB9z/RFKit/releases