libsswf: sswf::Data Class Reference

Referenced by sswf::TagScalingGrid::GridSave(), sswf::TagHeader::Load(), sswf::TagProtect::ParseTag(), sswf::TagFrameLabel::ParseTag(), sswf::TagBinaryData::ParseTag(), sswf::TagFont::PreSave2ndPass(), sswf::TagText::Save(), sswf::TagSprite::Save(), sswf::TagSound::Save(), sswf::TagStartSound::Save(), sswf::TagShape::Save(), sswf::TagPlace::Save(), sswf::TagImport::Save(), sswf::TagImage::Save(), sswf::TagHeader::Save(), sswf::TagFont::Save(), sswf::TagExport::Save(), sswf::TagEditText::Save(), sswf::TagDoAction::Save(), sswf::TagButton::Save(), sswf::Action::Save(), sswf::ActionWith::SaveData(), sswf::ActionTry::SaveData(), sswf::ActionFunction::SaveData(), and sswf::Action::SaveList().

References f_data, f_pos, f_size, and sswf::MemoryManager::MemRealloc().

Referenced by Append(), Write(), and WriteBits().

void Data::Align ( void )

Whenever writing an SWF movie, it is most often compressed on bytes and quite often on bits. Whenever bits are used to save one structure (such as a rectangle), the following data which are aligned on a byte need to appear on a byte.

This function ensures that this is indeed the case.

This function can safely be called multiple times in a raw. The position will be adjusted only the first time and only if necessary.

References f_pos.

Referenced by Append(), sswf::TagFont::PreSave2ndPass(), Read(), sswf::Matrix::Save(), sswf::ColorTransform::Save(), sswf::TagText::Save(), sswf::TagShape::Save(), sswf::TagHeader::Save(), sswf::TagFont::Save(), sswf::TagEditText::Save(), sswf::Style::Save(), and Write().

void Data::Append ( const Data & data )

This function appends a Data buffer to this Data buffer.

The source Data buffer is not modified.

The destination is first aligned with a call to Align(). The buffer is grown as required, then the source is copied at the end of the destination.

Parameters:

[in]

data

The source Data buffer

References AdjustSize(), Align(), f_data, and f_pos.

Referenced by sswf::TagScalingGrid::GridSave(), sswf::TagText::Save(), sswf::TagSprite::Save(), sswf::TagSound::Save(), sswf::TagStartSound::Save(), sswf::TagShape::Save(), sswf::TagPlace::Save(), sswf::TagImport::Save(), sswf::TagImage::Save(), sswf::TagHeader::Save(), sswf::TagFont::Save(), sswf::TagExport::Save(), sswf::TagEditText::Save(), sswf::TagDoAction::Save(), sswf::TagButton::Save(), sswf::Action::Save(), sswf::ActionTry::SaveData(), and sswf::TagShape::SaveWithoutStyles().

sswf::Data::ByteSize ( void ) const [inline]

Returns the size of the buffer in bytes. The exact size of the buffer is in bits. The byte size is the bit size rounded up.

Returns:: The size of the buffer in bytes

References f_pos.

sswf::Data::Empty ( void ) [inline]

This function marks the Data buffer as empty.

All the data previously saved in this buffer is lost.

References f_limit, f_pos, and f_rpos.

Referenced by sswf::TagHeader::Load(), sswf::TagFont::PreSave2ndPass(), sswf::TagPlace::Save(), sswf::TagFont::Save(), and sswf::TagButton::Save().

ErrorManager::error_code_t Data::GetBits	(	int &	value,
		size_t	bits
	)			const

This function reads the specified number of bits from the current position.

References sswf::assert(), sswf::ErrorManager::ERROR_CODE_NONE, sswf::ErrorManager::ERROR_CODE_NOT_ENOUGH_DATA, f_data, f_limit, f_pos, and f_rpos.

Referenced by sswf::Matrix::Parse(), sswf::ColorTransform::Parse(), sswf::SRectangle::Parse(), sswf::ActionTry::ParseData(), sswf::TagFont::ParseTag(), and sswf::TagCSMTextSettings::ParseTag().

ErrorManager::error_code_t Data::GetByte ( uint8_t & c ) const

This function reads one byte from this data buffer.

Parameters:

[in]

c

The new read position for the Get...() functions in bits

Returns:: An error (buffer overflow) or NONE.

References sswf::assert(), sswf::ErrorManager::ERROR_CODE_NONE, sswf::ErrorManager::ERROR_CODE_NOT_ENOUGH_DATA, f_data, f_limit, f_pos, f_rpos, and ReadAlign().

ErrorManager::error_code_t Data::GetByte ( int8_t & c ) const

This function reads one byte from this data buffer.

Parameters:

[in]

c

The new read position for the Get...() functions in bits

