ROSE  0.9.9.109
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm Class Reference

Description

UTF-8 character encoding form.

Encodes each code point as one to six 8-bit code values.

Definition at line 282 of file BinaryString.h.

#include <BinaryString.h>

Inheritance diagram for Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm:
Inheritance graph
[legend]
Collaboration diagram for Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm:
Collaboration graph
[legend]

Public Types

typedef Sawyer::SharedPointer< Utf8CharacterEncodingFormPtr
 Shared-ownership pointer to a Utf8CharacterEncodingForm. More...
 
- Public Types inherited from Rose::BinaryAnalysis::Strings::CharacterEncodingForm
typedef Sawyer::SharedPointer< CharacterEncodingFormPtr
 Shared ownership pointer to a CharacterEncodingForm. More...
 

Public Member Functions

virtual CharacterEncodingForm::Ptr clone () const ROSE_OVERRIDE
 Create a new encoder from this one. More...
 
virtual std::string name () const ROSE_OVERRIDE
 Name of encoder. More...
 
virtual CodeValues encode (CodePoint cp) ROSE_OVERRIDE
 Encode a code point into a sequence of one or more code values. More...
 
virtual State decode (CodeValue) ROSE_OVERRIDE
 Decode one code value. More...
 
virtual CodePoint consume () ROSE_OVERRIDE
 Consume a decoded code point. More...
 
virtual void reset () ROSE_OVERRIDE
 Reset the decoder state machine. More...
 
- Public Member Functions inherited from Rose::BinaryAnalysis::Strings::CharacterEncodingForm
State state () const
 Decoder state. More...
 
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor. More...
 
 SharedObject (const SharedObject &)
 Copy constructor. More...
 
virtual ~SharedObject ()
 Virtual destructor. More...
 
SharedObjectoperator= (const SharedObject &)
 Assignment. More...
 

Static Public Member Functions

static Ptr instance ()
 

Additional Inherited Members

- Protected Attributes inherited from Rose::BinaryAnalysis::Strings::CharacterEncodingForm
State state_
 

Member Typedef Documentation

Shared-ownership pointer to a Utf8CharacterEncodingForm.

See Shared ownership.

Definition at line 288 of file BinaryString.h.

Member Function Documentation

virtual CharacterEncodingForm::Ptr Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm::clone ( ) const
inlinevirtual

Create a new encoder from this one.

Implements Rose::BinaryAnalysis::Strings::CharacterEncodingForm.

Definition at line 291 of file BinaryString.h.

virtual std::string Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm::name ( ) const
inlinevirtual

Name of encoder.

Implements Rose::BinaryAnalysis::Strings::CharacterEncodingForm.

Definition at line 292 of file BinaryString.h.

virtual CodeValues Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm::encode ( CodePoint  )
virtual

Encode a code point into a sequence of one or more code values.

For instance, an ecoder for UTF-16 will encode a code point into one or more values in the range 0 through (2^16)-1.

Implements Rose::BinaryAnalysis::Strings::CharacterEncodingForm.

virtual State Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm::decode ( CodeValue  )
virtual

Decode one code value.

Processes a single code value and updates the decoder state machine. Returns the decoder's new state. See documentation for State for restrictions on state transitions.

Implements Rose::BinaryAnalysis::Strings::CharacterEncodingForm.

virtual CodePoint Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm::consume ( )
virtual

Consume a decoded code point.

The decoder must be in the FINAL_STATE or COMPLETED_STATE, and upon return will be in the INITIAL_STATE.

Implements Rose::BinaryAnalysis::Strings::CharacterEncodingForm.

virtual void Rose::BinaryAnalysis::Strings::Utf8CharacterEncodingForm::reset ( )
virtual

Reset the decoder state machine.

Implements Rose::BinaryAnalysis::Strings::CharacterEncodingForm.


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