A complete internal representation consisting of Modules (Module). More...

#include <IR.hpp>

Inheritance diagram for gtirb::IR:

Collaboration diagram for gtirb::IR:

Public Types
enum	load_error { load_error::IncorrectVersion = 1, load_error::CorruptFile, load_error::CorruptModule, load_error::CorruptSection, load_error::CorruptByteInterval, load_error::CorruptCFG, load_error::BadUUID, load_error::MissingUUID, load_error::NotGTIRB }
	Specifies various failure modes when loading an IR. More...

Public Types inherited from gtirb::AuxDataContainer
using	const_aux_data_iterator = boost::transform_iterator< AccessRawData, AuxDataSet::const_iterator >
	An iterator type for traversing the AuxData in this container. More...

using	const_aux_data_range = boost::iterator_range< const_aux_data_iterator >

Public Member Functions
CFG &	getCFG ()
	Get a const reference to the associated Control Flow Graph (CFG). More...

const CFG &	getCFG () const
	Get the associated Control Flow Graph (CFG). More...

uint32_t	getVersion () const
	Get the version of the Protobuf used when creating this IR. More...

void	save (std::ostream &Out) const
	Serialize to an output stream in binary format. More...

void	saveJSON (std::ostream &Out) const
	Serialize to an output stream in JSON format. More...

void	setVersion (uint32_t V)
	Set the version of the Protobuf used when creating this IR. More...

Public Member Functions inherited from gtirb::AuxDataContainer
template<typename Schema >
void	addAuxData (typename Schema::Type &&X)
	Add a new AuxData, transferring ownership. More...

template<typename Schema >
Schema::Type *	getAuxData ()
	Get a reference to the underlying type stored in the AuxData by name. More...

template<typename Schema >
const Schema::Type *	getAuxData () const
	Get a reference to the underlying type stored in the AuxData by name. More...

template<typename Schema >
bool	removeAuxData ()
	Remove an AuxData by schema. More...

bool	removeAuxData (std::string Name)
	Remove an AuxData by name. More...

const_aux_data_iterator	aux_data_begin () const
	Return a constant iterator to the first AuxData. More...

const_aux_data_iterator	aux_data_end () const
	Return a constant iterator to the element following the last AuxData. More...

const_aux_data_range	aux_data () const
	Return a constant range of the auxiliary data (AuxData). More...

size_t	getAuxDataSize () const
	Get the total number of AuxData objects in this IR. More...

bool	getAuxDataEmpty () const
	Check: Is the number of AuxData objects in this IR zero? More...

void	clearAuxData ()
	Clear all AuxData from the IR. More...

Public Member Functions inherited from gtirb::Node
	Node (const Node &)=delete
	Copying Nodes is explicitly disabled. More...

	Node (Node &&)=delete
	Move-constructing Nodes is explicitly disabled. More...

	~Node () noexcept
	Cleans up resources no longer needed by the Node object. More...

const UUID &	getUUID () const
	Get the Universally Unique ID (UUID) for `this`. More...

Node &	operator= (const Node &)=delete
	Copying Nodes is explicilty disabled. More...

Node &	operator= (Node &&)=delete
	Move-assigning Nodes is explicilty disabled. More...

Static Public Member Functions
static IR *	Create (Context &C)
	Create an IR object in its default state. More...

static ErrorOr< IR * >	load (Context &C, std::istream &In)
	Deserialize binary format from an input stream. More...

static ErrorOr< IR * >	loadJSON (Context &C, std::istream &In)
	Deserialize JSON format from an input stream. More...

Static Public Member Functions inherited from gtirb::AuxDataContainer
template<typename Schema >
static void	registerAuxDataType ()
	Register a type to be used with AuxData of the given name. More...

Static Public Member Functions inherited from gtirb::Node
static Node *	Create (Context &C)
	Create a Node object in its default state. More...

static const Node *	getByUUID (const Context &C, const UUID &Uuid)
	Retrieve a node by its UUID. More...

static Node *	getByUUID (Context &C, const UUID &Uuid)
	Retrieve a node by its UUID. More...

Friends
class	Context

Module-Related Public Types and Functions
Iterator over Modules. Modules are returned in name order. If more than one module has the same name, the order in which they are returned is unspecified.
using	module_iterator = boost::indirect_iterator< ModuleSet::iterator >

using	const_module_iterator = boost::indirect_iterator< ModuleSet::const_iterator, const Module >
	Constant iterator over Modules. More...

using	module_range = boost::iterator_range< module_iterator >
	Range of Modules. More...

using	const_module_range = boost::iterator_range< const_module_iterator >
	Constant range of Modules. More...

using	module_name_iterator = boost::indirect_iterator< ModuleSet::index< by_name >::type::iterator >
	Iterator over modules Modules. More...

using	module_name_range = boost::iterator_range< module_name_iterator >
	Range of modules Modules. More...

using	const_module_name_iterator = boost::indirect_iterator< ModuleSet::index< by_name >::type::const_iterator, const Module >
	Constant iterator over modules Modules. More...

using	const_module_name_range = boost::iterator_range< const_module_name_iterator >
	Constant range of modules Modules. More...

module_iterator	modules_begin ()
	Returns an iterator to the first Module. More...

module_iterator	modules_end ()
	Returns an iterator to the element following the last Module. More...

const_module_iterator	modules_begin () const
	Returns a constant iterator to the first Module. More...

const_module_iterator	modules_end () const
	Returns a constant iterator to the element following the last Module. More...

module_range	modules ()
	Returns a range of the Modules. More...

const_module_range	modules () const
	Returns a constant range of the Modules. More...

bool	removeModule (Module *M)
	Remove a Module object located in this IR. More...

Module *	addModule (Module *M)
	Move a Module object to be located in this IR. More...

template<typename... Args>
Module *	addModule (Context &C, Args... A)
	Creates a new Module in this IR. More...

module_name_range	findModules (const std::string &N)
	Find modules by name. More...

const_module_name_range	findModules (const std::string &N) const
	Find modules by name. More...

ProxyBlock-Related Public Types and Functions
using	proxy_block_iterator = MergeSortedIterator< Module::proxy_block_iterator, ArbitraryLess< ProxyBlock > >
	Iterator over ProxyBlock objects. More...

using	proxy_block_range = boost::iterator_range< proxy_block_iterator >
	Range over ProxyBlock objects. More...

using	const_proxy_block_iterator = MergeSortedIterator< Module::const_proxy_block_iterator, ArbitraryLess< ProxyBlock > >
	Iterator over ProxyBlock objects. More...

using	const_proxy_block_range = boost::iterator_range< const_proxy_block_iterator >
	Range over ProxyBlock objects. More...

proxy_block_iterator	proxy_blocks_begin ()
	Return an iterator to the first ProxyBlock. More...

proxy_block_iterator	proxy_blocks_end ()
	Return an iterator to the element following the last ProxyBlock. More...

proxy_block_range	proxy_blocks ()
	Return a range of all the ProxyBlock objects. More...

const_proxy_block_iterator	proxy_blocks_begin () const
	Return an iterator to the first ProxyBlock. More...

const_proxy_block_iterator	proxy_blocks_end () const
	Return an iterator to the element following the last ProxyBlock. More...

const_proxy_block_range	proxy_blocks () const
	Return an iterator to the first ProxyBlock. More...

Symbol-Related Public Types and Functions
using	symbol_iterator = MergeSortedIterator< Module::symbol_iterator, ArbitraryLess< Symbol > >
	Iterator over Symbol objects. More...

using	symbol_range = boost::iterator_range< symbol_iterator >
	Range of Symbol objects. More...

using	const_symbol_iterator = MergeSortedIterator< Module::const_symbol_iterator, ArbitraryLess< Symbol > >
	Iterator over Symbol objects. More...

using	const_symbol_range = boost::iterator_range< const_symbol_iterator >
	Range of Symbol objects. More...

symbol_iterator	symbols_begin ()
	Return an iterator to the first Symbol. More...

symbol_iterator	symbols_end ()
	Return an iterator to the element following the last Symbol. More...

symbol_range	symbols ()
	Return a range of the Symbol objects. More...

const_symbol_iterator	symbols_begin () const
	Return an iterator to the first Symbol. More...

const_symbol_iterator	symbols_end () const
	Return an iterator to the element following the last Symbol. More...

const_symbol_range	symbols () const
	Return a range of the Symbol objects. More...

Section-Related Public Types and Functions
using	section_iterator = MergeSortedIterator< Module::section_iterator, AddressLess >
	Iterator over Section objects. More...

using	section_range = boost::iterator_range< section_iterator >
	Range of Section objects. More...

using	section_subrange = boost::iterator_range< MergeSortedIterator< Module::section_subrange::iterator, AddressLess > >
	Sub-range of Section objects overlapping an address. More...

using	const_section_iterator = MergeSortedIterator< Module::const_section_iterator, AddressLess >
	Iterator over Section objects. More...

using	const_section_range = boost::iterator_range< const_section_iterator >
	Range of Section objects. More...

using	const_section_subrange = boost::iterator_range< MergeSortedIterator< Module::const_section_subrange::iterator, AddressLess > >
	Sub-range of Section objects overlapping an address. More...

using	section_name_iterator = MergeSortedIterator< Module::section_name_iterator, AddressLess >
	Iterator over Section objects. More...

using	section_name_range = boost::iterator_range< section_name_iterator >
	Range of Section objects. More...

using	const_section_name_iterator = MergeSortedIterator< Module::const_section_name_iterator, AddressLess >
	Iterator over Section objects. More...

using	const_section_name_range = boost::iterator_range< const_section_name_iterator >
	Range of Section objects. More...

section_iterator	sections_begin ()
	Return an iterator to the first Section. More...

section_iterator	sections_end ()
	Return an iterator to the element following the last Section. More...

section_range	sections ()
	Return a range of all the Section objects. More...

const_section_iterator	sections_begin () const
	Return an iterator to the first Section. More...

const_section_iterator	sections_end () const
	Return an iterator to the element following the last Section. More...

const_section_range	sections () const
	Return a range of all the Section objects. More...

section_subrange	findSectionsOn (Addr A)
	Find a Section containing an address. More...

const_section_subrange	findSectionsOn (Addr A) const
	Find a Section containing an address. More...

section_range	findSectionsAt (Addr A)
	Find all the sections that start at an address. More...

section_range	findSectionsAt (Addr Low, Addr High)
	Find all the sections that start between a range of addresses. More...

const_section_range	findSectionsAt (Addr A) const
	Find all the sections that start at an address. More...

const_section_range	findSectionsAt (Addr Low, Addr High) const
	Find all the sections that start between a range of addresses. More...

section_name_range	findSections (const std::string &X)
	Find all the sections containing a name. More...

const_section_name_range	findSections (const std::string &X) const
	Find all the sections containing a name. More...

ByteInterval-Related Public Types and Functions
using	byte_interval_iterator = MergeSortedIterator< Module::byte_interval_iterator, AddressLess >
	Iterator over ByteInterval objects. More...

using	byte_interval_range = boost::iterator_range< byte_interval_iterator >
	Range of ByteInterval objects. More...

using	byte_interval_subrange = boost::iterator_range< MergeSortedIterator< Module::byte_interval_subrange::iterator, AddressLess > >
	Sub-range of ByteInterval objects overlapping addresses. More...

using	const_byte_interval_iterator = MergeSortedIterator< Module::const_byte_interval_iterator, AddressLess >
	Const iterator over ByteInterval objects. More...

using	const_byte_interval_range = boost::iterator_range< const_byte_interval_iterator >
	Const range of ByteInterval objects. More...

using	const_byte_interval_subrange = boost::iterator_range< MergeSortedIterator< Module::const_byte_interval_subrange::iterator, AddressLess > >
	Sub-range of ByteInterval objects overlapping addresses. More...

byte_interval_iterator	byte_intervals_begin ()
	Return an iterator to the first ByteInterval. More...

byte_interval_iterator	byte_intervals_end ()
	Return an iterator to the element following the last ByteInterval. More...

byte_interval_range	byte_intervals ()
	Return a range of all the ByteInterval objects. More...

const_byte_interval_iterator	byte_intervals_begin () const
	Return an iterator to the first ByteInterval. More...

const_byte_interval_iterator	byte_intervals_end () const
	Return an iterator to the element following the last ByteInterval. More...

const_byte_interval_range	byte_intervals () const
	Return a range of all the ByteInterval objects. More...

byte_interval_subrange	findByteIntervalsOn (Addr A)
	Find all the intervals that have bytes that lie within the address specified. More...

const_byte_interval_subrange	findByteIntervalsOn (Addr A) const
	Find all the intervals that have bytes that lie within the address specified. More...

byte_interval_range	findByteIntervalsAt (Addr A)
	Find all the intervals that start at an address. More...

byte_interval_range	findByteIntervalsAt (Addr Low, Addr High)
	Find all the intervals that start between a range of addresses. More...

const_byte_interval_range	findByteIntervalsAt (Addr A) const
	Find all the intervals that start at an address. More...

const_byte_interval_range	findByteIntervalsAt (Addr Low, Addr High) const
	Find all the intervals that start between a range of addresses. More...

Block-Related Public Types and Functions
using	block_iterator = MergeSortedIterator< Module::block_iterator, BlockAddressLess >
	Iterator over blocks. More...

using	block_range = boost::iterator_range< block_iterator >
	Range of blocks. More...

using	block_subrange = boost::iterator_range< MergeSortedIterator< Module::block_subrange::iterator, BlockAddressLess > >
	Sub-range of blocks overlapping an address or range of addreses. More...

using	const_block_iterator = MergeSortedIterator< Module::const_block_iterator, BlockAddressLess >
	Iterator over blocks. More...

using	const_block_range = boost::iterator_range< const_block_iterator >
	Range of blocks. More...

using	const_block_subrange = boost::iterator_range< MergeSortedIterator< Module::const_block_subrange::iterator, BlockAddressLess > >
	Sub-range of blocks overlapping an address or range of addreses. More...

block_iterator	blocks_begin ()
	Return an iterator to the first block. More...

