Clang.FFI

Documentation

type Index = Ptr IndexObj

createIndex :: Bool -> Bool -> IO (ForeignPtr IndexObj)

type TranslationUnit = Ptr TranslationUnitObj

type ClientData = ForeignPtr ClientDataObj

data UnsavedFile

data AvailabilityKind

Constructors

Availability_Available

Availability_Deprecated

Availability_NotAvailable

Instances

Eq AvailabilityKind

data CXString

Instances

Show CXString

getCString :: CXString -> IO String

data File

getFileName :: File -> IO CXString

getFileTime :: File -> IO CTime

getFile :: TranslationUnit -> String -> IO File

data SourceLocation

Instances

Eq SourceLocation

getNullLocation :: IO SourceLocation

equalLocations :: SourceLocation -> SourceLocation -> IO Bool

getLocation :: TranslationUnit -> File -> Int -> Int -> IO SourceLocation

getLocationForOffset :: TranslationUnit -> File -> Int -> IO SourceLocation

data SourceRange

getNullRange :: IO SourceRange

getRange :: SourceLocation -> SourceLocation -> IO SourceRange

getInstantiationLocation :: SourceLocation -> IO (File, Int, Int, Int)

getSpellingLocation :: SourceLocation -> IO (File, Int, Int, Int)

getRangeStart :: SourceRange -> IO SourceLocation

getRangeEnd :: SourceRange -> IO SourceLocation

data DiagnosticSeverity

Constructors

Diagnostic_Ignored

Diagnostic_Note

Diagnostic_Warning

Diagnostic_Error

Diagnostic_Fatal

Instances

Eq DiagnosticSeverity

type Diagnostic = ForeignPtr DiagnosticObj

getNumDiagnostics :: TranslationUnit -> IO Int

getDiagnostic :: TranslationUnit -> Int -> IO Diagnostic

data DiagnosticDisplayOptions

Constructors

Diagnostic_DisplaySourceLocation

Diagnostic_DisplayColumn

Diagnostic_DisplaySourceRanges

Diagnostic_DisplayOption

Diagnostic_DisplayCategoryId

Diagnostic_DisplayCategoryName

Instances

Eq DiagnosticDisplayOptions

getDiagnosticDispOptSum :: [DiagnosticDisplayOptions] -> Int

formatDiagnostic :: Diagnostic -> Int -> IO CXString

defaultDiagnosticDisplayOptions :: IO Int

getDiagnosticSeverity :: Diagnostic -> IO DiagnosticSeverity

getDiagnosticLocation :: Diagnostic -> IO SourceLocation

getDiagnosticSpelling :: Diagnostic -> IO CXString

getDiagnosticOption :: Diagnostic -> IO (CXString, CXString)

getDiagnosticCategory :: Diagnostic -> IO Int

getDiagnosticCategoryName :: Int -> IO CXString

getDiagnosticNumRanges :: Diagnostic -> IO Int

getDiagnosticRange :: Diagnostic -> Int -> IO SourceRange

getDiagnosticNumFixIts :: Diagnostic -> IO Int

getDiagnosticFixIt :: Diagnostic -> Int -> IO (SourceRange, CXString)

getTranslationUnitSpelling :: TranslationUnit -> IO CXString

createTranslationUnitFromSourceFile :: Index -> String -> [String] -> [UnsavedFile] -> IO (ForeignPtr TranslationUnitObj)

createTranslationUnit :: Index -> String -> IO (ForeignPtr TranslationUnitObj)

data TranslationUnitFlags

Constructors

TranslationUnit_None

TranslationUnit_DetailedPreprocessingRecord

TranslationUnit_Incomplete

TranslationUnit_PrecompiledPreamble

TranslationUnit_CacheCompletionResults

TranslationUnit_CXXPrecompiledPreamble

TranslationUnit_CXXChainedPCH

Instances

Eq TranslationUnitFlags

getTranslationUnitFlagsSum :: [TranslationUnitFlags] -> Int

defaultEditingTranslationUnitOptions :: IO Int

parseTranslationUnit :: Index -> Maybe String -> [String] -> [UnsavedFile] -> Int -> IO (Maybe (ForeignPtr TranslationUnitObj))

