View source code
Display the source code in dmd/dmodule.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.dmodule.Module

class Module
  : Package ;

Fields

NameTypeDescription
ctfe_cov uint[uint]coverage information from ctfe execution_count[line]
importedFrom ModuleA root module is one that will be compiled all the way to object code. This field holds the root module that caused this module to be loaded. If this module is a root module, then it will be set to this. This is used to determine ownership of template instantiation.
cppnamespace CPPNamespaceDeclarationC++ namespace this symbol belongs to

Methods

NameDescription
addDeferredSemantic (s) Can't run semantic on s now, try again later.
checkImportDeprecation (loc, sc) Print deprecation warning if we're deprecated, when this module is imported from scope sc.
deinitialize () Deinitializes the global state of the compiler.
fullyQualifiedName (buf) Writes this module's fully-qualified name to buf
imports (m) Recursively look at every module this module imports, return true if it imports m. Can be used to detect circular imports.
loadSourceBuffer (loc, readResult) Loads the source buffer from the given read result into this.srcBuffer.
needModuleInfo () Determine if we need to generate an instance of ModuleInfo for this Module.
parse () syntactic parse
parseModule () syntactic parse
read (loc) Reads the file from srcfile and loads the source buffer.
rootImports () Return true if module imports root module.
runDeferredSemantic () Run semantic() on deferred symbols.
selfImports () Return true if module imports itself.
setOutfilename (name, dir, arg, ext) Combines things into output file name for .html and .di files.
_foreach (sc, members, dg, pn) Expands attribute declarations in members in depth first order. Calls dg(size_t symidx, Dsymbol *sym) for each member. If dg 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.
accept (v)
addComment (comment) Add documentation comment to Dsymbol. Ignore NULL comments.
arraySyntaxCopy (a) Do syntax copy of an array of Dsymbol's.
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.
findGetMembers () Look for member of the form: const(MemberInfo)[] getMembers(string); Returns NULL if not found
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.
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.
isAncestorPackageOf (pkg) Checks if pkg is a sub-package of this
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 for opEquals should attempt to compare objects by their contents.
pastMixin () pastMixin returns the enclosing symbol if this is a template mixin.
prot ()
resolve (packages, pparent, ppkg)
resolvePKGunknown () Checks for the existence of a package.d to set isPkgMod appropriately if isPkgMod == PKG.unknown
search (loc, ident, flags) This function is #1 on the list of functions that eat cpu time. Be very, very careful about slowing it down.
searchX (loc, sc, id, flags) Search for identifier id as a member of this. id may be a template instance.
setScope (sc) Set scope for future semantic analysis so we can deal better with forward references.
size (loc)
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.

Authors

Walter Bright

License

Boost License 1.0