Class CXIdxEntityInfo

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class CXIdxEntityInfo extends Struct<CXIdxEntityInfo> implements NativeResource

 struct CXIdxEntityInfo {
     CXIdxEntityKind kind;
     CXIdxEntityCXXTemplateKind templateKind;
     CXIdxEntityLanguage lang;
     char const * name;
     char const * USR;
     CXCursor cursor;
     CXIdxAttrInfo const * const * attributes;
     unsigned numAttributes;
 }
  • 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.
    • TEMPLATEKIND

      public static final int TEMPLATEKIND
      The struct member offsets.
    • LANG

      public static final int LANG
      The struct member offsets.
    • NAME

      public static final int NAME
      The struct member offsets.
    • USR

      public static final int USR
      The struct member offsets.
    • CURSOR

      public static final int CURSOR
      The struct member offsets.
    • ATTRIBUTES

      public static final int ATTRIBUTES
      The struct member offsets.
    • NUMATTRIBUTES

      public static final int NUMATTRIBUTES
      The struct member offsets.
  • Constructor Details

    • CXIdxEntityInfo

      public CXIdxEntityInfo(ByteBuffer container)
      Creates a CXIdxEntityInfo 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()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<CXIdxEntityInfo>
    • kind

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

      public int templateKind()
      Returns:
      the value of the templateKind field.
    • lang

      public int lang()
      Returns:
      the value of the lang field.
    • name

      public ByteBuffer name()
      Returns:
      a ByteBuffer view of the null-terminated string pointed to by the name field.
    • nameString

      public String nameString()
      Returns:
      the null-terminated string pointed to by the name field.
    • USR

      public ByteBuffer USR()
      Returns:
      a ByteBuffer view of the null-terminated string pointed to by the USR field.
    • USRString

      public String USRString()
      Returns:
      the null-terminated string pointed to by the USR field.
    • cursor

      public CXCursor cursor()
      Returns:
      a CXCursor view of the cursor field.
    • attributes

      public PointerBuffer attributes()
      Returns:
      a PointerBuffer view of the data pointed to by the attributes field.
    • numAttributes

      public int numAttributes()
      Returns:
      the value of the numAttributes field.
    • malloc

      public static CXIdxEntityInfo malloc()
      Returns a new CXIdxEntityInfo instance allocated with memAlloc. The instance must be explicitly freed.
    • calloc

      public static CXIdxEntityInfo calloc()
      Returns a new CXIdxEntityInfo instance allocated with memCalloc. The instance must be explicitly freed.
    • create

      public static CXIdxEntityInfo create()
      Returns a new CXIdxEntityInfo instance allocated with BufferUtils.
    • create

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

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

      public static CXIdxEntityInfo.Buffer malloc(int capacity)
      Returns a new CXIdxEntityInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity
    • calloc

      public static CXIdxEntityInfo.Buffer calloc(int capacity)
      Returns a new CXIdxEntityInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity
    • create

      public static CXIdxEntityInfo.Buffer create(int capacity)
      Returns a new CXIdxEntityInfo.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity
    • create

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

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

      public static CXIdxEntityInfo malloc(MemoryStack stack)
      Returns a new CXIdxEntityInfo instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate
    • calloc

      public static CXIdxEntityInfo calloc(MemoryStack stack)
      Returns a new CXIdxEntityInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate
    • malloc

      public static CXIdxEntityInfo.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new CXIdxEntityInfo.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • calloc

      public static CXIdxEntityInfo.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new CXIdxEntityInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • nkind

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

      public static int ntemplateKind(long struct)
      Unsafe version of templateKind().
    • nlang

      public static int nlang(long struct)
      Unsafe version of lang().
    • nname

      public static ByteBuffer nname(long struct)
      Unsafe version of name().
    • nnameString

      public static String nnameString(long struct)
      Unsafe version of nameString().
    • nUSR

      public static ByteBuffer nUSR(long struct)
      Unsafe version of USR.
    • nUSRString

      public static String nUSRString(long struct)
      Unsafe version of USRString().
    • ncursor

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

      public static PointerBuffer nattributes(long struct)
      Unsafe version of attributes.
    • nnumAttributes

      public static int nnumAttributes(long struct)
      Unsafe version of numAttributes().