FuncDeclaration

extern (C++)
class FuncDeclaration : Declaration {}

Constructors

this
this(Loc loc, Loc endloc, Identifier ident, StorageClass storage_class, Type type)
Undocumented in source.

Members

Functions

accept
void accept(Visitor v)
Undocumented in source. Be warned that the author may not have intended to support it.
addPostInvariant
bool addPostInvariant()
Undocumented in source. Be warned that the author may not have intended to support it.
addPreInvariant
bool addPreInvariant()
Undocumented in source. Be warned that the author may not have intended to support it.
buildEnsureRequire
void buildEnsureRequire()

Rewrite contracts as statements.

buildResultVar
void buildResultVar(Scope* sc, Type tret)

Declare result variable lazily.

canInferAttributes
bool canInferAttributes(Scope* sc)

Decide if attributes for this function can be inferred from examining the function body.

canInferAttributesImpl
bool canInferAttributesImpl(Scope* sc)
Undocumented in source. Be warned that the author may not have intended to support it.
checkClosure
bool checkClosure()

Check that the function contains any closure. If it's @nogc, report suitable errors. This is mostly consistent with FuncDeclaration::needsClosure().

checkDmain
void checkDmain()

Check parameters and return type of D main() function. Issue error messages.

checkForwardRef
bool checkForwardRef(Loc loc)

Check that this function type is properly resolved. If not, report "forward reference error" and return true.

checkNestedReference
bool checkNestedReference(Scope* sc, Loc loc)

In the current function, we are calling 'this' function. 1. Check to see if the current function can call 'this' function, issue error if not. 2. If the current function is not the parent of 'this' function, then add the current function to the list of siblings of 'this' function. 3. If the current function is a literal, and it's accessing an uplevel scope, then mark it as a delegate. Returns true if error occurs.

checkNrvo
bool checkNrvo()

Check all return statements for a function to verify that returning using NRVO is possible.

declareThis
void declareThis(Scope* sc)

Creates and returns the hidden parameters for this function declaration.

equals
bool equals(RootObject o)
Undocumented in source. Be warned that the author may not have intended to support it.
findTemplateDeclRoot
TemplateDeclaration findTemplateDeclRoot()

find function template root in overload list

findVtblIndex
int findVtblIndex(Dsymbols* vtbl, int dim, bool fix17349)

Find index of function in vtbl[0..dim] that this function overrides. Prefer an exact match to a covariant one.

functionSemantic
bool functionSemantic()

Resolve forward reference of function signature - parameter types, return type, and attributes. Returns false if any errors exist in the signature.

functionSemantic3
bool functionSemantic3()

Resolve forward reference of function body. Returns false if any errors exist in the body.

getLevel
int getLevel(FuncDeclaration fd, int intypeof)

Determine lexical level difference from this to nested function fd.

getLevelAndCheck
int getLevelAndCheck(Loc loc, Scope* sc, FuncDeclaration fd)

Determine lexical level difference from this to nested function fd. Issue error if this cannot call fd.

getParameterList
ParameterList getParameterList()
hasNestedFrameRefs
bool hasNestedFrameRefs()

Determine if function's variables are referenced by a function nested within it.

inUnittest
bool inUnittest()

Returns true if function was declared directly or indirectly in a unittest block

initInferAttributes
void initInferAttributes()

Initialize for inferring the attributes of this function.

isAbstract
bool isAbstract()

Override so it can work even if semantic() hasn't yet been run.

isCMain
bool isCMain()
Undocumented in source. Be warned that the author may not have intended to support it.
isCodeseg
bool isCodeseg()
Undocumented in source. Be warned that the author may not have intended to support it.
isDllMain
bool isDllMain()
Undocumented in source. Be warned that the author may not have intended to support it.
isExport
bool isExport()
Undocumented in source. Be warned that the author may not have intended to support it.
isFinalFunc
bool isFinalFunc()
Undocumented in source. Be warned that the author may not have intended to support it.
isFuncDeclaration
inout(FuncDeclaration) isFuncDeclaration()
Undocumented in source. Be warned that the author may not have intended to support it.
isImportedSymbol
bool isImportedSymbol()
Undocumented in source. Be warned that the author may not have intended to support it.
isMain
bool isMain()
Undocumented in source. Be warned that the author may not have intended to support it.
isNested
bool isNested()

Determine if function needs a static frame pointer.

isNogc
bool isNogc()
Undocumented in source. Be warned that the author may not have intended to support it.
isNogcBypassingInference
bool isNogcBypassingInference()
Undocumented in source. Be warned that the author may not have intended to support it.
isOverloadable
bool isOverloadable()
Undocumented in source. Be warned that the author may not have intended to support it.
isPure
PURE isPure()
Undocumented in source. Be warned that the author may not have intended to support it.
isPureBypassingInference
PURE isPureBypassingInference()
Undocumented in source. Be warned that the author may not have intended to support it.
isReturnIsolated
bool isReturnIsolated()

See if pointers from function parameters, mutable globals, or uplevel functions could leak into return value.

isRtInit
bool isRtInit()
Undocumented in source. Be warned that the author may not have intended to support it.
isSafe
bool isSafe()
Undocumented in source. Be warned that the author may not have intended to support it.
isSafeBypassingInference
bool isSafeBypassingInference()
Undocumented in source. Be warned that the author may not have intended to support it.
isThis
inout(AggregateDeclaration) isThis()

Determine if function is a non-static member function that has an implicit 'this' expression.

isTrusted
bool isTrusted()
Undocumented in source. Be warned that the author may not have intended to support it.
isTypeIsolated
bool isTypeIsolated(Type t)

See if pointers from function parameters, mutable globals, or uplevel functions could leak into type t.

isUnique
bool isUnique()
isVirtual
bool isVirtual()
Undocumented in source. Be warned that the author may not have intended to support it.
isVirtualMethod
bool isVirtualMethod()
Undocumented in source. Be warned that the author may not have intended to support it.
isWinMain
bool isWinMain()
Undocumented in source. Be warned that the author may not have intended to support it.
kind
const(char)* kind()
Undocumented in source. Be warned that the author may not have intended to support it.
leastAsSpecialized
MATCH leastAsSpecialized(FuncDeclaration g)

Determine partial specialization order of 'this' vs g. This is very similar to TemplateDeclaration::leastAsSpecialized().

mergeFensure
Statement mergeFensure(Statement sf, Identifier oid, Expressions* params)

Merge into this function the 'out' contracts of all it overrides. 'out's are AND'd together, i.e. all of them need to pass.

mergeFrequire
Statement mergeFrequire(Statement sf, Expressions* params)

Merge into this function the 'in' contracts of all it overrides. 'in's are OR'd together, i.e. only one of them needs to pass.

needThis
bool needThis()
Undocumented in source. Be warned that the author may not have intended to support it.
needsClosure
bool needsClosure()

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.

overloadExactMatch
FuncDeclaration overloadExactMatch(Type t)

Find function in overload list that exactly matches t.

overloadInsert
bool overloadInsert(Dsymbol s)

Overload this FuncDeclaration with the new one f. Return true if successful; i.e. no conflict.

overloadModMatch
FuncDeclaration overloadModMatch(Loc loc, Type tthis, bool hasOverloads)

Find function in overload list that matches to the 'this' modifier. There's four result types.

overrideInterface
BaseClass* overrideInterface()

If function a function in a base class, return that base class.

overrides
int overrides(FuncDeclaration fd)

Determine if 'this' overrides fd. Return !=0 if it does.

printGCUsage
void printGCUsage(Loc loc, const(char)* warn)
Undocumented in source. Be warned that the author may not have intended to support it.
searchLabel
LabelDsymbol searchLabel(Identifier ident)

Labels are in a separate scope, one per function.

setGC
bool setGC()

The function is doing something that may allocate with the GC, so mark it as not nogc (not no-how).

setImpure
bool setImpure()

The function is doing something impure, so mark it as impure. If there's a purity error, return true.

setUnsafe
bool setUnsafe()

The function is doing something unsafe, so mark it as unsafe. If there's a safe error, return true.

syntaxCopy
Dsymbol syntaxCopy(Dsymbol s)
Undocumented in source. Be warned that the author may not have intended to support it.
toAliasFunc
inout(FuncDeclaration) toAliasFunc()
Undocumented in source. Be warned that the author may not have intended to support it.
toFullSignature
const(char)* toFullSignature()

for diagnostics, e.g. 'int foo(int x, int y) pure'

toPrettyChars
const(char)* toPrettyChars(bool QualifyTypes)
Undocumented in source. Be warned that the author may not have intended to support it.

Manifest constants

LevelError
enum LevelError;
Undocumented in source.

