Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 2.17 KB

README.mdown

File metadata and controls

26 lines (16 loc) · 2.17 KB

CDEvents Project status

What is this?

It's an Objective-C wrapper for Mac OS X's FSEvents C API. Inspired and based upon the (MIT-licensed) open source project SCEvents created by Stuart Connolly.

Requirements

Requires Mac OS X 10.5, since FSEvents were introduced in 10.5, and an Intel CPU. Supports both manual memory management and garbage collection.

What differentiates CDEvents from SCEvents then?

Not all that much but a few things differentiate the two. The (event data wrapper) class CDEvent is immutable in contrast to SCEvent which is mutable. The next difference, which were the initial reason why I decided to rewrite SCEvents is that the class SCEvents' is a singleton class, where's CDEvents is a "normal" class. I couldn't find a good reason as to why SCEvents had been designed that way and for my project a "normal" non-singleton class would be and is better.

Another difference between CDEvents and SCEvents is that CDEvents is available for both manual memory management and environments using garbage collection.

So I've written some of the code from scratch and "borrowed" some from SCEvents.

API documentation

You can generate API documentation with the help of Doxygen. In Doxygen open the file api.doxygen, click the Run tab and then the Run doxygen button. When it's done you should have a directory (ignored by git) in the root of the project named api with a sub-directory html in which you will find index.html double-click and enjoy.

Authors

  • Aron Cedercrantz

License

The code is released under the MIT-license.

If you want, even though you really don't have to, I would love hearing what you use CDEvents for! Send me an email (first name @ last name dot se) or a message via GitHub.