Returns:: An error (buffer overflow) or NONE.

Referenced by GetDLong(), GetLong(), GetShort(), GetShortFloat(), GetString(), sswf::Color::Parse(), sswf::State::Parse(), sswf::BlendMode::Parse(), sswf::Action::Parse(), sswf::ActionWaitForFrame::ParseData(), sswf::ActionURL::ParseData(), sswf::ActionTry::ParseData(), sswf::ActionStrictMode::ParseData(), sswf::ActionStoreRegister::ParseData(), sswf::ActionPushData::ParseData(), sswf::ActionFunction::ParseData(), sswf::TagFont::ParseTag(), sswf::TagEditText::ParseTag(), and sswf::TagButton::ParseTag().

ErrorManager::error_code_t Data::GetDLong ( uint64_t & l ) const

This function reads one long (32 bit integer) from this data buffer.

Parameters:

[in]

l

The long value read

Returns:: An error (buffer overflow) or NONE.

References sswf::ErrorManager::ERROR_CODE_NONE, and GetByte().

ErrorManager::error_code_t Data::GetDLong ( int64_t & l ) const

This function reads one long (32 bit integer) from this data buffer.

Parameters:

[in]

l

The long value read

Returns:: An error (buffer overflow) or NONE.

References sswf::ErrorManager::ERROR_CODE_NONE, and GetByte().

Referenced by GetDoubleFloat().

ErrorManager::error_code_t Data::GetDoubleFloat ( double & f ) const

This function reads one double float (64 bit floating point number) from this data buffer.

Bug:: Note that the double float values saved in a PushData action are NOT loaded with this function. Those doubles are saved swapped instead and thus the PushData class takes care of loading the double floats as required.

Parameters:

[in]

f

The double value read

Returns:: An error (buffer overflow) or NONE.

References GetDLong().

ErrorManager::error_code_t Data::GetLong ( uint32_t & l ) const

This function reads one long (32 bit integer) from this data buffer.

Parameters:

[in]

l

The long value read

Returns:: An error (buffer overflow) or NONE.

References sswf::ErrorManager::ERROR_CODE_NONE, and GetByte().

ErrorManager::error_code_t Data::GetLong ( int32_t & l ) const

This function reads one long (32 bit integer) from this data buffer.

Parameters:

[in]

l

The long value read

Returns:: An error (buffer overflow) or NONE.

References sswf::ErrorManager::ERROR_CODE_NONE, and GetByte().

Referenced by GetLongFloat(), sswf::ActionPushData::ParseData(), and sswf::TagBinaryData::ParseTag().

ErrorManager::error_code_t Data::GetLongFloat ( float & f ) const

This function reads one long float (32 bit floating point number) from this data buffer.

Parameters:

[in]

f

The float value read

Returns:: An error (buffer overflow) or NONE.

References GetLong().

Referenced by sswf::ActionPushData::ParseData(), and sswf::TagCSMTextSettings::ParseTag().

size_t Data::GetReadPosition ( void ) const

This function retrieves the current pointer used by the different Get...() functions.

The pointer is defined as a bit position.

At the start, the position is set to 0.

Returns:: The current read position for the Get...() functions in bits

References f_rpos.

Referenced by sswf::Action::Parse().

ErrorManager::error_code_t Data::GetShort ( uint16_t & s ) const

This function reads one short (16 bit integer) from this data buffer.

Parameters:

[in]

s

The short value read

Returns:: An error (buffer overflow) or NONE.

References sswf::ErrorManager::ERROR_CODE_NONE, and GetByte().

ErrorManager::error_code_t Data::GetShort ( int16_t & s ) const

This function reads one short (16 bit integer) from this data buffer.

Parameters:

[in]

s

The short value read

Returns:: An error (buffer overflow) or NONE.

References sswf::ErrorManager::ERROR_CODE_NONE, and GetByte().

ErrorManager::error_code_t Data::GetShortFloat ( float & f ) const

This function reads one float (16 bit floating point number) from this data buffer.

Parameters:

[in]

f

The float value read

Returns:: An error (buffer overflow) or NONE.

References sswf::ErrorManager::ERROR_CODE_NONE, and GetByte().

Referenced by sswf::TagShape::ParseAlignZone().

sswf::Data::GetSize ( void ) const [inline]

Returns the size of the buffer in bits. This is the exact position in the buffer.

In general, one needs to call ByteSize() instead.

Returns:: The size of the buffer in bits

References f_pos.

Referenced by sswf::Action::Save(), and sswf::ActionTry::SaveData().

ErrorManager::error_code_t Data::GetString	(	MemoryManager *	mem,
		int	l,
		char **	str
	)			const

This function reads a null terminated string.

By default 99% of the strings in Flash are null terminated, thus, by default this function expects to read a null terminated string.

The l parameter is the expected size of the string. Set to 0 if the string length isn't known.

If the string has a specific size and is not expected to be null terminated, set l to '-<string size>'.

This function will manage the string buffer. If the pointer is not null, then it will be freed with a call to MemClean().

Note:: When l is positive, it MUST include the null terminator. So if you have a string of 3 characters, l is expected to be 4.

: To the contrary, when l is negative, it is expected to NOT include the null terminator. This function then adds 1 to the length of the allocated string.

Parameters:

[in]	mem	An object with a memory manager to be used to allocate the string
[in]	l	The expected length of the string
[in]	str	Pointer to the string pointer

Returns:: An error or ERROR_CODE_NONE.

References sswf::ErrorManager::ERROR_CODE_BAD_STRING, sswf::ErrorManager::ERROR_CODE_NONE, GetByte(), sswf::MemoryManager::MemAlloc(), sswf::MemoryManager::MemClean(), and sswf::MemoryManager::MemRealloc().

Referenced by sswf::ActionURL::ParseData(), sswf::ActionTry::ParseData(), sswf::ActionSetTarget::ParseData(), sswf::ActionPushData::ParseData(), sswf::ActionGoto::ParseData(), sswf::ActionFunction::ParseData(), sswf::ActionDictionary::ParseData(), sswf::TagProtect::ParseTag(), sswf::TagFont::ParseTag(), sswf::TagExport::ParseTag(), and sswf::TagEditText::ParseTag().

bool Data::IsEndOfData ( void ) const

This function checks whether the Read & Get functions reached the end of the Data buffer. If a limit is currently imposed, this function returns true if that limit was reached. In other words, there could still be data available after the limit is left off.

Returns:: true if the end of the current Data limit was reached

References f_limit, f_pos, and f_rpos.

Referenced by sswf::ActionPushData::ParseData(), sswf::Action::ParseList(), and sswf::TagButton::ParseTag().

unsigned long Data::Limit	(	unsigned long	limit,
		bool	offset
	)			const

This function limits the size of the data the following Get...() function calls can make until they fail with an End of File reached error.

The function returns the current limit which you need to restore once you are done with your read.

Please, in C++, make use of the RAII DataLimit class instead. It ensures that the limit is automatically reset to the previous value for you.

Note:: This function does NOT affect the ReadBytes() function.

Exceptions:

OutOfBoundsErrorException

is raised if the limit is more than the current size of the Data buffer.

Parameters:

[in]	limit	The new limit in bits. Set to zero (0) to reset.
[in]	offset	Whether the limit is an offset from the current position.

Returns:: The limit before the call.

References f_limit, f_pos, and f_rpos.

Referenced by sswf::Data::DataLimit::Restore().

void Data::Overwrite	(	size_t	offset,
		const void *	ptr,
		size_t	size
	)

This function is used to overwrite data at offset on size bytes with the data pointed by ptr. This function will not enlarge the Data buffer and thus is must be used to overwrite only.

See also:

References sswf::assert(), f_data, and f_pos.

void Data::OverwriteByte	(	size_t	offset,
		char	c
	)

This function is used to overwrite one byte at the specified offset. This function will not enlarge the Data buffer and thus is must be used to overwrite only.

See also:

References sswf::assert(), f_data, and f_pos.

void Data::OverwriteLong	(	size_t	offset,
		long	l
	)

This function is used to overwrite one long at the specified offset (i.e. 4 bytes). This function will not enlarge the Data buffer and thus is must be used to overwrite only.

The long value is saved in little endian (least significant byte first.)

See also:

References sswf::assert(), f_data, and f_pos.

void Data::OverwriteShort	(	size_t	offset,
		short	s
	)

This function is used to overwrite one short at the specified offset. This function will not enlarge the Data buffer and thus is must be used to overwrite only.

The short value is saved in little endian (least significant byte first.)

See also:

References sswf::assert(), f_data, and f_pos.

Referenced by sswf::TagSprite::Save(), and sswf::ActionBranch::Save2ndPass().

void Data::PutByte ( char c )

This is a convenient function used to save one byte in the Data buffer.

This function implicitly calls Align().

Parameters:

[in]

c

The byte to save

See also:

Referenced by PutDLong(), PutLong(), PutShort(), PutString(), sswf::Color::Save(), sswf::TagText::Save(), sswf::SoundInfo::Save(), sswf::TagShape::Save(), sswf::TagSetBackgroundColor::Save(), sswf::TagPlace::Save(), sswf::TagProductInfo::Save(), sswf::TagImport::Save(), sswf::TagImage::Save(), sswf::TagHeader::Save(), sswf::TagFrameLabel::Save(), sswf::TagFont::Save(), sswf::TagEditText::Save(), sswf::TagButton::Save(), sswf::State::Save(), sswf::Style::Save(), sswf::BlendMode::Save(), sswf::Action::Save(), sswf::TagCSMTextSettings::SaveCSMTextSettings(), sswf::ActionWaitForFrame::SaveData(), sswf::ActionURL::SaveData(), sswf::ActionTry::SaveData(), sswf::ActionStrictMode::SaveData(), sswf::ActionStoreRegister::SaveData(), sswf::ActionPushData::SaveData(), sswf::ActionFunction::SaveData(), sswf::TagHeader::SaveEncodedString(), sswf::Action::SaveList(), sswf::TagShape::SaveStyles(), sswf::TagShape::SaveStylesCount(), sswf::TagShape::SaveWithoutStyles(), and sswfWriteData().

References Write().

void Data::PutDLong ( int64_t ll )

This is a convenient function used to save one 64 bits long in the Data buffer.

The long least significant byte is saved first.

This function implicitly calls Align().

Parameters:

[in]

ll

The 64 bits long to save

See also:

References PutByte().

Referenced by PutDoubleFloat(), and sswf::TagProductInfo::Save().

void Data::PutDoubleFloat ( double d )

This is a convenient function used to save a 64 bits floating point.

Bug:: Note that the double float values saved in a PushData action are NOT saved with this function. Those doubles are saved swapped instead and thus the PushData class takes care of saving the double floats as required.

Parameters:

[in]

d

The floating point to save

See also:

References PutDLong().

void Data::PutLong ( long l )

This is a convenient function used to save one long in the Data buffer.

The long least significant byte is saved first.

This function implicitly calls Align().

Parameters:

[in]

l

The long to save

See also:

References PutByte().

Referenced by PutLongFloat(), sswf::TagSound::Save(), sswf::SoundInfo::Save(), sswf::Envelope::Save(), sswf::TagShape::Save(), sswf::TagPlace::Save(), sswf::TagInfo::Save(), sswf::TagProductInfo::Save(), sswf::TagImage::Save(), sswf::TagHeader::Save(), sswf::TagBinaryData::Save(), sswf::ActionPushData::SaveData(), and sswf::TagBase::SaveTag().

void Data::PutLongFloat ( float f )

This is a convenient function used to save a 32 bits floating point.

Parameters:

[in]

f

The floating point to save

See also:

References PutLong().

Referenced by sswf::TagCSMTextSettings::SaveCSMTextSettings().

void Data::PutShort ( short s )

This is a convenient function used to save one short in the Data buffer.

The short least significant byte is saved first.

This function implicitly calls Align().

Parameters:

[in]

s

The short to save

See also:

Referenced by sswf::TagScalingGrid::GridSave(), PutShortFloat(), sswf::TagText::Save(), sswf::TagSprite::Save(), sswf::TagSound::Save(), sswf::SoundInfo::Save(), sswf::Envelope::Save(), sswf::TagSetTabIndex::Save(), sswf::TagScriptLimits::Save(), sswf::TagRemove::Save(), sswf::TagProtect::Save(), sswf::TagPlace::Save(), sswf::TagImport::Save(), sswf::TagImage::Save(), sswf::TagHeader::Save(), sswf::TagFont::Save(), sswf::TagExport::Save(), sswf::TagEditText::Save(), sswf::TagDoAction::Save(), sswf::TagButton::Save(), sswf::State::Save(), sswf::Style::Save(), sswf::Action::Save(), sswf::ActionWith::SaveData(), sswf::ActionWaitForFrame::SaveData(), sswf::ActionTry::SaveData(), sswf::ActionPushData::SaveData(), sswf::ActionGoto::SaveData(), sswf::ActionFunction::SaveData(), sswf::ActionDictionary::SaveData(), sswf::ActionBranch::SaveData(), sswf::TagBaseID::SaveID(), sswf::TagShape::SaveStylesCount(), and sswf::TagBase::SaveTag().

References PutByte().

void Data::PutShortFloat ( float f )

This is a convenient function used to save a floating point on 16 bits. This is not a fixed point value, it really is a floating point defined as:

1 bit of sign
5 bits of exponent
10 bits of mantissa

Bug:: This function assumes that the input floating point is a valid number, not a NaN. Your SWF will work better that way anyway.

Parameters:

[in]

f

The floating point to convert and save

See also:

References PutShort().

Referenced by sswf::TagShape::SaveAlignZone().

void Data::PutString ( const char * string )

This is a convenient function used to save a string in the Data buffer.

It is valid to call the function with a NULL pointer. It is considered to be an empty string and just one zero byte is written.

Otherwise, strlen(string) + 1 bytes are saved (i.e. the string characters and the nul terminator.)

This function implicitly calls Align().

Parameters:

[in]

string

The string to save

See also: