Package org.lwjgl.llvm

Class CXIdxEntityRefInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<CXIdxEntityRefInfo>
org.lwjgl.llvm.CXIdxEntityRefInfo
All Implemented Interfaces:
org.lwjgl.system.Pointer
public class CXIdxEntityRefInfo extends org.lwjgl.system.Struct<CXIdxEntityRefInfo>
Data for IndexerCallbacks.indexEntityReference().

Layout


 struct CXIdxEntityRefInfo {
     CXIdxEntityRefKind kind;
     CXCursor cursor();
     CXIdxLoc loc;
     CXIdxEntityInfo const * referencedEntity();
     CXIdxEntityInfo const * parentEntity();
     CXIdxContainerInfo const * container();
     CXSymbolRole role();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • KIND

      public static final int KIND
      The struct member offsets.

    • CURSOR

      public static final int CURSOR
      The struct member offsets.

    • LOC

      public static final int LOC
      The struct member offsets.

    • REFERENCEDENTITY

      public static final int REFERENCEDENTITY
      The struct member offsets.

    • PARENTENTITY

      public static final int PARENTENTITY
      The struct member offsets.

    • CONTAINER

      public static final int CONTAINER
      The struct member offsets.

    • ROLE

      public static final int ROLE
      The struct member offsets.

  • Constructor Details

    • CXIdxEntityRefInfo

      public CXIdxEntityRefInfo(ByteBuffer container)
      Creates a CXIdxEntityRefInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

      The created instance holds a strong reference to the container object.

  • Method Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<CXIdxEntityRefInfo>

    • kind

      public int kind()
      Returns:
      the value of the kind field.

    • cursor

      public CXCursor cursor()
      reference cursor

    • loc

      public CXIdxLoc loc()
      Returns:
      a CXIdxLoc view of the loc field.

    • referencedEntity

      public CXIdxEntityInfo referencedEntity()
      the entity that gets referenced

    • parentEntity

      public CXIdxEntityInfo parentEntity()
      Immediate "parent" of the reference. For example: 
      
 Foo *var;

      The parent of reference of type Foo is the variable var. For references inside statement bodies of functions/methods, the parentEntity will be the function/method.

    • container

      public CXIdxContainerInfo container()
      lexical container context of the reference

    • role

      public int role()
      sets of symbol roles of the reference

    • create

      public static CXIdxEntityRefInfo create(long address)
      Returns a new CXIdxEntityRefInfo instance for the specified memory address.

    • createSafe

      public static @Nullable CXIdxEntityRefInfo createSafe(long address)
      Like create, but returns null if address is NULL.

    • create

      public static CXIdxEntityRefInfo.Buffer create(long address, int capacity)
      Create a CXIdxEntityRefInfo.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable CXIdxEntityRefInfo.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • nkind

      public static int nkind(long struct)
      Unsafe version of kind().

    • ncursor

      public static CXCursor ncursor(long struct)
      Unsafe version of cursor().

    • nloc

      public static CXIdxLoc nloc(long struct)
      Unsafe version of loc().

    • nreferencedEntity

      public static CXIdxEntityInfo nreferencedEntity(long struct)
      Unsafe version of referencedEntity().

    • nparentEntity

      public static CXIdxEntityInfo nparentEntity(long struct)
      Unsafe version of parentEntity().

    • ncontainer

      public static CXIdxContainerInfo ncontainer(long struct)
      Unsafe version of container().

    • nrole

      public static int nrole(long struct)
      Unsafe version of role().