1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
|
/* valaclass.vala
*
* Copyright (C) 2006-2008 Jürg Billeter
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Author:
* Jürg Billeter <j@bitron.ch>
*/
using GLib;
using Gee;
/**
* Represents a class declaration in the source code.
*/
public class Vala.Class : Typesymbol {
/**
* Specifies the base class.
*/
public Class base_class { get; set; }
/**
* Specifies whether this class is abstract. Abstract classes may not be
* instantiated.
*/
public bool is_abstract { get; set; }
/**
* Specifies whether this class is static. Static classes may not be
* instantiated and may only contain static members.
*/
public bool is_static { get; set; }
/**
* Specifies whether this class has private fields.
*/
public bool has_private_fields { get; private set; }
private string cname;
private string const_cname;
private string lower_case_cprefix;
private string lower_case_csuffix;
private bool has_type_id;
private string type_id;
private string ref_function;
private string unref_function;
private string copy_function;
private string free_function;
private string marshaller_type_name;
private string get_value_function;
private string set_value_function;
private Gee.List<TypeParameter> type_parameters = new ArrayList<TypeParameter> ();
private Gee.List<DataType> base_types = new ArrayList<DataType> ();
private Gee.List<Constant> constants = new ArrayList<Constant> ();
private Gee.List<Field> fields = new ArrayList<Field> ();
private Gee.List<Method> methods = new ArrayList<Method> ();
private Gee.List<Property> properties = new ArrayList<Property> ();
private Gee.List<Signal> signals = new ArrayList<Signal> ();
// inner types
private Gee.List<Class> classes = new ArrayList<Class> ();
private Gee.List<Struct> structs = new ArrayList<Struct> ();
private Gee.List<Enum> enums = new ArrayList<Enum> ();
private Gee.List<Delegate> delegates = new ArrayList<Delegate> ();
/**
* Specifies the default construction method.
*/
public Method default_construction_method { get; set; }
/**
* Specifies the instance constructor.
*/
public Constructor constructor { get; set; }
/**
* Specifies the static class constructor.
*/
public Constructor static_constructor { get; set; }
/**
* Specifies the instance destructor.
*/
public Destructor destructor { get; set; }
/**
* Specifies whether this class denotes an error base.
*/
public bool is_error_base { get; set ; }
/**
* Creates a new class.
*
* @param name type name
* @param source reference to source code
* @return newly created class
*/
public Class (string name, SourceReference source_reference = null) {
this.source_reference = source_reference;
this.name = name;
}
/**
* Adds the specified class or interface to the list of base types of
* this class.
*
* @param type a class or interface reference
*/
public void add_base_type (DataType type) {
base_types.add (type);
type.parent_node = this;
}
/**
* Returns a copy of the base type list.
*
* @return list of base types
*/
public Collection<DataType> get_base_types () {
return new ReadOnlyCollection<DataType> (base_types);
}
/**
* Appends the specified parameter to the list of type parameters.
*
* @param p a type parameter
*/
public void add_type_parameter (TypeParameter p) {
type_parameters.add (p);
p.type = this;
scope.add (p.name, p);
}
/**
* Returns a copy of the type parameter list.
*
* @return list of type parameters
*/
public Collection<TypeParameter> get_type_parameters () {
return new ReadOnlyCollection<TypeParameter> (type_parameters);
}
/**
* Adds the specified constant as a member to this class.
*
* @param c a constant
*/
public void add_constant (Constant c) {
constants.add (c);
scope.add (c.name, c);
}
/**
* Adds the specified field as a member to this class.
*
* @param f a field
*/
public void add_field (Field f) {
fields.add (f);
if (f.access == SymbolAccessibility.PRIVATE && f.instance) {
has_private_fields = true;
}
scope.add (f.name, f);
}
/**
* Returns a copy of the list of fields.
*
* @return list of fields
*/
public Collection<Field> get_fields () {
return new ReadOnlyCollection<Field> (fields);
}
/**
* Adds the specified method as a member to this class.
*
* @param m a method
*/
public void add_method (Method m) {
if (m.instance || m is CreationMethod) {
if (m.this_parameter != null) {
m.scope.remove (m.this_parameter.name);
}
m.this_parameter = new FormalParameter ("this", new ClassType (this));
m.scope.add (m.this_parameter.name, m.this_parameter);
}
if (!(m.return_type is VoidType) && m.get_postconditions ().size > 0) {
if (m.result_var != null) {
m.scope.remove (m.result_var.name);
}
m.result_var = new VariableDeclarator ("result");
m.result_var.type_reference = m.return_type.copy ();
m.scope.add (m.result_var.name, m.result_var);
}
if (m is CreationMethod) {
if (m.name == null) {
default_construction_method = m;
m.name = ".new";
} else {
m.name = ".new." + m.name;
}
var cm = (CreationMethod) m;
if (cm.type_name != null && cm.type_name != name) {
// type_name is null for constructors generated by GIdlParser
Report.error (m.source_reference, "missing return type in method `%s.%s´".printf (get_full_name (), cm.type_name));
m.error = true;
return;
}
}
methods.add (m);
scope.add (m.name, m);
}
/**
* Returns a copy of the list of methods.
*
* @return list of methods
*/
public Collection<Method> get_methods () {
return new ReadOnlyCollection<Method> (methods);
}
/**
* Adds the specified property as a member to this class.
*
* @param prop a property
*/
public void add_property (Property prop, bool no_field = false) {
properties.add (prop);
scope.add (prop.name, prop);
prop.this_parameter = new FormalParameter ("this", new ClassType (this));
prop.scope.add (prop.this_parameter.name, prop.this_parameter);
if (!no_field && source_reference != null && !source_reference.file.pkg) {
bool empty_get = (prop.get_accessor != null && prop.get_accessor.body == null);
bool empty_set = (prop.set_accessor != null && prop.set_accessor.body == null);
if (empty_get != empty_set) {
if (empty_get) {
Report.error (prop.source_reference, "property getter must have a body");
} else if (empty_set) {
Report.error (prop.source_reference, "property setter must have a body");
}
prop.error = true;
return;
}
if (empty_get && empty_set) {
/* automatic property accessor body generation */
var field_type = prop.type_reference.copy ();
var f = new Field ("_%s".printf (prop.name), field_type, prop.default_expression, prop.source_reference);
f.access = SymbolAccessibility.PRIVATE;
prop.field = f;
add_field (f);
}
}
}
/**
* Returns a copy of the list of properties.
*
* @return list of properties
*/
public Collection<Property> get_properties () {
return new ReadOnlyCollection<Property> (properties);
}
/**
* Adds the specified signal as a member to this class.
*
* @param sig a signal
*/
public void add_signal (Signal sig) {
signals.add (sig);
scope.add (sig.name, sig);
}
/**
* Returns a copy of the list of signals.
*
* @return list of signals
*/
public Collection<Signal> get_signals () {
return new ReadOnlyCollection<Signal> (signals);
}
/**
* Adds the specified class as an inner class.
*
* @param cl a class
*/
public void add_class (Class cl) {
classes.add (cl);
scope.add (cl.name, cl);
}
/**
* Adds the specified struct as an inner struct.
*
* @param st a struct
*/
public void add_struct (Struct st) {
structs.add (st);
scope.add (st.name, st);
}
/**
* Adds the specified enum as an inner enum.
*
* @param en an enum
*/
public void add_enum (Enum en) {
enums.add (en);
scope.add (en.name, en);
}
/**
* Adds the specified delegate as an inner delegate.
*
* @param d a delegate
*/
public void add_delegate (Delegate d) {
delegates.add (d);
scope.add (d.name, d);
}
public override void accept (CodeVisitor visitor) {
visitor.visit_class (this);
}
public override void accept_children (CodeVisitor visitor) {
foreach (DataType type in base_types) {
type.accept (visitor);
}
foreach (TypeParameter p in type_parameters) {
p.accept (visitor);
}
foreach (Field f in fields) {
f.accept (visitor);
}
foreach (Constant c in constants) {
c.accept (visitor);
}
foreach (Method m in methods) {
m.accept (visitor);
}
foreach (Property prop in properties) {
prop.accept (visitor);
}
foreach (Signal sig in signals) {
sig.accept (visitor);
}
if (constructor != null) {
constructor.accept (visitor);
}
if (static_constructor != null) {
static_constructor.accept (visitor);
}
if (destructor != null) {
destructor.accept (visitor);
}
foreach (Class cl in classes) {
cl.accept (visitor);
}
foreach (Struct st in structs) {
st.accept (visitor);
}
foreach (Enum en in enums) {
en.accept (visitor);
}
foreach (Delegate d in delegates) {
d.accept (visitor);
}
}
public override string get_cprefix () {
return get_cname ();
}
public override string get_cname (bool const_type = false) {
if (const_type && const_cname != null) {
return const_cname;
}
if (cname == null) {
cname = get_default_cname ();
}
return cname;
}
/**
* Returns the default name of this class as it is used in C code.
*
* @return the name to be used in C code by default
*/
public string get_default_cname () {
return "%s%s".printf (parent_symbol.get_cprefix (), name);
}
/**
* Sets the name of this class as it is used in C code.
*
* @param cname the name to be used in C code
*/
public void set_cname (string cname) {
this.cname = cname;
}
private string get_lower_case_csuffix () {
if (lower_case_csuffix == null) {
lower_case_csuffix = camel_case_to_lower_case (name);
// remove underscores in some cases to avoid conflicts of type macros
if (lower_case_csuffix.has_prefix ("type_")) {
lower_case_csuffix = "type" + lower_case_csuffix.offset ("type_".len ());
} else if (lower_case_csuffix.has_prefix ("is_")) {
lower_case_csuffix = "is" + lower_case_csuffix.offset ("is_".len ());
}
if (lower_case_csuffix.has_suffix ("_class")) {
lower_case_csuffix = lower_case_csuffix.substring (0, lower_case_csuffix.len () - "_class".len ()) + "class";
}
}
return lower_case_csuffix;
}
public override string get_lower_case_cname (string infix) {
if (infix == null) {
infix = "";
}
return "%s%s%s".printf (parent_symbol.get_lower_case_cprefix (), infix, get_lower_case_csuffix ());
}
public override string get_lower_case_cprefix () {
if (lower_case_cprefix == null) {
lower_case_cprefix = "%s_".printf (get_lower_case_cname (null));
}
return lower_case_cprefix;
}
public override string get_upper_case_cname (string infix) {
return get_lower_case_cname (infix).up ();
}
public override bool is_reference_type () {
return true;
}
private void process_ccode_attribute (Attribute a) {
if (a.has_argument ("ref_function")) {
set_ref_function (a.get_string ("ref_function"));
}
if (a.has_argument ("unref_function")) {
set_unref_function (a.get_string ("unref_function"));
}
if (a.has_argument ("copy_function")) {
set_dup_function (a.get_string ("copy_function"));
}
if (a.has_argument ("free_function")) {
set_free_function (a.get_string ("free_function"));
}
if (a.has_argument ("has_type_id")) {
has_type_id = a.get_bool ("has_type_id");
}
if (a.has_argument ("type_id")) {
type_id = a.get_string ("type_id");
}
if (a.has_argument ("marshaller_type_name")) {
marshaller_type_name = a.get_string ("marshaller_type_name");
}
if (a.has_argument ("get_value_function")) {
get_value_function = a.get_string ("get_value_function");
}
if (a.has_argument ("set_value_function")) {
set_value_function = a.get_string ("set_value_function");
}
if (a.has_argument ("cname")) {
set_cname (a.get_string ("cname"));
}
if (a.has_argument ("const_cname")) {
const_cname = a.get_string ("const_cname");
}
if (a.has_argument ("cprefix")) {
lower_case_cprefix = a.get_string ("cprefix");
}
if (a.has_argument ("lower_case_csuffix")) {
lower_case_csuffix = a.get_string ("lower_case_csuffix");
}
if (a.has_argument ("cheader_filename")) {
var val = a.get_string ("cheader_filename");
foreach (string filename in val.split (",")) {
add_cheader_filename (filename);
}
}
}
/**
* Process all associated attributes.
*/
public void process_attributes () {
foreach (Attribute a in attributes) {
if (a.name == "CCode") {
process_ccode_attribute (a);
} else if (a.name == "ErrorBase") {
is_error_base = true;
}
}
}
private bool get_has_type_id () {
return has_type_id || (base_class != null && base_class.get_has_type_id ());
}
public override string get_type_id () {
if (type_id == null) {
if (get_has_type_id ()) {
type_id = get_upper_case_cname ("TYPE_");
} else {
type_id = "G_TYPE_POINTER";
}
}
return type_id;
}
public void set_type_id (string type_id) {
this.type_id = type_id;
}
public override string get_marshaller_type_name () {
if (marshaller_type_name == null) {
if (base_class != null) {
marshaller_type_name = base_class.get_marshaller_type_name ();
} else {
marshaller_type_name = "POINTER";
}
}
return marshaller_type_name;
}
public override string get_get_value_function () {
if (get_value_function == null) {
if (base_class != null) {
get_value_function = base_class.get_get_value_function ();
} else {
get_value_function = "g_value_get_pointer";
}
}
return get_value_function;
}
public override string get_set_value_function () {
if (set_value_function == null) {
if (base_class != null) {
set_value_function = base_class.get_set_value_function ();
} else {
set_value_function = "g_value_set_pointer";
}
}
return set_value_function;
}
public override bool is_reference_counting () {
return get_ref_function () != null;
}
public override string get_ref_function () {
if (ref_function == null && base_class != null) {
return base_class.get_ref_function ();
} else {
return ref_function;
}
}
public void set_ref_function (string name) {
this.ref_function = name;
}
public override string get_unref_function () {
if (unref_function == null && base_class != null) {
return base_class.get_unref_function ();
} else {
return unref_function;
}
}
public void set_unref_function (string name) {
this.unref_function = name;
}
public override string get_dup_function () {
return copy_function;
}
public void set_dup_function (string name) {
this.copy_function = name;
}
public string get_default_free_function () {
return get_lower_case_cprefix () + "free";
}
public override string get_free_function () {
if (free_function == null) {
free_function = get_default_free_function ();
}
return free_function;
}
public void set_free_function (string name) {
this.free_function = name;
}
public override bool is_subtype_of (Typesymbol t) {
if (this == t) {
return true;
}
foreach (DataType base_type in base_types) {
if (base_type.data_type != null && base_type.data_type.is_subtype_of (t)) {
return true;
}
}
return false;
}
public override int get_type_parameter_index (string name) {
int i = 0;
foreach (TypeParameter parameter in type_parameters) {
if (parameter.name == name) {
return i;
}
i++;
}
return -1;
}
public override void replace_type (DataType old_type, DataType new_type) {
for (int i = 0; i < base_types.size; i++) {
if (base_types[i] == old_type) {
base_types[i] = new_type;
return;
}
}
}
}
|