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

A float constant. More...

#include <const_float.h>

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

Public Types

using Type = llvm::APFloat
 Underlying floating-point 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< retdec::llvmir2hll::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...
 
Type getValue () const
 Returns the constant's value. More...
 
unsigned getSize () const
 Returns the number of bits of the constant's type. More...
 
std::string toString (unsigned precision=0, unsigned maxPadding=0) const
 Converts the constant into a decimal string. More...
 
std::string toMostReadableString () const
 Converts the constant into the most readable decimal representation. More...
 
void flipSign ()
 Flip the sign of value. More...
 
bool isNegative () const
 Determines whether the float constant is negative (< 0). More...
 
bool isNegativeOne () const
 Determines whether the float constant is negative one. More...
 
bool isPositive () const
 Determines whether the float constant is positive (> 0). More...
 
bool isZero () const
 Determines whether the float constant is zero. 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< ConstFloatcreate (Type value)
 Constructs a float constant initialized to the given 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 Types

using ToStringArgs = std::pair< unsigned, unsigned >
 Arguments of toString(). More...
 

Private Member Functions

 ConstFloat (Type value)
 Constructs a float constant initialized to the given value. More...
 
ToStringArgs getToStringArgsForMostReadableString () const
 Returns the arguments for which toString() returns the most readable string. More...
 

Private Attributes

Type value
 Value of the constant. More...
 
ShPtr< FloatTypetype
 Type of the constant. 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 float constant.

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

Member Typedef Documentation

◆ ToStringArgs

using retdec::llvmir2hll::ConstFloat::ToStringArgs = std::pair<unsigned, unsigned>
private

Arguments of toString().

◆ Type

using retdec::llvmir2hll::ConstFloat::Type = llvm::APFloat

Underlying floating-point type.

Constructor & Destructor Documentation

◆ ConstFloat()

retdec::llvmir2hll::ConstFloat::ConstFloat ( Type  value)
explicitprivate

Constructs a float constant initialized to the given value.

See create() for more information.

Member Function Documentation

◆ accept()

void retdec::llvmir2hll::ConstFloat::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::ConstFloat::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< ConstFloat > retdec::llvmir2hll::ConstFloat::create ( Type  value)
static

Constructs a float constant initialized to the given value.

Parameters
[in]valueValue of the constant.

◆ flipSign()

void retdec::llvmir2hll::ConstFloat::flipSign ( )

Flip the sign of value.

◆ getSize()

unsigned retdec::llvmir2hll::ConstFloat::getSize ( ) const

Returns the number of bits of the constant's type.

◆ getToStringArgsForMostReadableString()

ConstFloat::ToStringArgs retdec::llvmir2hll::ConstFloat::getToStringArgsForMostReadableString ( ) const
private

Returns the arguments for which toString() returns the most readable string.

◆ getType()

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

ConstFloat::Type retdec::llvmir2hll::ConstFloat::getValue ( ) const

Returns the constant's value.

◆ isEqualTo()

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

◆ isNegative()

bool retdec::llvmir2hll::ConstFloat::isNegative ( ) const

Determines whether the float constant is negative (< 0).

◆ isNegativeOne()

bool retdec::llvmir2hll::ConstFloat::isNegativeOne ( ) const

Determines whether the float constant is negative one.

◆ isPositive()

bool retdec::llvmir2hll::ConstFloat::isPositive ( ) const

Determines whether the float constant is positive (> 0).

◆ isZero()

bool retdec::llvmir2hll::ConstFloat::isZero ( ) const

Determines whether the float constant is zero.

◆ replace()

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

◆ toMostReadableString()

std::string retdec::llvmir2hll::ConstFloat::toMostReadableString ( ) const

Converts the constant into the most readable decimal representation.

If you want to have a finer control of the resulting form, use toString().

◆ toString()

std::string retdec::llvmir2hll::ConstFloat::toString ( unsigned  precision = 0,
unsigned  maxPadding = 0 
) const

Converts the constant into a decimal string.

The description of this function has been taken from the description of llvm::APFloat::toString().

Parameters
[in]precisionThe maximum number of digits of precision to output. If there are fewer digits available, zero padding will not be used unless the value is integral and small enough to be expressed in precision digits. 0 means to use the natural precision of the number.
[in]maxPaddingThe maximum number of zeros to consider inserting before falling back to scientific notation. 0 means to always use scientific notation.
Number Precision MaxPadding Result
------ --------- ---------- ------
1.01e+4 5 2 10100
1.01e+4 4 2 1.01e+4
1.01e+4 5 1 1.01e+4
1.01e-2 5 2 0.0101
1.01e-2 4 2 0.0101
1.01e-2 4 1 1.01e-2

The resulting string has all characters lowercase.

Member Data Documentation

◆ type

ShPtr<FloatType> retdec::llvmir2hll::ConstFloat::type
private

Type of the constant.

◆ value

Type retdec::llvmir2hll::ConstFloat::value
private

Value of the constant.


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