block_iterator	blocks_end ()
	Return an iterator to the element following the last block. More...

block_range	blocks ()
	Return a range of all the blocks. More...

const_block_iterator	blocks_begin () const
	Return an iterator to the first block. More...

const_block_iterator	blocks_end () const
	Return an iterator to the element following the last block. More...

const_block_range	blocks () const
	Return a range of all the blocks. More...

block_subrange	findBlocksOn (Addr A)
	Find all the blocks that have bytes that lie within the address specified. More...

const_block_subrange	findBlocksOn (Addr A) const
	Find all the blocks that have bytes that lie within the address specified. More...

block_range	findBlocksAt (Addr A)
	Find all the blocks that start at an address. More...

block_range	findBlocksAt (Addr Low, Addr High)
	Find all the blocks that start between a range of addresses. More...

const_block_range	findBlocksAt (Addr A) const
	Find all the blocks that start at an address. More...

const_block_range	findBlocksAt (Addr Low, Addr High) const
	Find all the blocks that start between a range of addresses. More...

CodeBlock-Related Public Types and Functions
using	code_block_iterator = MergeSortedIterator< Module::code_block_iterator, AddressLess >
	Iterator over CodeBlock objects. More...

using	code_block_range = boost::iterator_range< code_block_iterator >
	Range of CodeBlock objects. More...

using	code_block_subrange = boost::iterator_range< MergeSortedIterator< Module::code_block_subrange::iterator, AddressLess > >
	Sub-range of CodeBlock objects overlapping an address or range of addreses. More...

using	const_code_block_iterator = MergeSortedIterator< Module::const_code_block_iterator, AddressLess >
	Iterator over CodeBlock objects. More...

using	const_code_block_range = boost::iterator_range< const_code_block_iterator >
	Range of CodeBlock objects. More...

using	const_code_block_subrange = boost::iterator_range< MergeSortedIterator< Module::const_code_block_subrange::iterator, AddressLess > >
	Sub-range of CodeBlock objects overlapping an address or range of addreses. More...

code_block_iterator	code_blocks_begin ()
	Return an iterator to the first CodeBlock. More...

code_block_iterator	code_blocks_end ()
	Return an iterator to the element following the last CodeBlock. More...

code_block_range	code_blocks ()
	Return a range of all the CodeBlock objects. More...

const_code_block_iterator	code_blocks_begin () const
	Return an iterator to the first CodeBlock. More...

const_code_block_iterator	code_blocks_end () const
	Return an iterator to the element following the last CodeBlock. More...

const_code_block_range	code_blocks () const
	Return a range of all the CodeBlock objects. More...

code_block_subrange	findCodeBlocksOn (Addr A)
	Find all the code blocks that have bytes that lie within the address specified. More...

const_code_block_subrange	findCodeBlocksOn (Addr A) const
	Find all the code blocks that have bytes that lie within the address specified. More...

code_block_range	findCodeBlocksAt (Addr A)
	Find all the code blocks that start at an address. More...

code_block_range	findCodeBlocksAt (Addr Low, Addr High)
	Find all the code blocks that start between a range of addresses. More...

const_code_block_range	findCodeBlocksAt (Addr A) const
	Find all the code blocks that start at an address. More...

const_code_block_range	findCodeBlocksAt (Addr Low, Addr High) const
	Find all the code blocks that start between a range of addresses. More...

DataBlock-Related Public Types and Functions
using	data_block_iterator = MergeSortedIterator< Module::data_block_iterator, AddressLess >
	Iterator over DataBlock objects. More...

using	data_block_range = boost::iterator_range< data_block_iterator >
	Range of DataBlock objects. More...

using	data_block_subrange = boost::iterator_range< MergeSortedIterator< Module::data_block_subrange::iterator, AddressLess > >
	Sub-range of DataBlock objects overlapping an address or range of addreses. More...

using	const_data_block_iterator = MergeSortedIterator< Module::const_data_block_iterator, AddressLess >
	Iterator over DataBlock objects. More...

using	const_data_block_range = boost::iterator_range< const_data_block_iterator >
	Range of DataBlock objects. More...

using	const_data_block_subrange = boost::iterator_range< MergeSortedIterator< Module::const_data_block_subrange::iterator, AddressLess > >
	Sub-range of DataBlock objects overlapping an address or range of addreses. More...

data_block_iterator	data_blocks_begin ()
	Return an iterator to the first DataBlock. More...

data_block_iterator	data_blocks_end ()
	Return an iterator to the element following the last DataBlock. More...

data_block_range	data_blocks ()
	Return a range of all the DataBlock objects. More...

const_data_block_iterator	data_blocks_begin () const
	Return an iterator to the first DataBlock. More...

const_data_block_iterator	data_blocks_end () const
	Return an iterator to the element following the last DataBlock. More...

const_data_block_range	data_blocks () const
	Return a range of all the DataBlock objects. More...

data_block_subrange	findDataBlocksOn (Addr A)
	Find all the data blocks that have bytes that lie within the address specified. More...

const_data_block_subrange	findDataBlocksOn (Addr A) const
	Find all the data blocks that have bytes that lie within the address specified. More...

data_block_range	findDataBlocksAt (Addr A)
	Find all the data blocks that start at an address. More...

data_block_range	findDataBlocksAt (Addr Low, Addr High)
	Find all the data blocks that start between a range of addresses. More...

const_data_block_range	findDataBlocksAt (Addr A) const
	Find all the data blocks that start at an address. More...

const_data_block_range	findDataBlocksAt (Addr Low, Addr High) const
	Find all the data blocks that start between a range of addresses. More...

SymbolicExpression-Related Public Types and Functions
using	symbolic_expression_iterator = MergeSortedIterator< Module::symbolic_expression_iterator, ByteInterval::SymbolicExpressionElement::AddressLess >
	Iterator over SymbolicExpressionElement objects. More...

using	symbolic_expression_range = boost::iterator_range< symbolic_expression_iterator >
	Range of SymbolicExpressionElement objects. More...

using	const_symbolic_expression_iterator = MergeSortedIterator< Module::const_symbolic_expression_iterator, ByteInterval::ConstSymbolicExpressionElement::AddressLess >
	Iterator over SymbolicExpressionElement objects. More...

using	const_symbolic_expression_range = boost::iterator_range< const_symbolic_expression_iterator >
	Range of SymbolicExpressionElement objects. More...

symbolic_expression_iterator	symbolic_expressions_begin ()
	Return an iterator to the first SymbolicExpression. More...

symbolic_expression_iterator	symbolic_expressions_end ()
	Return an iterator to the element following the last SymbolicExpression. More...

symbolic_expression_range	symbolic_expressions ()
	Return a range of all the SymbolicExpression objects. More...

const_symbolic_expression_iterator	symbolic_expressions_begin () const
	Return an iterator to the first SymbolicExpression. More...

const_symbolic_expression_iterator	symbolic_expressions_end () const
	Return an iterator to the element following the last SymbolicExpression. More...

const_symbolic_expression_range	symbolic_expressions () const
	Return a range of all the SymbolicExpression objects. More...

symbolic_expression_range	findSymbolicExpressionsAt (Addr A)
	Find all the symbolic expressions that start at an address. More...

symbolic_expression_range	findSymbolicExpressionsAt (Addr Low, Addr High)
	Find all the symbolic expressions that start between a range of addresses. More...

const_symbolic_expression_range	findSymbolicExpressionsAt (Addr A) const
	Find all the symbolic expressions that start at an address. More...

const_symbolic_expression_range	findSymbolicExpressionsAt (Addr Low, Addr High) const
	Find all the symbolic expressions that start between a range of addresses. More...

Detailed Description

A complete internal representation consisting of Modules (Module).

Member Typedef Documentation

◆ block_iterator

using gtirb::IR::block_iterator = MergeSortedIterator<Module::block_iterator, BlockAddressLess>

Iterator over blocks.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ block_range

using gtirb::IR::block_range = boost::iterator_range<block_iterator>

Range of blocks.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ block_subrange

using gtirb::IR::block_subrange = boost::iterator_range< MergeSortedIterator<Module::block_subrange::iterator, BlockAddressLess> >

Sub-range of blocks overlapping an address or range of addreses.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ byte_interval_iterator

using gtirb::IR::byte_interval_iterator = MergeSortedIterator<Module::byte_interval_iterator, AddressLess>

Iterator over ByteInterval objects.

◆ byte_interval_range

using gtirb::IR::byte_interval_range = boost::iterator_range<byte_interval_iterator>

Range of ByteInterval objects.

◆ byte_interval_subrange

using gtirb::IR::byte_interval_subrange = boost::iterator_range<MergeSortedIterator< Module::byte_interval_subrange::iterator, AddressLess> >

Sub-range of ByteInterval objects overlapping addresses.

◆ code_block_iterator

using gtirb::IR::code_block_iterator = MergeSortedIterator<Module::code_block_iterator, AddressLess>

Iterator over CodeBlock objects.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ code_block_range

using gtirb::IR::code_block_range = boost::iterator_range<code_block_iterator>

Range of CodeBlock objects.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ code_block_subrange

using gtirb::IR::code_block_subrange = boost::iterator_range< MergeSortedIterator<Module::code_block_subrange::iterator, AddressLess> >

Sub-range of CodeBlock objects overlapping an address or range of addreses.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ const_block_iterator

using gtirb::IR::const_block_iterator = MergeSortedIterator<Module::const_block_iterator, BlockAddressLess>

Iterator over blocks.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ const_block_range

using gtirb::IR::const_block_range = boost::iterator_range<const_block_iterator>

Range of blocks.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ const_block_subrange

using gtirb::IR::const_block_subrange = boost::iterator_range<MergeSortedIterator< Module::const_block_subrange::iterator, BlockAddressLess> >

Sub-range of blocks overlapping an address or range of addreses.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ const_byte_interval_iterator

using gtirb::IR::const_byte_interval_iterator = MergeSortedIterator<Module::const_byte_interval_iterator, AddressLess>

Const iterator over ByteInterval objects.

◆ const_byte_interval_range

using gtirb::IR::const_byte_interval_range = boost::iterator_range<const_byte_interval_iterator>

Const range of ByteInterval objects.

◆ const_byte_interval_subrange

using gtirb::IR::const_byte_interval_subrange = boost::iterator_range<MergeSortedIterator< Module::const_byte_interval_subrange::iterator, AddressLess> >

Sub-range of ByteInterval objects overlapping addresses.

◆ const_code_block_iterator

using gtirb::IR::const_code_block_iterator = MergeSortedIterator<Module::const_code_block_iterator, AddressLess>

Iterator over CodeBlock objects.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ const_code_block_range

using gtirb::IR::const_code_block_range = boost::iterator_range<const_code_block_iterator>

Range of CodeBlock objects.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ const_code_block_subrange

using gtirb::IR::const_code_block_subrange = boost::iterator_range<MergeSortedIterator< Module::const_code_block_subrange::iterator, AddressLess> >

Sub-range of CodeBlock objects overlapping an address or range of addreses.

Blocks are yielded in address order, ascending.

◆ const_data_block_iterator

using gtirb::IR::const_data_block_iterator = MergeSortedIterator<Module::const_data_block_iterator, AddressLess>

Iterator over DataBlock objects.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ const_data_block_range

using gtirb::IR::const_data_block_range = boost::iterator_range<const_data_block_iterator>

Range of DataBlock objects.

Blocks are yielded in address order, ascending.

◆ const_data_block_subrange

using gtirb::IR::const_data_block_subrange = boost::iterator_range<MergeSortedIterator< Module::const_data_block_subrange::iterator, AddressLess> >

Sub-range of DataBlock objects overlapping an address or range of addreses.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ const_module_iterator

using gtirb::IR::const_module_iterator = boost::indirect_iterator<ModuleSet::const_iterator, const Module>

Constant iterator over Modules.

Modules are returned in name order. If more than one module has the same name, the order in which they are returned is unspecified.

◆ const_module_name_iterator

using gtirb::IR::const_module_name_iterator = boost::indirect_iterator<ModuleSet::index<by_name>::type::const_iterator, const Module>

Constant iterator over modules Modules.

This iterator returns modules in name order. If two modules have the same name, their order is unspecified.

◆ const_module_name_range

using gtirb::IR::const_module_name_range = boost::iterator_range<const_module_name_iterator>

Constant range of modules Modules.

This range returns modules in name order. If two modules have the same name, their order is unspecified.

◆ const_module_range

using gtirb::IR::const_module_range = boost::iterator_range<const_module_iterator>

Constant range of Modules.

Modules are returned in name order. If more than one module has the same name, the order in which they are returned is unspecified.

◆ const_proxy_block_iterator

using gtirb::IR::const_proxy_block_iterator = MergeSortedIterator<Module::const_proxy_block_iterator, ArbitraryLess<ProxyBlock> >

Iterator over ProxyBlock objects.

◆ const_proxy_block_range

using gtirb::IR::const_proxy_block_range = boost::iterator_range<const_proxy_block_iterator>

Range over ProxyBlock objects.

◆ const_section_iterator

using gtirb::IR::const_section_iterator = MergeSortedIterator<Module::const_section_iterator, AddressLess>

Iterator over Section objects.

◆ const_section_name_iterator

using gtirb::IR::const_section_name_iterator = MergeSortedIterator<Module::const_section_name_iterator, AddressLess>

Iterator over Section objects.

◆ const_section_name_range

using gtirb::IR::const_section_name_range = boost::iterator_range<const_section_name_iterator>

Range of Section objects.

◆ const_section_range

using gtirb::IR::const_section_range = boost::iterator_range<const_section_iterator>

Range of Section objects.

◆ const_section_subrange

using gtirb::IR::const_section_subrange = boost::iterator_range<MergeSortedIterator< Module::const_section_subrange::iterator, AddressLess> >

Sub-range of Section objects overlapping an address.

◆ const_symbol_iterator

using gtirb::IR::const_symbol_iterator = MergeSortedIterator<Module::const_symbol_iterator, ArbitraryLess<Symbol> >

Iterator over Symbol objects.

This iterator returns symbols in an arbitrary order.

◆ const_symbol_range

using gtirb::IR::const_symbol_range = boost::iterator_range<const_symbol_iterator>

Range of Symbol objects.

This range returns symbols in an arbitrary order.

◆ const_symbolic_expression_iterator

using gtirb::IR::const_symbolic_expression_iterator = MergeSortedIterator< Module::const_symbolic_expression_iterator, ByteInterval::ConstSymbolicExpressionElement::AddressLess>

Iterator over SymbolicExpressionElement objects.

Results are yielded in address order, ascending.

◆ const_symbolic_expression_range

using gtirb::IR::const_symbolic_expression_range = boost::iterator_range<const_symbolic_expression_iterator>

Range of SymbolicExpressionElement objects.

Results are yielded in address order, ascending.

◆ data_block_iterator

using gtirb::IR::data_block_iterator = MergeSortedIterator<Module::data_block_iterator, AddressLess>

Iterator over DataBlock objects.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ data_block_range

using gtirb::IR::data_block_range = boost::iterator_range<data_block_iterator>

Range of DataBlock objects.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ data_block_subrange

using gtirb::IR::data_block_subrange = boost::iterator_range< MergeSortedIterator<Module::data_block_subrange::iterator, AddressLess> >

Sub-range of DataBlock objects overlapping an address or range of addreses.

Blocks are yielded in address order, ascending. For more details, see the documentation on iteration order.

◆ module_iterator

using gtirb::IR::module_iterator = boost::indirect_iterator<ModuleSet::iterator>

◆ module_name_iterator

using gtirb::IR::module_name_iterator = boost::indirect_iterator<ModuleSet::index<by_name>::type::iterator>

Iterator over modules Modules.

This iterator returns modules in name order. If two modules have the same name, their order is unspecified.

◆ module_name_range

using gtirb::IR::module_name_range = boost::iterator_range<module_name_iterator>

Range of modules Modules.

This range returns modules in name order. If two modules have the same name, their order is unspecified.

◆ module_range

using gtirb::IR::module_range = boost::iterator_range<module_iterator>

Range of Modules.

Modules are returned in name order. If more than one module has the same name, the order in which they are returned is unspecified.

◆ proxy_block_iterator

using gtirb::IR::proxy_block_iterator = MergeSortedIterator<Module::proxy_block_iterator, ArbitraryLess<ProxyBlock> >

Iterator over ProxyBlock objects.

◆ proxy_block_range

using gtirb::IR::proxy_block_range = boost::iterator_range<proxy_block_iterator>

Range over ProxyBlock objects.

◆ section_iterator

using gtirb::IR::section_iterator = MergeSortedIterator<Module::section_iterator, AddressLess>

Iterator over Section objects.

◆ section_name_iterator

using gtirb::IR::section_name_iterator = MergeSortedIterator<Module::section_name_iterator, AddressLess>

Iterator over Section objects.

◆ section_name_range

using gtirb::IR::section_name_range = boost::iterator_range<section_name_iterator>

Range of Section objects.

◆ section_range

using gtirb::IR::section_range = boost::iterator_range<section_iterator>

Range of Section objects.

◆ section_subrange

using gtirb::IR::section_subrange = boost::iterator_range< MergeSortedIterator<Module::section_subrange::iterator, AddressLess> >

Sub-range of Section objects overlapping an address.

◆ symbol_iterator

using gtirb::IR::symbol_iterator = MergeSortedIterator<Module::symbol_iterator, ArbitraryLess<Symbol> >

Iterator over Symbol objects.

This iterator returns symbols in an arbitrary order.

◆ symbol_range

using gtirb::IR::symbol_range = boost::iterator_range<symbol_iterator>

Range of Symbol objects.

This range returns symbols in an arbitrary order.

◆ symbolic_expression_iterator

using gtirb::IR::symbolic_expression_iterator = MergeSortedIterator<Module::symbolic_expression_iterator, ByteInterval::SymbolicExpressionElement::AddressLess>

Iterator over SymbolicExpressionElement objects.

Results are yielded in address order, ascending.

◆ symbolic_expression_range

using gtirb::IR::symbolic_expression_range = boost::iterator_range<symbolic_expression_iterator>

Range of SymbolicExpressionElement objects.

Results are yielded in address order, ascending.

Member Enumeration Documentation

◆ load_error

enum gtirb::IR::load_error

strong

Specifies various failure modes when loading an IR.

Enumerator
IncorrectVersion	The version number in the file does not match.
CorruptFile	The content of the file could not be deserialized.
CorruptModule
CorruptSection
CorruptByteInterval
CorruptCFG	The control flow graph could not be deserialized.
BadUUID	An object had an incorrectly formatted UUID.
MissingUUID	A UUID did not refer to an object in the loading Context.
NotGTIRB	Indicates the GTIRB magic number was not found.

Member Function Documentation

◆ addModule() [1/2]

template<typename... Args>

Module* gtirb::IR::addModule	(	Context &	C,
		Args...	A
	)

inline

Creates a new Module in this IR.

Template Parameters

Args	The arguments to construct a Module.

◆ addModule() [2/2]

Module* gtirb::IR::addModule ( Module * M )

inline

Move a Module object to be located in this IR.

Parameters

S	The Module object to add.

◆ blocks() [1/2]

block_range gtirb::IR::blocks ( )

inline

Return a range of all the blocks.

◆ blocks() [2/2]

const_block_range gtirb::IR::blocks ( ) const

inline

Return a range of all the blocks.

◆ blocks_begin() [1/2]

block_iterator gtirb::IR::blocks_begin ( )

inline

Return an iterator to the first block.

◆ blocks_begin() [2/2]

const_block_iterator gtirb::IR::blocks_begin ( ) const

inline

Return an iterator to the first block.

◆ blocks_end() [1/2]

block_iterator gtirb::IR::blocks_end ( )

inline

Return an iterator to the element following the last block.

◆ blocks_end() [2/2]

const_block_iterator gtirb::IR::blocks_end ( ) const

inline

Return an iterator to the element following the last block.

◆ byte_intervals() [1/2]

byte_interval_range gtirb::IR::byte_intervals ( )

inline

Return a range of all the ByteInterval objects.

◆ byte_intervals() [2/2]

const_byte_interval_range gtirb::IR::byte_intervals ( ) const

inline

Return a range of all the ByteInterval objects.

◆ byte_intervals_begin() [1/2]

byte_interval_iterator gtirb::IR::byte_intervals_begin ( )

inline

Return an iterator to the first ByteInterval.

◆ byte_intervals_begin() [2/2]

const_byte_interval_iterator gtirb::IR::byte_intervals_begin ( ) const

inline

Return an iterator to the first ByteInterval.

◆ byte_intervals_end() [1/2]

byte_interval_iterator gtirb::IR::byte_intervals_end ( )

inline

Return an iterator to the element following the last ByteInterval.

◆ byte_intervals_end() [2/2]

const_byte_interval_iterator gtirb::IR::byte_intervals_end ( ) const

inline

Return an iterator to the element following the last ByteInterval.

◆ code_blocks() [1/2]

