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.TemplateInstance

class TemplateInstance
  : ScopeDsymbol ;

Constructors

NameDescription
this (loc, td, tiargs) This constructor is only called when we figured out which function template to instantiate.

Fields

NameTypeDescription
fargs dmd.root.array.Array!(dmd.expression.Expression)*For function template, these are the function names and arguments Relevant because different resolutions of auto ref parameters create different template instances even with the same template arguments
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

Properties

NameTypeDescription
gagged[get] boolif the instantiation is done with error gagging
havetempdecl[get] boolif used second constructor
semantictiargsdone[get] boolhas semanticTiargs() been done?

Methods

NameDescription
appendToModuleMember () Append 'this' to the specific module members[]
declareParameters (sc) Declare parameters of template instance, initialize them with the template instance arguments.
equalsx (ti) Compare proposed template instantiation with existing template instantiation. Note that this is not commutative because of the auto ref check.
findBestMatch (sc, argumentList) Find the TemplateDeclaration that matches this TemplateInstance best.
findTempDecl (sc, pwithsym) Find template declaration corresponding to template instance.
genIdent (args) This instance needs an identifier for name mangling purposes. Create one by taking the template declaration name and adding the type signature for it.
getIdent () Lazily generate identifier for template instance. This is because 75% of the ident's are never needed.
hasNestedArgs (args, isstatic) Determines if a TemplateInstance will need a nested generation of the TemplateDeclaration. Sets enclosing property if so, and returns != 0;
isDiscardable ()
needsCodegen () Returns true if this is not instantiated in non-root module, and is a part of non-speculative instantiatiation.
needsTypeInference (sc, flag) Determine if template instance is really a template function, and that template function needs to infer types from the function arguments.
printInstantiationTrace (cl, max_shown) Given an error instantiating the TemplateInstance, give the nested TemplateInstance instantiations that got us here. Those are a list threaded into the nested scopes.
semanticTiargs (loc, sc, tiargs, flags, atd) Run semantic of tiargs as arguments of template.
semanticTiargs (sc) Run semantic on the elements of tiargs.
updateTempDecl (sc, s) Confirm s is a valid template, then store it.
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#explicit_tmp_instantiation

Given

foo!(args) => name = foo tiargs = args

Authors

Walter Bright

License

Boost License 1.0