Class CXCursor

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

    public class CXCursor
    extends Struct
    implements NativeResource
    A cursor representing some element in the abstract syntax tree for a translation unit.

    The cursor abstraction unifies the different kinds of entities in a program --declaration, statements, expressions, references to declarations, etc.-- under a single "cursor" abstraction with a common set of operations. Common operation for a cursor include: getting the physical location in a source file where the cursor points, getting the name associated with a cursor, and retrieving cursors for any child nodes of a particular cursor.

    Cursors can be produced in two specific ways. getTranslationUnitCursor produces a cursor for a translation unit, from which one can use visitChildren to explore the rest of the translation unit. getCursor maps from a physical source location to the entity that resides at that location, allowing one to map from the source code into the AST.

    Layout

    
     struct CXCursor {
         enum CXCursorKind kind;
         int xdata;
         void const * data[3];
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • KIND, XDATA, DATA

        The struct member offsets.
    • Constructor Detail

      • CXCursor

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

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

        public int xdata()
        Returns the value of the xdata field.
      • data

        public long data​(int index)
        Returns the value at the specified index of the data field.
      • malloc

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public static CXCursor.Buffer callocStack​(int capacity,
                                                  MemoryStack stack)
        Returns a new CXCursor.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
      • nkind

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

        public static int nxdata​(long struct)
        Unsafe version of xdata().
      • ndata

        public static long ndata​(long struct,
                                 int index)
        Unsafe version of data.