Class CXIndexOptions

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class CXIndexOptions extends Struct<CXIndexOptions> implements NativeResource

 struct CXIndexOptions {
     unsigned Size;
     unsigned char ThreadBackgroundPriorityForIndexing;
     unsigned char ThreadBackgroundPriorityForEditing;
     unsigned ExcludeDeclarationsFromPCH : 1;
     unsigned DisplayDiagnostics : 1;
     unsigned StorePreamblesInMemory : 1;
     unsigned Reserved : 13;
     char const * PreambleStoragePath;
     char const * InvocationEmissionPath;
 }
  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.
    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.
    • SIZE

      public static final int SIZE
      The struct member offsets.
    • THREADBACKGROUNDPRIORITYFORINDEXING

      public static final int THREADBACKGROUNDPRIORITYFORINDEXING
      The struct member offsets.
    • THREADBACKGROUNDPRIORITYFOREDITING

      public static final int THREADBACKGROUNDPRIORITYFOREDITING
      The struct member offsets.
    • BITFIELD0

      public static final int BITFIELD0
      The struct member offsets.
    • PREAMBLESTORAGEPATH

      public static final int PREAMBLESTORAGEPATH
      The struct member offsets.
    • INVOCATIONEMISSIONPATH

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

    • CXIndexOptions

      public CXIndexOptions(ByteBuffer container)
      Creates a CXIndexOptions 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<CXIndexOptions>
    • Size

      public int Size()
      Returns:
      the value of the Size field.
    • ThreadBackgroundPriorityForIndexing

      public byte ThreadBackgroundPriorityForIndexing()
      Returns:
      the value of the ThreadBackgroundPriorityForIndexing field.
    • ThreadBackgroundPriorityForEditing

      public byte ThreadBackgroundPriorityForEditing()
      Returns:
      the value of the ThreadBackgroundPriorityForEditing field.
    • ExcludeDeclarationsFromPCH

      public boolean ExcludeDeclarationsFromPCH()
      Returns:
      the value of the ExcludeDeclarationsFromPCH field.
    • DisplayDiagnostics

      public boolean DisplayDiagnostics()
      Returns:
      the value of the DisplayDiagnostics field.
    • StorePreamblesInMemory

      public boolean StorePreamblesInMemory()
      Returns:
      the value of the StorePreamblesInMemory field.
    • PreambleStoragePath

      public @Nullable ByteBuffer PreambleStoragePath()
      Returns:
      a ByteBuffer view of the null-terminated string pointed to by the PreambleStoragePath field.
    • PreambleStoragePathString

      public @Nullable String PreambleStoragePathString()
      Returns:
      the null-terminated string pointed to by the PreambleStoragePath field.
    • InvocationEmissionPath

      public @Nullable ByteBuffer InvocationEmissionPath()
      Returns:
      a ByteBuffer view of the null-terminated string pointed to by the InvocationEmissionPath field.
    • InvocationEmissionPathString

      public @Nullable String InvocationEmissionPathString()
      Returns:
      the null-terminated string pointed to by the InvocationEmissionPath field.
    • Size

      public CXIndexOptions Size(int value)
      Sets the specified value to the Size field.
    • Size$Default

      public CXIndexOptions Size$Default()
      Sets the default value to the Size field.
    • ThreadBackgroundPriorityForIndexing

      public CXIndexOptions ThreadBackgroundPriorityForIndexing(byte value)
      Sets the specified value to the ThreadBackgroundPriorityForIndexing field.
    • ThreadBackgroundPriorityForEditing

      public CXIndexOptions ThreadBackgroundPriorityForEditing(byte value)
      Sets the specified value to the ThreadBackgroundPriorityForEditing field.
    • ExcludeDeclarationsFromPCH

      public CXIndexOptions ExcludeDeclarationsFromPCH(boolean value)
      Sets the specified value to the ExcludeDeclarationsFromPCH field.
    • DisplayDiagnostics

      public CXIndexOptions DisplayDiagnostics(boolean value)
      Sets the specified value to the DisplayDiagnostics field.
    • StorePreamblesInMemory

      public CXIndexOptions StorePreamblesInMemory(boolean value)
      Sets the specified value to the StorePreamblesInMemory field.
    • PreambleStoragePath

      public CXIndexOptions PreambleStoragePath(@Nullable ByteBuffer value)
      Sets the address of the specified encoded string to the PreambleStoragePath field.
    • InvocationEmissionPath

      public CXIndexOptions InvocationEmissionPath(@Nullable ByteBuffer value)
      Sets the address of the specified encoded string to the InvocationEmissionPath field.
    • set

      public CXIndexOptions set(int Size, byte ThreadBackgroundPriorityForIndexing, byte ThreadBackgroundPriorityForEditing, boolean ExcludeDeclarationsFromPCH, boolean DisplayDiagnostics, boolean StorePreamblesInMemory, @Nullable ByteBuffer PreambleStoragePath, @Nullable ByteBuffer InvocationEmissionPath)
      Initializes this struct with the specified values.
    • set

      public CXIndexOptions set(CXIndexOptions src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct
    • malloc

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static CXIndexOptions.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new CXIndexOptions.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
    • nSize

      public static int nSize(long struct)
      Unsafe version of Size().
    • nThreadBackgroundPriorityForIndexing

      public static byte nThreadBackgroundPriorityForIndexing(long struct)
    • nThreadBackgroundPriorityForEditing

      public static byte nThreadBackgroundPriorityForEditing(long struct)
    • nbitfield0

      public static int nbitfield0(long struct)
    • nExcludeDeclarationsFromPCH

      public static int nExcludeDeclarationsFromPCH(long struct)
      Unsafe version of ExcludeDeclarationsFromPCH().
    • nDisplayDiagnostics

      public static int nDisplayDiagnostics(long struct)
      Unsafe version of DisplayDiagnostics().
    • nStorePreamblesInMemory

      public static int nStorePreamblesInMemory(long struct)
      Unsafe version of StorePreamblesInMemory().
    • nReserved

      public static int nReserved(long struct)
    • nPreambleStoragePath

      public static @Nullable ByteBuffer nPreambleStoragePath(long struct)
      Unsafe version of PreambleStoragePath().
    • nPreambleStoragePathString

      public static @Nullable String nPreambleStoragePathString(long struct)
      Unsafe version of PreambleStoragePathString().
    • nInvocationEmissionPath

      public static @Nullable ByteBuffer nInvocationEmissionPath(long struct)
      Unsafe version of InvocationEmissionPath().
    • nInvocationEmissionPathString

      public static @Nullable String nInvocationEmissionPathString(long struct)
    • nSize

      public static void nSize(long struct, int value)
      Unsafe version of Size.
    • nThreadBackgroundPriorityForIndexing

      public static void nThreadBackgroundPriorityForIndexing(long struct, byte value)
    • nThreadBackgroundPriorityForEditing

      public static void nThreadBackgroundPriorityForEditing(long struct, byte value)
    • nbitfield0

      public static void nbitfield0(long struct, int value)
    • nExcludeDeclarationsFromPCH

      public static void nExcludeDeclarationsFromPCH(long struct, int value)
      Unsafe version of ExcludeDeclarationsFromPCH.
    • nDisplayDiagnostics

      public static void nDisplayDiagnostics(long struct, int value)
      Unsafe version of DisplayDiagnostics.
    • nStorePreamblesInMemory

      public static void nStorePreamblesInMemory(long struct, int value)
      Unsafe version of StorePreamblesInMemory.
    • nReserved

      public static void nReserved(long struct, int value)
    • nPreambleStoragePath

      public static void nPreambleStoragePath(long struct, @Nullable ByteBuffer value)
      Unsafe version of PreambleStoragePath.
    • nInvocationEmissionPath

      public static void nInvocationEmissionPath(long struct, @Nullable ByteBuffer value)
      Unsafe version of InvocationEmissionPath.