Difference between revisions of "ObjCParser"

From Lazarus wiki
Jump to navigationJump to search
Line 66: Line 66:
  
 
for example
 
for example
[TypeReplace]
+
[TypeReplace]
NSUInteger = Longword;
+
NSUInteger = Longword;
NSUInteger* = LongWord;
+
NSUInteger* = LongWord;
  
 
so the following code would be generated
 
so the following code would be generated

Revision as of 20:50, 16 February 2009

ObjCparser is the tool that helps to convert obj-c header to FPC headers as described at PasCocoa


Currently ObjCParser supports Objective-C 1.0 language specification. (Objective-C 2.0 properties are not yet supported).

ObjCParser is available at PasCocoa/Parser folder

SVN: https://lazarus-ccr.svn.sourceforge.net/svnroot/lazarus-ccr/bindings/pascocoa/parser/


Command line usage is the following:

objcparser [switches] [headername.h]

Supported switches:

-all (any file named *.h is considered a header file and being parsed);

-ini (setting file)

-uini (setting file to write to updated files. Type definition information [TypeDefs] is written to the specified file )

-noout (.inc files are not generated, though config file (is still written, if specified)

Configuration File Sections

Configuration file uses simple .INI file format, so it can be easily edited by any editor available.

Common flags

Following parsing settings are defined at [Common] section

  • mainunit=mainunitname

defines the main unit specifier to be added to the generated pascal files

 [Common]
 mainunit=HelloWorld.pas

would result, each .inc generated file to contain <delphi> {$mainunit HelloWorld.pas} </delphi>


  • ignoreinclude

specifies, what file #include or #import must be ignored, otherwise file would be also $include-d. Full file name must be specified, or if file name ends with back slash (CoreFoundation/), all files that belongs to the path would also be ignored (like: CoreFoundation/SomeFile.h, CoreFoundation/SomeFile2.h)

files specified as ignoreinclude value should be space seperated.

it is possible to define any number of ignoreinclude values, but they must be prefixed whith 'ignoreinclude', for example

 [Common]
 ignoreinclude = "ioctrl.h"
 ignoreinclude1 = "iostd.h conio.h SomeLib/"
 ignoreinclude2 = "Foundation/ MyLib/hello2.h"

in this case: #include or #import definition containing: "ioctrl.h", "iostd.h", "conio.h" or "MyLib/hello2.h" or any file that is sub-file to "Foundation" or "SomeLib" folders are ignored.

There's no difference if <> or "" is used to #include or #import a file.

Type replacement

[TypeReplace] Replaces type name (at method params, results, and type structures) with specified type name. type replacement can also be specified for type references, for this case type name must end with '*' (asterix)

for example

[TypeReplace]
NSUInteger = Longword;
NSUInteger* = LongWord;

so the following code would be generated objc: <objc> -(NSUInteger) doSomethingWithNumber: (NSUInteger *) num </objc>

pascal: <delphi> function SomeClass.doSomethingWithNumber(num: PLongword): LongWord; </delphi>

Type name definition

[TypeDefs] Specifies the type name usage.

There're 4 types available:

  • int (any type that can be casted to 4-byte integer)
  • float (float point value: single or double)
  • struct (any type or structure that cannot be cased to 4 byte integer or larger than 4 bytes)
  • objcclass (objective-c class)

if type definition is not specified, it's considered to be int-typed.

this information is critical to select proper objc_msgSend function (implementation section). objcclass types are also replaced with 'objc.id' type to avoid type naming conflicts between pascal and objc class names.

Token Replacement

Token replacement (currently REMOVE ONLY) should be used to get rid of C pre-compiler defined values.

[TokenReplace]
AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER=""

AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER token is usually met by method, function or type declaration. It should be removed, or file is cannot be parsed correctly. Remember double quotes "" (empty string) must be specified, or parser ignores TokenReplacement