retdec
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
retdec::llvmir2hll::ConstSymbol Class Referencefinal

A symbolic constant. More...

#include <const_symbol.h>

Inheritance diagram for retdec::llvmir2hll::ConstSymbol:
Inheritance graph
[legend]
Collaboration diagram for retdec::llvmir2hll::ConstSymbol:
Collaboration graph
[legend]

Public Member Functions

virtual ShPtr< Valueclone () override
 Returns a clone of the value. More...
 
virtual bool isEqualTo (ShPtr< Value > otherValue) const override
 Returns true if this value is equal to otherValue, false otherwise. More...
 
virtual ShPtr< TypegetType () const override
 Returns the type of the expression. More...
 
virtual void replace (ShPtr< Expression > oldExpr, ShPtr< Expression > newExpr) override
 Replaces all occurrences of oldExpr with newExpr in the current expression. More...
 
const std::string & getName () const
 Returns the name of the symbolic constant. More...
 
ShPtr< ConstantgetValue () const
 Returns the value of the symbolic constant. More...
 
Visitor Interface
virtual void accept (Visitor *v) override
 Visitor pattern implementation. More...
 
- Public Member Functions inherited from retdec::llvmir2hll::Value
virtual ~Value ()=default
 
virtual ShPtr< ValuegetSelf () override
 Returns a shared pointer of self. More...
 
std::string getTextRepr ()
 Returns a textual representation of the value. More...
 
- Public Member Functions inherited from retdec::llvmir2hll::Metadatable< std::string >
void setMetadata (std::string data)
 Attaches new metadata. More...
 
std::string getMetadata () const
 Returns the attached metadata. More...
 
bool hasMetadata () const
 Are there any non-empty metadata? More...
 
- Public Member Functions inherited from retdec::llvmir2hll::Observer< Value >
 Observer ()=default
 Creates a new observer. More...
 
virtual ~Observer ()=default
 Destructs the observer. More...
 
virtual void update (ShPtr< Value > subject, ShPtr< Value > arg=nullptr)
 Subject has changed its state. More...
 
- Public Member Functions inherited from retdec::llvmir2hll::Subject< Value >
 Subject ()
 Creates a new subject. More...
 
virtual ~Subject ()=default
 Destructs the subject. More...
 
void addObserver (ObserverPtr observer)
 Adds a new observer to the list of observers. More...
 
void removeObserver (ObserverPtr observer)
 Removes the selected observer from the list of observers. More...
 
void removeObservers ()
 Removes all observers. More...
 
void notifyObservers (ShPtr< Value > arg=nullptr)
 Notifies all observers by calling Observer::update() on them. More...
 

Static Public Member Functions

static ShPtr< ConstSymbolcreate (const std::string &name, ShPtr< Constant > value)
 Constructs a symbolic constant with the given name and value. More...
 
- Static Public Member Functions inherited from retdec::llvmir2hll::Expression
static void replaceExpression (ShPtr< Expression > oldExpr, ShPtr< Expression > newExpr)
 Replaces oldExpr with newExpr. More...
 

Private Member Functions

 ConstSymbol (const std::string &name, ShPtr< Constant > value)
 Constructs a symbolic constant. More...
 
void setValue (ShPtr< Constant > newValue)
 Sets a new value of the constant. More...
 

Private Attributes

std::string name
 Name of the constant. More...
 
ShPtr< Constantvalue
 Value of the constant. More...
 

Additional Inherited Members

- Public Types inherited from retdec::llvmir2hll::Subject< Value >
using ConcreteObserver = Observer< Value, Value >
 A concrete observer. More...
 
using ObserverPtr = WkPtr< ConcreteObserver >
 A pointer to an observer. More...
 
- Protected Types inherited from retdec::llvmir2hll::Subject< Value >
using ObserverContainer = std::vector< ObserverPtr >
 A container to store observers. More...
 
using observer_iterator = typename ObserverContainer::const_iterator
 
- Protected Member Functions inherited from retdec::llvmir2hll::Constant
 Constant ()=default
 
- Protected Member Functions inherited from retdec::llvmir2hll::Expression
 Expression ()=default
 
- Protected Member Functions inherited from retdec::llvmir2hll::Value
 Value ()=default
 
