ROSE  0.11.87.0
Public Member Functions | Protected Attributes | List of all members
Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter Class Reference

Description

Format for printing things.

Some semantic domains may want to pass some additional information to print methods on a per-call basis. This base class provides something they can subclass to do that. A reference is passed to all print() methods for semantic objects.

Definition at line 16 of file Formatter.h.

#include <Rose/BinaryAnalysis/InstructionSemantics2/BaseSemantics/Formatter.h>

Inheritance diagram for Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter:
Inheritance graph
[legend]
Collaboration diagram for Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter:
Collaboration graph
[legend]

Public Member Functions

const RegisterDictionaryget_register_dictionary () const ROSE_DEPRECATED("use registerDictionary property")
 
void set_register_dictionary (const RegisterDictionary *rd) ROSE_DEPRECATED("use registerDictionary property")
 
const RegisterDictionaryregisterDictionary () const
 Property: Register dictionary. More...
 
void registerDictionary (const RegisterDictionary *rd)
 Property: Register dictionary. More...
 
bool get_suppress_initial_values () const
 Whether register initial values should be suppressed. More...
 
void set_suppress_initial_values (bool b=true)
 Whether register initial values should be suppressed. More...
 
void clear_suppress_initial_values ()
 Whether register initial values should be suppressed. More...
 
std::string get_line_prefix () const
 The string to print at the start of each line. More...
 
void set_line_prefix (const std::string &s)
 The string to print at the start of each line. More...
 
std::string get_indentation_suffix () const
 Indentation string appended to the line prefix for multi-level, multi-line outputs.
 
void set_indentation_suffix (const std::string &s)
 Indentation string appended to the line prefix for multi-level, multi-line outputs.
 
bool get_show_latest_writers () const
 Whether to show latest writer information for register and memory states.
 
void set_show_latest_writers (bool b=true)
 Whether to show latest writer information for register and memory states.
 
void clear_show_latest_writers ()
 Whether to show latest writer information for register and memory states.
 
bool get_show_properties () const
 Whether to show register properties.
 
void set_show_properties (bool b=true)
 Whether to show register properties.
 
void clear_show_properties ()
 Whether to show register properties.
 

Protected Attributes

const RegisterDictionaryregdict
 
bool suppress_initial_values
 
std::string line_prefix
 
std::string indentation_suffix
 
bool show_latest_writers
 
bool show_properties
 

Member Function Documentation

const RegisterDictionary* Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter::registerDictionary ( ) const
inline

Property: Register dictionary.

The register dictionary which is used for printing register names.

Definition at line 27 of file Formatter.h.

void Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter::registerDictionary ( const RegisterDictionary rd)
inline

Property: Register dictionary.

The register dictionary which is used for printing register names.

Definition at line 30 of file Formatter.h.

bool Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter::get_suppress_initial_values ( ) const
inline

Whether register initial values should be suppressed.

If a register's value has a comment that is equal to the register name with "_0" appended, then that value is assumed to be the register's initial value.

Definition at line 48 of file Formatter.h.

void Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter::set_suppress_initial_values ( bool  b = true)
inline

Whether register initial values should be suppressed.

If a register's value has a comment that is equal to the register name with "_0" appended, then that value is assumed to be the register's initial value.

Definition at line 49 of file Formatter.h.

Referenced by clear_suppress_initial_values().

void Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter::clear_suppress_initial_values ( )
inline

Whether register initial values should be suppressed.

If a register's value has a comment that is equal to the register name with "_0" appended, then that value is assumed to be the register's initial value.

Definition at line 50 of file Formatter.h.

References set_suppress_initial_values().

std::string Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter::get_line_prefix ( ) const
inline

The string to print at the start of each line.

This only applies to objects that occupy more than one line.

Definition at line 55 of file Formatter.h.

void Rose::BinaryAnalysis::InstructionSemantics2::BaseSemantics::Formatter::set_line_prefix ( const std::string &  s)
inline

The string to print at the start of each line.

This only applies to objects that occupy more than one line.

Definition at line 56 of file Formatter.h.


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