ObjCParser: what changed

Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		## Overview
2	2
3	3		ObjCparser is the tool that helps to convert Objective-C headers to FPC headers as described at [[PasCocoa]]
4	4
5	5		Currently, the ObjCParser supports the Objective-C 1.0 language specification. (Objective-C 2.0 properties are not yet supported).
6	6
7	7		## Installation
8	8
9	9		ObjCParser is available from the PasCocoa/Parser folder:
10	10
11	11		SVN: <https://sourceforge.net/p/lazarus-ccr/svn/475/tree/bindings/pascocoa/parser/>
12	12
13	13		## Usage
14	14
15	15		The command line usage of the Parser is the following:
16	16
17	17		objcparser \[switches\] \[headername.h\]
18	18
19	19		Supported switches:
20	20
21	21		-all (any file named *.h is considered a header file and being parsed);
22	22
23	23		-ini (setting file)
24	24
25	25		-uini (setting file to write to updated files. Type definition information \[TypeDefs\] is written to the specified file )
26	26
27	27		-noout (.inc files are not generated. However, if specified, the config file is still written)
28	28
29	29		### Configuration File Sections
30	30
31	31		The configuration file uses the simple .INI file format. So, it can be easily edited by any editor available.
32	32
33	33		### Common flags
34	34
35	35		Following parsing settings are defined in the \[Common\] section
36	36
37	37		- mainunit=mainunitname
38	38
39	39		defines the main unit specifier to be added to the generated pascal files
40	40
41		-	~~` [Common]`\~~
42		-	~~` mainunit=HelloWorld.pas`~~
	41	+	```text
	42	+	[Common]
	43	+	mainunit=HelloWorld.pas
	44	+	```
43	45
44	46		As a result, each .inc generated file contains
45	47
46	48		``` pascal
47	49		{$mainunit HelloWorld.pas}
48	50		```
49	51
50	52		- ignoreinclude
51	53
52	54		specifies, what file \#include or \#import must be ignored, otherwise file would be also \$include-d. The full file name must be specified, or if the 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)
53	55
54	56		Files specified as ignoreinclude value should be space separated.
55	57
56	58		It is possible to define any number of ignoreinclude values, but they must be prefixed whith 'ignoreinclude'.
57	59
58	60		Example:
59	61
60		-	~~` [Common]`\~~
61		-	~~` ignoreinclude = "ioctrl.h"`\~~
62		-	~~` ignoreinclude1 = "iostd.h conio.h SomeLib/"`\~~
63		-	~~` ignoreinclude2 = "Foundation/ MyLib/hello2.h"`~~
	62	+	```text
	63	+	[Common]
	64	+	ignoreinclude = "ioctrl.h"
	65	+	ignoreinclude1 = "iostd.h conio.h SomeLib/"
	66	+	ignoreinclude2 = "Foundation/ MyLib/hello2.h"
	67	+	```
64	68
65	69		in this case: \#include or \#import definition containing: "ioctrl.h", "iostd.h", "conio.h" or "MyLib/hello2.h" or any file that is a sub-file to "Foundation" or "SomeLib" folders is ignored.
66	70
67	71		There is no difference whether \<\> or "" is used to \#include or \#import a file.
68	72
69	73		### Type replacement
70	74
71	75		\[TypeReplace\] Replaces type name (at method params, results, and type structures) with the specified type name. type replacement can also be specified for type references, for this case type the name must end with '*' (asterisk)
72	76
73	77		Example:
74	78
75		-	~~`[TypeReplace]`\~~
76		-	~~`NSUInteger = Longword;`\~~
77		-	~~`NSUInteger* = PLongWord;`~~
	79	+	```text
	80	+	[TypeReplace]
	81	+	NSUInteger = Longword;
	82	+	NSUInteger* = PLongWord;
	83	+	```
78	84
79	85		This generates the following code: objc: \<objc\> -(NSUInteger) doSomethingWithNumber: (NSUInteger *) num \</objc\>
80	86
81	87		pascal:
82	88
83	89		``` pascal
84	90		function SomeClass.doSomethingWithNumber(num: PLongword): LongWord;
85	91		```
86	92
87	93		### Type name definition
88	94
89	95		\[TypeDefs\] Specifies the type name usage.
90	96
91	97		There are 4 types available:
92	98
93	99		- int (any type that can be cast to a 4-byte integer)
94	100
95	101		- float (floating point value: single or double)
96	102
97	103		- struct (any type or structure that cannot be cast to a 4 byte integer or larger than 4 bytes)
98	104
99	105		- objcclass (objective-c class)
100	106
101	107		if no type definition is specified, it is considered to be int-typed.
102	108
103	109		this information is critical to select the proper objc_msgSend function (implementation section). objcclass types are also replaced with the 'objc.id' type to avoid type naming conflicts between pascal and objc class names.
104	110
105	111		### Token Replacement
106	112
107	113		Token replacement (currently REMOVE ONLY) should be used to get rid of C pre-compiler defined values.
108	114
109		-	~~`[TokenReplace]`\~~
110		-	~~`AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER=""`~~
	115	+	```text
	116	+	[TokenReplace]
	117	+	AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER=""
	118	+	```
111	119
112	120		AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER token is usually met by the method, function or type declaration. It should be removed or the file cannot be parsed correctly. Remember, that double quotes "" (empty string) must be specified or the parser ignores TokenReplacement
113	121
114	122		---
115	123		From the Free Pascal wiki, page "ObjCParser", as it stood on 2020-06-12 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
116	124		Category: Lazarus-CCR
117	125		Category: Objective Pascal
118	126		Category: Objective-C
119	127		Category: macOS

Back to history