Static functions

create
FuncDeclaration create(Loc loc, Loc endloc, Identifier id, StorageClass storage_class, Type type)
Undocumented in source. Be warned that the author may not have intended to support it.
genCfunc
FuncDeclaration genCfunc(Parameters* fparams, Type treturn, const(char)* name, StorageClass stc)

Generate a FuncDeclaration for a runtime library function.

genCfunc
FuncDeclaration genCfunc(Parameters* fparams, Type treturn, Identifier id, StorageClass stc)
Undocumented in source. Be warned that the author may not have intended to support it.
needsFensure
bool needsFensure(FuncDeclaration fd)

Determine whether an 'out' contract is declared inside the given function or any of its overrides.

Variables

builtin
BUILTIN builtin;

set if this is a known, builtin function we can evaluate at compile time

canInferAttributesOverride
bool delegate(FuncDeclaration func, Scope* scope_, bool delegate(Scope*) defaultCanInferAttributes) canInferAttributesOverride;
Undocumented in source.
closureVars
VarDeclarations closureVars;

local variables in this function which are referenced by nested functions (They'll get put into the "closure" for this function.)

eh_none
bool eh_none;

true if no exception unwinding is needed

endloc
Loc endloc;

location of closing curly bracket

fbody
Statement fbody;

function body

fdensure
FuncDeclaration fdensure;

function that does the out contract

fdensureParams
Expressions* fdensureParams;

argument list for __ensure

fdrequire
FuncDeclaration fdrequire;

function that does the in contract

fdrequireParams
Expressions* fdrequireParams;

argument list for __require

fensure
Statement fensure;

lowered out contract

fensures
Ensures* fensures;

out contracts

fes
ForeachStatement fes;

if foreach body, this is the foreach

flags
uint flags;

FUNCFLAG.xxxxx

foverrides
FuncDeclarations foverrides;

functions this function overrides

frequire
Statement frequire;

lowered in contract

frequires
Statements* frequires;

in contracts

generated
bool generated;

true if function was generated by the compiler rather than

gotos
GotoStatements* gotos;

Gotos with forward references

hasReturnExp
int hasReturnExp;

1 if there's a return exp; statement 2 if there's a throw statement 4 if there's an assert(0) 8 if there's inline asm 16 if there are multiple return statements

inferRetType
bool inferRetType;

true if return type is to be inferred

inlineNest
int inlineNest;

!=0 if nested inline

inlineStatusExp
ILS inlineStatusExp;
Undocumented in source.
inlineStatusStmt
ILS inlineStatusStmt;

not set before the glue layer

inlinedNestedCallees
FuncDeclarations* inlinedNestedCallees;
Undocumented in source.
inlining
PINLINE inlining;
Undocumented in source.
interfaceVirtual
BaseClass* interfaceVirtual;

if virtual, but only appears in base interface vtbl[]

introducing
bool introducing;

true if 'introducing' function

isArrayOp
bool isArrayOp;

true if array operation

isCrtCtorDtor
ubyte isCrtCtorDtor;

supplied by the user +//// has attribute pragma(crt_constructor(1)/crt_destructor(2)

isThis2
bool isThis2;

has a dual-context 'this' parameter

labtab
DsymbolTable labtab;

statement label symbol table

localsymtab
DsymbolTable localsymtab;
Undocumented in source.
mangleString
const(char)* mangleString;

mangled symbol created from mangleExact()

naked
bool naked;

true if naked

nrvo_can
bool nrvo_can;

true means we can do NRVO

nrvo_var
VarDeclaration nrvo_var;

variable to replace with shidden

outerVars
VarDeclarations outerVars;

Outer variables which are referenced by this nested function (the inverse of closureVars)

overnext
Dsymbol overnext;

next in overload list

overnext0
FuncDeclaration overnext0;

next in overload list (only used during IFTI)

parameters
VarDeclarations* parameters;

Array of VarDeclaration's for parameters

requiresClosure
bool requiresClosure;
Undocumented in source.
returnLabel
LabelDsymbol returnLabel;

where the return goes

returns
ReturnStatements* returns;
Undocumented in source.
selector
ObjcSelector* selector;

Objective-C method selector (member function only)

selectorParameter
VarDeclaration selectorParameter;

Objective-C implicit selector parameter

semantic3Errors
bool semantic3Errors;

true if errors in semantic3 this function's frame ptr

shidden
Symbol* shidden;

hidden pointer passed to function

siblingCallers
FuncDeclarations siblingCallers;

Sibling nested functions which called this one

storage_class2
StorageClass storage_class2;

storage class for template onemember's

tintro
Type tintro;

if !=NULL, then this is the type of the 'introducing' function this one is overriding

tookAddressOf
int tookAddressOf;

set if someone took the address of this function

v_argptr
VarDeclaration v_argptr;

'_argptr' variable

v_arguments
VarDeclaration v_arguments;

'_arguments' parameter

vresult
VarDeclaration vresult;

result variable for out contracts

vtblIndex
int vtblIndex;

for member functions, index into vtbl[]

vthis
VarDeclaration vthis;

'this' parameter (member and nested)

Inherited Members

From Declaration

type
Type type;
Undocumented in source.
originalType
Type originalType;
Undocumented in source.
storage_class
StorageClass storage_class;
Undocumented in source.
protection
Prot protection;
Undocumented in source.
linkage
LINK linkage;
Undocumented in source.
inuse
int inuse;
Undocumented in source.
mangleOverride
const(char)[] mangleOverride;
Undocumented in source.
kind
const(char)* kind()
Undocumented in source. Be warned that the author may not have intended to support it.
size
d_uns64 size(Loc loc)
Undocumented in source. Be warned that the author may not have intended to support it.
checkDisabled
bool checkDisabled(Loc loc, Scope* sc, bool isAliasedDeclaration)

Issue an error if an attempt to call a disabled method is made

checkModify
Modifiable checkModify(Loc loc, Scope* sc, Expression e1, int flag)

Check to see if declaration can be modified in this context (sc). Issue error if not.

search
Dsymbol search(Loc loc, Identifier ident, int flags)
Undocumented in source. Be warned that the author may not have intended to support it.
isStatic
bool isStatic()
Undocumented in source. Be warned that the author may not have intended to support it.
isDelete
bool isDelete()
Undocumented in source. Be warned that the author may not have intended to support it.
isDataseg
bool isDataseg()
Undocumented in source. Be warned that the author may not have intended to support it.
isThreadlocal
bool isThreadlocal()
Undocumented in source. Be warned that the author may not have intended to support it.
isCodeseg
bool isCodeseg()
Undocumented in source. Be warned that the author may not have intended to support it.
isCtorinit
bool isCtorinit()
Undocumented in source. Be warned that the author may not have intended to support it.
isFinal
bool isFinal()
Undocumented in source. Be warned that the author may not have intended to support it.
isAbstract
bool isAbstract()
Undocumented in source. Be warned that the author may not have intended to support it.
isConst
bool isConst()
Undocumented in source. Be warned that the author may not have intended to support it.
isImmutable
bool isImmutable()
Undocumented in source. Be warned that the author may not have intended to support it.
isWild
bool isWild()
Undocumented in source. Be warned that the author may not have intended to support it.
isAuto
bool isAuto()
Undocumented in source. Be warned that the author may not have intended to support it.
isScope
bool isScope()
Undocumented in source. Be warned that the author may not have intended to support it.
isSynchronized
bool isSynchronized()
Undocumented in source. Be warned that the author may not have intended to support it.
isParameter
bool isParameter()
Undocumented in source. Be warned that the author may not have intended to support it.
isDeprecated
bool isDeprecated()
Undocumented in source. Be warned that the author may not have intended to support it.
isDisabled
bool isDisabled()
Undocumented in source. Be warned that the author may not have intended to support it.
isOverride
bool isOverride()
Undocumented in source. Be warned that the author may not have intended to support it.
isResult
bool isResult()
Undocumented in source. Be warned that the author may not have intended to support it.
isField
bool isField()
Undocumented in source. Be warned that the author may not have intended to support it.
isIn
bool isIn()
Undocumented in source. Be warned that the author may not have intended to support it.
isOut
bool isOut()
Undocumented in source. Be warned that the author may not have intended to support it.
isRef
bool isRef()
Undocumented in source. Be warned that the author may not have intended to support it.
isFuture
bool isFuture()
Undocumented in source. Be warned that the author may not have intended to support it.
prot
Prot prot()
Undocumented in source. Be warned that the author may not have intended to support it.
isDeclaration
inout(Declaration) isDeclaration()
Undocumented in source. Be warned that the author may not have intended to support it.
accept
void accept(Visitor v)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta