Struct Expansion

pub struct Expansion<'a> {
    pub filenames: Vec<&'a str>,
    pub branches: Vec<Branch>,
    pub source_region: Region,
    pub target_regions: Vec<Region>,
}

Metrics of an expansion, i.e., a expanded macro or include statement.

Fields

filenames: Vec<&'a str>

Vector that is references via index by the branches, source_region and target_regions attribute in order to refer to a specific file.

branches: Vec<Branch>

All branches in a file that is included into other files. E.g., these are the branches in the header file self.filenames[self.branches[x].file_id]. A Branch object may reference a macro such as #define LTC_ARGCHK(x) do { if (!(x)) { … } }, or, to be more specific, the column/row value would point to ‘if (!(x))’. TODO: Where does branch.expanded_file_id points to?

source_region: Region

The source and destination of the expansion (i.e., macro/include statement). Indexing the filenames array with the source_region.file_id returns the path of the file in which the macro/include was used. The source_region.line_* and source_region.column_* attrbiutes refer to the code location where in macro was used. The source_region.expanded_file_id can be used as index for the filenames array to get the file path where the expanded macro or included file is located.

target_regions: Vec<Region>

Trait Implementations

impl<'a> Debug for Expansion<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Expansion<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq for Expansion<'a>

fn eq(&self, other: &Expansion<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for Expansion<'a>