Struct IEntityContext#

Inheritance Relationships#

Derived Type#

Struct Documentation#

struct IEntityContext#

Context information interface.

Subclassed by CEntity

Public Types

enum class ELocation : uint32_t#

The location of the parsed file.

Values:

enumerator source#

Source code or source file.

enumerator local_include#

Local include file.

enumerator global_include#

Global include file.

enumerator source

Source code or source file.

enumerator source

Source code or source file.

enumerator local_include

Local include file.

enumerator local_include

Local include file.

enumerator global_include

Global include file.

enumerator global_include

Global include file.

enum ELocation

The location of the parsed file.

Values:

enumerator source

Source code or source file.

enumerator local_include

Local include file.

enumerator global_include

Global include file.

Public Functions

virtual ELocation GetLocation() const = 0#

Get the location.

Returns:

Returns context location.

virtual sdv::u8string GetSourcePath() const = 0#

Get the path to the file.

Returns:

Returns the source path string.

virtual void GetPosition(uint32_t &ruiLineBegin, uint32_t &ruiColBegin, uint32_t &ruiLineEnd, uint32_t &ruiColEnd) = 0#

Get the position in the file.

Remark

Not all entities have a position. If no position is available, the position return value has the value 0.

Parameters:

  • ruiLineBegin – [out] Reference to the variable receiving the line number of the entity beginning.

  • ruiColBegin – [out] Reference to the variable receiving the column number of the entity beginning.

  • ruiLineEnd – [out] Reference to the variable receiving the line number of the entity ending.

  • ruiColEnd – [out] Reference to the variable receiving the column number of the entity ending.

ELocation GetLocation() const

Get the location.

Returns:

Returns context location.

u8string GetSourcePath() const

Get the path to the file.

Returns:

Returns the source path string.

void GetPosition (out uint32 ruiLineBegin, out uint32 ruiColBegin, out uint32 ruiLineEnd, out uint32 ruiColEnd)

Get the position in the file.

Remark

Not all entities have a position. If no position is available, the position return value has the value 0.

Parameters:

  • ruiLineBegin – [out] Reference to the variable receiving the line number of the entity beginning.

  • ruiColBegin – [out] Reference to the variable receiving the column number of the entity beginning.

  • ruiLineEnd – [out] Reference to the variable receiving the line number of the entity ending.

  • ruiColEnd – [out] Reference to the variable receiving the column number of the entity ending.

Public Static Attributes

static ::sdv::interface_id _id = 0xCDC79F5E7E643529#

Interface ID.