b2e5f0908473ed1dc0a2bef3a2f1fb151082a73c
1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
24 # Path to the output file
25 var opt_output
= new OptionString("Output file", "-o")
27 # Shall `init` methods/constructors be wrapped as methods?
29 # By default, these methods/constructors are wrapped as extern constructors.
30 # So initializing an extern Objective-C object looks like:
32 # var o = new NSArray.init_with_array(some_other_array)
35 # If this option is set, the object must first be allocated and then initialized.
36 # This is closer to the Objective-C behavior:
39 # o.init_with_array(some_other_array)
41 var opt_init_as_methods
= new OptionBool(
42 "Wrap `init...` constructors as Nit methods instead of Nit constructors",
45 private var objc_to_nit_types
: Map[String, String] is lazy
do
46 var types
= new HashMap[String, String]
47 types
["char"] = "Byte"
48 types
["short"] = "Int"
49 types
["short int"] = "Int"
52 types
["long int"] = "Int"
53 types
["long long"] = "Int"
54 types
["long long int"] = "Int"
55 types
["float"] = "Float"
56 types
["double"] = "Float"
57 types
["long double"] = "Float"
59 types
["NSUInteger"] = "Int"
60 types
["BOOL"] = "Bool"
61 types
["id"] = "NSObject"
62 types
["constid"] = "NSObject"
63 types
["SEL"] = "NSObject"
64 types
["void"] = "Pointer"
71 redef fun knows_type
(objc_type
) do return super or
72 objc_to_nit_types
.keys
.has
(objc_type
)
81 # Generate Nit code to wrap `classes`
84 var classes
= model
.classes
86 # Open specified path or stdin
88 var path
= opt_output
.value
90 if path
.file_extension
!= "nit" then
91 print_error
"Warning: output file path does not end with '.nit'"
94 file
= new FileWriter.open
(path
)
101 # File generated by objcwrapper with the following command:
102 # {{{program_name}}} {{{args.join(" ")}}}
106 file
.write
"import cocoa::foundation\n"
107 for classe
in classes
do
108 write_class
(classe
, file
)
111 if path
!= null then file
.close
114 private fun write_class
(classe
: ObjcClass, file
: Writer)
119 extern class {{{classe.name}}} in "ObjC" `{ {{{classe.name}}} * `}
123 for super_name
in classe
.super_names
do file
.write
"""
124 super {{{super_name}}}
126 if classe
.super_names
.is_empty
then file
.write
"""
130 # Constructor or constructors
131 write_constructors
(classe
, file
)
134 for attribute
in classe
.attributes
do
135 write_attribute
(attribute
, file
)
138 # Instance methods '-'
139 for method
in classe
.methods
do
140 if not model
.knows_all_types
(method
) then method
.is_commented
= true
142 if not opt_init_as_methods
.value
and method
.is_init
then continue
143 if method
.is_class_property
then continue
145 write_method_signature
(method
, file
)
146 write_objc_method_call
(method
, file
)
154 for method
in classe
.methods
do
155 if not method
.is_class_property
then continue
157 write_method_signature
(method
, file
)
158 write_objc_method_call
(method
, file
)
162 private fun write_constructors
(classe
: ObjcClass, file
: Writer)
164 if opt_init_as_methods
.value
then
165 # A single constructor for `alloc`
169 return [{{{classe.name}}} alloc];
175 # A constructor per `init...` method
176 for method
in classe
.methods
do
177 if not method
.is_init
then continue
179 if not model
.knows_all_types
(method
) then method
.is_commented
= true
181 write_method_signature
(method
, file
)
183 write_objc_init_call
(classe
.name
, method
, file
)
187 private fun write_attribute
(attribute
: ObjcAttribute, file
: Writer)
189 if not model
.knows_type
(attribute
.return_type
) then attribute
.is_commented
= true
191 write_attribute_getter
(attribute
, file
)
192 # TODO write_attribute_setter if there is no `readonly` annotation
195 private fun write_attribute_getter
(attribute
: ObjcAttribute, file
: Writer)
197 var nit_attr_name
= attribute
.name
.to_snake_case
198 var nit_attr_type
= attribute
.return_type
.objc_to_nit_type
200 var c
= attribute
.comment_str
205 {{{c}}} fun {{{nit_attr_name}}}: {{{nit_attr_type}}} in "ObjC" `{
206 {{{c}}} return [self {{{attribute.name}}}];
211 private fun write_attribute_setter
(attribute
: ObjcAttribute, file
: Writer)
213 var nit_attr_name
= attribute
.name
.to_snake_case
214 var nit_attr_type
= attribute
.return_type
.objc_to_nit_type
216 var c
= attribute
.comment_str
221 {{{c}}} fun {{{nit_attr_name}}}=(value: {{{nit_attr_type}}}) in "ObjC" `{
222 {{{c}}} return self.{{{attribute.name}}} = value;
227 private fun write_method_signature
(method
: ObjcMethod, file
: Writer)
229 var c
= method
.comment_str
231 # Build Nit method name
233 for param
in method
.params
do
234 name
+= param
.name
[0].to_upper
.to_s
+ param
.name
.substring_from
(1)
236 name
= name
.to_snake_case
238 if name
== "init" then name
= ""
240 # If class method, prefix with class name
241 if method
.is_class_property
then name
= "{method.objc_class.name.to_snake_case}_{name}"
244 var fun_keyword
= "fun"
245 if not opt_init_as_methods
.value
and method
.is_init
then
250 var params
= new Array[String]
251 for param
in method
.params
do
252 if param
.is_single
then break
253 params
.add
"{param.variable_name}: {param.return_type.objc_to_nit_type}"
256 var params_with_par
= ""
257 if params
.not_empty
then params_with_par
= "({params.join(", ")})"
261 if method
.return_type
!= "void" and fun_keyword
!= "new" then
262 ret
= ": {method.return_type.objc_to_nit_type}"
268 {{{c}}}{{{fun_keyword}}} {{{name}}}{{{params_with_par}}}{{{ret}}} in "ObjC" `{
272 # Write a combined call to alloc and to a constructor/method
273 private fun write_objc_init_call
(class_name
: String, method
: ObjcMethod, file
: Writer)
275 # Method name and other params
276 var params
= new Array[String]
277 for param
in method
.params
do
278 if not param
.is_single
then
279 params
.add
"{param.name}: {param.variable_name}"
280 else params
.add param
.name
283 var c
= method
.comment_str
286 {{{c}}} return [[{{{class_name}}} alloc] {{{params.join(" ")}}}];
291 private fun write_objc_method_call
(method
: ObjcMethod, file
: Writer)
293 # Is there a value to return?
295 if method
.return_type
!= "void" then ret
= "return "
297 # Method name and other params
298 var params
= new Array[String]
299 for param
in method
.params
do
300 if not param
.is_single
then
301 params
.add
"{param.name}: {param.variable_name}"
302 else params
.add param
.name
305 # Receiver, instance or class
307 if method
.is_class_property
then recv
= method
.objc_class
.name
309 var c
= method
.comment_str
312 {{{c}}} {{{ret}}}[{{{recv}}} {{{params.join(" ")}}}];
319 # Nit equivalent to this type
320 private fun objc_to_nit_type
: String
322 var types
= sys
.objc_to_nit_types
324 if types
.has_key
(self) then
332 redef class ObjcProperty
333 private fun comment_str
: String do if is_commented
then
337 # Full documentation to be generated for the Nit code
338 private fun doc
: String is abstract
341 redef class ObjcMethod
342 private fun indent
: String do return if is_class_property
then "" else "\t"
344 redef fun comment_str
do return indent
+ super
348 var recv
= if is_class_property
then objc_class
.name
else "self"
349 return "{indent}# Wraps: `[{recv} {params.join(" ")}]`"
353 redef class ObjcAttribute
354 redef fun doc
do return "\t# Wraps: `{objc_class.name}.{name}`"