Class CXComment

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<CXComment>
org.lwjgl.llvm.CXComment
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class CXComment extends org.lwjgl.system.Struct<CXComment> 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 
    An array of CXComment structs.

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

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

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The struct alignment in bytes.
    static final int
    The struct member offsets.
    static final int
    The struct size in bytes.
    static final int
    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(ByteBuffer container)
    Creates a CXComment instance at the current position of the specified ByteBuffer container.
  • Method Summary

    Modifier and Type
    Method
    Description
    long
     
    static CXComment
    Returns a new CXComment instance allocated with memCalloc.
    calloc(int capacity)
    Returns a new CXComment.Buffer instance allocated with memCalloc.
    calloc(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.
    static CXComment
    calloc(org.lwjgl.system.MemoryStack stack)
    Returns a new CXComment instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static CXComment
    Deprecated.
    callocStack(int capacity)
    Deprecated.
    callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static CXComment
    callocStack(org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static CXComment
    Returns a new CXComment instance allocated with BufferUtils.
    create(int capacity)
    Returns a new CXComment.Buffer instance allocated with BufferUtils.
    static CXComment
    create(long address)
    Returns a new CXComment instance for the specified memory address.
    create(long address, int capacity)
    Create a CXComment.Buffer instance at the specified memory.
    static @Nullable CXComment
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable CXComment.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    static CXComment
    Returns a new CXComment instance allocated with memAlloc.
    malloc(int capacity)
    Returns a new CXComment.Buffer instance allocated with memAlloc.
    malloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new CXComment.Buffer instance allocated on the specified MemoryStack.
    static CXComment
    malloc(org.lwjgl.system.MemoryStack stack)
    Returns a new CXComment instance allocated on the specified MemoryStack.
    static CXComment
    Deprecated.
    mallocStack(int capacity)
    Deprecated.
    mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static CXComment
    mallocStack(org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static long
    nASTNode(long struct)
    Unsafe version of ASTNode().
    static long
    nTranslationUnit(long struct)
    Unsafe version of TranslationUnit().
    int
     
    long
     

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    Methods inherited from class org.lwjgl.system.Pointer.Default

    address, equals, hashCode, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.lwjgl.system.NativeResource

    close, free
  • Field Details

    • SIZEOF

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

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

      public static final int ASTNODE
      The struct member offsets.
    • TRANSLATIONUNIT

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

    • CXComment

      public CXComment(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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<CXComment>
    • 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

      public static @Nullable 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

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

      @Deprecated public static CXComment mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
    • callocStack

      @Deprecated public static CXComment callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
    • mallocStack

      @Deprecated public static CXComment mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
    • callocStack

      @Deprecated public static CXComment callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
    • mallocStack

      @Deprecated public static CXComment.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
    • callocStack

      @Deprecated public static CXComment.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
    • mallocStack

      @Deprecated public static CXComment.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
    • callocStack

      @Deprecated public static CXComment.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
    • malloc

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

      public static CXComment calloc(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
    • malloc

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

      public static CXComment.Buffer calloc(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:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • nASTNode

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

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