Class CXCompletionResult

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class CXCompletionResult
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    A single result of code completion.

    Member documentation

    • CursorKind – the kind of entity that this completion refers to.

      The cursor kind will be a macro, keyword, or a declaration (one of the *Decl cursor kinds), describing the entity that the completion is referring to.

    • CompletionString – the code-completion string that describes how to insert this code-completion result into the editing buffer

    Layout

    
     struct CXCompletionResult {
         enum CXCursorKind CursorKind;
         CXCompletionString CompletionString;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • CURSORKIND, COMPLETIONSTRING

        The struct member offsets.
    • Constructor Detail

      • CXCompletionResult

        public CXCompletionResult​(java.nio.ByteBuffer container)
        Creates a CXCompletionResult 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 Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • CursorKind

        public int CursorKind()
        Returns the value of the CursorKind field.
      • CompletionString

        public long CompletionString()
        Returns the value of the CompletionString field.
      • malloc

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

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

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

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

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

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

        public static CXCompletionResult mallocStack()
        Returns a new CXCompletionResult instance allocated on the thread-local MemoryStack.
      • callocStack

        public static CXCompletionResult callocStack()
        Returns a new CXCompletionResult instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static CXCompletionResult mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new CXCompletionResult instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static CXCompletionResult callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new CXCompletionResult instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static CXCompletionResult.Buffer callocStack​(int capacity)
        Returns a new CXCompletionResult.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • mallocStack

        public static CXCompletionResult.Buffer mallocStack​(int capacity,
                                                            org.lwjgl.system.MemoryStack stack)
        Returns a new CXCompletionResult.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • callocStack

        public static CXCompletionResult.Buffer callocStack​(int capacity,
                                                            org.lwjgl.system.MemoryStack stack)
        Returns a new CXCompletionResult.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • nCursorKind

        public static int nCursorKind​(long struct)
        Unsafe version of CursorKind().
      • nCompletionString

        public static long nCompletionString​(long struct)
        Unsafe version of CompletionString().