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

A generic string constant. More...

#include <const_string.h>

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

Public Types

using UnderlyingCharType = retdec::utils::WideCharType
 Underlying character type. More...
 
using UnderlyingStringType = retdec::utils::WideStringType
 Underlying string type. More...
 
- 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...
 

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...
 
UnderlyingStringType getValue () const
 Returns the constant's value. More...
 
std::string getValueAsEscapedCString () const
 Returns the constant's value as an escaped C string. More...
 
std::size_t getCharSize () const
 Returns how large are characters in the string (in bits). More...
 
bool is8BitString () const
 Is the string an 8-bit string? More...
 
bool isWideString () const
 Is the string a wide string? 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< ConstStringcreate (const UnderlyingStringType &value, std::size_t charSize)
 Constructs a string constant initialized to the given value. More...
 
static ShPtr< ConstStringcreate (const std::string &str)
 Constructs a string constant initialized from the given 8-bit string. 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

 ConstString (const UnderlyingStringType &value, std::size_t charSize)
 Constructs a string constant initialized to the given value. More...
 

Private Attributes

UnderlyingStringType value
 Value. More...
 
std::size_t charSize
 
ShPtr< StringTypetype
 Type. More...
 

Additional Inherited Members

- 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 generic string constant.

It can hold strings with characters of an arbitrary size.

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

Member Typedef Documentation

◆ UnderlyingCharType

Underlying character type.

◆ UnderlyingStringType

Underlying string type.

Constructor & Destructor Documentation

◆ ConstString()

retdec::llvmir2hll::ConstString::ConstString ( const UnderlyingStringType value,
std::size_t  charSize 
)
private

Constructs a string constant initialized to the given value.

See create() for more information.

Member Function Documentation

◆ accept()

void retdec::llvmir2hll::ConstString::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::ConstString::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() [1/2]

ShPtr< ConstString > retdec::llvmir2hll::ConstString::create ( const std::string &  str)
static

Constructs a string constant initialized from the given 8-bit string.

◆ create() [2/2]

ShPtr< ConstString > retdec::llvmir2hll::ConstString::create ( const UnderlyingStringType value,
std::size_t  charSize 
)
static

Constructs a string constant initialized to the given value.

Parameters
[in]valueValue of the constant.
[in]charSizeHow large are characters in the string (in bits)?
Preconditions
  • charSize is 8, 16, or 32

◆ getCharSize()

std::size_t retdec::llvmir2hll::ConstString::getCharSize ( ) const

Returns how large are characters in the string (in bits).

◆ getType()

ShPtr< Type > retdec::llvmir2hll::ConstString::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()

ConstString::UnderlyingStringType retdec::llvmir2hll::ConstString::getValue ( ) const

Returns the constant's value.

◆ getValueAsEscapedCString()

std::string retdec::llvmir2hll::ConstString::getValueAsEscapedCString ( ) const

Returns the constant's value as an escaped C string.

◆ is8BitString()

bool retdec::llvmir2hll::ConstString::is8BitString ( ) const

Is the string an 8-bit string?

◆ isEqualTo()

bool retdec::llvmir2hll::ConstString::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.

◆ isWideString()

bool retdec::llvmir2hll::ConstString::isWideString ( ) const

Is the string a wide string?

◆ replace()

void retdec::llvmir2hll::ConstString::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.

Member Data Documentation

◆ charSize

std::size_t retdec::llvmir2hll::ConstString::charSize
private

◆ type

ShPtr<StringType> retdec::llvmir2hll::ConstString::type
private

Type.

◆ value

UnderlyingStringType retdec::llvmir2hll::ConstString::value
private

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