Display the source code in dmd/aggregate.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

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.aggregate.AggregateDeclaration`

Abstract aggregate as a common ancestor for Class- and StructDeclaration.


						
				class AggregateDeclaration
				
  : ScopeDsymbol
				;

Fields

Name	Type	Description
`aggrDtor`	`DtorDeclaration`	aggregate destructor calling userDtors and fieldDtor (and base class aggregate dtor for C++ classes)
`aliasthis`	`AliasThis`	forward unresolved lookups to aliasthis
`alignsize`	`uint`	size of struct for alignment purposes
`classKind`	`ClassKind`	specifies whether this is a D, C++, Objective-C or anonymous struct/class/interface
`cppmangle`	`CPPMANGLE`	Specify whether to mangle the aggregate as a `class` or a `struct` This information is used by the MSVC mangler Only valid for class and struct. TODO: Merge with ClassKind ?
`ctor`	`Dsymbol`	CtorDeclaration or TemplateDeclaration
`defaultCtor`	`CtorDeclaration`	default constructor - should have no arguments, because it would be stored in TypeInfo_Class.defaultConstructor
`deferred`	`Dsymbol`	any deferred semantic2() or semantic3() symbol
`disableNew`	`bool`	disallow allocations using `new`
`dtor`	`DtorDeclaration`	the aggregate destructor exposed as `__xdtor` alias
`enclosing`	`Dsymbol`	!=null if is nested pointing to the dsymbol that directly enclosing it. 1. The function that enclosing it (nested struct and class) 2. The class that enclosing it (nested class only) 3. If enclosing aggregate is template, its enclosing dsymbol.
`fieldDtor`	`DtorDeclaration`	function destructing (non-inherited) fields
`fields`	`dmd.root.array.Array!(dmd.declaration.VarDeclaration)`	VarDeclaration fields
`getRTInfo`	`Expression`	pointer to GC info generated by object.RTInfo(this)
`inv`	`FuncDeclaration`	Merged invariant calling all members of invs
`invs`	`dmd.root.array.Array!(dmd.func.FuncDeclaration)`	Array of invariants
`noDefaultCtor`	`bool`	no default construction
`pMangleOverride`	`MangleOverride*`	overridden symbol with pragma(mangle, "...") if not null
`sinit`	`void*`	initializer symbol
`sizeok`	`dmd.astenums.Sizeok`	set when structsize contains valid data
`storage_class`	`ulong`
`structsize`	`uint`	size of struct
`tidtor`	`DtorDeclaration`	(same as aggrDtor, except for C++ classes with virtual dtor on Windows)
`type`	`Type`
`userDtors`	`dmd.root.array.Array!(dmd.func.DtorDeclaration)`	user-defined destructors (`~this()`) - mixins can yield multiple ones
`visibility`	`dmd.dsymbol.Visibility`
`vthis`	`VarDeclaration`	'this' parameter if this aggregate is nested
`vthis2`	`VarDeclaration`	'this' parameter if this aggregate is a template and is nested
`cppnamespace`	`CPPNamespaceDeclaration`	C++ namespace this symbol belongs to
`localNum`	`ushort`	perturb mangled name to avoid collisions with those in FuncDeclaration.localsymtab

Methods

Name	Description
`alignmember` (alignment, memalignsize, poffset)	Do byte or word alignment as necessary. Align sizes of 0, as we may not know array sizes yet.
`checkOverlappedFields` ()	Calculate field[i].overlapped and overlapUnsafe, and check that all of explicit field initializers have unique memory space on instance.
`determineSize` (loc)	Collect all instance fields, then determine instance size.
`fill` (loc, elements, ctorinit)	Fill out remainder of elements[] with default initializers for fields[].
`isNested` ()	Returns true if there's an extra member which is the 'this' pointer to the enclosing context (enclosing aggregate or function)
`newScope` (sc)	Create a new scope from sc. semantic, semantic2 and semantic3 will use this for aggregate members.
`nonHiddenFields` ()
`placeField` (nextoffset, memsize, memalignsize, alignment, paggsize, paggalignsize, isunion)	Place a field (mem) into an aggregate (agg), which can be a struct, union or class
`searchCtor` ()	Look for constructor declaration.
`setDeprecated` ()	Flag this aggregate as deprecated
`_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.
`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.
`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.
`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.
`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)
`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` ()

Authors

Walter Bright

License

Boost License 1.0