Display the source code in dmd/func.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Class `dmd.func.FuncDeclaration`


						
				class FuncDeclaration
				
  : Declaration
				;

Fields

Name	Type	Description
`builtin`	`dmd.func.BUILTIN`	set if this is a known, builtin function we can evaluate at compile time
`closureVars`	`dmd.root.array.Array!(dmd.declaration.VarDeclaration)`	local variables in this function which are referenced by nested functions (They'll get put into the "closure" for this function.)
`endloc`	`Loc`	location of closing curly bracket
`fbody`	`Statement`	function body
`fdensure`	`FuncDeclaration`	function that does the out contract
`fdensureParams`	`dmd.root.array.Array!(dmd.expression.Expression)*`	argument list for _ensure
`fdrequire`	`FuncDeclaration`	function that does the in contract
`fdrequireParams`	`dmd.root.array.Array!(dmd.expression.Expression)*`	argument list for _require
`fensure`	`Statement`	lowered out contract
`fensures`	`dmd.root.array.Array!(dmd.func.Ensure)*`	out contracts
`fes`	`ForeachStatement`	if foreach body, this is the foreach
`flags`	`uint`	Function flags: A collection of boolean packed for memory efficiency See the `FUNCFLAG` enum
`foverrides`	`dmd.root.array.Array!(dmd.func.FuncDeclaration)`	functions this function overrides
`frequire`	`Statement`	lowered in contract
`frequires`	`dmd.root.array.Array!(dmd.statement.Statement)*`	in contracts
`gotos`	`dmd.root.array.Array!(dmd.statement.GotoStatement)*`	Gotos with forward references
`hasReturnExp`	`int`	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
`inlineNest`	`int`	!=0 if nested inline
`interfaceVirtual`	`BaseClass*`	if virtual, but only appears in base interface vtbl[]
`isTypeIsolatedCache`	`bool[ulong]`	cache for the potentially very expensive isTypeIsolated check
`labtab`	`DsymbolTable`	statement label symbol table
`mangleString`	`const(char)*`	mangled symbol created from mangleExact()
`nrvo_var`	`VarDeclaration`	variable to replace with shidden
`objc`	`ObjcFuncDeclaration`	Data for a function declaration that is needed for the Objective-C integration.
`outerVars`	`dmd.root.array.Array!(dmd.declaration.VarDeclaration)`	Outer variables which are referenced by this nested function (the inverse of closureVars)
`overnext`	`Dsymbol`	next in overload list
`overnext0`	`FuncDeclaration`	next in overload list (only used during IFTI)
`parameters`	`dmd.root.array.Array!(dmd.declaration.VarDeclaration)*`	Array of VarDeclaration's for parameters
`returnLabel`	`LabelDsymbol`	where the return goes
`shidden`	`dmd.backend.cc.Symbol*`	hidden pointer passed to function
`siblingCallers`	`dmd.root.array.Array!(dmd.func.FuncDeclaration)`	Sibling nested functions which called this one
`storage_class2`	`ulong`	storage class for template onemember's
`tintro`	`Type`	if !=NULL, then this is the type of the 'introducing' function this one is overriding
`tookAddressOf`	`int`	set if someone took the address of this function
`v_argptr`	`VarDeclaration`	'argptr' variable
`v_arguments`	`VarDeclaration`	'arguments' parameter
`vresult`	`VarDeclaration`	result variable for out contracts
`vtblIndex`	`int`	for member functions, index into vtbl[]
`vthis`	`VarDeclaration`	'this' parameter (member and nested)
`cppnamespace`	`CPPNamespaceDeclaration`	C++ namespace this symbol belongs to
`localNum`	`ushort`	perturb mangled name to avoid collisions with those in FuncDeclaration.localsymtab

Methods

Name	Description
`buildEnsureRequire` ()	Rewrite contracts as statements.
`buildResultVar` (sc, tret)	Declare result variable lazily.
`canInferAttributes` (sc)	Decide if attributes for this function can be inferred from examining the function body.
`checkClosure` ()	Check that the function contains any closure. If it's @nogc, report suitable errors. This is mostly consistent with FuncDeclaration::needsClosure().
`checkForwardRef` (loc)	Check that this function type is properly resolved. If not, report "forward reference error" and return true.
`checkNestedReference` (sc, 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` ()	Check all return statements for a function to verify that returning using NRVO is possible.
`declareThis` (sc)	Creates and returns the hidden parameters for this function declaration.
`findTemplateDeclRoot` ()	find function template root in overload list
`findVtblIndex` (vtbl, dim)	Find index of function in vtbl[0..dim] that this function overrides. Prefer an exact match to a covariant one.
`functionSemantic` ()	Resolve forward reference of function signature - parameter types, return type, and attributes.
`functionSemantic3` ()	Resolve forward reference of function body. Returns false if any errors exist in the body.
`genCfunc` (fparams, treturn, name, stc)	Generate a FuncDeclaration for a runtime library function.
`getLevel` (fd, intypeof)	Determine lexical level difference from `this` to nested function `fd`.
`getLevelAndCheck` (loc, sc, fd, decl)	Determine lexical level difference from `this` to nested function `fd`. Issue error if `this` cannot call `fd`.
`getParameterList` ()
`hasNestedFrameRefs` ()	Determine if function's variables are referenced by a function nested within it.
`initInferAttributes` ()	Initialize for inferring the attributes of this function.
`inUnittest` ()	Returns true if function was declared directly or indirectly in a unittest block
`isAbstract` ()	Override so it can work even if semantic() hasn't yet been run.
`isNested` ()	Determine if function needs a static frame pointer.
`isReturnIsolated` ()	See if pointers from function parameters, mutable globals, or uplevel functions could leak into return value.
`isThis` ()	Determine if function is a non-static member function that has an implicit 'this' expression.
`isTypeIsolated` (t)	See if pointers from function parameters, mutable globals, or uplevel functions could leak into type `t`.
`isUnique` ()
`leastAsSpecialized` (g)	Determine partial specialization order of 'this' vs g. This is very similar to TemplateDeclaration::leastAsSpecialized().
`mergeFensure` (sf, oid, 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` (sf, 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.
`mergeFrequireInclusivePreview` (sf, params)	Merge into this function the 'in' contracts of all it overrides.
`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.
`needsFensure` (fd)	Determine whether an 'out' contract is declared inside the given function or any of its overrides.
`overloadExactMatch` (t)	Find function in overload list that exactly matches t.
`overloadInsert` (s)	Overload this FuncDeclaration with the new one f. Return true if successful; i.e. no conflict.
`overloadModMatch` (loc, tthis, hasOverloads)	Find function in overload list that matches to the 'this' modifier. There's four result types.
`overrideInterface` ()	If function a function in a base class, return that base class.
`overrides` (fd)	Determine if 'this' overrides fd. Return !=0 if it does.
`searchLabel` (ident, loc)	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`.
`setGC` ()	The function is doing something that may allocate with the GC, so mark it as not nogc (not no-how).
`setImpure` ()	The function is doing something impure, so mark it as impure. If there's a purity error, return true.
`setUnsafe` ()	The function is doing something unsafe, so mark it as unsafe. If there's a safe error, return true.
`toFullSignature` ()	for diagnostics, e.g. 'int foo(int x, int y) pure'
`accept` (v)
`addComment` (comment)	Add documentation comment to Dsymbol. Ignore NULL comments.
`arraySyntaxCopy` (a)	Do syntax copy of an array of Dsymbol's.
`checkDisabled` (loc, sc, isAliasedDeclaration)	Issue an error if an attempt to call a disabled method is made
`checkModify` (loc, sc, e1, flag)	Check to see if declaration can be modified in this context (sc). Issue error if not.
`comment` ()	get documentation comment for this Dsymbol
`ddocUnittest` ()	Get ddoc unittest associated with this symbol. (only use this with ddoc)
`ddocUnittest` (utd)	Set ddoc unittest associated with this symbol.
`deinitialize` ()	Deinitializes the global state of the compiler.
`factory` (classname)	Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
`followInstantiationContext` (p1, p2)	Returns true if any of the symbols `p1` or `p2` resides in the enclosing instantiation scope of `this`.
`getAccessModule` ()	Determine which Module a Dsymbol is in, as far as access rights go.
`getModule` ()	Determine which Module a Dsymbol is in.
`hasPointers` ()	Is Dsymbol a variable that contains pointers?
`inNonRoot` ()	Returns true if this symbol is defined in a non-root module without instantiation.
`isCsymbol` ()	Does this Dsymbol come from a C file?
`isMember` ()	Returns an AggregateDeclaration when toParent() is that.
`isMember2` ()	Returns an AggregateDeclaration when toParent2() is that.
`isMemberDecl` ()	Returns an AggregateDeclaration when toParentDecl() is that.
`isMemberLocal` ()	Returns an AggregateDeclaration when toParentLocal() is that.
`isReference` ()
`oneMember` (ps, ident)	Determine if this symbol is only one.
`oneMembers` (members, ps, ident)	Same as Dsymbol::oneMember(), but look at an array of Dsymbols.
`opCmp` (o)	Compare with another Object obj.
`opEquals` (o)	Test whether `this` is equal to `o`. The default implementation only compares by identity (using the `is` operator). Generally, overrides and overloads for `opEquals` should attempt to compare objects by their contents. A class will most likely want to add an overload that takes your specific type as the argument and does the content comparison. Then you can override this and forward it to your specific typed overload with a cast. Remember to check for `null` on the typed overload.
`pastMixin` ()	`pastMixin` returns the enclosing symbol if this is a template mixin.
`resolvedLinkage` ()	Returns the linkage, resolving the target-specific `System` one.
`search` (loc, ident, flags)	Search for ident as member of s.
`searchX` (loc, sc, id, flags)	Search for identifier id as a member of `this`. `id` may be a template instance.
`setScope` (sc)	Set scope for future semantic analysis so we can deal better with forward references.
`size` (loc)
`syntaxCopy` (s)	Copy the syntax. Used for template instantiations. If s is NULL, allocate the new object, otherwise fill it in.
`toAlias` ()	If this symbol is really an alias for another, return that other. If needed, semantic() is invoked due to resolve forward reference.
`toAlias2` ()	Resolve recursive tuple expansion in eponymous template.
`toHash` ()	Compute hash function for Object.
`toParent` ()	`parent` field returns a lexically enclosing scope symbol this is a member of.
`toParent2` ()	`parent` field returns a lexically enclosing scope symbol this is a member of.
`toParentDecl` ()	`parent` field returns a lexically enclosing scope symbol this is a member of.
`toParentLocal` ()	`parent` field returns a lexically enclosing scope symbol this is a member of.
`toParentP` (p1, p2)	Returns the declaration scope scope of `this` unless any of the symbols `p1` or `p2` resides in its enclosing instantiation scope then the latter is returned.
`toString` ()
`toString` ()	Convert Object to a human readable string.
`visible` ()

Authors

Walter Bright

License

Boost License 1.0