-
Notifications
You must be signed in to change notification settings - Fork 138
/
class.pmc
1945 lines (1424 loc) · 61.8 KB
/
class.pmc
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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
src/pmc/class.pmc - defines a class
=head1 DESCRIPTION
This class implements the Class PMC, as outlined in
F<docs/pdds/pdd15_objects.pod>.
Class is not derived from any other PMC.
=head2 Structure
The Class PMC structure (C<Parrot_Class>) consists of twelve items:
=over 4
=item C<id>
The type number of the PMC.
=item C<name>
The name of the class -- a STRING.
An empty STRING is allocated during initialization.
=item C<namespace>
The namespace the class is associated with, if any.
A Null PMC is allocated during initialization.
=item C<instantiated>
A flag denoting whether this class has been instantiated since last
modification. A native integer with value zero is allocated during
initialization.
=item C<parents>
An array of immediate parent classes.
An empty ResizablePMCArray PMC is allocated during initialization.
=item C<all_parents>
A cached array of ourself and all parent classes, in method resolution
order (MRO). A ResizablePMCArray PMC is allocated during initialization,
and is populated with the current class.
=item C<roles>
An array of the roles this class has been composed from.
An empty ResizablePMCArray PMC is allocated during initialization.
=item C<methods>
A directory of method names and method bodies this class provides.
An empty Hash PMC is allocated during initialization.
=item C<vtable_overrides>
A directory of vtable method names and method bodies this class overrides.
An empty Hash PMC is allocated during initialization.
=item C<attrib_metadata>
A directory of attribute names and attribute metadata this class contains.
An empty Hash PMC is allocated during initialization.
=item C<attrib_index>
A lookup table for attributes in this class and parents.
A Null PMC is allocated during initialization.
=item C<attrib_cache>
A cache of visible attribute names to attribute indexes.
A Null PMC is allocated during initialization.
=item C<resolve_method>
A list of method names the class provides used for name conflict resolution.
An empty ResizablePMCArray PMC is allocated during initialization.
=cut
*/
#define PARROT_IN_OBJECTS_C /* To get the vtable.h imports we want. */
#include "parrot/oo_private.h"
#include "pmc/pmc_object.h"
#include "pmc/pmc_namespace.h"
static int
cache_class_attribs(PARROT_INTERP, PMC *cur_class, PMC *attrib_index,
PMC *cache, int cur_index)
{
/* The attribute metadata hash. */
Parrot_Class_attributes * const class_info = PARROT_CLASS(cur_class);
PMC * const attribs = class_info->attrib_metadata;
PMC * const iter = VTABLE_get_iter(interp, attribs);
/* Build a string representing the fully qualified class name. */
/* Retrieve the fully qualified class name for the class. */
STRING * const fq_class = VTABLE_get_string(interp, cur_class);
PMC * const class_cache = Parrot_pmc_new(interp, enum_class_Hash);
VTABLE_set_pmc_keyed_str(interp, cache, fq_class, class_cache);
/* Iterate over the attributes. */
while (VTABLE_get_bool(interp, iter)) {
/* Get attribute. */
PMC * const cur_attrib = VTABLE_get_pmc_keyed_str(interp,
attribs, VTABLE_shift_string(interp, iter));
/* Get attribute name and append it to the key. */
STRING * const name_str = CONST_STRING(interp, "name");
STRING * const attrib_name = VTABLE_get_string_keyed_str(
interp, cur_attrib, name_str);
STRING * const full_key = Parrot_str_append(interp, fq_class, attrib_name);
/* Insert into hash, along with index. */
VTABLE_set_integer_keyed_str(interp, attrib_index, full_key, cur_index);
VTABLE_set_integer_keyed_str(interp, class_cache, attrib_name, cur_index);
cur_index++;
}
return cur_index;
}
/* This function builds the attribute index (table to map class name and
* attribute name to an index) for the current class. */
static void
build_attrib_index(PARROT_INTERP, PMC *self)
{
Parrot_Class_attributes * const _class = PARROT_CLASS(self);
int cur_index = 0;
PMC * const attrib_index = Parrot_pmc_new(interp, enum_class_Hash);
PMC * const cache = Parrot_pmc_new(interp, enum_class_Hash);
const int num_classes = VTABLE_elements(interp, _class->all_parents);
int i;
/* Go over the list of all parents to construct the attribute index. */
for (i = 0; i < num_classes; i++) {
/* Get the class and check that it respects the standard class interface
* (if not we don't know how it stores its attributes, so we'll have to
* delegate the lookup). */
PMC * const cur_class = VTABLE_get_pmc_keyed_int(interp,
_class->all_parents, i);
if (PObj_is_class_TEST(cur_class))
cur_index = cache_class_attribs(interp, cur_class,
attrib_index, cache, cur_index);
}
/* Store built attribute index and invalidate cache. */
_class->attrib_index = attrib_index;
_class->attrib_cache = cache;
}
/* Takes a hash and initializes the class based on it. */
static void
init_class_from_hash(PARROT_INTERP, PMC *self, PMC *info)
{
Parrot_Class_attributes * const _class = PARROT_CLASS(self);
STRING * const name_str = CONST_STRING(interp, "name");
STRING * const parents_str = CONST_STRING(interp, "parents");
STRING * const methods_str = CONST_STRING(interp, "methods");
STRING * const roles_str = CONST_STRING(interp, "roles");
STRING * const attrs_str = CONST_STRING(interp, "attributes");
PMC *old_ns;
STRING *resolve_method_str;
/* Ensure we actually have some initialization info. */
if (PMC_IS_NULL(info))
return;
/* Take a copy of the current namespace the class is attached to. */
old_ns = _class->_namespace;
/* Check if we have a name/namespace. */
if (VTABLE_exists_keyed_str(interp, info, name_str)) {
STRING *new_name;
PMC *new_namespace;
PMC *name_arg = VTABLE_get_pmc_keyed_str(interp, info, name_str);
VTABLE *new_vtable;
INTVAL type_num;
/* If we were passed a namespace PMC, set the namespace attribute
* directly. Otherwise, lookup or create the appropriate namespace. */
if (name_arg->vtable->base_type == enum_class_NameSpace) {
new_namespace = name_arg;
name_arg = Parrot_ns_get_name(interp, new_namespace);
VTABLE_shift_string(interp, name_arg);
}
else {
PMC * const hll_ns = VTABLE_get_pmc_keyed_int(interp,
interp->HLL_namespace, Parrot_pcc_get_HLL(interp, CURRENT_CONTEXT(interp)));
new_namespace = Parrot_make_namespace_keyed(interp, hll_ns, name_arg);
}
if (PMC_IS_NULL(new_namespace))
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Failed to set namespace for class.");
/* Set the name of the class to the name of the innermost namespace
* associated with the class. */
new_name = VTABLE_get_string(interp, new_namespace);
if (STRING_IS_NULL(new_name) || STRING_IS_EMPTY(new_name))
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Failed to set name for class.");
_class->_namespace = new_namespace;
_class->name = new_name;
/* At this point we know the class isn't anonymous */
CLASS_is_anon_CLEAR(self);
/* Register a type number for the class. */
type_num = Parrot_oo_register_type(interp, name_arg, new_namespace);
/* Link the type number with the class's vtable. */
new_vtable = Parrot_clone_vtable(interp, self->vtable);
new_vtable->base_type = type_num;
new_vtable->pmc_class = self;
new_vtable->whoami = VTABLE_get_string(interp, self);
new_vtable->mro = _class->all_parents;
new_vtable->ro_variant_vtable =
Parrot_clone_vtable(interp, self->vtable->ro_variant_vtable);
/* Store the class's vtable in the global table */
interp->vtables[type_num] = new_vtable;
_class->id = type_num;
}
/* If we were attached to a namespace and are now attached to a new one,
* need to unset ourselves in the old namespace. */
if (!PMC_IS_NULL(old_ns) && _class->_namespace != old_ns)
Parrot_pcc_invoke_method_from_c_args(interp, old_ns, CONST_STRING(interp, "set_class"), "P->", PMCNULL);
/* Link namespace to this class, if there is one. */
if (!PMC_IS_NULL(_class->_namespace)) {
STRING * const set_class_str = CONST_STRING(interp, "set_class");
Parrot_pcc_invoke_method_from_c_args(interp, _class->_namespace, set_class_str, "P->",
self);
}
/* Initialize resolve_method. */
resolve_method_str = CONST_STRING(interp, "resolve_method");
if (VTABLE_exists_keyed_str(interp, info, resolve_method_str)) {
/* Set it. */
_class->resolve_method =
VTABLE_get_pmc_keyed_str(interp, info, resolve_method_str);
}
/* Initialize parents, if we have any. */
if (VTABLE_exists_keyed_str(interp, info, parents_str)) {
/* Loop over parents array and add them. */
PMC * const parent_list = VTABLE_get_pmc_keyed_str(interp, info,
parents_str);
const int parent_count = VTABLE_elements(interp, parent_list);
int i;
for (i = 0; i < parent_count; i++)
VTABLE_add_parent(interp, self,
VTABLE_get_pmc_keyed_int(interp, parent_list, i));
}
/* Initialize roles, if we have any. */
if (VTABLE_exists_keyed_str(interp, info, roles_str)) {
/* Loop over roles array and compose them. */
PMC * const role_list = VTABLE_get_pmc_keyed_str(interp, info,
roles_str);
const int role_count = VTABLE_elements(interp, role_list);
int i;
for (i = 0; i < role_count; i++)
VTABLE_add_role(interp, self,
VTABLE_get_pmc_keyed_int(interp, role_list, i));
}
/* Initialize attributes, if we have any. */
if (VTABLE_exists_keyed_str(interp, info, attrs_str)) {
/* Loop over attributes array and add them. */
PMC * const attrs_name_list = VTABLE_get_pmc_keyed_str(interp, info,
attrs_str);
const int attrib_count = VTABLE_elements(interp, attrs_name_list);
int i;
for (i = 0; i < attrib_count; i++) {
STRING * const attr_name = VTABLE_get_string_keyed_int(interp,
attrs_name_list, i);
VTABLE_add_attribute(interp, self, attr_name, PMCNULL);
}
}
/* Initialize methods. */
if (VTABLE_exists_keyed_str(interp, info, methods_str)) {
/* Get the methods hash. */
PMC * const methods = VTABLE_get_pmc_keyed_str(interp, info,
methods_str);
/* Iterate over the list of methods. */
PMC * const iter = VTABLE_get_iter(interp, methods);
while (VTABLE_get_bool(interp, iter)) {
/* Add the method. */
STRING * const method_name = VTABLE_shift_string(interp, iter);
PMC * const method_pmc = VTABLE_get_pmc_keyed_str(interp,
methods, method_name);
VTABLE_add_method(interp, self, method_name, method_pmc);
}
}
/* Extract any methods from the namespace */
Parrot_oo_extract_methods_from_namespace(interp, self, _class->_namespace);
}
static void
initialize_parents(PARROT_INTERP, PMC *object, PMC *all_parents)
{
INTVAL parent_index = VTABLE_elements(interp, all_parents) - 1;
STRING * const name = CONST_STRING(interp, "init");
/* Loop through the parents in reverse MRO order. */
for (; parent_index >= 0; parent_index--) {
PMC *meth;
PMC * const parent = VTABLE_get_pmc_keyed_int(interp,
all_parents, parent_index);
/* PMCProxy parents store an instance to delegate to */
if (parent->vtable->base_type == enum_class_PMCProxy) {
PMC *proxy = VTABLE_instantiate(interp, parent, PMCNULL);
STRING *proxy_str = CONST_STRING(interp, "proxy");
VTABLE_set_attr_keyed(interp, object, parent, proxy_str, proxy);
}
meth = Parrot_oo_find_vtable_override_for_class(interp, parent, name);
if (!PMC_IS_NULL(meth)) {
/* build an empty signature; it has an invocant but no args/retvals */
PMC * const sig_obj = Parrot_pmc_new(interp, enum_class_CallContext);
/* preserve current_object */
PMC * const old_object = interp->current_object;
VTABLE_set_string_native(interp, sig_obj, CONST_STRING(interp, "Pi->"));
/* add the invocant */
VTABLE_unshift_pmc(interp, sig_obj, object);
interp->current_object = object;
Parrot_pcc_invoke_from_sig_object(interp, meth, sig_obj);
interp->current_object = old_object;
}
}
}
static void
initialize_parents_pmc(PARROT_INTERP, PMC *object, PMC *all_parents, PMC *init)
{
INTVAL parent_index = VTABLE_elements(interp, all_parents) - 1;
STRING * const name = CONST_STRING(interp, "init_pmc");
/* Loop through the parents in reverse MRO order. */
for (; parent_index >= 0; parent_index--) {
PMC *meth;
PMC * const parent = VTABLE_get_pmc_keyed_int(interp,
all_parents, parent_index);
/* PMCProxy parents store an instance to delegate to */
if (parent->vtable->base_type == enum_class_PMCProxy) {
PMC * const proxy = VTABLE_instantiate(interp, parent, init);
STRING * const proxy_str = CONST_STRING(interp, "proxy");
VTABLE_set_attr_keyed(interp, object, parent, proxy_str, proxy);
}
meth = Parrot_oo_find_vtable_override_for_class(interp, parent, name);
if (!PMC_IS_NULL(meth))
Parrot_pcc_invoke_sub_from_c_args(interp, meth,
"PiP->", object, init);
}
}
/* This function makes and caches the name of this class, returning the string
* directly. VTABLE_isa() uses the name without copying it, for efficiency
* reasons, as it does not modify the STRING. VTABLE_get_string() makes a copy
* of the STRING, so its callers are free to modify it. */
static STRING *
make_class_name(PARROT_INTERP, PMC *SELF)
{
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
PMC * const _namespace = _class->_namespace;
if (!PMC_IS_NULL(_namespace)) {
if (_class->fullname)
return _class->fullname;
else {
/* Call the 'get_name' method on the class's associated
* namespace to retrieve a fully qualified list of names, then
* join the list with a semicolon. */
PMC * const names = Parrot_ns_get_name(interp, _namespace);
if (!PMC_IS_NULL(names))
/* remove the HLL namespace name */
VTABLE_shift_string(interp, names);
_class->fullname = Parrot_str_join(interp, CONST_STRING(interp, ";"), names);
return _class->fullname;
}
}
/* Otherwise, copy the stored string name of the class. */
return _class->name;
}
/* calculates the C3 method resolution order for this class. C3 is the
* name of an algorithm used to calculate the method resolution order
* (MRO) to use in a system with multiple inheritance. For more information
* see the documentation associated with C<Parrot_ComputeMRO_C3>.
*/
static void
calculate_mro(PARROT_INTERP, PMC *SELF, INTVAL num_parents)
{
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
/* SELF is already on the all_parents */
if (num_parents == 0)
return;
if (num_parents == 1) {
STRING * const ap = CONST_STRING(interp, "all_parents");
PMC * const parent = VTABLE_get_pmc_keyed_int(interp,
_class->parents, 0);
PMC * const parent_mro = VTABLE_inspect_str(interp, parent, ap);
PMC * const mro = VTABLE_clone(interp, parent_mro);
VTABLE_unshift_pmc(interp, mro, SELF);
_class->all_parents = mro;
}
else
_class->all_parents = Parrot_ComputeMRO_C3(interp, SELF);
if (!CLASS_is_anon_TEST(SELF))
interp->vtables[VTABLE_type(interp, SELF)]->mro = _class->all_parents;
}
/*
=back
=head2 Functions
=over 4
=cut
*/
pmclass Class auto_attrs {
ATTR INTVAL id; /* The type number of the PMC. */
ATTR STRING *name; /* The name of the class. */
ATTR STRING *fullname; /* The name of the class. */
ATTR PMC *_namespace; /* The namespace it's linked to, if any. */
ATTR INTVAL instantiated; /* Any instantiations since last modification? */
ATTR PMC *parents; /* Immediate parent classes. */
ATTR PMC *all_parents; /* Cached list of ourself and all parents, in MRO order. */
ATTR PMC *roles; /* An array of roles. */
ATTR PMC *methods; /* Hash of method names to methods in this class. */
ATTR PMC *vtable_overrides; /* Hash of Parrot v-table methods we override. */
ATTR PMC *attrib_metadata; /* Hash of attributes in this class to hashes of metadata. */
ATTR PMC *attrib_index; /* Lookup table for attributes in this and parents. */
ATTR PMC *attrib_cache; /* Cache of visible attrib names to indexes. */
ATTR PMC *resolve_method; /* List of method names the class provides to resolve
* conflicts with methods from roles. */
ATTR PMC *parent_overrides;
ATTR PMC *meth_cache;
/*
=item C<void init()>
Initializes a Class PMC.
=item C<void init_pmc(PMC *init_data)>
The actual class creation code, called from C<newclass> opcode. The C<init_data>
argument may be either the name of the class or a hash of initialization
arguments. The class is attached to the current HLL namespace.
=cut
*/
VTABLE void init() {
Parrot_Class_attributes * const _class =
(Parrot_Class_attributes *) PMC_data(SELF);
/* Set flag for custom GC mark. */
PObj_custom_mark_SET(SELF);
/* Set up the object. */
_class->name = CONST_STRING(interp, "");
_class->_namespace = PMCNULL;
_class->parents = Parrot_pmc_new(interp, enum_class_ResizablePMCArray);
_class->all_parents = Parrot_pmc_new(interp, enum_class_ResizablePMCArray);
_class->roles = Parrot_pmc_new(interp, enum_class_ResizablePMCArray);
_class->methods = Parrot_pmc_new(interp, enum_class_Hash);
_class->attrib_metadata = Parrot_pmc_new(interp, enum_class_Hash);
_class->attrib_index = PMCNULL;
_class->attrib_cache = PMCNULL;
_class->meth_cache = PMCNULL;
_class->resolve_method = Parrot_pmc_new(interp, enum_class_ResizablePMCArray);
_class->vtable_overrides = Parrot_pmc_new(interp, enum_class_Hash);
_class->parent_overrides = Parrot_pmc_new(interp, enum_class_Hash);
/* We put ourself on the all parents list. */
VTABLE_push_pmc(interp, _class->all_parents, SELF);
/* We are a class. */
PObj_is_class_SET(SELF);
/* By default we're anonymous. */
CLASS_is_anon_SET(SELF);
}
VTABLE void init_pmc(PMC *init_data) {
PMC *arg;
const INTVAL arg_type = VTABLE_type(interp, init_data);
STRING * const name_str = CONST_STRING(interp, "name");
/* Set up the object. */
SELF.init();
/* fast attempt to determine init_data type */
switch (arg_type) {
case enum_class_String:
case enum_class_Key:
case enum_class_ResizableStringArray:
case enum_class_NameSpace:
/* set only the name property */
arg = Parrot_pmc_new(interp, enum_class_Hash);
VTABLE_set_pmc_keyed_str(interp, arg, name_str, init_data);
break;
case enum_class_Hash:
arg = init_data;
break;
/* slow attempt to determine init_data type */
default:
if (VTABLE_isa(interp, init_data, CONST_STRING(interp, "String"))
|| VTABLE_isa(interp, init_data, CONST_STRING(interp, "Key"))
|| VTABLE_isa(interp, init_data, CONST_STRING(interp, "ResizableStringArray"))) {
/* set only the name property */
arg = Parrot_pmc_new(interp, enum_class_Hash);
VTABLE_set_pmc_keyed_str(interp, arg, name_str, init_data);
}
if (VTABLE_isa(interp, init_data, CONST_STRING(interp, "Hash")))
arg = init_data;
else
Parrot_ex_throw_from_c_args(INTERP, NULL,
EXCEPTION_INVALID_OPERATION,
"Invalid class name key in init_pmc for Class");
break;
}
/* Initialize the class with the supplied data. */
init_class_from_hash(interp, SELF, arg);
}
/*
=item C<STRING *get_string()>
Returns the name of the class (without the HLL namespace).
=cut
*/
VTABLE STRING *get_string() {
return Parrot_str_copy(interp, make_class_name(interp, SELF));
}
/*
=item C<void mark()>
Marks any referenced strings and PMCs in the structure as live.
=cut
*/
VTABLE void mark() {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
Parrot_gc_mark_STRING_alive(interp, _class->name);
Parrot_gc_mark_STRING_alive(interp, _class->fullname);
Parrot_gc_mark_PMC_alive(interp, _class->_namespace);
Parrot_gc_mark_PMC_alive(interp, _class->parents);
Parrot_gc_mark_PMC_alive(interp, _class->all_parents);
Parrot_gc_mark_PMC_alive(interp, _class->roles);
Parrot_gc_mark_PMC_alive(interp, _class->methods);
Parrot_gc_mark_PMC_alive(interp, _class->vtable_overrides);
Parrot_gc_mark_PMC_alive(interp, _class->parent_overrides);
Parrot_gc_mark_PMC_alive(interp, _class->attrib_metadata);
Parrot_gc_mark_PMC_alive(interp, _class->attrib_index);
Parrot_gc_mark_PMC_alive(interp, _class->attrib_cache);
Parrot_gc_mark_PMC_alive(interp, _class->resolve_method);
Parrot_gc_mark_PMC_alive(interp, _class->meth_cache);
}
/*
=item C<void add_attribute(STRING *name, PMC *type)>
Adds the given attribute (C<name>) with an optional C<type>.
Throws an exception if the current class has been instantiated.
Enters the attribute in the C<attrib_metadata> table.
Returns an error if an attribute of C<name> already exists.
=cut
*/
VTABLE void add_attribute(STRING *name, PMC *type) {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
PMC * const new_attribute = Parrot_pmc_new(interp, enum_class_Hash);
/* If we've been instantiated already, not allowed. */
if (_class->instantiated)
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Modifications to classes are not allowed after instantiation.");
/* If we already have an attribute of this name, it's an error. */
if (VTABLE_exists_keyed_str(interp, _class->attrib_metadata, name))
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Attribute '%Ss' already exists in '%Ss'.", name,
VTABLE_get_string(INTERP, SELF));
/* Set name and type. */
VTABLE_set_string_keyed_str(interp, new_attribute, CONST_STRING(interp, "name"), name);
if (!PMC_IS_NULL(type))
VTABLE_set_pmc_keyed_str(interp, new_attribute, CONST_STRING(interp, "type"), type);
/* Enter the attribute in the attrib_metadata table. */
VTABLE_set_pmc_keyed_str(interp, _class->attrib_metadata, name,
new_attribute);
}
/*
=item C<void remove_attribute(STRING *name)>
Removes the given attribute (C<name>) from the class. Throws an exception if
the current class has been instantiated, or if the class has no attribute
C<name>.
=cut
*/
VTABLE void remove_attribute(STRING *name) {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
/* If we've been instantiated already, not allowed. */
if (_class->instantiated)
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Modifications to classes are not allowed after instantiation.");
/* If we don't have an attribute of this name, it's an error. */
if (!VTABLE_exists_keyed_str(interp, _class->attrib_metadata, name))
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Attribute '%Ss' cannot be removed, does not exist in '%Ss'.", name,
VTABLE_get_string(INTERP, SELF));
/* Remove the attribute from the attrib_metadata table. */
VTABLE_delete_keyed_str(interp, _class->attrib_metadata, name);
build_attrib_index(interp, SELF);
}
/*
=item C<void add_method(STRING *name, PMC *sub)>
Adds the given sub PMC as a method with the given name.
=cut
*/
VTABLE void add_method(STRING *name, PMC *sub) {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
PMC * const method =
VTABLE_get_pmc_keyed_str(interp, _class->methods, name);
/* If we have already added a method with this name... */
if (!PMC_IS_NULL(method)) {
if (method == sub)
return;
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"A method named '%S' already exists in class '%S'. "
"It may have been supplied by a role.",
name, VTABLE_get_string(interp, SELF));
}
/* Enter it into the table. */
VTABLE_set_pmc_keyed_str(interp, _class->methods, name, sub);
}
/*
=item C<void remove_method(STRING *name)>
Removes the method with the given name.
=cut
*/
VTABLE void remove_method(STRING *name) {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
if (VTABLE_exists_keyed_str(interp, _class->methods, name))
VTABLE_delete_keyed_str(interp, _class->methods, name);
else
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"No method named '%S' to remove in class '%S'.",
name, VTABLE_get_string(interp, SELF));
}
/*
=item C<void add_vtable_override(STRING *name, PMC *sub)>
Adds the given sub PMC as a vtable override with the given name.
=cut
*/
VTABLE void add_vtable_override(STRING *name, PMC *sub) {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
PMC * const vtable =
VTABLE_get_pmc_keyed_str(interp, _class->vtable_overrides, name);
/* If we have already added a vtable override with this name... */
if (!PMC_IS_NULL(vtable)) {
if (vtable == sub)
return;
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"A vtable override named '%S' already exists in class '%S'. "
"It may have been supplied by a role.",
name, VTABLE_get_string(interp, SELF));
}
/* Check that the name is actually valid as a vtable override */
if (Parrot_get_vtable_index(interp, name) == -1)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_METHOD_NOT_FOUND,
"'%S' is not a valid vtable function name.", name);
/* Add it to vtable methods list. */
VTABLE_set_pmc_keyed_str(interp, _class->vtable_overrides, name, sub);
}
/*
=item C<void add_parent(PMC *parent)>
Adds the supplied PMC to the list of parents for the class.
=cut
*/
VTABLE void add_parent(PMC *parent) {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
int parent_count, index;
/* If we've been instantiated already, not allowed. */
if (_class->instantiated)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Modifications to classes are not allowed after instantiation.");
/* Ensure it really is a class. */
if (!PObj_is_class_TEST(parent))
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION, "Parent isn't a Class.");
/* Check is not self */
if (parent == SELF)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION, "Can't be own parent");
/* get number of direct parents */
parent_count = VTABLE_elements(interp, _class->parents);
/* iterate over all direct parents, check whether this class already has
* the parent being added. */
for (index = 0; index < parent_count; index++) {
/* get the next parent */
PMC * const current_parent = VTABLE_get_pmc_keyed_int(interp,
_class->parents, index);
/* throw an exception if we already have this parent */
if (current_parent == parent)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"The class '%S' already has a parent class '%S'. "
"It may have been supplied by a role.",
VTABLE_get_string(interp, SELF),
VTABLE_get_string(interp, parent));
}
/* Check that none of the parents is self */
parent_count = VTABLE_elements(interp, PARROT_CLASS(parent)->all_parents);
for (index = 0; index < parent_count; index++) {
/* get the next parent */
PMC * const current_parent = VTABLE_get_pmc_keyed_int(interp,
PARROT_CLASS(parent)->all_parents, index);
if (current_parent == SELF)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Loop in class hierarchy: '%S' is an ancestor of '%S'.",
VTABLE_get_string(interp, SELF),
VTABLE_get_string(interp, parent));
}
/* Add to the lists of our immediate parents and all parents. */
VTABLE_push_pmc(interp, _class->parents, parent);
calculate_mro(interp, SELF, parent_count + 1);
}
/*
=item C<void remove_parent(PMC *parent)>
Remove the supplied class object from the list of parents for the class.
Throws an exception if parent is null, is not a class, or is not a parent, or
if the class has been instantiated.
=cut
*/
VTABLE void remove_parent(PMC *parent) {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
int parent_count, index;
/* If we've been instantiated already, not allowed. */
if (_class->instantiated)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Modifications to classes are not allowed after instantiation.");
/* Ensure it really is a class. */
if (!PObj_is_class_TEST(parent))
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION, "Parent isn't a Class.");
/* get number of direct parents */
parent_count = VTABLE_elements(interp, _class->parents);
/* iterate over all direct parents, looking for the parent to remove */
for (index = 0; index < parent_count; index++) {
/* get the next parent */
PMC * const current_parent = VTABLE_get_pmc_keyed_int(interp,
_class->parents, index);
if (current_parent == parent)
break;
}
if (index >= parent_count)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Can't remove_parent: is not a parent.");
VTABLE_delete_keyed_int(interp, _class->parents, index);
calculate_mro(interp, SELF, parent_count - 1);
}
/*
=item C<void add_role(PMC *role)>
Adds the supplied PMC to the list of roles for the class, provided there are
no conflicts.
=cut
*/
VTABLE void add_role(PMC *role) {
const Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
/* Do the composition. */
Parrot_ComposeRole(interp, role,
_class->resolve_method, !PMC_IS_NULL(_class->resolve_method),
PMCNULL, 0, _class->methods, _class->roles);
}
/*
=item C<PMC *inspect_str(STRING *what)>
Provides introspection of a specific piece of information about the class. The
available information is:
=over 8
=item name
String PMC containing the name of the class
=item namespace
NameSpace PMC of the the namespace attached to the class.
=item attributes
Hash keyed on attribute name, where the value is a hash describing it.
=item methods
Hash keyed on method name, value is an invokable PMC. Includes methods composed
in from roles.
=item roles
Array of Role PMCs. Includes roles done by the roles that were composed into
this class.
=item parents
Array of Class PMCs representing the direct parents of this class.
=back
=cut
*/
VTABLE PMC *inspect_str(STRING *what) {
Parrot_Class_attributes * const _class = PARROT_CLASS(SELF);
/* What should we return? */
PMC *found;
if (Parrot_str_equal(interp, what, CONST_STRING(interp, "attributes"))) {
found = _class->attrib_metadata;
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "parents"))) {
found = _class->parents;
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "name"))) {
found = Parrot_pmc_new(interp, enum_class_String);
VTABLE_set_string_native(interp, found, _class->name);
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "id"))) {
found = Parrot_pmc_new(interp, enum_class_Integer);
VTABLE_set_integer_native(interp, found, _class->id);
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "namespace"))) {
/* Should not clone this. */
return _class->_namespace;
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "attrib_index"))) {
found = _class->attrib_index;
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "methods"))) {
found = _class->methods;
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "vtable_overrides"))) {
found = _class->vtable_overrides;
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "all_parents"))) {
found = _class->all_parents;
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "roles"))) {
found = _class->roles;
}
else if (Parrot_str_equal(interp, what, CONST_STRING(interp, "flags"))) {
found = Parrot_pmc_new(interp, enum_class_Integer);
VTABLE_set_integer_native(interp, found,
(INTVAL)PObj_get_FLAGS(SELF));
}
else
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Unknown introspection value '%S'", what);
/* return found value */
if (PMC_IS_NULL(found))
return PMCNULL;