libsswf: sswf Namespace Reference

This typedef is used anywhere a frame needs to be defined by number. The very first frame in a movie is frame 0. The very last frame is to the total number of frames minus one.

Note that there are frames within a sswf::TagSprite. Similarly, the very first frame starts at 0 and the last is the number of frames in that sprite minus one.

See also:

sswf::TagHeader

sswf::TagSprite

sswf::ActionCallFrame

Definitions in an SWF animation are given an identifier which can later be used to reference the definition. For instance, you create a sswf::TagSprite, assign it identifier 5, and later you display the sswf::TagSprite using a sswf::TagPlace and referencing the sswf::TagSprite number 5.

See also:

class sswf::TagBaseID

class sswf::TagSprite

class sswf::TagPlace

This type is used to represent UCS-4 strings. The wchar_t cannot be used since on some systems it is only 16 bits (and can therefore only represent UCS-2 or UTF-16).

The SSWF library supports functions to convert strings from UCS-4 to UTF-8 and vice versa.

See also:

int sswf::wctomb(const sswf_ucs4_t *wc, size_t wc_len, char *mb, size_t& mb_size)

int sswf::mbtowc(const char *mb, size_t mb_len, sswf_ucs4_t *& wc, size_t& wc_len)

char *sswfwcname(sswf_ucs4_t wc, char *result)

long sswf::wcslen(sswf_ucs4_t *wcstr)

typedef unsigned int wint_t;

This function is used to assert() when 'cond' is true.

The function prints out the message defined by format and optional parameters (as in a printf(3) call) and then it exists the process with a call to abort(3).

The function only works in debug mode. In release mode (or non-debug at least) it is transformed into a do nothing inline function.

Parameters:

	cond	A true (i.e. do nothing) or false (abort the process) condition
	format	A format string as in a printf(3)
	...	Optional parameter to the format string message

Referenced by sswf::Action::Action(), sswf::ActionBranch::ActionBranch(), sswf::ActionFunction::ActionFunction(), sswf::ActionGoto::ActionGoto(), sswf::ActionURL::ActionURL(), sswf::ActionWaitForFrame::ActionWaitForFrame(), sswf::ActionFunction::AddParameter(), sswf::MemBuffer::AttachBuffer(), sswf::TagShape::Bounds(), sswf::Buffer::Buffer(), sswf::TagText::DefineText(), sswf::ActionPushData::Duplicate(), sswf::Buffer::FindBuffer(), sswf::TagBase::FindID(), sswf::Vectors::Get(), sswf::Data::GetBits(), sswf::Data::GetByte(), sswf::ActionPushData::GetMaxRegister(), sswf::MemoryManager::MemClean(), sswf::TagHeader::MinimumVersion(), sswf::Data::Overwrite(), sswf::Data::OverwriteByte(), sswf::Data::OverwriteLong(), sswf::Data::OverwriteShort(), sswf::ActionGoto::ParseData(), sswf::Action::ParseData(), sswf::TagFont::PreSave2ndPass(), sswf::Data::ReadAlign(), sswf::Data::ReadBytes(), sswf::Buffer::Realloc(), sswf::TagSound::Resample(), sswf::TagText::Save(), sswf::TagSound::Save(), sswf::TagShape::Save(), sswf::TagRemove::Save(), sswf::TagImage::Save(), sswf::Style::Save(), sswf::ActionTry::SaveData(), sswf::ActionPushData::SaveData(), sswf::ActionGoto::SaveData(), sswf::Action::SaveData(), sswf::TagHeader::SaveEncodedString(), sswf::TagBaseID::SaveID(), sswf::Edges::Set(), sswf::TagSound::SetData(), sswf::TagProtect::SetPassword(), sswf::Data::SetReadPosition(), sswf::Data::SetSize(), sswf::Style::SetType(), sswfWriteData(), sswf::Event::StringToEvents(), swap(), sswf::TagBaseID::TagBaseID(), sswf::TagDoAction::TagDoAction(), sswf::TagPlace::TagPlace(), sswf::TagText::text_entry_t::text_entry_t(), sswf::Data::WriteBits(), sswf::Buffer::~Buffer(), and sswf::TagBase::~TagBase().

This function transforms a UTF-8 string in a UCS-4 string.

The function moves the 'wc' pointer to the end of the string and decrements the 'wc_len' parameter for each character added to the output string.

Parameters:

	mb	The UTF-8 string to convert to UCS-4
	mb_len	The length of the UTF-8 string
	wc	A reference to a pointer to save the result
	wc_len	A reference to the size of the wc buffer

Returns:

