#include "stage/interact/ui-coord.hpp"

Description

Describe a location within the UI through structural/topological coordinates.

A UICoord specification is a sequence of Literal tokens, elaborating a path descending through the hierarchy of UI elements down to the specific UI element to refer.

See also: UICoord_test

Definition at line 138 of file ui-coord.hpp.

Public Member Functions
template<typename... ARGS>
	UICoord (ARGS &&...args)
	UI-Coordinates can be created explicitly by specifying a sequence of Literal tokens, which will be used to initialise and then normalise the underlying PathArray. More...

	UICoord (UICoord &&)=default

	UICoord (UICoord const &)=default

	UICoord (UICoord &o)

	UICoord (Builder &&builder)
	shortcut to allow init from builder expression More...

Builder	append (Literal elmID) const

string	getComp () const

Literal	getPanel () const

string	getPath () const

Literal	getPersp () const

Literal	getTab () const

Literal	getView () const

Literal	getWindow () const

bool	isComplete () const

bool	isExplicit () const

bool	isExtendedBelow (UICoord const &parent) const
	Check if this coordinate spec can be seen as an extension of the given parent coordinates and thus reaches further down towards specific UI elements in comparison to the parent path This constitutes a partial order, since some paths might just be totally unrelated to each other and thus not comparable. More...

bool	isIncomplete () const

bool	isPresent (size_t idx) const

bool	isWildcard (size_t idx) const

Builder	noTab () const

	operator string () const

UICoord &	operator= (UICoord const &)=default

UICoord &	operator= (UICoord &&)=default

Builder	panel (Literal panelID) const

Builder	path (Literal pathDefinition) const
	convenience builder function so set a full path definition More...

iterator	pathSeq () const
	iterative access to the path sequence section

Builder	persp (Literal perspectiveID) const

Builder	prepend (Literal elmID) const

Builder	rebuild () const

Builder	tab (Literal tabID) const

Builder	tab (uint tabIdx) const

Builder	view (Literal viewID) const

Public Member Functions inherited from PathArray< UIC_INLINE_SIZE >
	PathArray (ARGS &&...args)

	PathArray (PathArray &&)=default

	PathArray (PathArray const &)=default

	PathArray (PathArray &o)

iterator	begin () const

bool	empty () const

iterator	end () const

size_t	indexOf (Literal const &content) const
	reverse lookup of actual path content More...

size_t	leafLevel () const

	operator string () const
	joins nonempty content, separated by slash

PathArray &	operator= (PathArray const &)=default

PathArray &	operator= (PathArray &&)=default

Literal const &	operator[] (size_t idx) const
	Array style indexed access. More...

size_t	size () const

Static Public Member Functions
static Builder	currentWindow ()
	Builder: start definition of UI-Coordinates rooted in the `currentWindow` More...

static Builder	firstWindow ()
	Builder: start definition of UI-Coordinates rooted in the `firstWindow`

static Builder	window (Literal windowID)
	Builder: start definition of UI-Coordinates rooted in given window. More...

Classes
class	Builder

Friends
class	Builder

bool	operator!= (UICoord const &l, UICoord const &r)

bool	operator< (UICoord const &l, UICoord const &r)

bool	operator<= (UICoord const &l, UICoord const &r)

bool	operator== (UICoord const &l, UICoord const &r)

bool	operator> (UICoord const &l, UICoord const &r)

bool	operator>= (UICoord const &l, UICoord const &r)

Private Member Functions
Literal	accesComponent (UIPathElm idx) const

size_t	findStartIdx () const

void	setComponent (size_t idx, Literal newContent)

void	setTailSequence (size_t idx, Literal newContent)
	replace / overwrite existing content starting at given index. More...

void	setTailSequence (size_t idx, std::vector< Literal > &pathElms)
	replace the existing path information with the given elements More...

Additional Inherited Members
Public Types inherited from PathArray< UIC_INLINE_SIZE >
using	const_iterator = lib::IterAdapter< Literal const , PathArray const >

using	const_reference = Literal const &

using	iterator = const_iterator

using	reference = Literal &

using	value_type = Literal

Protected Member Functions inherited from PathArray< UIC_INLINE_SIZE >
Literal *	expandPosition (size_t idx)

Literal *	getPosition (size_t idx)

void	normalise ()
	establish the contract of PathArray More...

void	setContent (Literal pos, const char val)

void	truncateTo (size_t newSize)

Constructor & Destructor Documentation

◆ UICoord() [1/2]

UICoord ( ARGS &&... args )

inlineexplicit

UI-Coordinates can be created explicitly by specifying a sequence of Literal tokens, which will be used to initialise and then normalise the underlying PathArray.

Warning: Literal means _"literal"_ with guaranteed storage during the whole execution.

Remarks

- in case you need to construct some part, then use Symbol to intern the resulting string into the global static SymbolTable.

usually the Builder API leads to more readable definitions, explicitly indicating the meaning of the coordinate's parts.

Definition at line 154 of file ui-coord.hpp.

