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

An array constant. More...

#include <const_array.h>

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

Public Types

using ArrayValue = std::vector< ShPtr< Expression > >
 Underlying type of the array's value. More...
 
using init_iterator = ArrayValue::const_iterator
 Initialized array iterator. 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...
 
bool isInitialized () const
 Returns true if the array is initialized, false otherwise. More...
 
bool isEmpty () const
 Returns true if the array is empty, false otherwise. More...
 
ShPtr< TypegetContainedType () const
 Returns the type of items in the array. More...
 
ArrayType::Dimensions getDimensions () const
 Returns the dimensions of the array. More...
 
Initialized Array Accessors
const ArrayValuegetInitializedValue () const
 Returns the value of an initialized array. More...
 
init_iterator init_begin () const
 Returns an iterator to the first item of the initialized array. More...
 
init_iterator init_end () const
 Returns an iterator past the last item of the initialized array. More...
 
Observer Interface
virtual void update (ShPtr< Value > subject, ShPtr< Value > arg=nullptr) override
 Updates the array according to the changes of subject. 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...
 
- 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< ConstArraycreate (ArrayValue value, ShPtr< ArrayType > type)
 Creates an array constant initialized to the given value and type. More...
 
static ShPtr< ConstArraycreateUninitialized (ShPtr< ArrayType > type)
 Creates an uninitialized array constant of the given type. 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

 ConstArray (ArrayValue value, ShPtr< ArrayType > type)
 Constructs an array constant. More...
 

Private Attributes

ArrayValue value
 Value of an initialized array. More...
 
bool initialized
 Is the array initialized? More...
 
ShPtr< ArrayTypetype
 The type of the array. 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

An array constant.

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

Member Typedef Documentation

◆ ArrayValue

Underlying type of the array's value.

◆ init_iterator

using retdec::llvmir2hll::ConstArray::init_iterator = ArrayValue::const_iterator

Initialized array iterator.

Constructor & Destructor Documentation

◆ ConstArray()

retdec::llvmir2hll::ConstArray::ConstArray ( ArrayValue  value,
ShPtr< ArrayType type 
)
private

Constructs an array constant.

See create() or createUninitialized() for more information.

Member Function Documentation

◆ accept()

void retdec::llvmir2hll::ConstArray::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::ConstArray::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< ConstArray > retdec::llvmir2hll::ConstArray::create ( ArrayValue  value,
ShPtr< ArrayType type 
)
static

Creates an array constant initialized to the given value and type.

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

◆ createUninitialized()

ShPtr< ConstArray > retdec::llvmir2hll::ConstArray::createUninitialized ( ShPtr< ArrayType type)
static

Creates an uninitialized array constant of the given type.

Parameters
[in]typeType of the constant.
Preconditions
  • type is non-null

◆ getContainedType()

ShPtr< Type > retdec::llvmir2hll::ConstArray::getContainedType ( ) const

Returns the type of items in the array.

◆ getDimensions()

ArrayType::Dimensions retdec::llvmir2hll::ConstArray::getDimensions ( ) const

Returns the dimensions of the array.

◆ getInitializedValue()

const ConstArray::ArrayValue & retdec::llvmir2hll::ConstArray::getInitializedValue ( ) const

Returns the value of an initialized array.

Preconditions
  • the array is initialized
See also
isInitialized()

◆ getType()

ShPtr< Type > retdec::llvmir2hll::ConstArray::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.

◆ init_begin()

ConstArray::init_iterator retdec::llvmir2hll::ConstArray::init_begin ( ) const

Returns an iterator to the first item of the initialized array.

Preconditions
  • the array is initialized
See also
isInitialized()

◆ init_end()

ConstArray::init_iterator retdec::llvmir2hll::ConstArray::init_end ( ) const

Returns an iterator past the last item of the initialized array.

Preconditions
  • the array is initialized
See also
isInitialized()

◆ isEmpty()

bool retdec::llvmir2hll::ConstArray::isEmpty ( ) const

Returns true if the array is empty, false otherwise.

If the array is uninitialized, it needs to have no dimensions in order for this function to return true.

◆ isEqualTo()

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

◆ isInitialized()

bool retdec::llvmir2hll::ConstArray::isInitialized ( ) const

Returns true if the array is initialized, false otherwise.

◆ replace()

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

◆ update()

void retdec::llvmir2hll::ConstArray::update ( ShPtr< Value subject,
ShPtr< Value arg = nullptr 
)
overridevirtual

Updates the array according to the changes of subject.

Parameters
[in]subjectObservable object.
[in]argOptional argument.

It replaces subject with

  • . For example, if subject is an expression in the array, this function replaces it with arg.

This function does nothing when:

  • subject does not correspond to any expression in the array
  • arg is not an expression
Preconditions
  • both subject and arg are non-null
See also
Subject::update()

Reimplemented from retdec::llvmir2hll::Observer< Value >.

Member Data Documentation

◆ initialized

bool retdec::llvmir2hll::ConstArray::initialized
private

Is the array initialized?

◆ type

ShPtr<ArrayType> retdec::llvmir2hll::ConstArray::type
private

The type of the array.

◆ value

ArrayValue retdec::llvmir2hll::ConstArray::value
private

Value of an initialized array.


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