code_block_range gtirb::IR::code_blocks ( )

inline

Return a range of all the CodeBlock objects.

◆ code_blocks() [2/2]

const_code_block_range gtirb::IR::code_blocks ( ) const

inline

Return a range of all the CodeBlock objects.

◆ code_blocks_begin() [1/2]

code_block_iterator gtirb::IR::code_blocks_begin ( )

inline

Return an iterator to the first CodeBlock.

◆ code_blocks_begin() [2/2]

const_code_block_iterator gtirb::IR::code_blocks_begin ( ) const

inline

Return an iterator to the first CodeBlock.

◆ code_blocks_end() [1/2]

code_block_iterator gtirb::IR::code_blocks_end ( )

inline

Return an iterator to the element following the last CodeBlock.

◆ code_blocks_end() [2/2]

const_code_block_iterator gtirb::IR::code_blocks_end ( ) const

inline

Return an iterator to the element following the last CodeBlock.

◆ Create()

static IR* gtirb::IR::Create ( Context & C )

inlinestatic

Create an IR object in its default state.

Parameters

C	The Context in which this object will be held.

Returns: The newly created object.

◆ data_blocks() [1/2]

data_block_range gtirb::IR::data_blocks ( )

inline

Return a range of all the DataBlock objects.

◆ data_blocks() [2/2]

const_data_block_range gtirb::IR::data_blocks ( ) const

inline

Return a range of all the DataBlock objects.

◆ data_blocks_begin() [1/2]

data_block_iterator gtirb::IR::data_blocks_begin ( )

inline

Return an iterator to the first DataBlock.

◆ data_blocks_begin() [2/2]

const_data_block_iterator gtirb::IR::data_blocks_begin ( ) const

inline

Return an iterator to the first DataBlock.

◆ data_blocks_end() [1/2]

data_block_iterator gtirb::IR::data_blocks_end ( )

inline

Return an iterator to the element following the last DataBlock.

◆ data_blocks_end() [2/2]

const_data_block_iterator gtirb::IR::data_blocks_end ( ) const

inline

Return an iterator to the element following the last DataBlock.

◆ findBlocksAt() [1/4]

block_range gtirb::IR::findBlocksAt ( Addr A )

inline

Find all the blocks that start at an address.

Parameters

A	The address to look up.

Returns: A range of Node objects, which are either DataBlock objects or CodeBlock objects, that are at the address A.

◆ findBlocksAt() [2/4]

const_block_range gtirb::IR::findBlocksAt ( Addr A ) const

inline

Find all the blocks that start at an address.

Parameters

A	The address to look up.

Returns: A range of Node objects, which are either DataBlock objects or CodeBlock objects, that are at the address A.

◆ findBlocksAt() [3/4]

block_range gtirb::IR::findBlocksAt	(	Addr	Low,
		Addr	High
	)

inline

Find all the blocks that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of Node objects, which are either DataBlock objects or CodeBlock objects, that are between the addresses.

◆ findBlocksAt() [4/4]

const_block_range gtirb::IR::findBlocksAt	(	Addr	Low,
		Addr	High
	)		const

inline

Find all the blocks that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of Node objects, which are either DataBlock objects or CodeBlock objects, that are between the addresses.

◆ findBlocksOn() [1/2]

block_subrange gtirb::IR::findBlocksOn ( Addr A )

inline

Find all the blocks that have bytes that lie within the address specified.

Parameters

A	The address to look up.

Returns: A range of Node objects, which are either DataBlock objects or CodeBlock objects, that intersect the address A.

◆ findBlocksOn() [2/2]

const_block_subrange gtirb::IR::findBlocksOn ( Addr A ) const

inline

Find all the blocks that have bytes that lie within the address specified.

Parameters

A	The address to look up.

Returns: A range of Node objects, which are either DataBlock objects or CodeBlock objects, that intersect the address A.

◆ findByteIntervalsAt() [1/4]

byte_interval_range gtirb::IR::findByteIntervalsAt ( Addr A )

inline

Find all the intervals that start at an address.

Parameters

A	The address to look up.

Returns: A range of ByteInterval objects that are at the address A.

◆ findByteIntervalsAt() [2/4]

const_byte_interval_range gtirb::IR::findByteIntervalsAt ( Addr A ) const

inline

Find all the intervals that start at an address.

Parameters

A	The address to look up.

Returns: A range of ByteInterval objects that are at the address A.

◆ findByteIntervalsAt() [3/4]

byte_interval_range gtirb::IR::findByteIntervalsAt	(	Addr	Low,
		Addr	High
	)

inline

Find all the intervals that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of ByteInterval objects that are between the addresses.

◆ findByteIntervalsAt() [4/4]

const_byte_interval_range gtirb::IR::findByteIntervalsAt	(	Addr	Low,
		Addr	High
	)		const

inline

Find all the intervals that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of ByteInterval objects that are between the addresses.

◆ findByteIntervalsOn() [1/2]

byte_interval_subrange gtirb::IR::findByteIntervalsOn ( Addr A )

inline

Find all the intervals that have bytes that lie within the address specified.

Parameters

A	The address to look up.

Returns: A range of ByteInterval objects that intersect the address A.

◆ findByteIntervalsOn() [2/2]

const_byte_interval_subrange gtirb::IR::findByteIntervalsOn ( Addr A ) const

inline

Find all the intervals that have bytes that lie within the address specified.

Parameters

A	The address to look up.

Returns: A range of ByteInterval objects that intersect the address A.

◆ findCodeBlocksAt() [1/4]

code_block_range gtirb::IR::findCodeBlocksAt ( Addr A )

inline

Find all the code blocks that start at an address.

Parameters

A	The address to look up.

Returns: A range of CodeBlock objects that are at the address A.

◆ findCodeBlocksAt() [2/4]

const_code_block_range gtirb::IR::findCodeBlocksAt ( Addr A ) const

inline

Find all the code blocks that start at an address.

Parameters

A	The address to look up.

Returns: A range of CodeBlock objects that are at the address A.

◆ findCodeBlocksAt() [3/4]

code_block_range gtirb::IR::findCodeBlocksAt	(	Addr	Low,
		Addr	High
	)

inline

Find all the code blocks that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of CodeBlock objects that are between the addresses.

◆ findCodeBlocksAt() [4/4]

const_code_block_range gtirb::IR::findCodeBlocksAt	(	Addr	Low,
		Addr	High
	)		const

inline

Find all the code blocks that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of CodeBlock objects that are between the addresses.

◆ findCodeBlocksOn() [1/2]

code_block_subrange gtirb::IR::findCodeBlocksOn ( Addr A )

inline

Find all the code blocks that have bytes that lie within the address specified.

Parameters

A	The address to look up.

Returns: A range of CodeNode object that intersect the address A.

◆ findCodeBlocksOn() [2/2]

const_code_block_subrange gtirb::IR::findCodeBlocksOn ( Addr A ) const

inline

Find all the code blocks that have bytes that lie within the address specified.

Parameters

A	The address to look up.

Returns: A range of CodeNode object that intersect the address A.

◆ findDataBlocksAt() [1/4]

data_block_range gtirb::IR::findDataBlocksAt ( Addr A )

inline

Find all the data blocks that start at an address.

Parameters

A	The address to look up.

Returns: A range of DataBlock objects that are at the address A.

◆ findDataBlocksAt() [2/4]

const_data_block_range gtirb::IR::findDataBlocksAt ( Addr A ) const

inline

Find all the data blocks that start at an address.

Parameters

A	The address to look up.

Returns: A range of DataBlock objects that are at the address A.

◆ findDataBlocksAt() [3/4]

data_block_range gtirb::IR::findDataBlocksAt	(	Addr	Low,
		Addr	High
	)

inline

Find all the data blocks that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of DataBlock objects that are between the addresses.

◆ findDataBlocksAt() [4/4]

const_data_block_range gtirb::IR::findDataBlocksAt	(	Addr	Low,
		Addr	High
	)		const

inline

Find all the data blocks that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of DataBlock objects that are between the addresses.

◆ findDataBlocksOn() [1/2]

data_block_subrange gtirb::IR::findDataBlocksOn ( Addr A )

inline

Find all the data blocks that have bytes that lie within the address specified.

Parameters

A	The address to look up.

Returns: A range of DataNode object that intersect the address A.

◆ findDataBlocksOn() [2/2]

const_data_block_subrange gtirb::IR::findDataBlocksOn ( Addr A ) const

inline

Find all the data blocks that have bytes that lie within the address specified.

Parameters

A	The address to look up.

Returns: A range of DataNode object that intersect the address A.

◆ findModules() [1/2]

module_name_range gtirb::IR::findModules ( const std::string & N )

inline

Find modules by name.

Parameters

N	The name to look up.

Returns: A possibly empty range of all the modules with the given name.

◆ findModules() [2/2]

const_module_name_range gtirb::IR::findModules ( const std::string & N ) const

inline

Find modules by name.

Parameters

N	The name to look up.

Returns: A possibly empty constant range of all the modules with the given name.

◆ findSections() [1/2]

section_name_range gtirb::IR::findSections ( const std::string & X )

inline

Find all the sections containing a name.

Parameters

A	The string name to look up.

Returns: A range of Section objects containing the name.

◆ findSections() [2/2]

const_section_name_range gtirb::IR::findSections ( const std::string & X ) const

inline

Find all the sections containing a name.

Parameters

A	The string name to look up.

Returns: A range of Section objects containing the name.

◆ findSectionsAt() [1/4]

section_range gtirb::IR::findSectionsAt ( Addr A )

inline

Find all the sections that start at an address.

Parameters

A	The address to look up.

Returns: A range of Section objects that are at the address A.

◆ findSectionsAt() [2/4]

const_section_range gtirb::IR::findSectionsAt ( Addr A ) const

inline

Find all the sections that start at an address.

Parameters

A	The address to look up.

Returns: A range of Section objects that are at the address A.

◆ findSectionsAt() [3/4]

section_range gtirb::IR::findSectionsAt	(	Addr	Low,
		Addr	High
	)

inline

Find all the sections that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of Section objects that are between the addresses.

◆ findSectionsAt() [4/4]

const_section_range gtirb::IR::findSectionsAt	(	Addr	Low,
		Addr	High
	)		const

inline

Find all the sections that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of Section objects that are between the addresses.

◆ findSectionsOn() [1/2]

section_subrange gtirb::IR::findSectionsOn ( Addr A )

inline

Find a Section containing an address.

Parameters

A	The address to look up.

Returns: The range of Sections containing the address.

◆ findSectionsOn() [2/2]

const_section_subrange gtirb::IR::findSectionsOn ( Addr A ) const

inline

Find a Section containing an address.

Parameters

A	The address to look up.

Returns: The range of Sections containing the address.

◆ findSymbolicExpressionsAt() [1/4]

symbolic_expression_range gtirb::IR::findSymbolicExpressionsAt ( Addr A )

inline

Find all the symbolic expressions that start at an address.

Parameters

A	The address to look up.

Returns: A range of SymbolicExpression objects that are at the address A.

◆ findSymbolicExpressionsAt() [2/4]

const_symbolic_expression_range gtirb::IR::findSymbolicExpressionsAt ( Addr A ) const

inline

Find all the symbolic expressions that start at an address.

Parameters

A	The address to look up.

Returns: A range of SymbolicExpression objects that are at the address A.

◆ findSymbolicExpressionsAt() [3/4]

symbolic_expression_range gtirb::IR::findSymbolicExpressionsAt	(	Addr	Low,
		Addr	High
	)

inline

Find all the symbolic expressions that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of SymbolicExpression objects that are between the addresses.

◆ findSymbolicExpressionsAt() [4/4]

const_symbolic_expression_range gtirb::IR::findSymbolicExpressionsAt	(	Addr	Low,
		Addr	High
	)		const

inline

Find all the symbolic expressions that start between a range of addresses.

Parameters

Low	The low address, inclusive.
High	The high address, exclusive.

Returns: A range of SymbolicExpression objects that are between the addresses.

◆ getCFG() [1/2]

CFG& gtirb::IR::getCFG ( )

inline

Get a const reference to the associated Control Flow Graph (CFG).

Returns: The associated CFG.

◆ getCFG() [2/2]

const CFG& gtirb::IR::getCFG ( ) const

inline

Get the associated Control Flow Graph (CFG).

Returns: The associated CFG.

◆ getVersion()

uint32_t gtirb::IR::getVersion ( ) const

inline

Get the version of the Protobuf used when creating this IR.

Backwards-incompatible changes to the Protobuf structure of GTIRB cause this verison number to increment.

◆ load()

static ErrorOr<IR*> gtirb::IR::load	(	Context &	C,
		std::istream &	In
	)

static

Deserialize binary format from an input stream.

Parameters

C	The Context in which this IR will be loaded.
In	The input stream.

Returns: The deserialized IR object or an error.

◆ loadJSON()

static ErrorOr<IR*> gtirb::IR::loadJSON	(	Context &	C,
		std::istream &	In
	)

static

Deserialize JSON format from an input stream.

Parameters

C	The Context in which this IR will be loaded.
In	The input stream.

Returns: The deserialized IR object or an error.

◆ modules() [1/2]

module_range gtirb::IR::modules ( )

inline

Returns a range of the Modules.

◆ modules() [2/2]

const_module_range gtirb::IR::modules ( ) const

inline

Returns a constant range of the Modules.

◆ modules_begin() [1/2]

module_iterator gtirb::IR::modules_begin ( )

inline

Returns an iterator to the first Module.

◆ modules_begin() [2/2]

const_module_iterator gtirb::IR::modules_begin ( ) const

inline

Returns a constant iterator to the first Module.

◆ modules_end() [1/2]

module_iterator gtirb::IR::modules_end ( )

inline

Returns an iterator to the element following the last Module.

◆ modules_end() [2/2]

const_module_iterator gtirb::IR::modules_end ( ) const

inline

Returns a constant iterator to the element following the last Module.

◆ proxy_blocks() [1/2]

proxy_block_range gtirb::IR::proxy_blocks ( )