References UICoord::currentWindow(), UICoord::firstWindow(), UICoord::path(), UICoord::persp(), and UICoord::window().

Here is the call graph for this function:

◆ UICoord() [2/2]

UICoord ( Builder && builder )

inline

shortcut to allow init from builder expression

Note: this ctor is used to "fix" and normalise the contents established in the Builder thus far.

Definition at line 667 of file ui-coord.hpp.

Member Function Documentation

◆ currentWindow()

UICoord::Builder currentWindow ( )

inlinestatic

Builder: start definition of UI-Coordinates rooted in the currentWindow

Returns: a minimally defined Builder, allowing to define further parts; to finish the definition, cast / store it into UICoord, which itself is immutable.

Definition at line 678 of file ui-coord.hpp.

References UICoord::window().

Referenced by UICoord::UICoord().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ window()

UICoord::Builder window ( Literal windowID )

inlinestatic

Builder: start definition of UI-Coordinates rooted in given window.

Returns: a Builder with just the windowID defined

Definition at line 691 of file ui-coord.hpp.

Referenced by UICoord::currentWindow(), UICoord::firstWindow(), and UICoord::UICoord().

Here is the caller graph for this function:

◆ persp()

UICoord::Builder persp ( Literal perspectiveID ) const

inline

Returns: a Builder holding a clone copy of the original UICoord, with the perspective information set to a new value.

Remarks: This Builder can then be used do set further parts independently of the original. When done, store it as new UICoord object. To achieve real mutation, assign it to the original variable.

Definition at line 704 of file ui-coord.hpp.

References UICoord::Builder.

Referenced by UICoord::UICoord().

Here is the caller graph for this function:

◆ path()

UICoord::Builder path ( Literal pathDefinition ) const

inline

convenience builder function so set a full path definition

Note: the given path string will be split at `'/'` and the resulting components will be stored/retrieved as Symbol

Definition at line 745 of file ui-coord.hpp.

References UICoord::Builder.

Referenced by UICoord::UICoord().

Here is the caller graph for this function:

◆ isIncomplete()

bool isIncomplete ( ) const

inline

Remarks: incomplete UI-Coordinates have some fragment of the path defined, but lacks the definition of an anchor point, i.e. it has no window ID

Definition at line 215 of file ui-coord.hpp.

Referenced by UICoord::Builder::prepend().

Here is the caller graph for this function:

◆ isExplicit()

bool isExplicit ( ) const

inline

Remarks: an explicit coordinate spec does not use wildcards and is anchored in a window spec

Definition at line 234 of file ui-coord.hpp.

◆ isExtendedBelow()

bool isExtendedBelow ( UICoord const & parent ) const

inline

Check if this coordinate spec can be seen as an extension of the given parent coordinates and thus reaches further down towards specific UI elements in comparison to the parent path This constitutes a partial order, since some paths might just be totally unrelated to each other and thus not comparable.

Note: we tolerate (but not demand) expansion/interpolation of the given parent, i.e. parent may be incomplete or contain `'*'` placeholders.

Todo:: 10/2017 have to verify suitability of this definition

Definition at line 271 of file ui-coord.hpp.

◆ setTailSequence() [1/2]

void setTailSequence	(	size_t	idx,
		Literal	newContent
	)

inlineprivate

replace / overwrite existing content starting at given index.

Parameters

idx	where to start adding content; storage will be expanded to accommodate
newContent	either a single element, or several elements delimited by `'/' `@note - a path sequence will be split at`'/'` and the components interned any excess elements will be cleared

Warning: need to invoke PathArray::normalise() afterwards

Definition at line 423 of file ui-coord.hpp.

Referenced by UICoord::Builder::path().

Here is the caller graph for this function:

◆ setTailSequence() [2/2]

void setTailSequence	(	size_t	idx,
		std::vector< Literal > &	pathElms
	)

inlineprivate

replace the existing path information with the given elements

Note

- storage will possibly be expanded to accommodate

the individual path elements are required to persist
any excess elements will be cleared
the pathElms can be empty in which case just any content starting from idx will be cleared

Warning: need to invoke PathArray::normalise() afterwards

Definition at line 463 of file ui-coord.hpp.

References PathArray< UIC_INLINE_SIZE >::expandPosition(), PathArray< UIC_INLINE_SIZE >::PathArray(), and PathArray< UIC_INLINE_SIZE >::setContent().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Builder

friend class Builder

friend

Note: Builder allowed to manipulate stored data

Definition at line 391 of file ui-coord.hpp.

Referenced by UICoord::path(), and UICoord::persp().

Inheritance diagram for UICoord:

Collaboration diagram for UICoord:

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

ui-coord.hpp

Description

Public Member Functions

Static Public Member Functions

Classes

Friends

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ UICoord() [1/2]

◆ UICoord() [2/2]

Member Function Documentation

◆ currentWindow()

◆ window()

◆ persp()

◆ path()

◆ isIncomplete()

◆ isExplicit()

◆ isExtendedBelow()

◆ setTailSequence() [1/2]

◆ setTailSequence() [2/2]

Friends And Related Function Documentation

◆ Builder