Class CXComment

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

    public class CXComment
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    A parsed comment.

    Layout

    
     struct CXComment {
         void const * ASTNode;
         CXTranslationUnit TranslationUnit;
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CXComment.Buffer
      An array of CXComment structs.
      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

        org.lwjgl.system.Pointer.Default
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int ASTNODE
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static int TRANSLATIONUNIT
      The struct member offsets.
      • Fields inherited from interface org.lwjgl.system.Pointer

        BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
    • Constructor Summary

      Constructors 
      Constructor Description
      CXComment​(java.nio.ByteBuffer container)
      Creates a CXComment instance at the current position of the specified ByteBuffer container.
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • ASTNODE, TRANSLATIONUNIT

        The struct member offsets.
    • Constructor Detail

      • CXComment

        public CXComment​(java.nio.ByteBuffer container)
        Creates a CXComment 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
      • ASTNode

        public long ASTNode()
        Returns the value of the ASTNode field.
      • TranslationUnit

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public static CXComment.Buffer mallocStack​(int capacity)
        Returns a new CXComment.Buffer instance allocated on the thread-local MemoryStack.
        Parameters:
        capacity - the buffer capacity
      • callocStack

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

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

        public static CXComment.Buffer callocStack​(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
        Returns a new CXComment.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
      • nASTNode

        public static long nASTNode​(long struct)
        Unsafe version of ASTNode().
      • nTranslationUnit

        public static long nTranslationUnit​(long struct)
        Unsafe version of TranslationUnit().