Formatter Class Reference

#include <Formatter.h>

Inheritance diagram for Formatter:

Collaboration diagram for Formatter:

Public Member Functions
GingaState	getState ()
bool	start (const string &, string *)
bool	stop ()
void	resize (int, int)
void	redraw (cairo_t *)
bool	sendKeyEvent (const string &, bool)
bool	sendTickEvent (uint64_t, uint64_t, uint64_t)
const GingaOptions *	getOptions ()
bool	getOptionBool (const string &)
void	setOptionBool (const string &, bool)
int	getOptionInt (const string &)
void	setOptionInt (const string &, int)
string	getOptionString (const string &)
void	setOptionString (const string &, string)
	Formatter (int, char **, GingaOptions *)
	~Formatter ()
bool	getEOS ()
void	setEOS (bool)
virtual bool	start (const std::string &, std::string *)=0
virtual bool	sendKeyEvent (const std::string &, bool)=0
virtual bool	getOptionBool (const std::string &)=0
virtual void	setOptionBool (const std::string &, bool)=0
virtual int	getOptionInt (const std::string &)=0
virtual void	setOptionInt (const std::string &, int)=0
virtual std::string	getOptionString (const std::string &)=0
virtual void	setOptionString (const std::string &, std::string)=0

Static Public Member Functions
static void	setOptionBackground (Formatter *, const string &, string)
static void	setOptionDebug (Formatter *, const string &, bool)
static void	setOptionExperimental (Formatter *, const string &, bool)
static void	setOptionOpenGL (Formatter *, const string &, bool)
static void	setOptionSize (Formatter *, const string &, int)
static Ginga *	create (int, char **, GingaOptions *)
	Creates a new Ginga handle. More...
static std::string	version ()
	Gets Ginga version string. More...

Private Member Functions
list< Object * >	getObjectList (Event::State)
Object *	obtainExecutionObject (const string &)
Event *	obtainEvent (Object *, Event::Type, NclAnchor *, const string &)
Event *	obtainFormatterEventFromBind (NclBind *)
pair< list< Action >, list< Action > >	obtainFormatterLink (NclLink *)

Private Attributes
GingaState	_state
GingaOptions	_opts
Color	_background
uint64_t	_last_tick_total
uint64_t	_last_tick_diff
uint64_t	_last_tick_frameno
string	_saved_G_MESSAGES_DEBUG
Document *	_doc
NclDocument *	_docLegacy
string	_docPath
bool	_eos

Constructor & Destructor Documentation

Formatter::Formatter	(	int	,
		char **	,
		GingaOptions *
	)

References GINGA_STATE_STOPPED.

Formatter::~Formatter

(

)

Member Function Documentation

Ginga * Ginga::create ( int  argc, char **  argv, GingaOptions *  opts  )

staticinherited

Creates a new Ginga handle.

Parameters

argc	Number arguments passed to main.
argv	Arguments passed to main.
opts	State options.

Returns

A new formatter handle.

bool Formatter::getEOS

(

)

list< Object * > Formatter::getObjectList ( Event::State  state )

private

References Event::getState().

bool Formatter::getOptionBool

(

const string &

)

Referenced by Player::Player().

virtual bool Ginga::getOptionBool ( const std::string &  )

pure virtualinherited

int Formatter::getOptionInt

(

const string &

)

Referenced by PlayerAnimator::doSchedule().

virtual int Ginga::getOptionInt ( const std::string &  )

pure virtualinherited

const GingaOptions * Formatter::getOptions ( )

virtual

Implements Ginga.

string Formatter::getOptionString

(

const string &

)

virtual std::string Ginga::getOptionString ( const std::string &  )

pure virtualinherited

GingaState Formatter::getState ( )

virtual

Implements Ginga.

Event * Formatter::obtainEvent ( Object *  obj, Event::Type  type, NclAnchor *  anchor, const string &  key  )

private

References Object::addAttributionEvent(), Object::addPresentationEvent(), Object::addSelectionEvent(), Event::ATTRIBUTION, cast, g_assert(), g_assert_nonnull(), Object::getAttributionEvent(), NclArea::getBegin(), NclArea::getEnd(), Object::getEvent(), NclEntity::getId(), Object::getPresentationEvent(), Object::getSelectionEvent(), instanceof, Event::PRESENTATION, and Event::SELECTION.

Object * Formatter::obtainExecutionObject ( const string &  id )

private

References Composition::addChild(), cast, NclNode::derefer(), g_assert(), g_assert_nonnull(), NclEntity::getId(), NclContext::getLinks(), NclProperty::getName(), NclNode::getParent(), NclComposition::getPorts(), NclProperty::getValue(), instanceof, Event::PRESENTATION, and TRACE.

Event * Formatter::obtainFormatterEventFromBind ( NclBind *  bind )

private