unsavedFileSize :: Word32

setCXUnsavedFile :: CString -> CString -> CULong -> Ptr () -> CInt -> IO ()

data SaveTranslationUnitFlags

Constructors

SaveTranslationUnit_None

Instances

Eq SaveTranslationUnitFlags

getSaveTranslationUnitFlagsSum :: [SaveTranslationUnitFlags] -> Int

defaultSaveOptions :: TranslationUnit -> IO Int

saveTranslationUnit :: TranslationUnit -> String -> Int -> IO Bool

data ReparseFlags

Constructors

Reparse_None

Instances

Eq ReparseFlags

getReparseFlagsSum :: [ReparseFlags] -> Int

defaultReparseOptions :: TranslationUnit -> IO Int

reparseTranslationUnit :: TranslationUnit -> [UnsavedFile] -> Int -> IO Bool

data CursorKind

Constructors

Cursor_UnexposedDecl

Cursor_StructDecl

Cursor_UnionDecl

Cursor_ClassDecl

Cursor_EnumDecl

Cursor_FieldDecl

Cursor_EnumConstantDecl

Cursor_FunctionDecl

Cursor_VarDecl

Cursor_ParmDecl

Cursor_ObjCInterfaceDecl

Cursor_ObjCCategoryDecl

Cursor_ObjCProtocolDecl

Cursor_ObjCPropertyDecl

Cursor_ObjCIvarDecl

Cursor_ObjCInstanceMethodDecl

Cursor_ObjCClassMethodDecl

Cursor_ObjCImplementationDecl

Cursor_ObjCCategoryImplDecl

Cursor_TypedefDecl

Cursor_CXXMethod

Cursor_Namespace

Cursor_LinkageSpec

Cursor_Constructor

Cursor_Destructor

Cursor_ConversionFunction

Cursor_TemplateTypeParameter

Cursor_NonTypeTemplateParameter

Cursor_TemplateTemplateParameter

Cursor_FunctionTemplate

Cursor_ClassTemplate

Cursor_ClassTemplatePartialSpecialization

Cursor_NamespaceAlias

Cursor_UsingDirective

Cursor_UsingDeclaration

Cursor_FirstDecl

Cursor_LastDecl

Cursor_FirstRef

Cursor_ObjCSuperClassRef

Cursor_ObjCProtocolRef

Cursor_ObjCClassRef

Cursor_TypeRef

Cursor_CXXBaseSpecifier

Cursor_TemplateRef

Cursor_NamespaceRef

Cursor_MemberRef

Cursor_LabelRef

Cursor_OverloadedDeclRef

Cursor_LastRef

Cursor_FirstInvalid

Cursor_InvalidFile

Cursor_NoDeclFound

Cursor_NotImplemented

Cursor_InvalidCode

Cursor_LastInvalid

Cursor_FirstExpr

Cursor_UnexposedExpr

Cursor_DeclRefExpr

Cursor_MemberRefExpr

Cursor_CallExpr

Cursor_ObjCMessageExpr

Cursor_BlockExpr

Cursor_LastExpr

Cursor_FirstStmt

Cursor_UnexposedStmt

Cursor_LabelStmt

Cursor_LastStmt

Cursor_TranslationUnit

Cursor_FirstAttr

Cursor_UnexposedAttr

Cursor_IBActionAttr

Cursor_IBOutletAttr

Cursor_IBOutletCollectionAttr

Cursor_LastAttr

Cursor_PreprocessingDirective

Cursor_MacroDefinition

Cursor_MacroInstantiation

Cursor_InclusionDirective

Cursor_FirstPreprocessing

Cursor_LastPreprocessing

Instances

Eq CursorKind

data Cursor

Instances

Eq Cursor

Storable Cursor

getNullCursor :: IO Cursor

getTranslationUnitCursor :: TranslationUnit -> IO Cursor

equalCursors :: Cursor -> Cursor -> IO Bool

hashCursor :: Cursor -> IO Word32

getCursorKind :: Cursor -> IO CursorKind

isDeclaration :: CursorKind -> IO Bool

isReference :: CursorKind -> IO Bool

isExpression :: CursorKind -> IO Bool

isStatement :: CursorKind -> IO Bool

