VCF::VFFInputStream Class Reference

#include <vcf/ApplicationKit/VFFInputStream.h>

Inheritance diagram for VCF::VFFInputStream:


Public Types
typedef String(*	ComponentConstantFunc )(const String &)
enum	UsageFlags { ufCreateComponent = 0x0001, ufCreateChildren = 0x0002, ufCreateChildrenIfNoInstance = 0x0004, ufFindSubComponent = 0x0008 }
Public Member Functions
	VFFInputStream (InputStream *stream)
	VFFInputStream (const String &vffString)
virtual	~VFFInputStream ()
virtual void	seek (const uint64 &offset, const VCF::SeekType &offsetFrom)
virtual uint64	getSize ()
	returns the size of the stream.
virtual uchar *	getBuffer ()
	returns a pointer to the buffer that holds the stream memory
virtual VCF::uint64	getCurrentSeekPos ()
	this is a global offset from the beggining of the stream
virtual uint64	read (unsigned char *bytesToRead, uint64 sizeOfBytes)
void	getOuterClassNameAndUUID (String &className, String &UUID, String &fallbackClassName)
	retreives the outer most class/UUID that contains all other obejcts in this VFF stream
Component *	readNewComponent ()
	reads in a new component.
void	readComponentInstance (Component *component)
	reads in a Component from the stream, and assigns it's value to the component instance passed in
void	readNewComponentInstance (Component *component)
	Assumes we have a new, empty, top level component (typically a FormRootWindow instance), but NO child components yet.
void	setAllComponentsInDesignMode (const bool &val)
virtual bool	isEOS ()
Static Public Member Functions
static void	registerComponentConstant (const String &name, const String &data)
	Register a constant value to be used.
static void	registerComponentConstant (const String &name, ComponentConstantFunc funcPtr)
	Register a constant value to be used.
static void	internal_clearComponentConstants ()
static bool	getComponentConstant (const String &name, String &value)
	Returns a value for a specific constant name.
static void	setRootComponent (Component *component)
static void	setTransformer (UnitTransformer *val)
Protected Member Functions
void	hexToBin (const String &hexString, VCF::Persistable *persistableObject)
void	processAsignmentTokens (const VCFChar &token, const String &currentSymbol, VCF::Class *clazz)
void	processAsignmentTokens (const VCFChar &token, const String &currentSymbol, const VariantData &key, Class *clazz)
void	processDelegateAsignment (const VCFChar &token, const String &currentSymbol, VCF::Class *clazz)
void	readDelegates (Component component, VCF::Class clazz)
Component *	readObject (Component *componentInstance, int flags)
void	assignDeferredProperties (Component *component)
Object *	createClassInstance (const String &className, const String &classID, const String &fallbackClassName)
Component *	createNewComponent (Component *componentInstance, int flags)
String	transform (const String &originalValue)
Protected Attributes
InputStream *	stream_
VFFParser *	parser_
bool	deleteStream_
std::vector< DeferredPropertySetter * >	deferredProperties_
std::vector< DeferredDelegateSetter * >	deferredDelegates_
Component *	topLevelComponent_
bool	atTopLevel_
int32	componentInputLevel_
bool	topLevelControlVisibility_
bool	setDesignMode_
Static Protected Attributes
static Component *	rootComponent_
static UnitTransformer *	transformer
Classes
class	DeferredDelegateSetter
class	DeferredPropertySetter

Member Typedef Documentation

typedef String(* VCF::VFFInputStream::ComponentConstantFunc)(const String &)

Member Enumeration Documentation

enum VCF::VFFInputStream::UsageFlags

Enumerator:

ufCreateComponent

ufCreateChildren

ufCreateChildrenIfNoInstance

ufFindSubComponent

Constructor & Destructor Documentation

VCF::VFFInputStream::VFFInputStream ( InputStream * stream )

VCF::VFFInputStream::VFFInputStream ( const String & vffString )

virtual VCF::VFFInputStream::~VFFInputStream ( ) [virtual]

Member Function Documentation

void VCF::VFFInputStream::assignDeferredProperties ( Component * component ) [protected]

Object* VCF::VFFInputStream::createClassInstance ( const String & className,

const String & classID,

const String & fallbackClassName

) [protected]

Component* VCF::VFFInputStream::createNewComponent ( Component * componentInstance,

int flags

) [protected]

virtual uchar* VCF::VFFInputStream::getBuffer ( ) [inline, virtual]

returns a pointer to the buffer that holds the stream memory

Implements VCF::Stream.

static bool VCF::VFFInputStream::getComponentConstant ( const String & name,

String & value

) [static]

Returns a value for a specific constant name.

virtual VCF::uint64 VCF::VFFInputStream::getCurrentSeekPos ( ) [inline, virtual]

this is a global offset from the beggining of the stream

Implements VCF::Stream.

void VCF::VFFInputStream::getOuterClassNameAndUUID ( String & className,

String & UUID,

String & fallbackClassName

)

retreives the outer most class/UUID that contains all other obejcts in this VFF stream

virtual uint64 VCF::VFFInputStream::getSize ( ) [inline, virtual]

returns the size of the stream.
The size represents the number of bytes that have been written, or read to/from the stream
Implements VCF::Stream.

void VCF::VFFInputStream::hexToBin ( const String & hexString,

VCF::Persistable * persistableObject

) [protected]

static void VCF::VFFInputStream::internal_clearComponentConstants ( ) [static]

virtual bool VCF::VFFInputStream::isEOS ( ) [inline, virtual]

Implements VCF::InputStream.

void VCF::VFFInputStream::processAsignmentTokens ( const VCFChar & token,

const String & currentSymbol,

const VariantData & key,

Class * clazz

) [protected]

void VCF::VFFInputStream::processAsignmentTokens ( const VCFChar & token,

const String & currentSymbol,

VCF::Class * clazz

) [protected]

void VCF::VFFInputStream::processDelegateAsignment ( const VCFChar & token,

const String & currentSymbol,

VCF::Class * clazz

) [protected]

virtual uint64 VCF::VFFInputStream::read ( unsigned char * bytesToRead,

uint64 sizeOfBytes

) [inline, virtual]

Implements VCF::InputStream.

void VCF::VFFInputStream::readComponentInstance ( Component * component )

reads in a Component from the stream, and assigns it's value to the component instance passed in

Parameters:

Component* must NOT be null. Represents the already existing component that will be updated as a result of reading the contents of the stream.

void VCF::VFFInputStream::readDelegates ( Component * component,

VCF::Class * clazz

) [protected]

Component* VCF::VFFInputStream::readNewComponent ( )

reads in a new component.
The method creates a new instance for the caller.
Returns:
Component* usually this is a top level component like a Frame

void VCF::VFFInputStream::readNewComponentInstance ( Component * component )

Assumes we have a new, empty, top level component (typically a FormRootWindow instance), but NO child components yet.
Will create child components as neccessary

Component* VCF::VFFInputStream::readObject ( Component * componentInstance,

int flags

) [protected]

static void VCF::VFFInputStream::registerComponentConstant ( const String & name,

ComponentConstantFunc funcPtr

) [static]

Register a constant value to be used.
This can only hold basic types like an int, double, string, or bool. The symbolic name of the
Parameters:

String the name of the constant.

ComponentConstantFunc a function pointer that is used to retrieve the value of the constant name.

static void VCF::VFFInputStream::registerComponentConstant ( const String & name,

const String & data

) [static]

Register a constant value to be used.
This can only hold basic types like an int, double, string, or bool. The symbolic name of the
Parameters:

String the name of the constant.

String the value of the constant.

virtual void VCF::VFFInputStream::seek ( const uint64 & offset,

const VCF::SeekType & offsetFrom

) [inline, virtual]

Implements VCF::Stream.

void VCF::VFFInputStream::setAllComponentsInDesignMode ( const bool & val ) [inline]

static void VCF::VFFInputStream::setRootComponent ( Component * component ) [inline, static]

static void VCF::VFFInputStream::setTransformer ( UnitTransformer * val ) [inline, static]

String VCF::VFFInputStream::transform ( const String & originalValue ) [protected]

Member Data Documentation

bool VCF::VFFInputStream::atTopLevel_ [protected]

int32 VCF::VFFInputStream::componentInputLevel_ [protected]

std::vector<DeferredDelegateSetter*> VCF::VFFInputStream::deferredDelegates_ [protected]

std::vector<DeferredPropertySetter*> VCF::VFFInputStream::deferredProperties_ [protected]

bool VCF::VFFInputStream::deleteStream_ [protected]

VFFParser* VCF::VFFInputStream::parser_ [protected]

Component* VCF::VFFInputStream::rootComponent_ [static, protected]

bool VCF::VFFInputStream::setDesignMode_ [protected]

InputStream* VCF::VFFInputStream::stream_ [protected]

Component* VCF::VFFInputStream::topLevelComponent_ [protected]

bool VCF::VFFInputStream::topLevelControlVisibility_ [protected]

UnitTransformer* VCF::VFFInputStream::transformer [static, protected]

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

vcf/FoundationKit/VFFInputStream.h

VCF::VFFInputStream Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Classes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation