dmd.mtype
Defines a D type.
License
Source: mtype.d
Documentation: https://dlang.org/phobos/dmd_mtype.html
-
Declaration
pure nothrow @nogc @safe bool
MODimplicitConv
(MODmodfrom
, MODmodto
);Return !=0 if
modfrom
can be implicitly converted tomodto
-
Declaration
pure nothrow @nogc @safe MATCH
MODmethodConv
(MODmodfrom
, MODmodto
);Return MATCH.exact or MATCH.constant if a method of type '()
modfrom
' can call a method of type '()modto
'. -
Declaration
pure nothrow @nogc @safe MOD
MODmerge
(MODmod1
, MODmod2
);Merge mod bits to form common mod.
-
Declaration
nothrow void
MODtoBuffer
(OutBuffer*buf
, MODmod
);Store modifier name into
buf
. -
Declaration
pure nothrow const(char)*
MODtoChars
(MODmod
);
pure nothrow stringMODtoString
(MODmod
);Return Value
a human readable representation of
, which is the tokenmod
corresponds tomod
-
Declaration
pure nothrow @nogc @safe StorageClass
ModToStc
(uintmod
);Convert MODxxxx to STCxxx
-
Declaration
pure nothrow @nogc @safe bool
isSomeChar
(TYty
);Returns
true
ifty
is char, wchar, or dchar -
Declaration
enum
DotExpFlag
: int;dotExp() bit flags
-
Declaration
enum
VarArg
: ubyte;Variadic argument lists https://dlang.org/spec/function.html#variadic
-
Declaration
none
fixed number of arguments
-
Declaration
variadic
(T t, ...) can be C-style (core.stdc.stdarg) or D-style (core.vararg)
-
Declaration
typesafe
(T t ...)
typesafe
https://dlang.org/spec/function.html#typesafe_variadic_functions
-
-
Declaration
abstract class
Type
: dmd.ast_node.ASTNode;-
Declaration
final int
covariant
(Typet
, StorageClass*pstc
= null);Covariant means that 'this' can substitute for '
t
', i.e. a pure function is a match for an impure type.Parameters
Type
t
type 'this' is
covariant
withStorageClass*
pstc
if not
null
, store STCxxxx which would make itcovariant
Return Value
0 types are distinct 1 this is
covariant
witht
2 arguments match as far as overloading goes, but types are notcovariant
3 cannot determine covariance because of forward references *pstc
STCxxxx which would make itcovariant
-
Declaration
final const const(char)*
toChars
();
final char*toPrettyChars
(boolQualifyTypes
= false);For pretty-printing a type.
-
Declaration
static void
deinitialize
();Deinitializes the global state of the compiler.
Discussion
This can be used to restore the state set by
_init
to its original state. -
Declaration
final Type
merge2
();This version does a merge even if the deco is already computed. Necessary for types that have a deco, but are not merged.
-
Declaration
final const nothrow void
modToBuffer
(OutBuffer*buf
);Store this type's modifier name into
buf
. -
Declaration
final const nothrow char*
modToChars
();Return this type's modifier name.
-
Declaration
bool
isAssignable
();When T is mutable,
Given: T a, b; Can we bitwise assign: a = b; ?
-
Declaration
bool
isBoolean
();Returns
true
if T can be converted to boolean value. -
Declaration
void
checkDeprecated
(ref const Locloc
, Scope*sc
);Check type to see if it is based on a deprecated symbol.
-
Declaration
final const nothrow Type
nullAttributes
();Return a copy of this type with all attributes
null
-initialized. Useful for creating a type with different modifiers. -
Declaration
final Type
constOf
();Convert to 'const'.
-
Declaration
final Type
immutableOf
();Convert to 'immutable'.
-
Declaration
final Type
mutableOf
();Make type mutable.
-
Declaration
final Type
unSharedOf
();Make type unshared. 0 => 0 const => const immutable => immutable shared => 0 shared const => const wild => wild wild const => wild const shared wild => wild shared wild const => wild const
-
Declaration
final Type
wildOf
();Convert to 'wild'.
-
Declaration
final void
fixTo
(Typet
);For our new type 'this', which is type-constructed from
t
, fill in the cto, ito, sto, scto, wto shortcuts. -
Declaration
final void
check
();Look for bugs in constructing types.
-
Declaration
final Type
addSTC
(StorageClassstc
);Apply STCxxxx bits to existing type. Use before semantic analysis is run.
-
Declaration
final Type
castMod
(MODmod
);Apply MODxxxx bits to existing type.
-
Declaration
final Type
addMod
(MODmod
);Add MODxxxx bits to existing type. We're adding, not replacing, so adding const to a shared type => "shared const"
-
Declaration
Type
addStorageClass
(StorageClassstc
);Add storage class modifiers to type.
-
Declaration
final Type
toBasetype
();If this is a shell around another type, get that other type.
-
Declaration
MATCH
implicitConvTo
(Typeto
);Determine if 'this' can be implicitly converted
to
type 'to
'.Return Value
MATCH.nomatch, MATCH.convert, MATCH.constant, MATCH.exact
-
Declaration
MATCH
constConv
(Typeto
);Determine if converting 'this'
to
'to
' is an identity operation, a conversionto
const operation, or the types aren't the same.Return Value
MATCH.exact 'this' == '
to
' MATCH.constant 'to
' is const MATCH.nomatch conversionto
mutable or invariant -
Declaration
MOD
deduceWild
(Typet
, boolisRef
);Compute MOD bits matching
this
argument type to wild parameter type.Parameters
Type
t
corresponding parameter type
bool
isRef
parameter is
ref
orout
Return Value
MOD bits
-
Declaration
inout inout(Type)
toHeadMutable
();Return type with the top level of it being mutable.
-
Declaration
structalign_t
alignment
();Return
alignment
to use for this type. -
Declaration
Expression
defaultInitLiteral
(ref const Locloc
);Use when we prefer the default initializer to be a literal, rather than a global immutable variable.
-
Declaration
const int
hasWild
();Return !=0 if the type or any of its subtypes is wild.
-
Declaration
bool
hasPointers
();Return !=0 if type has pointers that need to be scanned by the GC during a collection cycle.
-
Declaration
bool
hasVoidInitPointers
();Detect if type has pointer fields that are initialized to void. Local stack variables with such void fields can remain uninitialized, leading to pointer bugs.
Return Value
true
if so -
Declaration
bool
hasInvariant
();Return Value
true
if type has any invariants -
Declaration
Type
nextOf
();If this is a type of something, return that something.
-
Declaration
final Type
baseElemOf
();If this is a type of static array, return its base element type.
-
Declaration
final uint
numberOfElems
(ref const Locloc
);Compute number of elements for a (possibly multidimensional) static array, or 1 for other types.
Parameters
Loc
loc
for error message
Return Value
number of elements, uint.max on overflow
-
Declaration
final uinteger_t
sizemask
();Return the mask that an integral type will fit into.
-
Declaration
bool
needsDestruction
();true
if when type goes out of scope, it needs a destructor applied. Only applies to value types, not ref types. -
Declaration
bool
needsCopyOrPostblit
();true
if when type is copied, it needs a copy constructor or postblit applied. Only applies to value types, not ref types. -
Declaration
bool
needsNested
(); -
Declaration
final bool
checkComplexTransition
(ref const Locloc
, Scope*sc
);https://issues.dlang.org/show_bug.cgi?id=14488 Check if the inner most base type is complex or imaginary. Should only give alerts when set to emit transitional messages.
Parameters
Loc
loc
The source location.
Scope*
sc
scope of the type
-
-
Declaration
class
TypeError
: dmd.mtype.Type; -
Declaration
abstract class
TypeNext
: dmd.mtype.Type;-
Declaration
final Type
nextOf
();For TypeFunction,
nextOf
() can return NULL if the function return type is meant to be inferred, and semantic() hasn't yet ben run on the function. After semantic(), it must no longer be NULL.
-
-
Declaration
class
TypeBasic
: dmd.mtype.Type; -
Declaration
class
TypeVector
: dmd.mtype.Type;The basetype must be one of: byte[16],ubyte[16],short[8],ushort[8],int[4],uint[4],long[2],ulong[2],float[4],double[2] For AVX: byte[32],ubyte[32],short[16],ushort[16],int[8],uint[8],long[4],ulong[4],float[8],double[4]
-
Declaration
abstract class
TypeArray
: dmd.mtype.TypeNext; -
Declaration
class
TypeSArray
: dmd.mtype.TypeArray;Static array, one with a fixed dimension
-
Declaration
bool
needsNested
();
-
-
Declaration
class
TypeDArray
: dmd.mtype.TypeArray;Dynamic array, no dimension
-
Declaration
class
TypeAArray
: dmd.mtype.TypeArray; -
Declaration
class
TypePointer
: dmd.mtype.TypeNext; -
Declaration
class
TypeReference
: dmd.mtype.TypeNext; -
Declaration
class
TypeFunction
: dmd.mtype.TypeNext;-
Declaration
void
purityLevel
();Set 'purity' field of 'this'. Do this lazily, as the parameter types might be forward referenced.
-
Declaration
bool
hasLazyParameters
();Return
true
if there are lazy parameters. -
Declaration
const pure nothrow bool
isDstyleVariadic
();Check for
extern (D) U func(T t, ...)
variadic function type, which has_arguments[]
added as the first argument.Return Value
true
if D-style variadic -
Declaration
bool
parameterEscapes
(Typetthis
, Parameterp
);Examine function signature for parameter
p
and see if the value ofp
can 'escape' the scope of the function. This is useful to minimize the needed annotations for the parameters.Parameters
Type
tthis
type of
this
parameter,null
if noneParameter
p
parameter to this function
Return Value
true
if escapes via assignment to global or through a parameter -
Declaration
StorageClass
parameterStorageClass
(Typetthis
, Parameterp
);Take the specified storage class for
p
, and use the function signature to infer whether STC.scope_ and STC.return_ should be OR'd in. (This will not affect the name mangling.)Parameters
Type
tthis
type of
this
parameter,null
if noneParameter
p
parameter to this function
Return Value
storage class with STC.scope_ or STC.return_ OR'd in
-
Declaration
MATCH
callMatch
(Typetthis
, Expression[]args
, intflag
= 0, const(char)**pMessage
= null, Scope*sc
= null);'
args
' are being matched to function 'this' Determine match level.Parameters
Type
tthis
type of
this
pointer,null
if not member functionExpression[]
args
array of function arguments
int
flag
1: performing a partial ordering match
const(char)**
pMessage
address to store error message, or
null
Scope*
sc
context
Return Value
MATCHxxxx
-
Declaration
MATCH
constConv
(Typeto
);Extends TypeNext.
constConv
by also checking for matching attributes -
Declaration
const pure nothrow @nogc @safe bool
isnothrow
();
pure nothrow @nogc @safe voidisnothrow
(boolv
);set or get if the function has the
nothrow
attribute -
Declaration
const pure nothrow @nogc @safe bool
isnogc
();
pure nothrow @nogc @safe voidisnogc
(boolv
);set or get if the function has the
@nogc
attribute -
Declaration
const pure nothrow @nogc @safe bool
isproperty
();
pure nothrow @nogc @safe voidisproperty
(boolv
);set or get if the function has the
@property
attribute -
Declaration
const pure nothrow @nogc @safe bool
isref
();
pure nothrow @nogc @safe voidisref
(boolv
);set or get if the function has the
ref
attribute -
Declaration
const pure nothrow @nogc @safe bool
isreturn
();
pure nothrow @nogc @safe voidisreturn
(boolv
);set or get if the function has the
return
attribute -
Declaration
const pure nothrow @nogc @safe bool
isScopeQual
();
pure nothrow @nogc @safe voidisScopeQual
(boolv
);set or get if the function has the
scope
attribute -
Declaration
const pure nothrow @nogc @safe bool
isreturninferred
();
pure nothrow @nogc @safe voidisreturninferred
(boolv
);set or get if the function has the
return
attribute inferred -
Declaration
const pure nothrow @nogc @safe bool
isscopeinferred
();set or get if the function has the
scope
attribute inferred -
Declaration
pure nothrow @nogc @safe void
isscopeinferred
(boolv
);ditoo
-
Declaration
const pure nothrow @nogc @safe bool
islive
();
pure nothrow @nogc @safe voidislive
(boolv
);set or get if the function has the
@live
attribute -
Declaration
const pure nothrow @nogc @safe bool
incomplete
();
pure nothrow @nogc @safe voidincomplete
(boolv
);set or get if the return type or the default arguments are removed
-
Declaration
const pure nothrow @nogc @safe bool
isInOutParam
();
pure nothrow @nogc @safe voidisInOutParam
(boolv
);set or get if the function has the
inout
on the parameters -
Declaration
const pure nothrow @nogc @safe bool
isInOutQual
();
pure nothrow @nogc @safe voidisInOutQual
(boolv
);set or get if the function has the
inout
on the parameters -
Declaration
const pure nothrow @nogc @safe bool
iswild
();Return Value
true
the function isisInOutQual
orisInOutParam
,false
otherwise. -
Declaration
const pure nothrow @nogc @safe bool
attributesEqual
(scope const TypeFunctionother
);Return Value
whether
this
function type has the same attributes (@safe
,...) asother
-
-
Declaration
class
TypeDelegate
: dmd.mtype.TypeNext; -
Declaration
class
TypeTraits
: dmd.mtype.Type;This is a shell containing a TraitsExp that can be either resolved to a type or to a symbol.
Discussion
The point is to allow AliasDeclarationY to use
__traits()
, see issue 7804.-
Declaration
TraitsExp
exp
;The expression to resolve as type or symbol.
-
Declaration
Dsymbol
sym
;After
typeSemantic
the symbol whenexp
doesn't represent a type.
-
-
Declaration
class
TypeMixin
: dmd.mtype.Type;Implements mixin types.
Discussion
Semantic analysis will convert it to a real type.
-
Declaration
abstract class
TypeQualified
: dmd.mtype.Type; -
Declaration
class
TypeIdentifier
: dmd.mtype.TypeQualified;-
Declaration
Dsymbol
toDsymbol
(Scope*sc
);See if type resolves to a symbol, if so, return that symbol.
-
-
Declaration
class
TypeInstance
: dmd.mtype.TypeQualified;Similar to TypeIdentifier, but with a TemplateInstance as the root
-
Declaration
class
TypeTypeof
: dmd.mtype.TypeQualified; -
Declaration
class
TypeReturn
: dmd.mtype.TypeQualified; -
Declaration
class
TypeStruct
: dmd.mtype.Type;-
Declaration
Expression
defaultInitLiteral
(ref const Locloc
);Use when we prefer the default initializer to be a literal, rather than a global immutable variable.
-
-
Declaration
class
TypeEnum
: dmd.mtype.Type; -
Declaration
class
TypeClass
: dmd.mtype.Type; -
Declaration
class
TypeTuple
: dmd.mtype.Type; -
Declaration
class
TypeSlice
: dmd.mtype.TypeNext;This is so we can slice a TypeTuple
-
Declaration
class
TypeNull
: dmd.mtype.Type; -
Declaration
class
TypeNoreturn
: dmd.mtype.Type; -
Declaration
struct
ParameterList
;Represents a function's formal parameters + variadics info. Length, indexing and iteration are based on a depth-first tuple expansion. https://dlang.org/spec/function.html#ParameterList
-
Declaration
Parameters*
parameters
;The raw (unexpanded) formal
parameters
, possibly containing tuples. -
Declaration
size_t
length
();Returns the number of expanded parameters. Complexity: O(N).
-
Declaration
Parameter
opIndex
(size_ti
);Returns the expanded parameter at the given index, or
null
if out of bounds. Complexity: O(i
). -
Declaration
int
opApply
(scope Parameter.ForeachDgdg
);Iterates over the expanded parameters. Complexity: O(N). Prefer this to avoid the O(N + N^2/2) complexity of calculating length and calling N times opIndex.
-
Declaration
int
opApply
(scope Parameter.SemanticForeachDgdg
);Iterates over the expanded parameters, matching them with the unexpanded ones, for semantic processing
-
Declaration
const bool
opEquals
(ref scope ParameterListother
);Compares this to another ParameterList (and expands tuples if necessary)
-
-
Declaration
class
Parameter
: dmd.ast_node.ASTNode;-
Declaration
Type
isLazyArray
();Determine if parameter is a lazy array of delegates. If so, return the return type of those delegates. If not, return NULL.
Discussion
Returns T if the type is one of the following forms: T delegate()[] T delegate()
dim
-
Declaration
const pure nothrow @nogc @safe bool
isReference
();Return Value
Whether the function parameter is a reference (out / ref)
-
Declaration
static size_t
dim
(Parameters*parameters
);Determine number of arguments, folding in tuples.
-
Declaration
static Parameter
getNth
(Parameters*parameters
, size_tnth
);Get
nth
Parameter
, folding in tuples.Discussion
Since
can include tuples, which would increase its length, this function allows to get theparameters
parameter as if all tuples transitively contained innth
were flattened.parameters
Parameters
Parameters*
parameters
Array of
Parameter
to iterate oversize_t
nth
Index of the desired parameter.
Return Value
The parameter at index
(taking tuples into account), ornth
null
if out of bound. -
Declaration
alias
ForeachDg
= int delegate(ulong paramidx, Parameter param);Type of delegate when iterating solely on the parameters
-
Declaration
alias
SemanticForeachDg
= int delegate(ulong oidx, Parameter oparam, ulong eidx, Parameter eparam);Type of delegate when iterating on both the original set of parameters, and the type tuple. Useful for semantic analysis. 'o' stands for 'original' and 'e' stands for 'expanded'.
-
Declaration
static int
_foreach
(Parameters*parameters
, scope ForeachDgdg
);
static int_foreach
(Parameters*parameters
, scope SemanticForeachDgdg
);Expands tuples in args in depth first order. Calls
dg
(void *ctx, size_t argidx, Parameter *arg) for each Parameter. Ifdg
returns !=0, stops and returns that value else returns 0. Use this function to avoid the O(N + N^2/2) complexity of calculating dim and calling N times getNth. -
Declaration
const pure nothrow @nogc @safe bool
isCovariant
(boolreturnByRef
, const Parameterp
, boolpreviewIn
= global.params.previewIn
);Compute covariance of parameters
this
and
as determined by the storage classes of both.p
Parameters
bool
returnByRef
true
if the function returns by refParameter
p
Parameter to compare with
bool
previewIn
Whether
-preview=in
is being used, and thus ifin
meansscope [ref]
.Return Value
true
=this
can be used in place ofp
false
= nope
-
-
Declaration
const(char*)[2]
toAutoQualChars
(Typet1
, Typet2
);For printing two types with qualification when necessary.
Parameters
Type
t1
The first type to receive the type name for
Type
t2
The second type to receive the type name for
Return Value
The fully-qualified names of both types if the two type names are not the same, or the unqualified names of both types if the two type names are the same.
-
Declaration
void
modifiersApply
(const TypeFunctiontf
, void delegate(string)dg
);For each active modifier (MODFlags.const_, MODFlags.immutable_, etc) call
fp
with a void* for the work param and a string representation of the attribute. -
Declaration
void
attributesApply
(const TypeFunctiontf
, void delegate(string)dg
, TRUSTformattrustFormat
= TRUSTformatDefault);For each active attribute (ref/const/nogc/etc) call
fp
with a void* for the work param and a string representation of the attribute. -
Declaration
AggregateDeclaration
isAggregate
(Typet
);If the type is a class or struct, returns the symbol for it, else
null
. -
Declaration
bool
isIndexableNonAggregate
(Typet
);Determine if type
t
can be indexed or sliced given that it is not an aggregate with operator overloads.Parameters
Type
t
type to check
Return Value
true
if an expression of typet
can be e1 in an array expression -
Declaration
bool
isCopyable
(Typet
);Determine if type
t
is copyable.Parameters
Type
t
type to check
Return Value
true
if we can copy it