-
Notifications
You must be signed in to change notification settings - Fork 530
/
class.c
1198 lines (935 loc) · 34.9 KB
/
class.c
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
/* class.c
*
* Copyright (C) 2022 by Paul Evans and others
*
* You may distribute under the terms of either the GNU General Public
* License or the Artistic License, as specified in the README file.
*
*/
/* This file contains the code that implements perl's new `use feature 'class'`
* object model
*/
#include "EXTERN.h"
#define PERL_IN_CLASS_C
#include "perl.h"
#include "XSUB.h"
enum {
PADIX_SELF = 1,
PADIX_PARAMS = 2,
};
void
Perl_croak_kw_unless_class(pTHX_ const char *kw)
{
PERL_ARGS_ASSERT_CROAK_KW_UNLESS_CLASS;
if(!HvSTASH_IS_CLASS(PL_curstash))
croak("Cannot '%s' outside of a 'class'", kw);
}
#define newSVobject(fieldcount) Perl_newSVobject(aTHX_ fieldcount)
SV *
Perl_newSVobject(pTHX_ Size_t fieldcount)
{
SV *sv = newSV_type(SVt_PVOBJ);
Newx(ObjectFIELDS(sv), fieldcount, SV *);
ObjectMAXFIELD(sv) = fieldcount - 1;
Zero(ObjectFIELDS(sv), fieldcount, SV *);
return sv;
}
PP(pp_initfield)
{
UNOP_AUX_item *aux = cUNOP_AUX->op_aux;
SV *self = PAD_SVl(PADIX_SELF);
assert(SvTYPE(SvRV(self)) == SVt_PVOBJ);
SV *instance = SvRV(self);
SV **fields = ObjectFIELDS(instance);
PADOFFSET fieldix = aux[0].uv;
SV *val = NULL;
switch(PL_op->op_private & (OPpINITFIELD_AV|OPpINITFIELD_HV)) {
case 0:
if(PL_op->op_flags & OPf_STACKED) {
val = newSVsv(*PL_stack_sp);
rpp_popfree_1();
}
else
val = newSV(0);
break;
case OPpINITFIELD_AV:
{
AV *av;
if(PL_op->op_flags & OPf_STACKED) {
SV **svp = PL_stack_base + POPMARK + 1;
STRLEN count = PL_stack_sp - svp + 1;
av = newAV_alloc_x(count);
while(svp <= PL_stack_sp) {
av_push_simple(av, newSVsv(*svp));
svp++;
}
rpp_popfree_to(PL_stack_sp - count);
}
else
av = newAV();
val = (SV *)av;
break;
}
case OPpINITFIELD_HV:
{
HV *hv = newHV();
if(PL_op->op_flags & OPf_STACKED) {
SV **svp = PL_stack_base + POPMARK + 1;
STRLEN svcount = PL_stack_sp - svp + 1;
if(svcount % 2)
Perl_warner(aTHX_
packWARN(WARN_MISC), "Odd number of elements in hash field initialization");
while(svp <= PL_stack_sp) {
SV *key = *svp; svp++;
SV *val = svp <= PL_stack_sp ? *svp : &PL_sv_undef; svp++;
(void)hv_store_ent(hv, key, newSVsv(val), 0);
}
rpp_popfree_to(PL_stack_sp - svcount);
}
val = (SV *)hv;
break;
}
}
fields[fieldix] = val;
PADOFFSET padix = PL_op->op_targ;
if(padix) {
SAVESPTR(PAD_SVl(padix));
SV *sv = PAD_SVl(padix) = SvREFCNT_inc(val);
save_freesv(sv);
}
return NORMAL;
}
XS(injected_constructor);
XS(injected_constructor)
{
dXSARGS;
HV *stash = CvSTASH(cv);
assert(HvSTASH_IS_CLASS(stash));
struct xpvhv_aux *aux = HvAUX(stash);
if((items - 1) % 2)
Perl_warn(aTHX_ "Odd number of arguments passed to %" HvNAMEf_QUOTEDPREFIX " constructor",
HvNAMEfARG(stash));
if (!aux->xhv_class_initfields_cv) {
Perl_croak(aTHX_ "Cannot create an object of incomplete class %" HvNAMEf_QUOTEDPREFIX,
HvNAMEfARG(stash));
}
HV *params = NULL;
{
/* Set up params HV */
params = newHV();
SAVEFREESV((SV *)params);
for(SSize_t i = 1; i < items; i += 2) {
SV *name = ST(i);
SV *val = (i+1 < items) ? ST(i+1) : &PL_sv_undef;
/* TODO: think about sanity-checking name for being
* defined
* not ref (but overloaded objects?? boo)
* not duplicate
* But then, %params = @_; wouldn't do that
*/
(void)hv_store_ent(params, name, SvREFCNT_inc(val), 0);
}
}
SV *instance = newSVobject(aux->xhv_class_next_fieldix);
SvOBJECT_on(instance);
SvSTASH_set(instance, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
SV *self = sv_2mortal(newRV_noinc(instance));
assert(aux->xhv_class_initfields_cv);
{
ENTER;
SAVETMPS;
EXTEND(SP, 2);
PUSHMARK(SP);
PUSHs(self);
if(params)
PUSHs((SV *)params); // yes a raw HV
else
PUSHs(&PL_sv_undef);
PUTBACK;
call_sv((SV *)aux->xhv_class_initfields_cv, G_VOID);
SPAGAIN;
FREETMPS;
LEAVE;
}
if(aux->xhv_class_adjust_blocks) {
CV **cvp = (CV **)AvARRAY(aux->xhv_class_adjust_blocks);
U32 nblocks = av_count(aux->xhv_class_adjust_blocks);
for(U32 i = 0; i < nblocks; i++) {
ENTER;
SAVETMPS;
SPAGAIN;
EXTEND(SP, 2);
PUSHMARK(SP);
PUSHs(self); /* I don't believe this needs to be an sv_mortalcopy() */
PUTBACK;
call_sv((SV *)cvp[i], G_VOID);
SPAGAIN;
FREETMPS;
LEAVE;
}
}
if(params && hv_iterinit(params) > 0) {
/* TODO: consider sorting these into a canonical order, but that's awkward */
HE *he = hv_iternext(params);
SV *paramnames = newSVsv(HeSVKEY_force(he));
SAVEFREESV(paramnames);
while((he = hv_iternext(params)))
Perl_sv_catpvf(aTHX_ paramnames, ", %" SVf, SVfARG(HeSVKEY_force(he)));
croak("Unrecognised parameters for %" HvNAMEf_QUOTEDPREFIX " constructor: %" SVf,
HvNAMEfARG(stash), SVfARG(paramnames));
}
EXTEND(SP, 1);
ST(0) = self;
XSRETURN(1);
}
/* OP_METHSTART is an UNOP_AUX whose AUX list contains
* [0].uv = count of fieldbinding pairs
* [1].uv = maximum fieldidx found in the binding list
* [...] = pairs of (padix, fieldix) to bind in .uv fields
*/
/* TODO: People would probably expect to find this in pp.c ;) */
PP(pp_methstart)
{
/* note that if AvREAL(@_), be careful not to leak self:
* so keep it in @_ for now, and only shift it later */
SV *self = *(av_fetch(GvAV(PL_defgv), 0, 1));
SV *rv = NULL;
/* pp_methstart happens before the first OP_NEXTSTATE of the method body,
* meaning PL_curcop still points at the callsite. This is useful for
* croak() messages. However, it means we have to find our current stash
* via a different technique.
*/
CV *curcv;
if(LIKELY(CxTYPE(CX_CUR()) == CXt_SUB))
curcv = CX_CUR()->blk_sub.cv;
else
curcv = find_runcv(NULL);
if(!SvROK(self) ||
!SvOBJECT((rv = SvRV(self))) ||
SvTYPE(rv) != SVt_PVOBJ) {
HEK *namehek = CvGvNAME_HEK(curcv);
croak(
namehek ? "Cannot invoke method %" HEKf_QUOTEDPREFIX " on a non-instance" :
"Cannot invoke method on a non-instance",
namehek);
}
if(CvSTASH(curcv) != SvSTASH(rv) &&
!sv_derived_from_hv(self, CvSTASH(curcv)))
croak("Cannot invoke a method of %" HvNAMEf_QUOTEDPREFIX " on an instance of %" HvNAMEf_QUOTEDPREFIX,
HvNAMEfARG(CvSTASH(curcv)), HvNAMEfARG(SvSTASH(rv)));
save_clearsv(&PAD_SVl(PADIX_SELF));
sv_setsv(PAD_SVl(PADIX_SELF), self);
UNOP_AUX_item *aux = cUNOP_AUX->op_aux;
if(aux) {
assert(SvTYPE(SvRV(self)) == SVt_PVOBJ);
SV *instance = SvRV(self);
SV **fieldp = ObjectFIELDS(instance);
U32 fieldcount = (aux++)->uv;
U32 max_fieldix = (aux++)->uv;
assert((U32)(ObjectMAXFIELD(instance)+1) > max_fieldix);
PERL_UNUSED_VAR(max_fieldix);
for(Size_t i = 0; i < fieldcount; i++) {
PADOFFSET padix = (aux++)->uv;
U32 fieldix = (aux++)->uv;
/* Defend against fields that don't yet exist; e.g. because of
* method invoked during DESTROY of an aborted constructor
* See also https://github.com/Perl/perl5/issues/22278
*/
if(fieldp[fieldix]) {
/* TODO: There isn't a convenient SAVE macro for doing both these
* steps in one go. Add one. */
SAVESPTR(PAD_SVl(padix));
SV *sv = PAD_SVl(padix) = SvREFCNT_inc(fieldp[fieldix]);
save_freesv(sv);
}
}
}
/* safe to shift and free self now */
self = av_shift(GvAV(PL_defgv));
if (AvREAL(GvAV(PL_defgv)))
SvREFCNT_dec_NN(self);
if(PL_op->op_private & OPpINITFIELDS) {
SV *params = *av_fetch(GvAV(PL_defgv), 0, 0);
if(params && SvTYPE(params) == SVt_PVHV) {
SAVESPTR(PAD_SVl(PADIX_PARAMS));
PAD_SVl(PADIX_PARAMS) = SvREFCNT_inc(params);
save_freesv(params);
}
}
return NORMAL;
}
static void
invoke_class_seal(pTHX_ void *_arg)
{
class_seal_stash((HV *)_arg);
}
void
Perl_class_setup_stash(pTHX_ HV *stash)
{
PERL_ARGS_ASSERT_CLASS_SETUP_STASH;
assert(HvHasAUX(stash));
if(HvSTASH_IS_CLASS(stash)) {
croak("Cannot reopen existing class %" HvNAMEf_QUOTEDPREFIX,
HvNAMEfARG(stash));
}
{
SV *isaname = newSVpvf("%" HEKf "::ISA", HvNAME_HEK(stash));
sv_2mortal(isaname);
AV *isa = get_av(SvPV_nolen(isaname), (SvFLAGS(isaname) & SVf_UTF8));
if(isa && av_count(isa) > 0)
croak("Cannot create class %" HEKf " as it already has a non-empty @ISA",
HvNAME_HEK(stash));
}
char *classname = HvNAME(stash);
U32 nameflags = HvNAMEUTF8(stash) ? SVf_UTF8 : 0;
/* TODO:
* Set some kind of flag on the stash to point out it's a class
* Allocate storage for all the extra things a class needs
* See https://github.com/leonerd/perl5/discussions/1
*/
/* Inject the constructor */
{
SV *newname = Perl_newSVpvf(aTHX_ "%s::new", classname);
SAVEFREESV(newname);
CV *newcv = newXS_flags(SvPV_nolen(newname), injected_constructor, __FILE__, NULL, nameflags);
CvSTASH_set(newcv, stash);
}
/* TODO:
* DOES method
*/
struct xpvhv_aux *aux = HvAUX(stash);
aux->xhv_class_superclass = NULL;
aux->xhv_class_initfields_cv = NULL;
aux->xhv_class_adjust_blocks = NULL;
aux->xhv_class_fields = NULL;
aux->xhv_class_next_fieldix = 0;
aux->xhv_class_param_map = NULL;
aux->xhv_aux_flags |= HvAUXf_IS_CLASS;
SAVEDESTRUCTOR_X(invoke_class_seal, stash);
/* Prepare a suspended compcv for parsing field init expressions */
{
I32 floor_ix = start_subparse(FALSE, 0);
CvIsMETHOD_on(PL_compcv);
/* We don't want to make `$self` visible during the expression but we
* still need to give it a name. Make it unusable from pure perl
*/
PADOFFSET padix = pad_add_name_pvs("$(self)", 0, NULL, NULL);
assert(padix == PADIX_SELF);
padix = pad_add_name_pvs("%(params)", 0, NULL, NULL);
assert(padix == PADIX_PARAMS);
PERL_UNUSED_VAR(padix);
Newx(aux->xhv_class_suspended_initfields_compcv, 1, struct suspended_compcv);
suspend_compcv(aux->xhv_class_suspended_initfields_compcv);
LEAVE_SCOPE(floor_ix);
}
}
#define split_package_ver(value, pkgname, pkgversion) S_split_package_ver(aTHX_ value, pkgname, pkgversion)
static const char *S_split_package_ver(pTHX_ SV *value, SV *pkgname, SV *pkgversion)
{
const char *start = SvPVX(value),
*p = start,
*end = start + SvCUR(value);
while(*p && !isSPACE_utf8_safe(p, end))
p += UTF8SKIP(p);
sv_setpvn(pkgname, start, p - start);
if(SvUTF8(value))
SvUTF8_on(pkgname);
while(*p && isSPACE_utf8_safe(p, end))
p += UTF8SKIP(p);
if(*p) {
/* scan_version() gets upset about trailing content. We need to extract
* exactly what it wants
*/
start = p;
if(*p == 'v')
p++;
while(*p && strchr("0123456789._", *p))
p++;
SV *tmpsv = newSVpvn(start, p - start);
SAVEFREESV(tmpsv);
scan_version(SvPVX(tmpsv), pkgversion, FALSE);
}
while(*p && isSPACE_utf8_safe(p, end))
p += UTF8SKIP(p);
return p;
}
#define ensure_module_version(module, version) S_ensure_module_version(aTHX_ module, version)
static void S_ensure_module_version(pTHX_ SV *module, SV *version)
{
ENTER;
PUSHMARK(PL_stack_sp);
rpp_xpush_2(module, version);
call_method("VERSION", G_VOID);
LEAVE;
}
#define split_attr_nameval(sv, namp, valp) S_split_attr_nameval(aTHX_ sv, namp, valp)
static void S_split_attr_nameval(pTHX_ SV *sv, SV **namp, SV **valp)
{
STRLEN svlen = SvCUR(sv);
bool do_utf8 = SvUTF8(sv);
const char *paren_at = (const char *)memchr(SvPVX(sv), '(', svlen);
if(paren_at) {
STRLEN namelen = paren_at - SvPVX(sv);
if(SvPVX(sv)[svlen-1] != ')')
/* Should be impossible to reach this by parsing regular perl code
* by as class_apply_attributes() is XS-visible API it might still
* be reachable. As it's likely unreachable by normal perl code,
* don't bother listing it in perldiag.
*/
/* diag_listed_as: SKIPME */
croak("Malformed attribute string");
*namp = sv_2mortal(newSVpvn_utf8(SvPVX(sv), namelen, do_utf8));
const char *value_at = paren_at + 1;
const char *value_max = SvPVX(sv) + svlen - 2;
/* TODO: We're only obeying ASCII whitespace here */
/* Trim whitespace at the start */
while(value_at < value_max && isSPACE(*value_at))
value_at += 1;
while(value_max > value_at && isSPACE(*value_max))
value_max -= 1;
if(value_max >= value_at)
*valp = sv_2mortal(newSVpvn_utf8(value_at, value_max - value_at + 1, do_utf8));
else
*valp = NULL;
}
else {
*namp = sv;
*valp = NULL;
}
}
static void
apply_class_attribute_isa(pTHX_ HV *stash, SV *value)
{
assert(HvSTASH_IS_CLASS(stash));
struct xpvhv_aux *aux = HvAUX(stash);
/* Parse `value` into name + version */
SV *superclassname = sv_newmortal(), *superclassver = sv_newmortal();
const char *end = split_package_ver(value, superclassname, superclassver);
if(*end)
croak("Unexpected characters while parsing class :isa attribute: %s", end);
if(aux->xhv_class_superclass)
croak("Class already has a superclass, cannot add another");
HV *superstash = gv_stashsv(superclassname, 0);
if (!superstash || !HvSTASH_IS_CLASS(superstash)) {
/* Try to `require` the module then attempt a second time */
load_module(PERL_LOADMOD_NOIMPORT, newSVsv(superclassname), NULL, NULL);
superstash = gv_stashsv(superclassname, 0);
}
if(!superstash || !HvSTASH_IS_CLASS(superstash))
/* TODO: This would be a useful feature addition */
croak("Class :isa attribute requires a class but %" HvNAMEf_QUOTEDPREFIX " is not one",
HvNAMEfARG(superstash));
if(superclassver && SvOK(superclassver))
ensure_module_version(superclassname, superclassver);
/* TODO: Suuuurely there's a way to fetch this neatly with stash + "ISA"
* You'd think that GvAV() of hv_fetchs() would do it, but no, because it
* won't lazily create a proper (magical) GV if one didn't already exist.
*/
{
SV *isaname = newSVpvf("%" HEKf "::ISA", HvNAME_HEK(stash));
sv_2mortal(isaname);
AV *isa = get_av(SvPV_nolen(isaname), GV_ADD | (SvFLAGS(isaname) & SVf_UTF8));
ENTER;
/* Temporarily remove the SVf_READONLY flag */
SAVESETSVFLAGS((SV *)isa, SVf_READONLY|SVf_PROTECT, SVf_READONLY|SVf_PROTECT);
SvREADONLY_off((SV *)isa);
av_push(isa, newSVsv(value));
LEAVE;
}
aux->xhv_class_superclass = (HV *)SvREFCNT_inc(superstash);
struct xpvhv_aux *superaux = HvAUX(superstash);
aux->xhv_class_next_fieldix = superaux->xhv_class_next_fieldix;
if(superaux->xhv_class_adjust_blocks) {
if(!aux->xhv_class_adjust_blocks)
aux->xhv_class_adjust_blocks = newAV();
for(SSize_t i = 0; i <= AvFILL(superaux->xhv_class_adjust_blocks); i++)
av_push(aux->xhv_class_adjust_blocks, AvARRAY(superaux->xhv_class_adjust_blocks)[i]);
}
if(superaux->xhv_class_param_map) {
aux->xhv_class_param_map = newHVhv(superaux->xhv_class_param_map);
}
}
static struct {
const char *name;
bool requires_value;
void (*apply)(pTHX_ HV *stash, SV *value);
} const class_attributes[] = {
{ .name = "isa",
.requires_value = true,
.apply = &apply_class_attribute_isa,
},
{ NULL, false, NULL }
};
static void
S_class_apply_attribute(pTHX_ HV *stash, OP *attr)
{
assert(attr->op_type == OP_CONST);
SV *name, *value;
split_attr_nameval(cSVOPx_sv(attr), &name, &value);
for(int i = 0; class_attributes[i].name; i++) {
/* TODO: These attribute names are not UTF-8 aware */
if(!strEQ(SvPVX(name), class_attributes[i].name))
continue;
if(class_attributes[i].requires_value && !(value && SvOK(value)))
croak("Class attribute %" SVf " requires a value", SVfARG(name));
(*class_attributes[i].apply)(aTHX_ stash, value);
return;
}
croak("Unrecognized class attribute %" SVf, SVfARG(name));
}
void
Perl_class_apply_attributes(pTHX_ HV *stash, OP *attrlist)
{
PERL_ARGS_ASSERT_CLASS_APPLY_ATTRIBUTES;
if(!attrlist)
return;
if(attrlist->op_type == OP_NULL) {
op_free(attrlist);
return;
}
if(attrlist->op_type == OP_LIST) {
OP *o = cLISTOPx(attrlist)->op_first;
assert(o->op_type == OP_PUSHMARK);
o = OpSIBLING(o);
for(; o; o = OpSIBLING(o))
S_class_apply_attribute(aTHX_ stash, o);
}
else
S_class_apply_attribute(aTHX_ stash, attrlist);
op_free(attrlist);
}
void
Perl_class_seal_stash(pTHX_ HV *stash)
{
PERL_ARGS_ASSERT_CLASS_SEAL_STASH;
assert(HvSTASH_IS_CLASS(stash));
struct xpvhv_aux *aux = HvAUX(stash);
if (PL_parser->error_count == 0) {
/* generate initfields CV */
I32 floor_ix = PL_savestack_ix;
SAVEI32(PL_subline);
save_item(PL_subname);
resume_compcv_final(aux->xhv_class_suspended_initfields_compcv);
/* Some OP_INITFIELD ops will need to populate the pad with their
* result because later ops will rely on it. There's no need to do
* this for every op though. Store a mapping to work out which ones
* we'll need.
*/
PADNAMELIST *pnl = PadlistNAMES(CvPADLIST(PL_compcv));
HV *fieldix_to_padix = newHV();
SAVEFREESV((SV *)fieldix_to_padix);
/* padix 0 == @_; padix 1 == $self. Start at 2 */
for(PADOFFSET padix = 2; padix <= PadnamelistMAX(pnl); padix++) {
PADNAME *pn = PadnamelistARRAY(pnl)[padix];
if(!pn || !PadnameIsFIELD(pn))
continue;
U32 fieldix = PadnameFIELDINFO(pn)->fieldix;
(void)hv_store_ent(fieldix_to_padix, sv_2mortal(newSVuv(fieldix)), newSVuv(padix), 0);
}
OP *ops = NULL;
ops = op_append_list(OP_LINESEQ, ops,
newUNOP_AUX(OP_METHSTART, OPpINITFIELDS << 8, NULL, NULL));
if(aux->xhv_class_superclass) {
HV *superstash = aux->xhv_class_superclass;
assert(HvSTASH_IS_CLASS(superstash));
struct xpvhv_aux *superaux = HvAUX(superstash);
/* Build an OP_ENTERSUB */
OP *o = newLISTOPn(OP_ENTERSUB, OPf_WANT_VOID|OPf_STACKED,
newPADxVOP(OP_PADSV, 0, PADIX_SELF),
newPADxVOP(OP_PADHV, OPf_REF, PADIX_PARAMS),
/* TODO: This won't work at all well under `use threads` because
* it embeds the CV * to the superclass initfields CV right into
* the optree. Maybe we'll have to pop it in the pad or something
*/
newSVOP(OP_CONST, 0, (SV *)superaux->xhv_class_initfields_cv),
NULL);
ops = op_append_list(OP_LINESEQ, ops, o);
}
PADNAMELIST *fieldnames = aux->xhv_class_fields;
for(SSize_t i = 0; fieldnames && i <= PadnamelistMAX(fieldnames); i++) {
PADNAME *pn = PadnamelistARRAY(fieldnames)[i];
char sigil = PadnamePV(pn)[0];
PADOFFSET fieldix = PadnameFIELDINFO(pn)->fieldix;
/* Extract the OP_{NEXT,DB}STATE op from the defop so we can
* splice it in
*/
OP *valop = PadnameFIELDINFO(pn)->defop;
if(valop && valop->op_type == OP_LINESEQ) {
OP *o = cLISTOPx(valop)->op_first;
cLISTOPx(valop)->op_first = NULL;
cLISTOPx(valop)->op_last = NULL;
/* have to clear the OPf_KIDS flag or op_free() will get upset */
valop->op_flags &= ~OPf_KIDS;
op_free(valop);
OP *fieldcop = o;
assert(fieldcop->op_type == OP_NEXTSTATE || fieldcop->op_type == OP_DBSTATE);
o = OpSIBLING(o);
OpLASTSIB_set(fieldcop, NULL);
valop = o;
OpLASTSIB_set(valop, NULL);
ops = op_append_list(OP_LINESEQ, ops, fieldcop);
}
SV *paramname = PadnameFIELDINFO(pn)->paramname;
U8 op_priv = 0;
switch(sigil) {
case '$':
if(paramname) {
if(!valop) {
SV *message =
newSVpvf("Required parameter '%" SVf "' is missing for %" HvNAMEf_QUOTEDPREFIX " constructor",
SVfARG(paramname), HvNAMEfARG(stash));
valop = newLISTOPn(OP_DIE, 0,
newSVOP(OP_CONST, 0, message),
NULL);
}
OP *helemop =
newBINOP(OP_HELEM, 0,
newPADxVOP(OP_PADHV, OPf_REF, PADIX_PARAMS),
newSVOP(OP_CONST, 0, SvREFCNT_inc(paramname)));
if(PadnameFIELDINFO(pn)->def_if_undef) {
/* delete $params{$paramname} // DEFOP */
valop = newLOGOP(OP_DOR, 0,
newUNOP(OP_DELETE, 0, helemop), valop);
}
else if(PadnameFIELDINFO(pn)->def_if_false) {
/* delete $params{$paramname} || DEFOP */
valop = newLOGOP(OP_OR, 0,
newUNOP(OP_DELETE, 0, helemop), valop);
}
else {
/* exists $params{$paramname} ? delete $params{$paramname} : DEFOP */
/* more efficient with the new OP_HELEMEXISTSOR */
valop = newLOGOP(OP_HELEMEXISTSOR, OPpHELEMEXISTSOR_DELETE << 8,
helemop, valop);
}
valop = op_contextualize(valop, G_SCALAR);
}
break;
case '@':
op_priv = OPpINITFIELD_AV;
break;
case '%':
op_priv = OPpINITFIELD_HV;
break;
default:
NOT_REACHED;
}
UNOP_AUX_item *aux;
aux = (UNOP_AUX_item *)PerlMemShared_malloc(
sizeof(UNOP_AUX_item) * 2);
aux[0].uv = fieldix;
OP *fieldop = newUNOP_AUX(OP_INITFIELD, valop ? OPf_STACKED : 0, valop, aux);
fieldop->op_private = op_priv;
HE *he;
if((he = hv_fetch_ent(fieldix_to_padix, sv_2mortal(newSVuv(fieldix)), 0, 0)) &&
SvOK(HeVAL(he))) {
fieldop->op_targ = SvUV(HeVAL(he));
}
ops = op_append_list(OP_LINESEQ, ops, fieldop);
}
/* initfields CV should not get class_wrap_method_body() called on its
* body. pretend it isn't a method for now */
CvIsMETHOD_off(PL_compcv);
CV *initfields = newATTRSUB(floor_ix, NULL, NULL, NULL, ops);
CvIsMETHOD_on(initfields);
aux->xhv_class_initfields_cv = initfields;
}
else {
/* we had errors, clean up and don't populate initfields */
PADNAMELIST *fieldnames = aux->xhv_class_fields;
if (fieldnames) {
for(SSize_t i = PadnamelistMAX(fieldnames); i >= 0 ; i--) {
PADNAME *pn = PadnamelistARRAY(fieldnames)[i];
op_free(PadnameFIELDINFO(pn)->defop);
}
}
}
}
void
Perl_class_prepare_initfield_parse(pTHX)
{
PERL_ARGS_ASSERT_CLASS_PREPARE_INITFIELD_PARSE;
assert(HvSTASH_IS_CLASS(PL_curstash));
struct xpvhv_aux *aux = HvAUX(PL_curstash);
resume_compcv_and_save(aux->xhv_class_suspended_initfields_compcv);
CvOUTSIDE_SEQ(PL_compcv) = PL_cop_seqmax;
}
void
Perl_class_prepare_method_parse(pTHX_ CV *cv)
{
PERL_ARGS_ASSERT_CLASS_PREPARE_METHOD_PARSE;
assert(cv == PL_compcv);
assert(HvSTASH_IS_CLASS(PL_curstash));
/* We expect this to be at the start of sub parsing, so there won't be
* anything in the pad yet
*/
assert(PL_comppad_name_fill == 0);
PADOFFSET padix;
padix = pad_add_name_pvs("$self", 0, NULL, NULL);
assert(padix == PADIX_SELF);
PERL_UNUSED_VAR(padix);
intro_my();
CvNOWARN_AMBIGUOUS_on(cv);
CvIsMETHOD_on(cv);
}
OP *
Perl_class_wrap_method_body(pTHX_ OP *o)
{
PERL_ARGS_ASSERT_CLASS_WRAP_METHOD_BODY;
if(!o)
return o;
/* Walk the pad of this CV looking for lexicals with field info. These
* will be the fields used by this particular method, which we build into
* a list for the OP_METHSTART op. This ensures we only set up the fields
* needed by this particular method body, rather than every available
* field in the whole class
*/
PADNAMELIST *pnl = PadlistNAMES(CvPADLIST(PL_compcv));
AV *fieldmap = newAV();
UV max_fieldix = 0;
SAVEFREESV((SV *)fieldmap);
/* padix 0 == @_; padix 1 == $self. Start at 2 */
for(PADOFFSET padix = 2; padix <= PadnamelistMAX(pnl); padix++) {
PADNAME *pn = PadnamelistARRAY(pnl)[padix];
if(!pn || !PadnameIsFIELD(pn))
continue;
U32 fieldix = PadnameFIELDINFO(pn)->fieldix;
if(fieldix > max_fieldix)
max_fieldix = fieldix;
av_push_simple(fieldmap, newSVuv(padix));
av_push_simple(fieldmap, newSVuv(fieldix));
}
UNOP_AUX_item *aux = NULL;
if(av_count(fieldmap)) {
aux = (UNOP_AUX_item *)PerlMemShared_malloc(
sizeof(UNOP_AUX_item)
* (2 + av_count(fieldmap))
);
UNOP_AUX_item *ap = aux;
(ap++)->uv = av_count(fieldmap) / 2;
(ap++)->uv = max_fieldix;
for(Size_t i = 0; i < av_count(fieldmap); i++)
(ap++)->uv = SvUV(AvARRAY(fieldmap)[i]);
}
/* If this is an empty method body then o will be an OP_STUB and not a
* list. This will confuse op_sibling_splice() */
if(o->op_type != OP_LINESEQ)
o = newLISTOP(OP_LINESEQ, 0, o, NULL);
op_sibling_splice(o, NULL, 0, newUNOP_AUX(OP_METHSTART, 0, NULL, aux));
return o;
}
void
Perl_class_add_field(pTHX_ HV *stash, PADNAME *pn)
{
PERL_ARGS_ASSERT_CLASS_ADD_FIELD;
assert(HvSTASH_IS_CLASS(stash));
struct xpvhv_aux *aux = HvAUX(stash);
PADOFFSET fieldix = aux->xhv_class_next_fieldix;
aux->xhv_class_next_fieldix++;
Newxz(PadnameFIELDINFO(pn), 1, struct padname_fieldinfo);
PadnameFLAGS(pn) |= PADNAMEf_FIELD;
PadnameFIELDINFO(pn)->refcount = 1;
PadnameFIELDINFO(pn)->fieldix = fieldix;
PadnameFIELDINFO(pn)->fieldstash = (HV *)SvREFCNT_inc(stash);
if(!aux->xhv_class_fields)
aux->xhv_class_fields = newPADNAMELIST(0);
padnamelist_store(aux->xhv_class_fields, PadnamelistMAX(aux->xhv_class_fields)+1, pn);
PadnameREFCNT_inc(pn);
}
static void
apply_field_attribute_param(pTHX_ PADNAME *pn, SV *value)
{
if(!value)
/* Default to name minus the sigil */
value = newSVpvn_utf8(PadnamePV(pn) + 1, PadnameLEN(pn) - 1, PadnameUTF8(pn));
if(PadnamePV(pn)[0] != '$')
croak("Only scalar fields can take a :param attribute");
if(PadnameFIELDINFO(pn)->paramname)
croak("Field already has a parameter name, cannot add another");
HV *stash = PadnameFIELDINFO(pn)->fieldstash;
assert(HvSTASH_IS_CLASS(stash));
struct xpvhv_aux *aux = HvAUX(stash);
if(aux->xhv_class_param_map &&
hv_exists_ent(aux->xhv_class_param_map, value, 0))
croak("Cannot assign :param(%" SVf ") to field %" SVf " because that name is already in use",
SVfARG(value), SVfARG(PadnameSV(pn)));
PadnameFIELDINFO(pn)->paramname = SvREFCNT_inc(value);
if(!aux->xhv_class_param_map)
aux->xhv_class_param_map = newHV();
(void)hv_store_ent(aux->xhv_class_param_map, value, newSVuv(PadnameFIELDINFO(pn)->fieldix), 0);
}
static void
apply_field_attribute_reader(pTHX_ PADNAME *pn, SV *value)
{
if(value)
SvREFCNT_inc(value);
else
/* Default to name minus the sigil */
value = newSVpvn_utf8(PadnamePV(pn) + 1, PadnameLEN(pn) - 1, PadnameUTF8(pn));
PADOFFSET fieldix = PadnameFIELDINFO(pn)->fieldix;
I32 floor_ix = start_subparse(FALSE, 0);
SAVEFREESV(PL_compcv);
I32 save_ix = block_start(TRUE);
PADOFFSET padix;
padix = pad_add_name_pvs("$self", 0, NULL, NULL);
assert(padix == PADIX_SELF);
padix = pad_add_name_pvn(PadnamePV(pn), PadnameLEN(pn), 0, NULL, NULL);
intro_my();
OP *methstartop;
{
UNOP_AUX_item *aux;
aux = (UNOP_AUX_item *)PerlMemShared_malloc(