/
clone.d
1721 lines (1579 loc) · 56.8 KB
/
clone.d
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
/**
* Builds struct member functions if needed and not defined by the user.
* Includes `opEquals`, `opAssign`, post blit, copy constructor and destructor.
*
* Copyright: Copyright (C) 1999-2024 by The D Language Foundation, All Rights Reserved
* Authors: $(LINK2 https://www.digitalmars.com, Walter Bright)
* License: $(LINK2 https://www.boost.org/LICENSE_1_0.txt, Boost License 1.0)
* Source: $(LINK2 https://github.com/dlang/dmd/blob/master/src/dmd/clone.d, _clone.d)
* Documentation: https://dlang.org/phobos/dmd_clone.html
* Coverage: https://codecov.io/gh/dlang/dmd/src/master/src/dmd/clone.d
*/
module dmd.clone;
import core.stdc.stdio;
import dmd.aggregate;
import dmd.arraytypes;
import dmd.astenums;
import dmd.dclass;
import dmd.declaration;
import dmd.dscope;
import dmd.dstruct;
import dmd.dsymbol;
import dmd.dsymbolsem;
import dmd.dtemplate;
import dmd.errors;
import dmd.expression;
import dmd.expressionsem;
import dmd.func;
import dmd.funcsem;
import dmd.globals;
import dmd.id;
import dmd.identifier;
import dmd.init;
import dmd.location;
import dmd.mtype;
import dmd.opover;
import dmd.semantic2;
import dmd.semantic3;
import dmd.statement;
import dmd.target;
import dmd.typesem;
import dmd.tokens;
/*******************************************
* Merge function attributes pure, nothrow, @safe, @nogc, and @disable
* from f into s1.
* Params:
* s1 = storage class to merge into
* f = function
* Returns:
* merged storage class
*/
StorageClass mergeFuncAttrs(StorageClass s1, const FuncDeclaration f) pure
{
if (!f)
return s1;
StorageClass s2 = (f.storage_class & STC.disable);
TypeFunction tf = cast(TypeFunction)f.type;
if (tf.trust == TRUST.safe)
s2 |= STC.safe;
else if (tf.trust == TRUST.system)
s2 |= STC.system;
else if (tf.trust == TRUST.trusted)
s2 |= STC.trusted;
if (tf.purity != PURE.impure)
s2 |= STC.pure_;
if (tf.isnothrow)
s2 |= STC.nothrow_;
if (tf.isnogc)
s2 |= STC.nogc;
const sa = s1 & s2;
const so = s1 | s2;
StorageClass stc = (sa & (STC.pure_ | STC.nothrow_ | STC.nogc)) | (so & STC.disable);
if (so & STC.system)
stc |= STC.system;
else if (sa & STC.trusted)
stc |= STC.trusted;
else if ((so & (STC.trusted | STC.safe)) == (STC.trusted | STC.safe))
stc |= STC.trusted;
else if (sa & STC.safe)
stc |= STC.safe;
return stc;
}
/*******************************************
* Check given aggregate actually has an identity opAssign or not.
* Params:
* ad = struct or class
* sc = current scope
* Returns:
* if found, returns FuncDeclaration of opAssign, otherwise null
*/
FuncDeclaration hasIdentityOpAssign(AggregateDeclaration ad, Scope* sc)
{
Dsymbol assign = search_function(ad, Id.assign);
if (assign)
{
/* check identity opAssign exists
*/
scope er = new NullExp(ad.loc, ad.type); // dummy rvalue
scope el = new IdentifierExp(ad.loc, Id.p); // dummy lvalue
el.type = ad.type;
auto a = new Expressions(1);
const errors = global.startGagging(); // Do not report errors, even if the template opAssign fbody makes it.
sc = sc.push();
sc.tinst = null;
sc.minst = null;
(*a)[0] = er;
auto f = resolveFuncCall(ad.loc, sc, assign, null, ad.type, ArgumentList(a), FuncResolveFlag.quiet);
if (!f)
{
(*a)[0] = el;
f = resolveFuncCall(ad.loc, sc, assign, null, ad.type, ArgumentList(a), FuncResolveFlag.quiet);
}
sc = sc.pop();
global.endGagging(errors);
if (f)
{
if (f.errors)
return null;
auto fparams = f.getParameterList();
if (fparams.length)
{
auto fparam0 = fparams[0];
if (fparam0.type.toDsymbol(null) != ad)
f = null;
}
}
// BUGS: This detection mechanism cannot find some opAssign-s like follows:
// struct S { void opAssign(ref immutable S) const; }
return f;
}
return null;
}
/*******************************************
* We need an opAssign for the struct if
* it has a destructor or a postblit.
* We need to generate one if a user-specified one does not exist.
*/
private bool needOpAssign(StructDeclaration sd)
{
//printf("StructDeclaration::needOpAssign() %s\n", sd.toChars());
static bool isNeeded()
{
//printf("\tneed\n");
return true;
}
if (sd.isUnionDeclaration())
return !isNeeded();
if (sd.hasIdentityAssign || // because has identity==elaborate opAssign
sd.dtor ||
sd.postblit)
return isNeeded();
/* If any of the fields need an opAssign, then we
* need it too.
*/
foreach (v; sd.fields)
{
if (v.storage_class & STC.ref_)
continue;
if (v.overlapped) // if field of a union
continue; // user must handle it themselves
Type tv = v.type.baseElemOf();
if (tv.ty == Tstruct)
{
TypeStruct ts = cast(TypeStruct)tv;
if (ts.sym.isUnionDeclaration())
continue;
if (needOpAssign(ts.sym))
return isNeeded();
}
}
return !isNeeded();
}
/******************************************
* Build opAssign for a `struct`.
*
* The generated `opAssign` function has the following signature:
*---
*ref S opAssign(S s) // S is the name of the `struct`
*---
*
* The opAssign function will be built for a struct `S` if the
* following constraints are met:
*
* 1. `S` does not have an identity `opAssign` defined.
*
* 2. `S` has at least one of the following members: a postblit (user-defined or
* generated for fields that have a defined postblit), a destructor
* (user-defined or generated for fields that have a defined destructor)
* or at least one field that has a defined `opAssign`.
*
* 3. `S` does not have any non-mutable fields.
*
* If `S` has a disabled destructor or at least one field that has a disabled
* `opAssign`, `S.opAssign` is going to be generated, but marked with `@disable`
*
* If `S` defines a destructor, the generated code for `opAssign` is:
*
*---
*S __swap = void;
*__swap = this; // bit copy
*this = s; // bit copy
*__swap.dtor();
*---
*
* Otherwise, if `S` defines a postblit, the generated code for `opAssign` is:
*
*---
*this = s;
*---
*
* Note that the parameter to the generated `opAssign` is passed by value, which means
* that the postblit is going to be called (if it is defined) in both of the above
* situations before entering the body of `opAssign`. The assignments in the above generated
* function bodies are blit expressions, so they can be regarded as `memcpy`s
* (`opAssign` is not called as this will result in an infinite recursion; the postblit
* is not called because it has already been called when the parameter was passed by value).
*
* If `S` does not have a postblit or a destructor, but contains at least one field that defines
* an `opAssign` function (which is not disabled), then the body will make member-wise
* assignments:
*
*---
*this.field1 = s.field1;
*this.field2 = s.field2;
*...;
*---
*
* In this situation, the assignemnts are actual assign expressions (`opAssign` is used
* if defined).
*
* References:
* https://dlang.org/spec/struct.html#assign-overload
* Params:
* sd = struct to generate opAssign for
* sc = context
* Returns:
* generated `opAssign` function
*/
FuncDeclaration buildOpAssign(StructDeclaration sd, Scope* sc)
{
if (FuncDeclaration f = hasIdentityOpAssign(sd, sc))
{
sd.hasIdentityAssign = true;
return f;
}
// Even if non-identity opAssign is defined, built-in identity opAssign
// will be defined.
if (!needOpAssign(sd))
return null;
//printf("StructDeclaration::buildOpAssign() %s\n", sd.toChars());
StorageClass stc = STC.safe | STC.nothrow_ | STC.pure_ | STC.nogc;
Loc declLoc = sd.loc;
Loc loc; // internal code should have no loc to prevent coverage
// One of our sub-field might have `@disable opAssign` so we need to
// check for it.
// In this event, it will be reflected by having `stc` (opAssign's
// storage class) include `STC.disabled`.
foreach (v; sd.fields)
{
if (v.storage_class & STC.ref_)
continue;
if (v.overlapped)
continue;
Type tv = v.type.baseElemOf();
if (tv.ty != Tstruct)
continue;
StructDeclaration sdv = (cast(TypeStruct)tv).sym;
stc = mergeFuncAttrs(stc, hasIdentityOpAssign(sdv, sc));
}
if (sd.dtor || sd.postblit)
{
// if the type is not assignable, we cannot generate opAssign
if (!sd.type.isAssignable()) // https://issues.dlang.org/show_bug.cgi?id=13044
return null;
stc = mergeFuncAttrs(stc, sd.dtor);
if (stc & STC.safe)
stc = (stc & ~STC.safe) | STC.trusted;
}
auto fparams = new Parameters();
fparams.push(new Parameter(loc, STC.nodtor, sd.type, Id.p, null, null));
auto tf = new TypeFunction(ParameterList(fparams), sd.handleType(), LINK.d, stc | STC.ref_);
auto fop = new FuncDeclaration(declLoc, Loc.initial, Id.assign, stc, tf);
fop.storage_class |= STC.inference;
fop.isGenerated = true;
Expression e;
if (stc & STC.disable)
{
e = null;
}
/* Do swap this and rhs.
* __swap = this; this = s; __swap.dtor();
*/
else if (sd.dtor)
{
//printf("\tswap copy\n");
TypeFunction tdtor = cast(TypeFunction)sd.dtor.type;
assert(tdtor.ty == Tfunction);
auto idswap = Identifier.generateId("__swap");
auto swap = new VarDeclaration(loc, sd.type, idswap, new VoidInitializer(loc));
swap.storage_class |= STC.nodtor | STC.temp | STC.ctfe;
if (tdtor.isScopeQual)
swap.storage_class |= STC.scope_;
auto e1 = new DeclarationExp(loc, swap);
auto e2 = new BlitExp(loc, new VarExp(loc, swap), new ThisExp(loc));
auto e3 = new BlitExp(loc, new ThisExp(loc), new IdentifierExp(loc, Id.p));
Expression e4;
if (target.isCalleeDestroyingArgs(tf))
{ /* callee destroys s
* Instead of running the destructor on s, run it
* on swap.
*/
e4 = new CallExp(loc, new DotVarExp(loc, new VarExp(loc, swap), sd.dtor, false));
}
else
{ /* caller destroys s, so copy contents of swap back into s
*/
e4 = new BlitExp(loc, new IdentifierExp(loc, Id.p), new VarExp(loc, swap));
}
e = Expression.combine(e1, e2, e3, e4);
}
/* postblit was called when the value was passed to opAssign, we just need to blit the result */
else if (sd.postblit)
{
e = new BlitExp(loc, new ThisExp(loc), new IdentifierExp(loc, Id.p));
sd.hasBlitAssign = true;
}
else
{
/* Do memberwise copy.
*
* If sd is a nested struct, its vthis field assignment is:
* 1. If it's nested in a class, it's a rebind of class reference.
* 2. If it's nested in a function or struct, it's an update of void*.
* In both cases, it will change the parent context.
*/
//printf("\tmemberwise copy\n");
e = null;
foreach (v; sd.fields)
{
// this.v = s.v;
auto ec = new AssignExp(loc,
new DotVarExp(loc, new ThisExp(loc), v),
new DotVarExp(loc, new IdentifierExp(loc, Id.p), v));
e = Expression.combine(e, ec);
}
}
if (e)
{
Statement s1 = new ExpStatement(loc, e);
/* Add:
* return this;
*/
auto er = new ThisExp(loc);
Statement s2 = new ReturnStatement(loc, er);
fop.fbody = new CompoundStatement(loc, s1, s2);
tf.isreturn = true;
}
sd.members.push(fop);
fop.addMember(sc, sd);
sd.hasIdentityAssign = true; // temporary mark identity assignable
const errors = global.startGagging(); // Do not report errors, even if the template opAssign fbody makes it.
Scope* sc2 = sc.push();
sc2.stc = 0;
sc2.linkage = LINK.d;
fop.dsymbolSemantic(sc2);
fop.semantic2(sc2);
// https://issues.dlang.org/show_bug.cgi?id=15044
//semantic3(fop, sc2); // isn't run here for lazy forward reference resolution.
sc2.pop();
if (global.endGagging(errors)) // if errors happened
{
// Disable generated opAssign, because some members forbid identity assignment.
fop.storage_class |= STC.disable;
fop.fbody = null; // remove fbody which contains the error
}
//printf("-StructDeclaration::buildOpAssign() %s, errors = %d\n", sd.toChars(), (fop.storage_class & STC.disable) != 0);
//printf("fop.type: %s\n", fop.type.toPrettyChars());
return fop;
}
/*******************************************
* We need an opEquals for the struct if
* any fields has an opEquals.
* Generate one if a user-specified one does not exist.
*/
bool needOpEquals(StructDeclaration sd)
{
//printf("StructDeclaration::needOpEquals() %s\n", sd.toChars());
if (sd.isUnionDeclaration())
{
/* If a union has only one field, treat it like a struct
*/
if (sd.fields.length != 1)
goto Ldontneed;
}
if (sd.hasIdentityEquals)
goto Lneed;
/* If any of the fields has an opEquals, then we
* need it too.
*/
foreach (VarDeclaration v; sd.fields)
{
if (v.storage_class & STC.ref_)
continue;
if (v.overlapped)
continue;
Type tv = v.type.toBasetype();
auto tvbase = tv.baseElemOf();
if (tvbase.ty == Tstruct)
{
TypeStruct ts = cast(TypeStruct)tvbase;
if (ts.sym.isUnionDeclaration() && ts.sym.fields.length != 1)
continue;
if (needOpEquals(ts.sym))
goto Lneed;
}
if (tvbase.isfloating())
{
// This is necessray for:
// 1. comparison of +0.0 and -0.0 should be true.
// 2. comparison of NANs should be false always.
goto Lneed;
}
if (tvbase.ty == Tarray)
goto Lneed;
if (tvbase.ty == Taarray)
goto Lneed;
if (tvbase.ty == Tclass)
goto Lneed;
}
Ldontneed:
//printf("\tdontneed\n");
return false;
Lneed:
//printf("\tneed\n");
return true;
}
/*******************************************
* Check given aggregate actually has an identity opEquals or not.
*/
private FuncDeclaration hasIdentityOpEquals(AggregateDeclaration ad, Scope* sc)
{
FuncDeclaration f;
if (Dsymbol eq = search_function(ad, Id.eq))
{
/* check identity opEquals exists
*/
scope er = new NullExp(ad.loc, null); // dummy rvalue
scope el = new IdentifierExp(ad.loc, Id.p); // dummy lvalue
auto a = new Expressions(1);
bool hasIt(Type tthis)
{
const errors = global.startGagging(); // Do not report errors, even if the template opAssign fbody makes it
sc = sc.push();
sc.tinst = null;
sc.minst = null;
FuncDeclaration rfc(Expression e)
{
(*a)[0] = e;
(*a)[0].type = tthis;
return resolveFuncCall(ad.loc, sc, eq, null, tthis, ArgumentList(a), FuncResolveFlag.quiet);
}
f = rfc(er);
if (!f)
f = rfc(el);
sc = sc.pop();
global.endGagging(errors);
return f !is null;
}
if (hasIt(ad.type) ||
hasIt(ad.type.constOf()) ||
hasIt(ad.type.immutableOf()) ||
hasIt(ad.type.sharedOf()) ||
hasIt(ad.type.sharedConstOf()))
{
if (f.errors)
return null;
}
}
return f;
}
/******************************************
* Build opEquals for struct.
* const bool opEquals(const S s) { ... }
*
* By fixing https://issues.dlang.org/show_bug.cgi?id=3789
* opEquals is changed to be never implicitly generated.
* Now, struct objects comparison s1 == s2 is translated to:
* s1.tupleof == s2.tupleof
* to calculate structural equality. See EqualExp.op_overload.
*/
FuncDeclaration buildOpEquals(StructDeclaration sd, Scope* sc)
{
if (hasIdentityOpEquals(sd, sc))
{
sd.hasIdentityEquals = true;
}
return null;
}
/******************************************
* Build __xopEquals for TypeInfo_Struct
* bool __xopEquals(ref const S p) const
* {
* return this == p;
* }
*
* This is called by TypeInfo.equals(p1, p2). If the struct does not support
* const objects comparison, it will throw "not implemented" Error in runtime.
*/
FuncDeclaration buildXopEquals(StructDeclaration sd, Scope* sc)
{
if (!needOpEquals(sd))
return null; // bitwise comparison would work
//printf("StructDeclaration::buildXopEquals() %s\n", sd.toChars());
if (Dsymbol eq = search_function(sd, Id.eq))
{
if (FuncDeclaration fd = eq.isFuncDeclaration())
{
TypeFunction tfeqptr;
{
Scope scx;
scx.eSink = sc.eSink;
/* const bool opEquals(ref const S s);
*/
auto parameters = new Parameters();
parameters.push(new Parameter(Loc.initial, STC.ref_ | STC.const_, sd.type, null, null, null));
tfeqptr = new TypeFunction(ParameterList(parameters), Type.tbool, LINK.d);
tfeqptr.mod = MODFlags.const_;
tfeqptr = cast(TypeFunction)tfeqptr.typeSemantic(Loc.initial, &scx);
}
fd = fd.overloadExactMatch(tfeqptr);
if (fd)
return fd;
}
}
if (!sd.xerreq)
{
// object._xopEquals
Identifier id = Identifier.idPool("_xopEquals");
Expression e = new IdentifierExp(sd.loc, Id.empty);
e = new DotIdExp(sd.loc, e, Id.object);
e = new DotIdExp(sd.loc, e, id);
e = e.expressionSemantic(sc);
if (!e.isErrorExp())
{
Dsymbol s = getDsymbol(e);
assert(s);
sd.xerreq = s.isFuncDeclaration();
}
}
Loc declLoc; // loc is unnecessary so __xopEquals is never called directly
Loc loc; // loc is unnecessary so errors are gagged
auto parameters = new Parameters();
parameters.push(new Parameter(loc, STC.ref_ | STC.const_, sd.type, Id.p, null, null));
auto tf = new TypeFunction(ParameterList(parameters), Type.tbool, LINK.d, STC.const_);
tf = tf.addSTC(STC.const_).toTypeFunction();
Identifier id = Id.xopEquals;
auto fop = new FuncDeclaration(declLoc, Loc.initial, id, 0, tf);
fop.isGenerated = true;
fop.parent = sd;
Expression e1 = new IdentifierExp(loc, Id.This);
Expression e2 = new IdentifierExp(loc, Id.p);
Expression e = new EqualExp(EXP.equal, loc, e1, e2);
fop.fbody = new ReturnStatement(loc, e);
uint errors = global.startGagging(); // Do not report errors
Scope* sc2 = sc.push();
sc2.stc = 0;
sc2.linkage = LINK.d;
fop.dsymbolSemantic(sc2);
fop.semantic2(sc2);
sc2.pop();
if (global.endGagging(errors)) // if errors happened
fop = sd.xerreq;
return fop;
}
/******************************************
* Build __xopCmp for TypeInfo_Struct
* int __xopCmp(ref const S p) const
* {
* return this.opCmp(p);
* }
*
* This is called by TypeInfo.compare(p1, p2). If the struct does not support
* const objects comparison, it will throw "not implemented" Error in runtime.
*/
FuncDeclaration buildXopCmp(StructDeclaration sd, Scope* sc)
{
//printf("StructDeclaration::buildXopCmp() %s\n", toChars());
if (Dsymbol cmp = search_function(sd, Id.cmp))
{
if (FuncDeclaration fd = cmp.isFuncDeclaration())
{
TypeFunction tfcmpptr;
{
Scope scx;
scx.eSink = sc.eSink;
/* const int opCmp(ref const S s);
*/
auto parameters = new Parameters();
parameters.push(new Parameter(Loc.initial, STC.ref_ | STC.const_, sd.type, null, null, null));
tfcmpptr = new TypeFunction(ParameterList(parameters), Type.tint32, LINK.d);
tfcmpptr.mod = MODFlags.const_;
tfcmpptr = cast(TypeFunction)tfcmpptr.typeSemantic(Loc.initial, &scx);
}
fd = fd.overloadExactMatch(tfcmpptr);
if (fd)
return fd;
}
}
else
{
version (none) // FIXME: doesn't work for recursive alias this
{
/* Check opCmp member exists.
* Consider 'alias this', but except opDispatch.
*/
Expression e = new DsymbolExp(sd.loc, sd);
e = new DotIdExp(sd.loc, e, Id.cmp);
Scope* sc2 = sc.push();
e = e.trySemantic(sc2);
sc2.pop();
if (e)
{
Dsymbol s = null;
switch (e.op)
{
case EXP.overloadSet:
s = e.isOverExp().vars;
break;
case EXP.scope_:
s = e.isScopeExp().sds;
break;
case EXP.variable:
s = e.isVarExp().var;
break;
default:
break;
}
if (!s || s.ident != Id.cmp)
e = null; // there's no valid member 'opCmp'
}
if (!e)
return null; // bitwise comparison would work
/* Essentially, a struct which does not define opCmp is not comparable.
* At this time, typeid(S).compare might be correct that throwing "not implement" Error.
* But implementing it would break existing code, such as:
*
* struct S { int value; } // no opCmp
* int[S] aa; // Currently AA key uses bitwise comparison
* // (It's default behavior of TypeInfo_Strust.compare).
*
* Not sure we should fix this inconsistency, so just keep current behavior.
*/
}
else
{
return null;
}
}
if (!sd.xerrcmp)
{
// object._xopCmp
Identifier id = Identifier.idPool("_xopCmp");
Expression e = new IdentifierExp(sd.loc, Id.empty);
e = new DotIdExp(sd.loc, e, Id.object);
e = new DotIdExp(sd.loc, e, id);
e = e.expressionSemantic(sc);
if (!e.isErrorExp())
{
Dsymbol s = getDsymbol(e);
assert(s);
sd.xerrcmp = s.isFuncDeclaration();
}
}
Loc declLoc; // loc is unnecessary so __xopCmp is never called directly
Loc loc; // loc is unnecessary so errors are gagged
auto parameters = new Parameters();
parameters.push(new Parameter(loc, STC.ref_ | STC.const_, sd.type, Id.p, null, null));
auto tf = new TypeFunction(ParameterList(parameters), Type.tint32, LINK.d, STC.const_);
tf = tf.addSTC(STC.const_).toTypeFunction();
Identifier id = Id.xopCmp;
auto fop = new FuncDeclaration(declLoc, Loc.initial, id, 0, tf);
fop.isGenerated = true;
fop.parent = sd;
Expression e1 = new IdentifierExp(loc, Id.This);
Expression e2 = new IdentifierExp(loc, Id.p);
Expression e = new CallExp(loc, new DotIdExp(loc, e1, Id.cmp), e2);
fop.fbody = new ReturnStatement(loc, e);
uint errors = global.startGagging(); // Do not report errors
Scope* sc2 = sc.push();
sc2.stc = 0;
sc2.linkage = LINK.d;
fop.dsymbolSemantic(sc2);
fop.semantic2(sc2);
sc2.pop();
if (global.endGagging(errors)) // if errors happened
fop = sd.xerrcmp;
return fop;
}
/*******************************************
* We need a toHash for the struct if
* any fields has a toHash.
* Generate one if a user-specified one does not exist.
*/
private bool needToHash(StructDeclaration sd)
{
//printf("StructDeclaration::needToHash() %s\n", sd.toChars());
if (sd.isUnionDeclaration())
goto Ldontneed;
if (sd.xhash)
goto Lneed;
/* If any of the fields has an toHash, then we
* need it too.
*/
foreach (VarDeclaration v; sd.fields)
{
if (v.storage_class & STC.ref_)
continue;
if (v.overlapped)
continue;
Type tv = v.type.toBasetype();
auto tvbase = tv.baseElemOf();
if (tvbase.ty == Tstruct)
{
TypeStruct ts = cast(TypeStruct)tvbase;
if (ts.sym.isUnionDeclaration())
continue;
if (needToHash(ts.sym))
goto Lneed;
}
if (tvbase.isfloating())
{
/* This is necessary because comparison of +0.0 and -0.0 should be true,
* i.e. not a bit compare.
*/
goto Lneed;
}
if (tvbase.ty == Tarray)
goto Lneed;
if (tvbase.ty == Taarray)
goto Lneed;
if (tvbase.ty == Tclass)
goto Lneed;
}
Ldontneed:
//printf("\tdontneed\n");
return false;
Lneed:
//printf("\tneed\n");
return true;
}
/******************************************
* Build __xtoHash for non-bitwise hashing
* static hash_t xtoHash(ref const S p) nothrow @trusted;
*/
FuncDeclaration buildXtoHash(StructDeclaration sd, Scope* sc)
{
if (Dsymbol s = search_function(sd, Id.tohash))
{
__gshared TypeFunction tftohash;
if (!tftohash)
{
tftohash = new TypeFunction(ParameterList(), Type.thash_t, LINK.d);
tftohash.mod = MODFlags.const_;
tftohash = cast(TypeFunction)tftohash.merge();
}
if (FuncDeclaration fd = s.isFuncDeclaration())
{
fd = fd.overloadExactMatch(tftohash);
if (fd)
return fd;
}
}
if (!needToHash(sd))
return null;
/* The trouble is that the following code relies on .tupleof, but .tupleof
* is not allowed for C files. If we allow it for C files, then that turns on
* the other D properties, too, such as .dup which will then conflict with allowed
* field names.
* One way to fix it is to replace the following foreach and .tupleof with C
* statements and expressions.
* But, it's debatable whether C structs should even need toHash().
* Note that it would only be necessary if it has floating point fields.
* For now, we'll just not generate a toHash() for C files.
*/
if (sc.flags & SCOPE.Cfile)
return null;
//printf("StructDeclaration::buildXtoHash() %s\n", sd.toPrettyChars());
Loc declLoc; // loc is unnecessary so __xtoHash is never called directly
Loc loc; // internal code should have no loc to prevent coverage
auto parameters = new Parameters();
parameters.push(new Parameter(loc, STC.ref_ | STC.const_, sd.type, Id.p, null, null));
auto tf = new TypeFunction(ParameterList(parameters), Type.thash_t, LINK.d, STC.nothrow_ | STC.trusted);
Identifier id = Id.xtoHash;
auto fop = new FuncDeclaration(declLoc, Loc.initial, id, STC.static_, tf);
fop.isGenerated = true;
/* Do memberwise hashing.
*
* If sd is a nested struct, and if it's nested in a class, the calculated
* hash value will also contain the result of parent class's toHash().
*/
const(char)[] code =
".object.size_t h = 0;" ~
"foreach (i, T; typeof(p.tupleof))" ~
// workaround https://issues.dlang.org/show_bug.cgi?id=17968
" static if(is(T* : const(.object.Object)*)) " ~
" h = h * 33 + typeid(const(.object.Object)).getHash(cast(const void*)&p.tupleof[i]);" ~
" else " ~
" h = h * 33 + typeid(T).getHash(cast(const void*)&p.tupleof[i]);" ~
"return h;";
fop.fbody = new MixinStatement(loc, new StringExp(loc, code));
Scope* sc2 = sc.push();
sc2.stc = 0;
sc2.linkage = LINK.d;
fop.dsymbolSemantic(sc2);
fop.semantic2(sc2);
sc2.pop();
//printf("%s fop = %s %s\n", sd.toChars(), fop.toChars(), fop.type.toChars());
return fop;
}
/*****************************************
* Create aggregate destructor for struct/class by aggregating
* all the destructors in userDtors[] with the destructors for
* all the members.
* Sets ad's fieldDtor, aggrDtor, dtor and tidtor fields.
* Params:
* ad = struct or class to build destructor for
* sc = context
* Note:
* Close similarity with StructDeclaration::buildPostBlit(),
* and the ordering changes (runs backward instead of forwards).
*/
void buildDtors(AggregateDeclaration ad, Scope* sc)
{
//printf("AggregateDeclaration::buildDtor() %s\n", ad.toChars());
if (ad.isUnionDeclaration())
return; // unions don't have destructors
StorageClass stc = STC.safe | STC.nothrow_ | STC.pure_ | STC.nogc;
Loc declLoc = ad.userDtors.length ? ad.userDtors[0].loc : ad.loc;
Loc loc; // internal code should have no loc to prevent coverage
FuncDeclaration xdtor_fwd = null;
// Build the field destructor (`ad.fieldDtor`), if needed.
// If the user dtor is an extern(C++) prototype, then we expect it performs a full-destruction and skip building.
const bool dtorIsCppPrototype = ad.userDtors.length && ad.userDtors[0]._linkage == LINK.cpp && !ad.userDtors[0].fbody;
if (!dtorIsCppPrototype)
{
Expression e = null;
for (size_t i = 0; i < ad.fields.length; i++)
{
auto v = ad.fields[i];
if (v.storage_class & STC.ref_)
continue;
if (v.overlapped)
continue;
auto tv = v.type.baseElemOf();
if (tv.ty != Tstruct)
continue;
auto sdv = (cast(TypeStruct)tv).sym;
if (!sdv.dtor)
continue;
// fix: https://issues.dlang.org/show_bug.cgi?id=17257
// braces for shrink wrapping scope of a
{
xdtor_fwd = sdv.dtor; // this dtor is temporary it could be anything
auto a = new AliasDeclaration(Loc.initial, Id.__xdtor, xdtor_fwd);
a.addMember(sc, ad); // temporarily add to symbol table
}
functionSemantic(sdv.dtor);
stc = mergeFuncAttrs(stc, sdv.dtor);
if (stc & STC.disable)
{
e = null;
break;
}
Expression ex;
tv = v.type.toBasetype();
if (tv.ty == Tstruct)
{
// this.v.__xdtor()
ex = new ThisExp(loc);
ex = new DotVarExp(loc, ex, v);
// This is a hack so we can call destructors on const/immutable objects.
// Do it as a type 'paint', `cast()`
ex = new CastExp(loc, ex, MODFlags.none);
if (stc & STC.safe)
stc = (stc & ~STC.safe) | STC.trusted;
ex = new DotVarExp(loc, ex, sdv.dtor, false);
ex = new CallExp(loc, ex);
}
else
{
// __ArrayDtor((cast(S*)this.v.ptr)[0 .. n])
const n = tv.numberOfElems(loc);
if (n == 0)
continue;
ex = new ThisExp(loc);
ex = new DotVarExp(loc, ex, v);
// This is a hack so we can call destructors on const/immutable objects.
ex = new DotIdExp(loc, ex, Id.ptr);
ex = new CastExp(loc, ex, sdv.type.pointerTo());
if (stc & STC.safe)
stc = (stc & ~STC.safe) | STC.trusted;
SliceExp se = new SliceExp(loc, ex, new IntegerExp(loc, 0, Type.tsize_t),
new IntegerExp(loc, n, Type.tsize_t));
// Prevent redundant bounds check
se.upperIsInBounds = true;
se.lowerIsLessThanUpper = true;
ex = new CallExp(loc, new IdentifierExp(loc, Id.__ArrayDtor), se);
}
e = Expression.combine(ex, e); // combine in reverse order
}
if (e || (stc & STC.disable))
{
//printf("Building __fieldDtor(), %s\n", e.toChars());
auto dd = new DtorDeclaration(declLoc, Loc.initial, stc, Id.__fieldDtor);
dd.isGenerated = true;
dd.storage_class |= STC.inference;
dd.fbody = new ExpStatement(loc, e);
ad.members.push(dd);
dd.dsymbolSemantic(sc);
ad.fieldDtor = dd;
}
}
// Generate list of dtors to call in that order
DtorDeclarations dtors;
foreach_reverse (userDtor; ad.userDtors[])
dtors.push(userDtor);
if (ad.fieldDtor)
dtors.push(ad.fieldDtor);
if (!dtorIsCppPrototype)
{
// extern(C++) destructors call into super to destruct the full hierarchy
ClassDeclaration cldec = ad.isClassDeclaration();
if (cldec && cldec.classKind == ClassKind.cpp && cldec.baseClass && cldec.baseClass.aggrDtor)
dtors.push(cldec.baseClass.aggrDtor);
}
// Set/build `ad.aggrDtor`