Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
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
a local clone.
dmd.funcsem
Does semantic analysis for functions.
Specification Functions
Authors:
License:
Source funcsem.d
Documentation https://dlang.org/phobos/dmd_funcsem.html
- void
funcDeclarationSemantic
(Scope*sc
, FuncDeclarationfuncdecl
); - Main semantic routine for functions.
- bool
functionSemantic
(FuncDeclarationfd
); - Resolve forward reference of function signature - parameter types, return type, and attributes.Parameters:
FuncDeclaration fd
function declaration Returns:false if any errors exist in the signature. - bool
functionSemantic3
(FuncDeclarationfd
); - Resolve forward reference of function body. Returns false if any errors exist in the body.
- void
declareThis
(FuncDeclarationfd
, Scope*sc
); - Creates and returns the hidden parameters for this function declaration.Hidden parameters include the this parameter of a class, struct or nested function and the selector parameter for Objective-C methods.
- bool
checkForwardRef
(FuncDeclarationfd
, const ref Locloc
); - Check that this function type is properly resolved. If not, report "forward reference error" and return true.
- int
findVtblIndex
(FuncDeclarationfd
, Dsymbol[]vtbl
); - Find index of function in vtbl[0..length] that this function overrides. Prefer an exact match to a covariant one.Parameters:
FuncDeclaration fd
function Dsymbol[] vtbl
vtable to use Returns:-1 didn't find one -2 can't determine because of forward references - BaseClass*
overrideInterface
(FuncDeclarationfd
); - If function is a function in a base class, return that base class.Parameters:
FuncDeclaration fd
function Returns:base class if overriding, null if not - enum
FuncResolveFlag
: ubyte; - Flag used by resolveFuncCall.
standard
- issue error messages, solve the call.
quiet
- do not issue error message on no match, just return null.
overloadOnly
- only resolve overloads, i.e. do not issue error on ambiguous
ufcs
- matches and need explicit this.trying to resolve UFCS call
- FuncDeclaration
resolveFuncCall
(const ref Locloc
, Scope*sc
, Dsymbols
, Objects*tiargs
, Typetthis
, ArgumentListargumentList
, FuncResolveFlagflags
); - Given a symbol that could be either a FuncDeclaration or a function template, resolve it to a function symbol.Parameters:
Loc loc
instantiation location Scope* sc
instantiation scope Dsymbol s
instantiation symbol Objects* tiargs
initial list of template arguments Type tthis
if !NULL, the this argument type ArgumentList argumentList
arguments to function FuncResolveFlag flags
see FuncResolveFlag. Returns:if match is found, then function symbol, else null - Expression
addInvariant
(AggregateDeclarationad
, VarDeclarationvthis
); - Generate Expression to call the invariant.
Input ad aggregate with the invariant vthis variable with 'this'
Returns:void expression that calls the invariant - FuncDeclaration
overloadExactMatch
(FuncDeclarationthisfd
, Typet
); - Find function in overload list that exactly matches t.
- int
overrides
(FuncDeclarationfd1
, FuncDeclarationfd2
); - Determine if fd1 overrides fd2. Return !=0 if it does.
- MATCH
leastAsSpecialized
(FuncDeclarationf
, FuncDeclarationg
, Identifiers*names
); - Determine partial specialization order of functions
f
vsg
. This is very similar to TemplateDeclaration::leastAsSpecialized().Parameters:FuncDeclaration f
first function FuncDeclaration g
second function Identifiers* names
names of parameters Returns:match 'this' is at least as specialized as g 0 g is more specialized than 'this' - FuncDeclaration
overloadModMatch
(FuncDeclarationthisfd
, const ref Locloc
, Typetthis
, ref boolhasOverloads
); - Find function in overload list that matches to the 'this' modifier. There's four result types.
- If the 'tthis' matches only one candidate, it's an "exact match". Returns the function and 'hasOverloads' is set to false. eg. If 'tthis" is mutable and there's only one mutable method.
- If there's two or more match candidates, but a candidate function will be a "better match". Returns the better match function but 'hasOverloads' is set to true. eg. If 'tthis' is mutable, and there's both mutable and const methods, the mutable method will be a better match.
- If there's two or more match candidates, but there's no better match, Returns null and 'hasOverloads' is set to true to represent "ambiguous match". eg. If 'tthis' is mutable, and there's two or more mutable methods.
- If there's no candidates, it's "no match" and returns null with error report. e.g. If 'tthis' is const but there's no const methods.
- int
getLevelAndCheck
(FuncDeclarationfd
, const ref Locloc
, Scope*sc
, FuncDeclarationtarget
, Declarationdecl
); - Determine lexical level difference from
fd
to nested functiontarget
. Issue error iffd
cannot calltarget
.Parameters:FuncDeclaration fd
function Loc loc
location for error messages Scope* sc
context FuncDeclaration target
target of call Declaration decl
The Declaration that triggered this check. Used to provide a better error message only. Returns:0 same level0 decrease nesting by number -1 increase nesting by 1 (
target
is nested within 'fd') LevelError error - bool
canInferAttributes
(FuncDeclarationfd
, Scope*sc
); - Decide if attributes for this function can be inferred from examining the function body.Returns:true if can
- bool
checkNestedReference
(FuncDeclarationfd
, Scope*sc
, const ref Locloc
); - In the current function, we are calling 'this' function.
- Check to see if the current function can call 'this' function, issue error if not.
- If the current function is not the parent of 'this' function, then add the current function to the list of siblings of 'this' function.
- If the current function is a literal, and it's accessing an uplevel scope, then mark it as a delegate.
- void
buildResultVar
(FuncDeclarationfd
, Scope*sc
, Typetret
); - Declare result variable lazily.
- Statement
mergeFrequire
(FuncDeclarationfd
, Statementsf
, 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.
- Statement
mergeFrequireInclusivePreview
(FuncDeclarationfd
, Statementsf
, Expressions*params
); - Merge into this function the 'in' contracts of all it overrides.
- void
buildEnsureRequire
(FuncDeclarationthisfd
); - Rewrite contracts as statements.
- @safe bool
needsFensure
(FuncDeclarationfd
); - Determine whether an 'out' contract is declared inside the given function or any of its overrides.Parameters:
FuncDeclaration fd
the function to search Returns:true found an 'out' contract - Statement
mergeFensure
(FuncDeclarationfd
, Statementsf
, Identifieroid
, 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.
- void
modifyReturns
(FuncLiteralDeclarationfld
, Scope*sc
, Typetret
); - Modify all expression type of return statements to tret.On function literals, return type may be modified based on the context type after its semantic3 is done, in FuncExp::implicitCastTo. A function() dg = (){ return new B(); } // OK if is(B : A) == true If B to A conversion is convariant that requires offseet adjusting, all return statements should be adjusted to return expressions typed A.
- bool
isRootTraitsCompilesScope
(Scope*sc
); - When a traits(compiles) is used on a function literal call we need to take into account if the body of the function violates any attributes, however, we must not affect the attribute inference on the outer function. The attributes of the function literal still need to be inferred, therefore we need a way to check for the scope that the traits compiles introduces.Parameters:
Scope* sc
scope to be checked for Returns:true if the provided scope is the root of the traits compiles list of scopes. - bool
setUnsafe
(Scope*sc
, boolgag
= false, Locloc
= Loc.init, const(char)*fmt
= null, RootObjectarg0
= null, RootObjectarg1
= null, RootObjectarg2
= null); - A statement / expression in this scope is not @safe, so mark the enclosing function as @systemParameters:
Scope* sc
scope that the unsafe statement / expression is in bool gag
surpress error message (used in escape.d) Loc loc
location of error const(char)* fmt
printf-style format string RootObject arg0
(optional) argument for first %s format specifier RootObject arg1
(optional) argument for second %s format specifier RootObject arg2
(optional) argument for third %s format specifier Returns:whether there's a safe error - bool
setUnsafePreview
(Scope*sc
, FeatureStatefs
, boolgag
, Locloc
, const(char)*msg
, RootObjectarg0
= null, RootObjectarg1
= null, RootObjectarg2
= null); - Like setUnsafe, but for safety errors still behind preview switchesGiven a FeatureState
fs
, for example dip1000 / dip25 / systemVariables, the behavior changes based on the setting:- In case of -revert=
fs
, it does nothing. - In case of -preview=
fs
, it's the same as setUnsafe - By default, print a deprecation in @safe functions, or store an attribute violation in inferred functions.
Parameters:Scope* sc
used to find affected function/variable, and for checking whether we are in a deprecated / speculative scope FeatureState fs
feature state from the preview flag bool gag
surpress error message Loc loc
location of error const(char)* msg
printf-style format string RootObject arg0
(optional) argument for first %s format specifier RootObject arg1
(optional) argument for second %s format specifier RootObject arg2
(optional) argument for third %s format specifier Returns:whether an actual safe error (not deprecation) occured - In case of -revert=
- bool
checkNRVO
(FuncDeclarationfd
); - Check all return statements for a function to verify that returning using NRVO is possible.Returns:false if the result cannot be returned by hidden reference.
- bool
setImpure
(FuncDeclarationfd
, Locloc
= Loc.init, const(char)*fmt
= null, RootObjectarg0
= null); - The function is doing something impure, so mark it as impure.Parameters:
FuncDeclaration fd
function declaration to mark Loc loc
location of impure action const(char)* fmt
format string for error message. Must include "%s %s" for the function kind and name. RootObject arg0
(optional) argument to format string Returns:true if there's a purity error - bool
traverseIndirections
(Typeta
, Typetb
); - Performs type-based alias analysis between a newly created value and a pre- existing memory reference:Assuming that a reference A to a value of type
ta
was available to the code that created a reference B to a value of typetb
, it returns whether B might alias memory reachable from A based on the types involved (either directly or via any number of indirections in either A or B). This relation is not symmetric in the two arguments. For example, a a const(int) reference can point to a pre-existing int, but not the other way round.Examples:ta, tb, result const(int), int, false int, const(int), true int, immutable(int), false const(immutable(int), immutable(int)), false // BUG: returns trueParameters:Type ta
value type being referred to Type tb
referred to value type that could be constructed from ta Returns:true if reference totb
is isolated from reference tota
- bool
isTypeIsolatedIndirect
(FuncDeclarationfd
, Typet
); - Parameters:
FuncDeclaration fd
function declaration to check Type t
type of object to test one level of indirection down Returns:true if an object typedt
has no indirections which could have come from the function's parameters, mutable globals, or uplevel functions. - bool
isReturnIsolated
(FuncDeclarationfd
); - See if pointers from function parameters, mutable globals, or uplevel functions could leak into return value.Returns:true if the function return value is isolated from any inputs to the function
- bool
isTypeIsolated
(FuncDeclarationfd
, Typet
);
boolisTypeIsolated
(FuncDeclarationfd
, Typet
, ref StringTable!TypeparentTypes
); - See if pointers from function parameters, mutable globals, or uplevel functions could leak into type
t
.Parameters:Type t
type to check if it is isolated Returns:true ift
is isolated from any inputs to the function
Copyright © 1999-2025 by the D Language Foundation | Page generated by
Ddoc on Sun Mar 23 04:28:29 2025