Juri Pakaste  committed 14c60a0


  • Participants
  • Parent commits 8436f0b

Comments (0)

Files changed (1)

-nsstringfromenumgen generates Objective-C functions for converting enums to
-NSStrings. It uses libclang to do it.
+nsstringfromenumgen generates Objective-C functions for converting enums to NSStrings. It uses libclang for parsing.
+Assuming you're on a Mac, you need Xcode and the command line tools installed. On other platforms you probably need libclang somewhere where Python finds it.
+This software includes a copy of the libclang Python bindings because they aren't installed by Xcode. They require LLVM 3.1 which is included at least in Xcode 4.5.2.
+Call ``nsstringfromenumgen`` with one or more Objective-C source files. It parses them and outputs NSStringFromEnum functions for each enumeration found. It tries to be smart with typedefs and enum names and if it finds both names, it produces two functions. It also outputs an extern declaration for each function.
+If your code relies on a prefix header, you need to include it on the command line with the ``--include`` flag. You can specify more than one of them if necessary.
+Because libclang is a real C parser, your file needs to make sense. If libclang produces errors, nsstringfromenumgen gives up because the syntax tree tends to be unpredictable in the presence of errors.