Menu
Search

API Documentation

version 2.107.0

overview

View source code
Display the source code in dmd/dtemplate.d from which this page was generated on github.
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 local clone.

Class dmd.dtemplate.TemplateDeclaration

[mixin] template Identifier (parameters) [Constraint]

class TemplateDeclaration
  : ScopeDsymbol ;

Fields

NameTypeDescription
deprecated_ boolthis template declaration is deprecated
isTrivialAlias boolmatches pattern template Alias(T) { alias Alias = qualifiers(T); }
isTrivialAliasSeq boolmatches pattern template AliasSeq(T...) { alias AliasSeq = T; }
importedScopes dmd.root.array.Array!(dmd.dsymbol.Dsymbol)*symbols whose members have been imported, i.e. imported modules and template mixins
localNum ushortperturb mangled name to avoid collisions with those in FuncDeclaration.localsymtab

Methods

NameDescription
addInstance (ti) Add instance ti to TemplateDeclaration's table of instances. Return a handle we can use to later remove it if it fails instantiation.
declareParameter (sc, tp, o) Declare template parameter tp with value o, and install it in the scope sc.
deduceFunctionTemplateMatch (ti, sc, fd, tthis, argumentList) Match function arguments against a specific template function.
doHeaderInstantiation (ti, sc2, fd, tthis, fargs) Limited function template instantiation for using fd.leastAsSpecialized()
evaluateConstraint (ti, sc, paramscope, dedargs, fd) Check to see if constraint is satisfied.
findExistingInstance (tithis, fargs) Given a new instance tithis of this TemplateDeclaration, see if there already exists an instance. If so, return that existing instance.
getConstraintEvalError (tip) Destructively get the error message from the last constraint evaluation
isOverloadable () We can overload templates.
isVariadic () Check if the last template parameter is a tuple one, and returns it if so, else returns null.
leastAsSpecialized (sc, td2, argumentList) Determine partial specialization order of 'this' vs td2.
matchWithInstance (sc, ti, dedtypes, argumentList, flag) Given that ti is an instance of this TemplateDeclaration, deduce the types of the parameters to this, and store those deduced types in dedtypes[].
overloadInsert (s) Overload existing TemplateDeclaration 'this' with the new one 's'. Return true if successful; i.e. no conflict.
removeInstance (ti) Remove TemplateInstance from table of instances.
scopeForTemplateParameters (ti, sc) Create a scope for the parameters of the TemplateInstance ti in the parent scope sc from the ScopeDsymbol paramsym.
toCharsNoConstraints () Similar to toChars, but does not print the template constraints
accept (v)
addComment (comment) Add documentation comment to Dsymbol. Ignore NULL comments.
arraySyntaxCopy (a) Do syntax copy of an array of Dsymbol's.
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.
getImportedScopes ()
getImportVisibilities ()
getModule () Determine which Module a Dsymbol is in.
hasPointers () Is Dsymbol a variable that contains pointers?
hasStaticCtorOrDtor () Return true if any of the members are static ctors or static dtors, or if any members have members that are.
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.
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.
size (loc)
symtabInsert (s) Insert Dsymbol in table.
symtabLookup (s, id) Look up identifier in symbol table.
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 ()

https

//dlang.org/spec/template.html

https

//dlang.org/spec/template-mixin.html

Authors

Walter Bright

License

Boost License 1.0