References cast, NclBind::CONDITION, g_assert_nonnull(), NclBind::getEventType(), NclEntity::getId(), NclBind::getInterface(), Object::getLambda(), NclComposition::getMapInterface(), NclBind::getNode(), NclBind::getParameter(), NclBind::getRoleType(), instanceof, and Event::SELECTION.

pair< list< Action >, list< Action > > Formatter::obtainFormatterLink ( NclLink *  docLink )

private

References NclBind::ACTION, Predicate::ATOM, Predicate::clone(), NclBind::CONDITION, Predicate::CONJUNCTION, Predicate::DISJUNCTION, Action::event, Predicate::FALSUM, g_assert_nonnull(), NclLink::getBinds(), Predicate::getChildren(), NclLink::getGhostBind(), Predicate::getTest(), Predicate::getType(), GINGA_NAMESPACE_END, Predicate::NEGATION, Action::predicate, Predicate::setTest(), Action::transition, Action::value, and Predicate::VERUM.

void Formatter::redraw ( cairo_t *  cr )

virtual

Implements Ginga.

References GL::beginDraw(), cast, GL::clear_scene(), cmpz(), GL::draw_quad(), GINGA_SECOND, GINGA_STATE_PLAYING, GINGA_TIME_ARGS, GINGA_TIME_FORMAT, PlayerText::renderSurface(), and xstrbuild().

void Formatter::resize ( int  width, int  height  )

virtual

Implements Ginga.

References g_assert(), GINGA_STATE_PLAYING, and instanceof.

bool Formatter::sendKeyEvent	(	const string &	key,
		bool	press
	)

References _GINGA_CHECK_EOS, GINGA_STATE_PLAYING, and Event::OCCURRING.

virtual bool Ginga::sendKeyEvent ( const std::string &  , bool    )

pure virtualinherited

bool Formatter::sendTickEvent ( uint64_t  total, uint64_t  diff, uint64_t  frame  )

virtual

Implements Ginga.

References _GINGA_CHECK_EOS, GINGA_STATE_PLAYING, and Event::OCCURRING.

void Formatter::setEOS

(

bool

eos

)

void Formatter::setOptionBackground ( Formatter *  self, const string &  name, string  value  )

static

References g_assert(), parse_color(), and TRACE.

void Formatter::setOptionBool	(	const string &	,
		bool
	)

virtual void Ginga::setOptionBool ( const std::string &  , bool    )

pure virtualinherited

void Formatter::setOptionDebug ( Formatter *  self, const string &  name, bool  value  )

static

References g_assert(), strbool, and TRACE.

void Formatter::setOptionExperimental ( Formatter *  , const string &  , bool    )

static

References g_assert(), strbool, and TRACE.

void Formatter::setOptionInt	(	const string &	,
		int
	)

virtual void Ginga::setOptionInt ( const std::string &  , int    )

pure virtualinherited

void Formatter::setOptionOpenGL ( Formatter *  , const string &  , bool    )

static

References ERROR, g_assert(), n, strbool, TRACE, and unlikely.

void Formatter::setOptionSize ( Formatter *  self, const string &  name, int  value  )

static

References g_assert(), GingaOptions::height, TRACE, and GingaOptions::width.

void Formatter::setOptionString	(	const string &	,
		string
	)

virtual void Ginga::setOptionString ( const std::string &  , std::string    )

pure virtualinherited

bool Formatter::start	(	const string &	file,
		string *	errmsg
	)

References Object::addAlias(), NclNode::addAnchor(), cast, g_assert(), g_assert_nonnull(), NclNode::getAnchors(), NclEntity::getId(), Object::getLambda(), NclContext::getLinks(), NclProperty::getName(), NclComposition::getPorts(), NclProperty::getValue(), GINGA_STATE_PLAYING, GINGA_STATE_STOPPED, instanceof, ParserXercesC::parse(), Parser::parseFile(), Event::PRESENTATION, MediaSettings::setProperty(), NclProperty::setValue(), Event::START, TRACE, Event::transition(), unlikely, and MediaSettings::updateCurrentFocus().

virtual bool Ginga::start ( const std::string &  , std::string *    )

pure virtualinherited

bool Formatter::stop ( )

virtual

Implements Ginga.

References GINGA_STATE_STOPPED.

string Ginga::version ( )

staticinherited

Gets Ginga version string.

Returns

libginga version string.

References PACKAGE_VERSION.

Member Data Documentation

Color Formatter::_background

private

Document* Formatter::_doc

private

NclDocument* Formatter::_docLegacy

private

string Formatter::_docPath

private

bool Formatter::_eos

private

uint64_t Formatter::_last_tick_diff

private

uint64_t Formatter::_last_tick_frameno

private

uint64_t Formatter::_last_tick_total

private

GingaOptions Formatter::_opts

private

string Formatter::_saved_G_MESSAGES_DEBUG

private

GingaState Formatter::_state

private

---

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

• Formatter.h
• Formatter.cpp