isInvalid :: CursorKind -> IO Bool

isTranslationUnit :: CursorKind -> IO Bool

isPreprocessing :: CursorKind -> IO Bool

isUnexposed :: CursorKind -> IO Bool

data LinkageKind

Constructors

Linkage_Invalid

Linkage_NoLinkage

Linkage_Internal

Linkage_UniqueExternal

Linkage_External

Instances

Eq LinkageKind

getCursorLinkage :: Cursor -> IO LinkageKind

getCursorAvailability :: Cursor -> IO AvailabilityKind

data LanguageKind

Constructors

Language_Invalid

Language_C

Language_ObjC

Language_CPlusPlus

Instances

Eq LanguageKind

getCursorLanguage :: Cursor -> IO LanguageKind

type CursorSet = ForeignPtr CursorSetObj

createCXCursorSet :: IO CursorSet

cXCursorSet_contains :: CursorSet -> Cursor -> IO Bool

cXCursorSet_insert :: CursorSet -> Cursor -> IO Bool

getCursorSemanticParent :: Cursor -> IO Cursor

getCursorLexicalParent :: Cursor -> IO Cursor

getOverriddenCursors :: Cursor -> IO CursorList

getIncludedFile :: Cursor -> IO File

getCursor :: TranslationUnit -> SourceLocation -> IO Cursor

getCursorLocation :: Cursor -> IO SourceLocation

getCursorExtent :: Cursor -> IO SourceRange

data TypeKind

Constructors

Type_Invalid

Type_Unexposed

Type_Void

Type_Bool

Type_Char_U

Type_UChar

Type_Char16

Type_Char32

Type_UShort

Type_UInt

Type_ULong

Type_ULongLong

Type_UInt128

Type_Char_S

Type_SChar

Type_WChar

Type_Short

Type_Int

Type_Long

Type_LongLong

Type_Int128

Type_Float

Type_Double

Type_LongDouble

Type_NullPtr

Type_Overload

Type_Dependent

Type_ObjCId

Type_ObjCClass

Type_ObjCSel

Type_FirstBuiltin

Type_LastBuiltin

Type_Complex

Type_Pointer

Type_BlockPointer

Type_LValueReference

Type_RValueReference

Type_Record

Type_Enum

Type_Typedef

Type_ObjCInterface

Type_ObjCObjectPointer

Type_FunctionNoProto

Type_FunctionProto

Instances

Eq TypeKind

data Type

Instances

Eq Type

getTypeKind :: Type -> TypeKind

getCursorType :: Cursor -> IO Type

equalTypes :: Type -> Type -> IO Bool

getCanonicalType :: Type -> IO Type

isConstQualifiedType :: Type -> IO Bool

isVolatileQualifiedType :: Type -> IO Bool

isRestrictQualifiedType :: Type -> IO Bool

getPointeeType :: Type -> IO Type

getTypeDeclaration :: Type -> IO Cursor

getDeclObjCTypeEncoding :: Cursor -> IO CXString

getTypeKindSpelling :: TypeKind -> IO CXString

getResultType :: Type -> IO Type

getCursorResultType :: Cursor -> IO Type

isPODType :: Type -> IO Bool

isVirtualBase :: Cursor -> IO Bool

data CXXAccessSpecifier

Constructors

CXXInvalidAccessSpecifier

CXXPublic

CXXProtected

CXXPrivate

Instances

Eq CXXAccessSpecifier

getCXXAccessSpecifier :: Cursor -> IO CXXAccessSpecifier

getNumOverloadedDecls :: Cursor -> IO Int

getOverloadedDecl :: Cursor -> Int -> IO Cursor

getIBOutletCollectionType :: Cursor -> IO Type

data ChildVisitResult

Constructors

ChildVisit_Break

ChildVisit_Continue

ChildVisit_Recurse

Instances

Eq ChildVisitResult

type ChildVisitor a

Arguments

 = Cursor

Current cursor

-> Cursor

Parent cursor

-> Maybe a

User data

-> IO (Maybe a, ChildVisitResult)

(user data to pass on, Visitor result code)

visitChildren :: (Storable a, Alloc a) => Cursor -> ChildVisitor a -> Maybe a -> IO (Maybe a, Bool)

getCursorUSR :: Cursor -> IO CXString

constructUSR_ObjCClass :: String -> IO CXString

constructUSR_ObjCCategory :: String -> String -> IO CXString

constructUSR_ObjCProtocol :: String -> IO CXString

constructUSR_ObjCIvar :: String -> CXString -> IO CXString

constructUSR_ObjCMethod :: String -> Bool -> CXString -> IO CXString

constructUSR_ObjCProperty :: String -> CXString -> IO CXString

getCursorSpelling :: Cursor -> IO CXString

getCursorDisplayName :: Cursor -> IO CXString

getCursorReferenced :: Cursor -> IO Cursor

getCursorDefinition :: Cursor -> IO Cursor

isCursorDefinition :: Cursor -> IO Bool

getCanonicalCursor :: Cursor -> IO Cursor

cXXMethod_isStatic :: Cursor -> IO Bool

getTemplateCursorKind :: Cursor -> IO CursorKind

getSpecializedCursorTemplate :: Cursor -> IO Cursor

data TokenKind

Constructors

Token_Punctuation

Token_Keyword

Token_Identifier

Token_Literal

Token_Comment

Instances

Eq TokenKind

data Token

getTokenKind :: Token -> IO TokenKind

getTokenSpelling :: TranslationUnit -> Token -> IO CXString

getTokenLocation :: TranslationUnit -> Token -> IO SourceLocation

getTokenExtent :: TranslationUnit -> Token -> IO SourceRange

tokenize :: TranslationUnit -> SourceRange -> IO TokenList

annotateTokens :: TranslationUnit -> TokenList -> IO CursorList

getCursorKindSpelling :: CursorKind -> IO CXString

enableStackTraces :: IO ()

data CompletionString

data CompletionResult

data CompletionChunkKind

Constructors

CompletionChunk_Optional

CompletionChunk_TypedText

CompletionChunk_Text

CompletionChunk_Placeholder

CompletionChunk_Informative

CompletionChunk_CurrentParameter

CompletionChunk_LeftParen

CompletionChunk_RightParen

CompletionChunk_LeftBracket

CompletionChunk_RightBracket

CompletionChunk_LeftBrace

CompletionChunk_RightBrace

CompletionChunk_LeftAngle

CompletionChunk_RightAngle

CompletionChunk_Comma

CompletionChunk_ResultType

CompletionChunk_Colon

CompletionChunk_SemiColon

CompletionChunk_Equal

CompletionChunk_HorizontalSpace

CompletionChunk_VerticalSpace

Instances

Eq CompletionChunkKind

getCompletionChunkKind :: CompletionString -> Int -> IO CompletionChunkKind

getCompletionChunkText :: CompletionString -> Int -> IO CXString

getCompletionChunkCompletionString :: CompletionString -> Int -> IO CompletionString

getNumCompletionChunks :: CompletionString -> IO Int

getCompletionPriority :: CompletionString -> IO Int

getCompletionAvailability :: CompletionString -> IO AvailabilityKind

data CodeCompleteFlags

Constructors

CodeComplete_IncludeMacros

CodeComplete_IncludeCodePatterns

Instances

Eq CodeCompleteFlags

getCodeCompleteFlagsSum :: [CodeCompleteFlags] -> Int

defaultCodeCompleteOptions :: IO CInt

type CodeCompleteResults = ForeignPtr CodeCompleteResultsObj

codeCompleteAt :: TranslationUnit -> String -> Int -> Int -> [UnsavedFile] -> Int -> IO CodeCompleteResults

sortCodeCompletionResults :: CodeCompleteResults -> Int -> IO ()

codeCompleteGetNumDiagnostics :: CodeCompleteResults -> IO Int

codeCompleteGetDiagnostic :: CodeCompleteResults -> Int -> IO Diagnostic

getClangVersion :: IO CXString

type InclusionVisitor a = File -> [SourceLocation] -> Maybe a -> IO (Maybe a)

getInclusions :: (Storable a, Alloc a) => TranslationUnit -> InclusionVisitor a -> Maybe a -> IO ()

wrapInclusionVisitor :: Storable a => InclusionVisitor a -> InclusionVisitorRaw