Configuration information for a function.
Definition at line 128 of file Config.h.
#include <Rose/BinaryAnalysis/Partitioner2/Config.h>
| Sawyer::Optional<rose_addr_t> Rose::BinaryAnalysis::Partitioner2::FunctionConfig::address |
( |
| ) |
const |
|
inline |
Property: address.
A function configuration has an optional address which is read-only, initialized by the constructor. The return value can be used in a boolean context to test whether the address is present and dereferenced to get the address. The Sawyer::Optional class has a number of other useful methods, such as getOrElse and assignTo:
FunctionConfig fconfig;
if (fconfig.address())
std::cout <<
address is
" <<*fconfig.address() <<"\n
";std::cout <<"address is
" <<fconfig.address().orElse(0) <<"\n
";
rose_addr_t va = 0;
if (fconfig.address().assignTo(va))
std::cout <<"address is
" <<va <<"\n
";
Definition at line 162 of file Config.h.
| const std::string& Rose::BinaryAnalysis::Partitioner2::FunctionConfig::name |
( |
| ) |
const |
|
inline |
Property: name.
This is the name to use for the function regardless of what name has been given to this function's address by the ELF/PE container, symbol tables, etc. The name is read-only if the config has no address.
- See also
- defaultName
Definition at line 172 of file Config.h.
| FunctionConfig& Rose::BinaryAnalysis::Partitioner2::FunctionConfig::name |
( |
const std::string & |
s | ) |
|
Property: name.
This is the name to use for the function regardless of what name has been given to this function's address by the ELF/PE container, symbol tables, etc. The name is read-only if the config has no address.
- See also
- defaultName
| const std::string& Rose::BinaryAnalysis::Partitioner2::FunctionConfig::defaultName |
( |
| ) |
const |
|
inline |
Property: default name.
This is the name to use for a function if it hasn't been given a name by any other means.
Definition at line 181 of file Config.h.
| FunctionConfig& Rose::BinaryAnalysis::Partitioner2::FunctionConfig::defaultName |
( |
const std::string & |
s | ) |
|
|
inline |
Property: default name.
This is the name to use for a function if it hasn't been given a name by any other means.
Definition at line 182 of file Config.h.
| const std::string& Rose::BinaryAnalysis::Partitioner2::FunctionConfig::comment |
( |
| ) |
const |
|
inline |
Property: comment.
A function may have a multi-line, plain-text, ASCII comment.
Definition at line 190 of file Config.h.
| FunctionConfig& Rose::BinaryAnalysis::Partitioner2::FunctionConfig::comment |
( |
const std::string & |
s | ) |
|
|
inline |
Property: comment.
A function may have a multi-line, plain-text, ASCII comment.
Definition at line 191 of file Config.h.
| Sawyer::Optional<int64_t> Rose::BinaryAnalysis::Partitioner2::FunctionConfig::stackDelta |
( |
| ) |
const |
|
inline |
Property: stack delta.
The stack delta is a numeric value that indicates the net effect this function has on the stack pointer. If a stack delta is specified then it will be used instead of performing a stack delta analysis.
This is an optional property; see address for typical uses of the return value. The stack delta can be set by passing a signed value, and cleared by passing Sawyer::Nothing:
FunctionConfig fconfig;
fconfig.stackDelta(4);
Definition at line 216 of file Config.h.
Property: stack delta.
The stack delta is a numeric value that indicates the net effect this function has on the stack pointer. If a stack delta is specified then it will be used instead of performing a stack delta analysis.
This is an optional property; see address for typical uses of the return value. The stack delta can be set by passing a signed value, and cleared by passing Sawyer::Nothing:
FunctionConfig fconfig;
fconfig.stackDelta(4);
Definition at line 217 of file Config.h.
| Sawyer::Optional<bool> Rose::BinaryAnalysis::Partitioner2::FunctionConfig::mayReturn |
( |
| ) |
const |
|
inline |
Property: may-return.
This property specifies whether the function might return to its caller. If the function might return, the value should be true; if the function cannot possibly return then the value is false; indeterminate values indicate that a may-return analysis should be performed.
Be careful using this return value: the return value is a SawyerOptional, which when evaluated in a boolean context will tell you whether a may-return value is present, not what that value is! In order to get the value, if present, you'll need to either dereference the return value or call something like orElse or assignTo.
Definition at line 231 of file Config.h.
Property: may-return.
This property specifies whether the function might return to its caller. If the function might return, the value should be true; if the function cannot possibly return then the value is false; indeterminate values indicate that a may-return analysis should be performed.
Be careful using this return value: the return value is a SawyerOptional, which when evaluated in a boolean context will tell you whether a may-return value is present, not what that value is! In order to get the value, if present, you'll need to either dereference the return value or call something like orElse or assignTo.
Definition at line 232 of file Config.h.
The documentation for this class was generated from the following file:
