Struct Index

pub struct Index<'c> { /* private fields */ }

A collection of translation units.

Implementations

impl<'c> Index<'c>

pub fn new(_: &'c Clang, exclude: bool, diagnostics: bool) -> Index<'c>

Constructs a new Index.

exclude determines whether declarations from precompiled headers are excluded and diagnostics determines whether diagnostics are printed while parsing source files.

Examples found in repository

examples/structs.rs (line 10)

fn main() {
    // Acquire an instance of `Clang`
    let clang = Clang::new().unwrap();

    // Create a new `Index`
    let index = Index::new(&clang, false, false);

    // Parse a source file into a translation unit
    let tu = index.parser("examples/structs.c").parse().unwrap();

    // Get the structs in this translation unit
    let structs = tu.get_entity().get_children().into_iter().filter(|e| {
        e.get_kind() == EntityKind::StructDecl
    }).collect::<Vec<_>>();

    // Print information about the structs
    for struct_ in structs {
        let type_ =  struct_.get_type().unwrap();
        let size = type_.get_sizeof().unwrap();
        println!("struct: {:?} (size: {} bytes)", struct_.get_name().unwrap(), size);

        for field in struct_.get_children() {
            let name = field.get_name().unwrap();
            let offset = type_.get_offsetof(&name).unwrap();
            println!("    field: {:?} (offset: {} bits)", name, offset);
        }
    }
}

pub fn parser<F: Into<PathBuf>>(&'c self, f: F) -> Parser<'c>

Returns a parser for the supplied file.

Examples found in repository

examples/structs.rs (line 13)

fn main() {
    // Acquire an instance of `Clang`
    let clang = Clang::new().unwrap();

    // Create a new `Index`
    let index = Index::new(&clang, false, false);

    // Parse a source file into a translation unit
    let tu = index.parser("examples/structs.c").parse().unwrap();

    // Get the structs in this translation unit
    let structs = tu.get_entity().get_children().into_iter().filter(|e| {
        e.get_kind() == EntityKind::StructDecl
    }).collect::<Vec<_>>();

    // Print information about the structs
    for struct_ in structs {
        let type_ =  struct_.get_type().unwrap();
        let size = type_.get_sizeof().unwrap();
        println!("struct: {:?} (size: {} bytes)", struct_.get_name().unwrap(), size);

        for field in struct_.get_children() {
            let name = field.get_name().unwrap();
            let offset = type_.get_offsetof(&name).unwrap();
            println!("    field: {:?} (offset: {} bits)", name, offset);
        }
    }
}

pub fn set_invocation_emission_path<P: AsRef<Path>>(&'c self, path: P)

Sets the invocation emission path for this index.

pub fn get_thread_options(&self) -> ThreadOptions

Returns the thread options for this index.

pub fn set_thread_options(&mut self, options: ThreadOptions)

Sets the thread options for this index.

Trait Implementations

impl<'c> Debug for Index<'c>

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'c> Drop for Index<'c>

fn drop(&mut self)

Executes the destructor for this type.