LibClang-3.4.0: Haskell bindings for libclang (a C++ parsing library)

Safe HaskellNone
LanguageHaskell2010

Clang.USR

Description

Functions for manipulating 'Unified Symbol Resolution' values, or 'USRs'. USRs are strings that provide an unambiguous reference to a symbol. Any two cursors that refer to the same semantic entity will have the same USR, even if they occur in different translation units. This is very useful when attempting to cross-reference between different source files in a project.

Most often, using USRs simply means retrieving the USR that corresponds to a Cursor. You can do this using getUSR, and then convert to a Haskell string using the functions in Clang.String.

This module is intended to be imported qualified.

Synopsis

Documentation

createFromObjCClass Source

Arguments

:: ClangBase m 
=> String

A class name.

-> ClangT s m (ClangString s) 

Construct a USR for the specified Objective-C class.

createFromObjCCategory Source

Arguments

:: ClangBase m 
=> String

A class name.

-> String

A category name.

-> ClangT s m (ClangString s) 

Construct a USR for the specified Objective-C category.

createFromObjCProtocol Source

Arguments

:: ClangBase m 
=> String

A protocol name.

-> ClangT s m (ClangString s) 

Construct a USR for the specified Objective-C protocol.

createFromObjCIvar Source

Arguments

:: ClangBase m 
=> String

An instance variable name.

-> ClangString s'

A class USR.

-> ClangT s m (ClangString s) 

Construct a USR for the specified Objective-C instance variable, given the USR for its containing class.

createFromObjCInstanceMethod Source

Arguments

:: ClangBase m 
=> String

A method name.

-> ClangString s'

A class USR.

-> ClangT s m (ClangString s) 

Construct a USR for the specified Objective-C instance method, given the USR for its containing class.

createFromObjCClassMethod Source

Arguments

:: ClangBase m 
=> String

A method name.

-> ClangString s'

A class USR.

-> ClangT s m (ClangString s) 

Construct a USR for the specified Objective-C class method, given the USR for its containing class.

createFromObjCProperty Source

Arguments

:: ClangBase m 
=> String

A property name.

-> ClangString s'

A class USR.

-> ClangT s m (ClangString s) 

Construct a USR for the specified Objective-C property, given the USR for its containing class.