Zero when no error occurs, EINVAL when an invalid input character is found (i.e. 0xFE or 0xFF) or ENOMEM when the output buffer is full before the convertion ends

See also:

int sswf::wctomb(const sswf_ucs4_t *wc, size_t wc_len, char *mb, size_t& mb_len)

long sswf::wcslen(sswf_ucs4_t *wcstr)

Referenced by sswf::TagText::AddText(), sswf::TagEditText::AddUsedString(), sswf::TagEditText::PreSave(), sswf::TagFont::SetUsedGlyphs(), and sswf::TagEditText::SetUsedGlyphs().

This function returns SSWF_VERSION as a string. (i.e. something like 1.7.5)

This string is a constant and cannot be written to.

Returns:

The SSWF version string

References SSWF_VERSION, and TO_STR.

The swap() function swaps the content of buffer s1 with buffer s2. 'size' bytes are swapped.

If you have a 64 bits system, s1 and s2 both point to a 64 bit value and the size is a multiple of 8 bytes, then the swap is done 64 bits at a time.

If s1 and s2 both point to a 32 bit value and the size is a multiple of 4 bytes, then the swap is done 32 bits at a time.

Otherwise the 8 bits (1 byte) at a time function is used.

Note:

Modifications to support 64-bit by Fabio A. Correa <facorread at gmail>

Parameters:

	s1	One of the buffers to swap
	s2	One of the buffers to swap
	size	The number of bytes to swap

See also:

unsigned short sswf::swap_short(unsigned short s)

unsigned int sswf::swap_int(unsigned int l)

References assert().

Referenced by sswf::TagImage::LoadTGA().

This function takes a 32 bits integer as input and swaps each byte. In effect, it transforms the 32 bits integer from a little to a big endian or vice versa.

Calling the function again with the result value cancels the swapping effect.

Parameters:

l

The 32 bits integer to swap

Returns:

The swapped 32 bits integer passed as input

See also:

unsigned short sswf::swap_short(unsigned short s)

void sswf::swap(void *s1, void *s2, size_t size)

Referenced by sswf::TagSound::LoadWaveFile(), and sswf::TagFont::PreSave2ndPass().

This function takes a 16 bits integer as input and swaps each byte. In effect, it transforms the 16 bits integer from a little to a big endian or vice versa.

Calling the function again with the result cancels the swapping effect.

Parameters:

s

The 16 bits integer to swap

Returns:

The swapped 16 bits integer passed as input

See also:

unsigned int sswf::swap_int(unsigned int l)

void sswf::swap(void *s1, void *s2, size_t size)

Referenced by sswf::TagSound::LoadWaveFile(), and sswf::TagFont::PreSave2ndPass().

This function transforms the given wide character in a string with a name one can display in a console or UI output.

A character between ' ' and 0x7E (127) are displayed as their ASCII character. Any other character is displayed as 'U+<number>'

Bug:

This function takes a string where the result is saved without any safeguards (i.e. it uses sprintf() on that buffer).

Parameters:

	wc	The character to transform
	result	A pointer to a string to fill with the result (output)

Returns:

The function returns 'result'.

See also:

typedef int32_t sswf_ucs4_t

Referenced by sswf::TagText::DefineText(), sswf::TagEditText::PreSave(), and sswf::TagFont::SetUsedGlyphs().

This function computes the length, in character, of a wide character string (i.e. UCS-4 characters.)

The length does not include the null terminator.

Parameters:

wcstr

The string to size or NULL

Returns:

The number of character in the string

See also:

int sswf::mbtowc(const char *mb, size_t mb_len, sswf_ucs4_t *& wc, size_t& wc_len)

int sswf::wctomb(const sswf_ucs4_t *wc, size_t wc_len, char *mb, size_t& mb_len)

Referenced by sswf::TagEditText::AddUsedString(), and sswf::TagText::text_entry_t::text_entry_t().

This function converts a UCS-4 string to a UTF-8 string.

Since version 6 of SWF, all strings in an SWF animations are assumed to be encoding using UTF-8.

The length of the output can be infered using 'mb_len' which is decremented by the number of bytes saved in 'mb'.

Parameters:

	wc	A pointer to a wide character string (input)
	wc_len	The number of characters to convert
	mb	A pointer to the output string (output)
	mb_len	A reference to a size_t value with the maximum number of bytes to write in this output buffer (in/out)

Returns:

Zero when the function succeeds, EINVAL when an input wide character is erroneous (i.e. negative) and ENOMEM when the output buffer is full

See also:

int sswf::mbtowc(const char *mb, size_t mb_len, sswf_ucs4_t *& wc, size_t& wc_len)

long sswf::wcslen(sswf_ucs4_t *wcstr)