inline

Return a range of all the ProxyBlock objects.

◆ proxy_blocks() [2/2]

const_proxy_block_range gtirb::IR::proxy_blocks ( ) const

inline

Return an iterator to the first ProxyBlock.

◆ proxy_blocks_begin() [1/2]

proxy_block_iterator gtirb::IR::proxy_blocks_begin ( )

inline

Return an iterator to the first ProxyBlock.

◆ proxy_blocks_begin() [2/2]

const_proxy_block_iterator gtirb::IR::proxy_blocks_begin ( ) const

inline

Return an iterator to the first ProxyBlock.

◆ proxy_blocks_end() [1/2]

proxy_block_iterator gtirb::IR::proxy_blocks_end ( )

inline

Return an iterator to the element following the last ProxyBlock.

◆ proxy_blocks_end() [2/2]

const_proxy_block_iterator gtirb::IR::proxy_blocks_end ( ) const

inline

Return an iterator to the element following the last ProxyBlock.

◆ removeModule()

bool gtirb::IR::removeModule ( Module * M )

inline

Remove a Module object located in this IR.

Parameters

S	The Module object to remove.

Returns: Whether or not the operation succeeded. This operation can fail if the node to remove is not actually part of this node to begin with.

◆ save()

void gtirb::IR::save ( std::ostream & Out ) const

Serialize to an output stream in binary format.

Parameters

Out	The output stream.

Returns: void

◆ saveJSON()

void gtirb::IR::saveJSON ( std::ostream & Out ) const

Serialize to an output stream in JSON format.

Parameters

Out	The output stream.

Returns: void

◆ sections() [1/2]

section_range gtirb::IR::sections ( )

inline

Return a range of all the Section objects.

◆ sections() [2/2]

const_section_range gtirb::IR::sections ( ) const

inline

Return a range of all the Section objects.

◆ sections_begin() [1/2]

section_iterator gtirb::IR::sections_begin ( )

inline

Return an iterator to the first Section.

◆ sections_begin() [2/2]

const_section_iterator gtirb::IR::sections_begin ( ) const

inline

Return an iterator to the first Section.

◆ sections_end() [1/2]

section_iterator gtirb::IR::sections_end ( )

inline

Return an iterator to the element following the last Section.

◆ sections_end() [2/2]

const_section_iterator gtirb::IR::sections_end ( ) const

inline

Return an iterator to the element following the last Section.

◆ setVersion()

void gtirb::IR::setVersion ( uint32_t V )

inline

Set the version of the Protobuf used when creating this IR.

Backwards-incompatible changes to the Protobuf structure of GTIRB cause this verison number to increment. This function is useful when, for example, migrating GTIRB from old versions to new versions of the Protobuf format.

◆ symbolic_expressions() [1/2]

symbolic_expression_range gtirb::IR::symbolic_expressions ( )

inline

Return a range of all the SymbolicExpression objects.

◆ symbolic_expressions() [2/2]

const_symbolic_expression_range gtirb::IR::symbolic_expressions ( ) const

inline

Return a range of all the SymbolicExpression objects.

◆ symbolic_expressions_begin() [1/2]

symbolic_expression_iterator gtirb::IR::symbolic_expressions_begin ( )

inline

Return an iterator to the first SymbolicExpression.

◆ symbolic_expressions_begin() [2/2]

const_symbolic_expression_iterator gtirb::IR::symbolic_expressions_begin ( ) const

inline

Return an iterator to the first SymbolicExpression.

◆ symbolic_expressions_end() [1/2]

symbolic_expression_iterator gtirb::IR::symbolic_expressions_end ( )

inline

Return an iterator to the element following the last SymbolicExpression.

◆ symbolic_expressions_end() [2/2]

const_symbolic_expression_iterator gtirb::IR::symbolic_expressions_end ( ) const

inline

Return an iterator to the element following the last SymbolicExpression.

◆ symbols() [1/2]

symbol_range gtirb::IR::symbols ( )

inline

Return a range of the Symbol objects.

◆ symbols() [2/2]

const_symbol_range gtirb::IR::symbols ( ) const

inline

Return a range of the Symbol objects.

◆ symbols_begin() [1/2]

symbol_iterator gtirb::IR::symbols_begin ( )

inline

Return an iterator to the first Symbol.

◆ symbols_begin() [2/2]

const_symbol_iterator gtirb::IR::symbols_begin ( ) const

inline

Return an iterator to the first Symbol.

◆ symbols_end() [1/2]

symbol_iterator gtirb::IR::symbols_end ( )

inline

Return an iterator to the element following the last Symbol.

◆ symbols_end() [2/2]

const_symbol_iterator gtirb::IR::symbols_end ( ) const

inline

Return an iterator to the element following the last Symbol.

Friends And Related Function Documentation

◆ Context

friend class Context

friend

The documentation for this class was generated from the following file:

IR.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Module-Related Public Types and Functions

ProxyBlock-Related Public Types and Functions

Symbol-Related Public Types and Functions

Section-Related Public Types and Functions

ByteInterval-Related Public Types and Functions

Block-Related Public Types and Functions

CodeBlock-Related Public Types and Functions

DataBlock-Related Public Types and Functions

SymbolicExpression-Related Public Types and Functions

Detailed Description

Member Typedef Documentation

◆ block_iterator

◆ block_range

◆ block_subrange

◆ byte_interval_iterator

◆ byte_interval_range

◆ byte_interval_subrange

◆ code_block_iterator

◆ code_block_range

◆ code_block_subrange

◆ const_block_iterator

◆ const_block_range

◆ const_block_subrange

◆ const_byte_interval_iterator

◆ const_byte_interval_range

◆ const_byte_interval_subrange

◆ const_code_block_iterator

◆ const_code_block_range

◆ const_code_block_subrange

◆ const_data_block_iterator

◆ const_data_block_range

◆ const_data_block_subrange

◆ const_module_iterator

◆ const_module_name_iterator

◆ const_module_name_range

◆ const_module_range

◆ const_proxy_block_iterator

◆ const_proxy_block_range

◆ const_section_iterator

◆ const_section_name_iterator

◆ const_section_name_range

◆ const_section_range

◆ const_section_subrange

◆ const_symbol_iterator

◆ const_symbol_range

◆ const_symbolic_expression_iterator

◆ const_symbolic_expression_range

◆ data_block_iterator

◆ data_block_range

◆ data_block_subrange

◆ module_iterator

◆ module_name_iterator

◆ module_name_range

◆ module_range

◆ proxy_block_iterator

◆ proxy_block_range

◆ section_iterator

◆ section_name_iterator

◆ section_name_range

◆ section_range

◆ section_subrange

◆ symbol_iterator

◆ symbol_range

◆ symbolic_expression_iterator

◆ symbolic_expression_range

Member Enumeration Documentation

◆ load_error

Member Function Documentation

◆ addModule() [1/2]

◆ addModule() [2/2]

◆ blocks() [1/2]

◆ blocks() [2/2]

◆ blocks_begin() [1/2]

◆ blocks_begin() [2/2]

◆ blocks_end() [1/2]

◆ blocks_end() [2/2]