- Protected Member Functions inherited from retdec::llvmir2hll::Visitable
 Visitable ()=default
 
 ~Visitable ()=default
 
- Protected Member Functions inherited from retdec::llvmir2hll::Metadatable< std::string >
 Metadatable ()
 Constructs a new metadatable object. More...
 
- Protected Member Functions inherited from retdec::llvmir2hll::Subject< Value >
observer_iterator observer_begin () const
 Returns a constant iterator to the first observer. More...
 
observer_iterator observer_end () const
 Returns a constant iterator past the last observer. More...
 

Detailed Description

A symbolic constant.

Use create() to create instances. Instances of this class have reference object semantics. This class is not meant to be subclassed.

Constructor & Destructor Documentation

◆ ConstSymbol()

retdec::llvmir2hll::ConstSymbol::ConstSymbol ( const std::string &  name,
ShPtr< Constant value 
)
private

Constructs a symbolic constant.

See create() for more information.

Member Function Documentation

◆ accept()

void retdec::llvmir2hll::ConstSymbol::accept ( Visitor v)
overridevirtual

Visitor pattern implementation.

Subclasses should implement this method as:

v->visit(ucast<T>(shared_from_this()));

where T is the name of the subclass, and shared_from_this() and ucast<> are from Decompiler/Support/SmartPtr.h.

Implements retdec::llvmir2hll::Visitable.

◆ clone()

ShPtr< Value > retdec::llvmir2hll::ConstSymbol::clone ( )
overridevirtual

Returns a clone of the value.

A clone is (in most cases) an exact copy of the value. This member function provides the copy mechanism for reference objects.

The following parts of values are not cloned:

  • predecessors and successors of statements

The following subclasses of Value are not cloned, i.e. they are returned without any copying:

Statements in compound statements (i.e. statements where isCompound() returns true) are cloned without their successors; therefore, e.g., just the first statement of every if's clause is cloned.

Implements retdec::llvmir2hll::Value.

◆ create()

ShPtr< ConstSymbol > retdec::llvmir2hll::ConstSymbol::create ( const std::string &  name,
ShPtr< Constant value 
)
static

Constructs a symbolic constant with the given name and value.

Parameters
[in]nameName of the constant
[in]valueValue of the constant.
Preconditions
  • value is non-null

◆ getName()

const std::string & retdec::llvmir2hll::ConstSymbol::getName ( ) const

Returns the name of the symbolic constant.

◆ getType()

ShPtr< Type > retdec::llvmir2hll::ConstSymbol::getType ( ) const
overridevirtual

Returns the type of the expression.

If an appropriate type cannot be detected, UnknownType is returned. This may happen, for example, when a binary operator have its operands of incompatible type.

Implements retdec::llvmir2hll::Expression.

◆ getValue()

ShPtr< Constant > retdec::llvmir2hll::ConstSymbol::getValue ( ) const

Returns the value of the symbolic constant.

◆ isEqualTo()

bool retdec::llvmir2hll::ConstSymbol::isEqualTo ( ShPtr< Value otherValue) const
overridevirtual

Returns true if this value is equal to otherValue, false otherwise.

This member function brings the support of value object semantics into reference objects, namely equality based not only on identity.

This function doesn't consider observers, metadata, etc.

Implements retdec::llvmir2hll::Value.

◆ replace()

void retdec::llvmir2hll::ConstSymbol::replace ( ShPtr< Expression oldExpr,
ShPtr< Expression newExpr 
)
overridevirtual

Replaces all occurrences of oldExpr with newExpr in the current expression.

Parameters
[in]oldExprOld expression to be replaced.
[in]newExprReplacement.

Note that if oldExpr is the current expression on which this function is called, nothing gets replaced, i.e. the replacements are done only in the members of the current expression on which this function is called.

Preconditions
  • oldExpr is non-null

Implements retdec::llvmir2hll::Expression.

◆ setValue()

void retdec::llvmir2hll::ConstSymbol::setValue ( ShPtr< Constant newValue)
private

Sets a new value of the constant.

Preconditions
  • newValue is non-null

Member Data Documentation

◆ name

std::string retdec::llvmir2hll::ConstSymbol::name
private

Name of the constant.

◆ value

ShPtr<Constant> retdec::llvmir2hll::ConstSymbol::value
private

Value of the constant.


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