-
-
Notifications
You must be signed in to change notification settings - Fork 267
/
Copy pathfunc.d
1885 lines (1633 loc) · 56.5 KB
/
func.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
/**
* Defines a function declaration.
*
* Includes:
* - function/delegate literals
* - function aliases
* - (static/shared) constructors/destructors/post-blits
* - `invariant`
* - `unittest`
*
* Copyright: Copyright (C) 1999-2025 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/compiler/src/dmd/func.d, _func.d)
* Documentation: https://dlang.org/phobos/dmd_func.html
* Coverage: https://codecov.io/gh/dlang/dmd/src/master/compiler/src/dmd/func.d
*/
module dmd.func;
import core.stdc.stdio;
import core.stdc.string;
import dmd.aggregate;
import dmd.arraytypes;
import dmd.astenums;
import dmd.blockexit;
import dmd.gluelayer;
import dmd.dcast;
import dmd.dclass;
import dmd.declaration;
import dmd.delegatize;
import dmd.dmodule;
import dmd.dscope;
import dmd.dstruct;
import dmd.dsymbol;
import dmd.dtemplate;
import dmd.escape;
import dmd.expression;
import dmd.funcsem : overloadApply;
import dmd.globals;
import dmd.hdrgen;
import dmd.id;
import dmd.identifier;
import dmd.init;
import dmd.location;
import dmd.mtype;
import dmd.objc;
import dmd.common.outbuffer;
import dmd.rootobject;
import dmd.root.string;
import dmd.root.stringtable;
import dmd.statement;
import dmd.tokens;
import dmd.visitor;
version (IN_GCC) {}
else version (IN_LLVM) {}
else version = MARS;
/// Inline Status
enum ILS : ubyte
{
uninitialized, /// not computed yet
no, /// cannot inline
yes, /// can inline
}
enum BUILTIN : ubyte
{
unknown = 255, /// not known if this is a builtin
unimp = 0, /// this is not a builtin
gcc, /// this is a GCC builtin
llvm, /// this is an LLVM builtin
sin,
cos,
tan,
sqrt,
fabs,
ldexp,
log,
log2,
log10,
exp,
expm1,
exp2,
round,
floor,
ceil,
trunc,
copysign,
pow,
fmin,
fmax,
fma,
isnan,
isinfinity,
isfinite,
bsf,
bsr,
bswap,
popcnt,
yl2x,
yl2xp1,
toPrecFloat,
toPrecDouble,
toPrecReal,
ctfeWrite,
// IN_LLVM:
llvm_sin,
llvm_cos,
llvm_sqrt,
llvm_exp,
llvm_exp2,
llvm_log,
llvm_log2,
llvm_log10,
llvm_fabs,
llvm_minnum,
llvm_maxnum,
llvm_floor,
llvm_ceil,
llvm_trunc,
llvm_rint,
llvm_nearbyint,
llvm_round,
llvm_lround,
llvm_llround,
llvm_lrint,
llvm_llrint,
llvm_fma,
llvm_copysign,
llvm_bswap,
llvm_cttz,
llvm_ctlz,
llvm_ctpop,
llvm_expect,
}
private struct FUNCFLAG
{
bool purityInprocess; /// working on determining purity
bool safetyInprocess; /// working on determining safety
bool nothrowInprocess; /// working on determining nothrow
bool nogcInprocess; /// working on determining @nogc
bool saferD; /// do -preview=safer checks if this function has default safety
bool scopeInprocess; /// infer `return` and `scope` for parameters
bool inlineScanned; /// function has been scanned for inline possibilities
bool hasCatches; /// function has try-catch statements
bool skipCodegen; /// do not generate code for this function.
bool printf; /// is a printf-like function
bool scanf; /// is a scanf-like function
bool noreturn; /// the function does not return
bool isNRVO = true; /// Support for named return value optimization
bool isNaked; /// The function is 'naked' (see inline ASM)
bool isGenerated; /// The function is compiler generated (e.g. `opCmp`)
bool isIntroducing; /// If this function introduces the overload set
bool hasSemantic3Errors; /// If errors in semantic3 this function's frame ptr
bool hasNoEH; /// No exception unwinding is needed
bool inferRetType; /// Return type is to be inferred
bool hasDualContext; /// has a dual-context 'this' parameter
bool hasAlwaysInlines; /// Contains references to functions that must be inlined
bool isCrtCtor; /// Has attribute pragma(crt_constructor)
bool isCrtDtor; /// Has attribute pragma(crt_destructor)
bool hasEscapingSiblings;/// Has sibling functions that escape
bool computedEscapingSiblings; /// `hasEscapingSiblings` has been computed
bool dllImport; /// __declspec(dllimport)
bool dllExport; /// __declspec(dllexport)
bool hasReturnExp; /// Has return exp; statement
bool hasInlineAsm; /// Has asm{} statement
bool hasMultipleReturnExp; /// Has multiple return exp; statements
}
/***********************************************************
* Tuple of result identifier (possibly null) and statement.
* This is used to store out contracts: out(id){ ensure }
*/
extern (C++) struct Ensure
{
Identifier id;
Statement ensure;
Ensure syntaxCopy()
{
return Ensure(id, ensure.syntaxCopy());
}
/*****************************************
* Do syntax copy of an array of Ensure's.
*/
static Ensures* arraySyntaxCopy(Ensures* a)
{
if (!a)
return null;
Ensures* b = a.copy();
foreach (i, e; *a)
(*b)[i] = e.syntaxCopy();
return b;
}
}
/***********************************************************
* Most functions don't have contracts, so save memory by grouping
* this information into a separate struct
*/
private struct ContractInfo
{
Statements* frequires; /// in contracts
Ensures* fensures; /// out contracts
Statement frequire; /// lowered in contract
Statement fensure; /// lowered out contract
FuncDeclaration fdrequire; /// function that does the in contract
FuncDeclaration fdensure; /// function that does the out contract
Expressions* fdrequireParams; /// argument list for __require
Expressions* fdensureParams; /// argument list for __ensure
}
/***********************************************************
*/
extern (C++) class FuncDeclaration : Declaration
{
Statement fbody; /// function body
FuncDeclarations foverrides; /// functions this function overrides
private ContractInfo* contracts; /// contract information
const(char)* mangleString; /// mangled symbol created from mangleExact()
version (IN_LLVM)
{
uint priority;
// true if overridden with the pragma(LDC_allow_inline); statement
bool allowInlining = false;
// true if set with the pragma(LDC_never_inline); statement
bool neverInline = false;
// Whether to emit instrumentation code if -fprofile-instr-generate is specified,
// the value is set with pragma(LDC_profile_instr, true|false)
bool emitInstrumentation = true;
}
VarDeclaration vresult; /// result variable for out contracts
LabelDsymbol returnLabel; /// where the return goes
bool[size_t] isTypeIsolatedCache; /// cache for the potentially very expensive isTypeIsolated check
// used to prevent symbols in different
// scopes from having the same name
DsymbolTable localsymtab;
VarDeclaration vthis; /// 'this' parameter (member and nested)
VarDeclaration v_arguments; /// '_arguments' parameter
VarDeclaration v_argptr; /// '_argptr' variable
VarDeclarations* parameters; /// Array of VarDeclaration's for parameters
DsymbolTable labtab; /// statement label symbol table
Dsymbol overnext; /// next in overload list
FuncDeclaration overnext0; /// next in overload list (only used during IFTI)
Loc endloc; /// location of closing curly bracket
int vtblIndex = -1; /// for member functions, index into vtbl[]
ILS inlineStatusStmt = ILS.uninitialized;
ILS inlineStatusExp = ILS.uninitialized;
PINLINE inlining = PINLINE.default_;
int inlineNest; /// !=0 if nested inline
ForeachStatement fes; /// if foreach body, this is the foreach
BaseClass* interfaceVirtual; /// if virtual, but only appears in base interface vtbl[]
/** if !=NULL, then this is the type
of the 'introducing' function
this one is overriding
*/
Type tintro;
STC storage_class2; /// storage class for template onemember's
// Things that should really go into Scope
VarDeclaration nrvo_var; /// variable to replace with shidden
version (IN_LLVM) {} else
{
Symbol* shidden; /// hidden pointer passed to function
}
ReturnStatements* returns;
GotoStatements* gotos; /// Gotos with forward references
version (MARS)
{
VarDeclarations* alignSectionVars; /// local variables with alignment needs larger than stackAlign
Symbol* salignSection; /// pointer to aligned section, if any
}
/// set if this is a known, builtin function we can evaluate at compile time
BUILTIN builtin = BUILTIN.unknown;
/// set if someone took the address of this function
int tookAddressOf;
bool requiresClosure; // this function needs a closure
/** local variables in this function which are referenced by nested functions
* (They'll get put into the "closure" for this function.)
*/
VarDeclarations closureVars;
/** Outer variables which are referenced by this nested function
* (the inverse of closureVars)
*/
VarDeclarations outerVars;
// Most recent encountered `main` (`WinMain` or `DllMain`) function.
// Track it to give error messages for multiple entrypoints
__gshared FuncDeclaration lastMain;
/// Sibling nested functions which called this one
FuncDeclarations siblingCallers;
FuncDeclarations* inlinedNestedCallees;
/// In case of failed `@safe` inference, store the error that made the function `@system` for
/// better diagnostics
AttributeViolation* safetyViolation;
AttributeViolation* nogcViolation;
AttributeViolation* pureViolation;
AttributeViolation* nothrowViolation;
/// See the `FUNCFLAG` struct
import dmd.common.bitfields;
mixin(generateBitFields!(FUNCFLAG, uint));
/**
* Data for a function declaration that is needed for the Objective-C
* integration.
*/
ObjcFuncDeclaration objc;
extern (D) this(Loc loc, Loc endloc, Identifier ident, STC storage_class, Type type, bool noreturn = false)
{
super(DSYM.funcDeclaration, loc, ident);
//.printf("FuncDeclaration(id = '%s', type = %s)\n", ident.toChars(), type.toChars());
//.printf("storage_class = x%llx\n", storage_class);
this.storage_class = storage_class;
this.type = type;
if (type)
{
// Normalize storage_class, because function-type related attributes
// are already set in the 'type' in parsing phase.
this.storage_class &= ~(STC.TYPECTOR | STC.FUNCATTR);
}
this.endloc = endloc;
if (noreturn)
this.noreturn = true;
/* The type given for "infer the return type" is a TypeFunction with
* NULL for the return type.
*/
if (type && type.nextOf() is null)
this.inferRetType = true;
}
static FuncDeclaration create(Loc loc, Loc endloc, Identifier id, StorageClass storage_class, Type type, bool noreturn = false)
{
return new FuncDeclaration(loc, endloc, id, cast(STC) storage_class, type, noreturn);
}
final nothrow pure @safe
{
private ref ContractInfo getContracts()
{
if (!contracts)
contracts = new ContractInfo();
return *contracts;
}
// getters
inout(Statements*) frequires() inout { return contracts ? contracts.frequires : null; }
inout(Ensures*) fensures() inout { return contracts ? contracts.fensures : null; }
inout(Statement) frequire() inout { return contracts ? contracts.frequire: null; }
inout(Statement) fensure() inout { return contracts ? contracts.fensure : null; }
inout(FuncDeclaration) fdrequire() inout { return contracts ? contracts.fdrequire : null; }
inout(FuncDeclaration) fdensure() inout { return contracts ? contracts.fdensure: null; }
inout(Expressions*) fdrequireParams() inout { return contracts ? contracts.fdrequireParams: null; }
inout(Expressions*) fdensureParams() inout { return contracts ? contracts.fdensureParams: null; }
extern (D) private static string generateContractSetter(string field, string type)
{
return type ~ " " ~ field ~ "(" ~ type ~ " param)" ~
"{
if (!param && !contracts) return null;
return getContracts()." ~ field ~ " = param;
}";
}
mixin(generateContractSetter("frequires", "Statements*"));
mixin(generateContractSetter("fensures", "Ensures*"));
mixin(generateContractSetter("frequire", "Statement"));
mixin(generateContractSetter("fensure", "Statement"));
mixin(generateContractSetter("fdrequire", "FuncDeclaration"));
mixin(generateContractSetter("fdensure", "FuncDeclaration"));
mixin(generateContractSetter("fdrequireParams", "Expressions*"));
mixin(generateContractSetter("fdensureParams", "Expressions*"));
}
override FuncDeclaration syntaxCopy(Dsymbol s)
{
//printf("FuncDeclaration::syntaxCopy('%s')\n", toChars());
FuncDeclaration f = s ? cast(FuncDeclaration)s
: new FuncDeclaration(loc, endloc, ident, storage_class, type.syntaxCopy(), this.noreturn != 0);
f.frequires = frequires ? Statement.arraySyntaxCopy(frequires) : null;
f.fensures = fensures ? Ensure.arraySyntaxCopy(fensures) : null;
f.fbody = fbody ? fbody.syntaxCopy() : null;
version (IN_LLVM)
{
f.mangleOverride = mangleOverride;
}
return f;
}
override final bool equals(const RootObject o) const
{
if (this == o)
return true;
auto s = isDsymbol(o);
if (!s)
return false;
auto fd1 = this;
auto fd2 = s.isFuncDeclaration();
if (!fd2)
return false;
auto fa1 = fd1.isFuncAliasDeclaration();
auto faf1 = fa1 ? fa1.toAliasFunc() : fd1;
auto fa2 = fd2.isFuncAliasDeclaration();
auto faf2 = fa2 ? fa2.toAliasFunc() : fd2;
if (fa1 && fa2)
return faf1.equals(faf2) && fa1.hasOverloads == fa2.hasOverloads;
bool b1 = fa1 !is null;
if (b1 && faf1.isUnique() && !fa1.hasOverloads)
b1 = false;
bool b2 = fa2 !is null;
if (b2 && faf2.isUnique() && !fa2.hasOverloads)
b2 = false;
if (b1 != b2)
return false;
return faf1.toParent().equals(faf2.toParent()) &&
faf1.ident.equals(faf2.ident) &&
faf1.type.equals(faf2.type);
}
/****************************************************
* Overload this FuncDeclaration with the new one f.
* Return true if successful; i.e. no conflict.
*/
override bool overloadInsert(Dsymbol s)
{
//printf("FuncDeclaration::overloadInsert(s = %s) this = %s\n", s.toChars(), toChars());
assert(s != this);
if (AliasDeclaration ad = s.isAliasDeclaration())
{
if (overnext)
return overnext.overloadInsert(ad);
if (!ad.aliassym && ad.type.ty != Tident && ad.type.ty != Tinstance && ad.type.ty != Ttypeof)
{
//printf("\tad = '%s'\n", ad.type.toChars());
return false;
}
overnext = ad;
//printf("\ttrue: no conflict\n");
return true;
}
TemplateDeclaration td = s.isTemplateDeclaration();
if (td)
{
if (!td.funcroot)
td.funcroot = this;
if (overnext)
return overnext.overloadInsert(td);
overnext = td;
return true;
}
FuncDeclaration fd = s.isFuncDeclaration();
if (!fd)
return false;
if (overnext)
{
td = overnext.isTemplateDeclaration();
if (td)
fd.overloadInsert(td);
else
return overnext.overloadInsert(fd);
}
overnext = fd;
//printf("\ttrue: no conflict\n");
return true;
}
/********************************************
* find function template root in overload list
*/
extern (D) final TemplateDeclaration findTemplateDeclRoot()
{
FuncDeclaration f = this;
while (f && f.overnext)
{
//printf("f.overnext = %p %s\n", f.overnext, f.overnext.toChars());
if (TemplateDeclaration td = f.overnext.isTemplateDeclaration())
return td;
f = f.overnext.isFuncDeclaration();
}
return null;
}
/********************************************
* Returns true if function was declared
* directly or indirectly in a unittest block
*/
final bool inUnittest()
{
Dsymbol f = this;
do
{
if (f.isUnitTestDeclaration())
return true;
f = f.toParent();
}
while (f);
return false;
}
/********************************
* Searches for a label with the given identifier. This function will insert a new
* `LabelDsymbol` into `labtab` if it does not contain a mapping for `ident`.
*
* Params:
* ident = identifier of the requested label
* loc = location used when creating a new `LabelDsymbol`
*
* Returns: the `LabelDsymbol` for `ident`
*/
final LabelDsymbol searchLabel(Identifier ident, Loc loc)
{
Dsymbol s;
if (!labtab)
labtab = new DsymbolTable(); // guess we need one
s = labtab.lookup(ident);
if (!s)
{
s = new LabelDsymbol(ident, loc);
labtab.insert(s);
}
return cast(LabelDsymbol)s;
}
/*****************************************
* Determine lexical level difference from `this` to nested function `fd`.
* Params:
* fd = target of call
* intypeof = !=0 if inside typeof
* Returns:
* 0 same level
* >0 decrease nesting by number
* -1 increase nesting by 1 (`fd` is nested within `this`)
* LevelError error, `this` cannot call `fd`
*/
extern (D) final int getLevel(FuncDeclaration fd, int intypeof)
{
//printf("FuncDeclaration::getLevel(fd = '%s')\n", fd.toChars());
Dsymbol fdparent = fd.toParent2();
if (fdparent == this)
return -1;
Dsymbol s = this;
int level = 0;
while (fd != s && fdparent != s.toParent2())
{
//printf("\ts = %s, '%s'\n", s.kind(), s.toChars());
if (auto thisfd = s.isFuncDeclaration())
{
if (!thisfd.isNested() && !thisfd.vthis && !intypeof)
return LevelError;
}
else
{
if (auto thiscd = s.isAggregateDeclaration())
{
/* AggregateDeclaration::isNested returns true only when
* it has a hidden pointer.
* But, calling the function belongs unrelated lexical scope
* is still allowed inside typeof.
*
* struct Map(alias fun) {
* typeof({ return fun(); }) RetType;
* // No member function makes Map struct 'not nested'.
* }
*/
if (!thiscd.isNested() && !intypeof)
return LevelError;
}
else
return LevelError;
}
s = s.toParentP(fd);
assert(s);
level++;
}
return level;
}
enum LevelError = -2;
override const(char)* toPrettyChars(bool QualifyTypes = false)
{
if (isMain())
return "D main";
return Dsymbol.toPrettyChars(QualifyTypes);
}
/** for diagnostics, e.g. 'int foo(int x, int y) pure' */
final const(char)* toFullSignature()
{
OutBuffer buf;
functionToBufferWithIdent(type.toTypeFunction(), buf, toChars(), isStatic);
return buf.extractChars();
}
final bool isMain() const
{
return ident == Id.main && resolvedLinkage() != LINK.c && !isMember() && !isNested();
}
final bool isCMain() const
{
return ident == Id.main && resolvedLinkage() == LINK.c && !isMember() && !isNested();
}
final bool isWinMain() const
{
//printf("FuncDeclaration::isWinMain() %s\n", toChars());
version (none)
{
bool x = ident == Id.WinMain && resolvedLinkage() != LINK.c && !isMember();
printf("%s\n", x ? "yes" : "no");
return x;
}
else
{
return ident == Id.WinMain && resolvedLinkage() != LINK.c && !isMember();
}
}
final bool isDllMain() const
{
return ident == Id.DllMain && resolvedLinkage() != LINK.c && !isMember();
}
final bool isRtInit() const
{
return ident == Id.rt_init && resolvedLinkage() == LINK.c && !isMember() && !isNested();
}
override final bool isExport() const
{
return visibility.kind == Visibility.Kind.export_ || dllExport;
}
override final bool isImportedSymbol() const
{
//printf("isImportedSymbol()\n");
//printf("protection = %d\n", visibility);
return (visibility.kind == Visibility.Kind.export_ || dllImport) && !fbody;
}
override final bool isCodeseg() const pure nothrow @nogc @safe
{
return true; // functions are always in the code segment
}
override final bool isOverloadable() const
{
return true; // functions can be overloaded
}
/***********************************
* Override so it can work even if semantic() hasn't yet
* been run.
*/
override final bool isAbstract()
{
if (storage_class & STC.abstract_)
return true;
if (semanticRun >= PASS.semanticdone)
return false;
if (_scope)
{
if (_scope.stc & STC.abstract_)
return true;
parent = _scope.parent;
Dsymbol parent = toParent();
if (parent.isInterfaceDeclaration())
return true;
}
return false;
}
extern (D) final uint saveFlags()
{
return bitFields;
}
extern (D) final uint restoreFlags(uint f)
{
bitFields = f;
return bitFields;
}
/**************************************
* The function is doing something that may throw an exception, register that in case nothrow is being inferred
*
* Params:
* loc = location of action
* format = format string for error message
* args = arguments to format string
*/
extern (D) final void setThrow(Loc loc, const(char)* format, RootObject[] args...)
{
if (nothrowInprocess && !nothrowViolation)
{
nothrowViolation = new AttributeViolation(loc, format, args); // action that requires GC
}
}
/**************************************
* The function calls non-`nothrow` function f, register that in case nothrow is being inferred
* Params:
* loc = location of call
* fd = function being called
*/
extern (D) final void setThrowCall(Loc loc, FuncDeclaration fd)
{
if (nothrowInprocess && !nothrowViolation)
{
nothrowViolation = new AttributeViolation(loc, fd); // action that requires GC
}
}
/****************************************
* Determine if function needs a static frame pointer.
* Returns:
* `true` if function is really nested within other function.
* Contracts:
* If isNested() returns true, isThis() should return false,
* unless the function needs a dual-context pointer.
*/
bool isNested() const
{
auto f = toAliasFunc();
//printf("\ttoParent2() = '%s'\n", f.toParent2().toChars());
return ((f.storage_class & STC.static_) == 0) &&
(f._linkage == LINK.d) &&
(f.toParent2().isFuncDeclaration() !is null ||
f.toParent2() !is f.toParentLocal());
}
/****************************************
* Determine if function is a non-static member function
* that has an implicit 'this' expression.
* Returns:
* The aggregate it is a member of, or null.
* Contracts:
* Both isThis() and isNested() should return true if function needs a dual-context pointer,
* otherwise if isThis() returns true, isNested() should return false.
*/
override inout(AggregateDeclaration) isThis() inout
{
//printf("+FuncDeclaration::isThis() '%s'\n", toChars());
auto ad = (storage_class & STC.static_) ? .objc.isThis(this) : isMemberLocal();
//printf("-FuncDeclaration::isThis() %p\n", ad);
return ad;
}
override final bool needThis()
{
//printf("FuncDeclaration::needThis() '%s'\n", toChars());
return toAliasFunc().isThis() !is null;
}
// Determine if a function is pedantically virtual
final bool isVirtualMethod()
{
if (toAliasFunc() != this)
return toAliasFunc().isVirtualMethod();
//printf("FuncDeclaration::isVirtualMethod() %s\n", toChars());
if (!isVirtual())
return false;
// If it's a final method, and does not override anything, then it is not virtual
if (isFinalFunc() && foverrides.length == 0)
{
return false;
}
return true;
}
// Determine if function goes into virtual function pointer table
bool isVirtual() const
{
if (toAliasFunc() != this)
return toAliasFunc().isVirtual();
auto p = toParent();
if (!isMember || !p.isClassDeclaration)
return false;
if (p.isClassDeclaration.classKind == ClassKind.objc)
return .objc.isVirtual(this);
version (none)
{
printf("FuncDeclaration::isVirtual(%s)\n", toChars());
printf("isMember:%p isStatic:%d private:%d ctor:%d !Dlinkage:%d\n", isMember(), isStatic(), visibility == Visibility.Kind.private_, isCtorDeclaration(), linkage != LINK.d);
printf("result is %d\n", isMember() && !(isStatic() || visibility == Visibility.Kind.private_ || visibility == Visibility.Kind.package_) && p.isClassDeclaration() && !(p.isInterfaceDeclaration() && isFinalFunc()));
}
return !(isStatic() || visibility.kind == Visibility.Kind.private_ || visibility.kind == Visibility.Kind.package_) && !(p.isInterfaceDeclaration() && isFinalFunc());
}
final bool isFinalFunc() const
{
if (toAliasFunc() != this)
return toAliasFunc().isFinalFunc();
version (none)
{{
auto cd = toParent().isClassDeclaration();
printf("FuncDeclaration::isFinalFunc(%s), %x\n", toChars(), Declaration.isFinal());
printf("%p %d %d %d\n", isMember(), isStatic(), Declaration.isFinal(), ((cd = toParent().isClassDeclaration()) !is null && cd.storage_class & STC.final_));
printf("result is %d\n", isMember() && (Declaration.isFinal() || (cd !is null && cd.storage_class & STC.final_)));
if (cd)
printf("\tmember of %s\n", cd.toChars());
}}
if (!isMember())
return false;
if (Declaration.isFinal())
return true;
auto cd = toParent().isClassDeclaration();
return (cd !is null) && (cd.storage_class & STC.final_);
}
bool addPreInvariant()
{
auto ad = isThis();
ClassDeclaration cd = ad ? ad.isClassDeclaration() : null;
return (ad && !(cd && cd.isCPPclass()) && global.params.useInvariants == CHECKENABLE.on && (visibility.kind == Visibility.Kind.protected_ || visibility.kind == Visibility.Kind.public_ || visibility.kind == Visibility.Kind.export_) && !this.isNaked());
}
bool addPostInvariant()
{
auto ad = isThis();
ClassDeclaration cd = ad ? ad.isClassDeclaration() : null;
return (ad && !(cd && cd.isCPPclass()) && ad.inv && global.params.useInvariants == CHECKENABLE.on && (visibility.kind == Visibility.Kind.protected_ || visibility.kind == Visibility.Kind.public_ || visibility.kind == Visibility.Kind.export_) && !this.isNaked());
}
override const(char)* kind() const
{
return this.isGenerated() ? "generated function" : "function";
}
/********************************************
* Returns:
* true if there are no overloads of this function
*/
final bool isUnique() const
{
bool result = false;
overloadApply(cast() this, (Dsymbol s)
{
auto f = s.isFuncDeclaration();
auto td = s.isTemplateDeclaration();
if (!f && !td)
return 0;
if (result)
{
result = false;
return 1; // ambiguous, done
}
else
{
result = true;
return 0;
}
});
return result;
}
/*******************************
* Look at all the variables in this function that are referenced
* by nested functions, and determine if a closure needs to be
* created for them.
*/
final bool needsClosure()
{
/* Need a closure for all the closureVars[] if any of the
* closureVars[] are accessed by a
* function that escapes the scope of this function.
* We take the conservative approach and decide that a function needs
* a closure if it:
* 1) is a virtual function
* 2) has its address taken
* 3) has a parent that escapes
* 4) calls another nested function that needs a closure
*
* Note that since a non-virtual function can be called by
* a virtual one, if that non-virtual function accesses a closure
* var, the closure still has to be taken. Hence, we check for isThis()
* instead of isVirtual(). (thanks to David Friedman)
*
* When the function returns a local struct or class, `requiresClosure`
* is already set to `true` upon entering this function when the
* struct/class refers to a local variable and a closure is needed.
*/
//printf("FuncDeclaration::needsClosure() %s\n", toPrettyChars());
if (requiresClosure)
goto Lyes;
for (size_t i = 0; i < closureVars.length; i++)
{
VarDeclaration v = closureVars[i];
//printf("\tv = %s\n", v.toChars());
for (size_t j = 0; j < v.nestedrefs.length; j++)
{
FuncDeclaration f = v.nestedrefs[j];
assert(f != this);
/* __require and __ensure will always get called directly,
* so they never make outer functions closure.
*/
if (f.ident == Id.require || f.ident == Id.ensure)
continue;
//printf("\t\tf = %p, %s, isVirtual=%d, isThis=%p, tookAddressOf=%d\n", f, f.toChars(), f.isVirtual(), f.isThis(), f.tookAddressOf);
/* Look to see if f escapes. We consider all parents of f within
* this, and also all siblings which call f; if any of them escape,
* so does f.
* Mark all affected functions as requiring closures.
*/
for (Dsymbol s = f; s && s != this; s = s.toParentP(this))
{
FuncDeclaration fx = s.isFuncDeclaration();
if (!fx)
continue;
if (fx.isThis() || fx.tookAddressOf)
{
//printf("\t\tfx = %s, isVirtual=%d, isThis=%p, tookAddressOf=%d\n", fx.toChars(), fx.isVirtual(), fx.isThis(), fx.tookAddressOf);
/* Mark as needing closure any functions between this and f
*/
markAsNeedingClosure((fx == f) ? fx.toParentP(this) : fx, this);
requiresClosure = true;
}
/* We also need to check if any sibling functions that
* called us, have escaped. This is recursive: we need
* to check the callers of our siblings.
*/
if (checkEscapingSiblings(fx, this))
requiresClosure = true;
/* https://issues.dlang.org/show_bug.cgi?id=12406
* Iterate all closureVars to mark all descendant
* nested functions that access to the closing context of this function.
*/
}
}