Package ghidra.program.model.address

Class GlobalNamespace

java.lang.Object

ghidra.program.model.address.GlobalNamespace

All Implemented Interfaces:

Namespace

public class GlobalNamespace
extends Object
implements Namespace

The global namespace implementation class

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.program.model.symbol.Namespace

Namespace.Type

Field Summary

Fields

Change	Modifier and Type	Field	Description
	static final String	GLOBAL_NAMESPACE_NAME	Global namespace name which may (incorrectly) appear as the first element within a namespace path (e.g., Global::Foo::Bar).

Fields inherited from interface ghidra.program.model.symbol.Namespace

DELIMITER, GLOBAL_NAMESPACE_ID, NAMESPACE_DELIMITER

Constructor Summary

Constructors

Change	Constructor	Description
	GlobalNamespace(Memory memory)	Constructs a new GlobalNamespace

Method Summary

Change	Modifier and Type	Method	Description
	boolean	equals(Object obj)
	AddressSetView	getBody()	Get the address set for this namespace.
	long	getID()	Return the namespace id
	String	getName()	Returns the simple namespace name (without parent path).
	String	getName(boolean includeNamespacePath)	Returns the namespace name, optionally prepended with the full parent namespace path.
	Namespace	getParentNamespace()	Get the parent scope.
	Symbol	getSymbol()	Get the symbol for this namespace.
	boolean	isExternal()	Returns true if this namespace is external (i.e., associated with a Library)
	void	setParentNamespace(Namespace parentNamespace)	Set the parent namespace for this namespace.
	String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ghidra.program.model.symbol.Namespace

getPathList, getType, isGlobal, isLibrary

Field Details

GLOBAL_NAMESPACE_NAME

public static final String GLOBAL_NAMESPACE_NAME

Global namespace name which may (incorrectly) appear as the first element within a namespace path (e.g., Global::Foo::Bar). It is preferred that the Global namespace be omitted in favor of Foo::Bar.

See Also:

• Constant Field Values

Constructor Details

GlobalNamespace

public GlobalNamespace(Memory memory)

Constructs a new GlobalNamespace

Parameters:

memory - the memory associated with this global namespace

Method Details

getSymbol

public Symbol getSymbol()

Description copied from interface: Namespace

Get the symbol for this namespace.

Specified by:

getSymbol in interface Namespace

Returns:

the symbol for this namespace.

See Also:

• Namespace.getSymbol()

getName

public String getName()

Description copied from interface: Namespace

Returns the simple namespace name (without parent path).

See Namespace.getName(boolean) for the namespace-qualified variant.

Specified by:

getName in interface Namespace

Returns:

the simple namespace name (without parent path)

See Also:

• Namespace.getName()

getID

public long getID()

Description copied from interface: Namespace

Return the namespace id

Specified by:

getID in interface Namespace

Returns:

the namespace id

See Also:

• Namespace.getID()

getParentNamespace

public Namespace getParentNamespace()

Description copied from interface: Namespace

Get the parent scope.

Specified by:

getParentNamespace in interface Namespace

Returns:

null if this scope is the global scope.

See Also:

• Namespace.getParentNamespace()

getBody

public AddressSetView getBody()

Description copied from interface: Namespace

Get the address set for this namespace. Note: The body of a namespace (currently only used by the function namespace) is restricted it Integer.MAX_VALUE.

Specified by:

getBody in interface Namespace

Returns:

the address set for this namespace

See Also:

• Namespace.getBody()

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

getName

public String getName(boolean includeNamespacePath)

Description copied from interface: Namespace

Returns the namespace name, optionally prepended with the full parent namespace path.

Specified by:

getName in interface Namespace

Parameters:

includeNamespacePath - true to include the namespace path (using Namespace.DELIMITER as separator) in the returned name

Returns:

the simple name if includeNamespacePath is false, or the full namespace-qualified name (e.g., "ClassA::InnerClass") if true

See Also:

• Namespace.getName(boolean)

setParentNamespace

public void setParentNamespace(Namespace parentNamespace)
                        throws DuplicateNameException,
InvalidInputException

Description copied from interface: Namespace

Set the parent namespace for this namespace. Restrictions may apply.

Specified by:

setParentNamespace in interface Namespace

Parameters:

parentNamespace - the namespace to use as this namespace's parent.

Throws:

DuplicateNameException - if another symbol exists in the parent namespace with the same name as this namespace

InvalidInputException - if the parent namespace is not applicable for this namespace.

See Also:

• Namespace.setParentNamespace(ghidra.program.model.symbol.Namespace)

isExternal

public boolean isExternal()

Description copied from interface: Namespace

Returns true if this namespace is external (i.e., associated with a Library)

Specified by:

isExternal in interface Namespace

Returns:

true if this namespace is external (i.e., associated with a Library)