Class CXIdxEntityRefInfo

  • All Implemented Interfaces:
    Pointer

    public class CXIdxEntityRefInfo
    extends Struct
    Data for IndexerCallbacks.indexEntityReference().

    Member documentation

    • cursor – reference cursor
    • referencedEntity – the entity that gets referenced
    • parentEntity – Immediate "parent" of the reference. For example:
      
       Foo *var;

      The parent of reference of type Foo is the variable var. For references inside statement bodies of functions/methods, the parentEntity will be the function/method.

    • container – lexical container context of the reference
    • role – sets of symbol roles of the reference

    Layout

    
     struct CXIdxEntityRefInfo {
         CXIdxEntityRefKind kind;
         CXCursor cursor;
         CXIdxLoc loc;
         CXIdxEntityInfo const * referencedEntity;
         CXIdxEntityInfo const * parentEntity;
         CXIdxContainerInfo const * container;
         CXSymbolRole role;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • KIND, CURSOR, LOC, REFERENCEDENTITY, PARENTENTITY, CONTAINER, ROLE

        The struct member offsets.
    • Constructor Detail

      • CXIdxEntityRefInfo

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

        public CXCursor cursor()
        Returns a CXCursor view of the cursor field.
      • role

        public int role()
        Returns the value of the role field.
      • create

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

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

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

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

        public static CXCursor ncursor​(long struct)
        Unsafe version of cursor().
      • nloc

        public static CXIdxLoc nloc​(long struct)
        Unsafe version of loc().
      • nrole

        public static int nrole​(long struct)
        Unsafe version of role().