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.InvariantDeclaration`


						
				class InvariantDeclaration
				
  : FuncDeclaration
				;

Fields

Name	Type	Description
`alignSectionVars`	`dmd.root.array.Array!(dmd.declaration.VarDeclaration)*`	local variables with alignment needs larger than stackAlign
`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
`fes`	`ForeachStatement`	if foreach body, this is the foreach
`foverrides`	`dmd.root.array.Array!(dmd.func.FuncDeclaration)`	functions this function overrides
`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
`localNum`	`ushort`	perturb mangled name to avoid collisions with those in FuncDeclaration.localsymtab
`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
`safetyViolation`	`AttributeViolation*`	In case of failed `@safe` inference, store the error that made the function `@system` for better diagnostics
`salignSection`	`dmd.backend.cc.Symbol*`	pointer to aligned section, if any
`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)

Methods

Name	Description
`accept` (v)
`addComment` (comment)	Add documentation comment to Dsymbol. Ignore NULL comments.
`arraySyntaxCopy` (a)	Do syntax copy of an array of Dsymbol's.
`checkClosure` ()	Check that the function contains any closure. If it's @nogc, report suitable errors. This is mostly consistent with FuncDeclaration::needsClosure().
`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.
`checkNRVO` ()	Check all return statements for a function to verify that returning using NRVO is possible.
`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.
`findTemplateDeclRoot` ()	find function template root in overload list
`followInstantiationContext` (p1, p2)	Returns true if any of the symbols `p1` or `p2` resides in the enclosing instantiation scope of `this`.
`genCfunc` (fparams, treturn, name, stc)	Generate a FuncDeclaration for a runtime library function.
`getAccessModule` ()	Determine which Module a Dsymbol is in, as far as access rights go.
`getLevel` (fd, intypeof)	Determine lexical level difference from `this` to nested function `fd`.
`getModule` ()	Determine which Module a Dsymbol is in.
`getParameterList` ()
`hasNestedFrameRefs` ()	Determine if function's variables are referenced by a function nested within it.
`hasPointers` ()	Is Dsymbol a variable that contains pointers?
`initInferAttributes` ()	Initialize for inferring the attributes of this function.
`inNonRoot` ()	Returns true if this symbol is defined in a non-root module without instantiation.
`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.
`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.
`isNested` ()	Determine if function needs a static frame pointer.
`isReference` ()
`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` (f, g, names)	Determine partial specialization order of functions `f` vs `g`. This is very similar to TemplateDeclaration::leastAsSpecialized().
`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.
`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.
`overloadInsert` (s)	Overload this FuncDeclaration with the new one f. Return true if successful; i.e. no conflict.
`overrides` (fd)	Determine if 'this' overrides fd. Return !=0 if it does.
`pastMixin` ()	`pastMixin` returns the enclosing symbol if this is a template mixin.
`resolvedLinkage` ()	Returns the linkage, resolving the target-specific `System` one.
`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` (loc, fmt, arg0)	The function is doing something that may allocate with the GC, so mark it as not nogc (not no-how).
`setGCCall` (f)	The function calls non-`@nogc` function f, mark it as not nogc.
`setImpure` (loc, fmt, arg0)	The function is doing something impure, so mark it as impure.
`setThrow` (loc, fmt, arg0)	The function is doing something that may throw an exception, register that in case nothrow is being inferred
`setThrowCall` (loc, f)	The function calls non-`nothrow` function f, register that in case nothrow is being inferred
`setUnsafe` (gag, loc, fmt, arg0, arg1, arg2)	The function is doing something unsafe, so mark it as unsafe.
`setUnsafeCall` (f)	The function is calling `@system` function `f`, so mark it as unsafe.
`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.
`toFullSignature` ()	for diagnostics, e.g. 'int foo(int x, int y) pure'
`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