benn/lumiera_
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Navigator: initial draft of the LocationQuery interface

Browse source 
the intention is to rely solely upon this abstract interface
in order to navigate the structure of the actual UI, so the
resolution process remains decoupled from the technicalities
of the actual UI toolkit set.

Through implementation of the corresponding unit test we'll determine
what it actually takes to build such a path resolution algorithm...
This commit is contained in:
Fischlurch 2017-10-21 23:37:04 +02:00
parent 0dd516a298
commit 78a9ae875b
2 changed files with 69 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
src/gui/interact/gen-node-location-query.hpp
View file

@ -73,8 +73,9 @@ namespace interact {
/**
* Query and mutate UICoord specifications in relation to actual UI topology.
*
* Test/Diagnostics: implementation of the LocationQuery-API
* based on a abstract topological structure given as Record<GenNode> ("GenNode tree").
* @remark intended for verifying path resolution and navigation through unit tests
* @todo initial draft as of 10/2017
*/
class GenNodeLocationQuery
@ -88,7 +89,29 @@ namespace interact {
/* === LocationQuery interface === */
/** */
/** resolve Anchor against GenNode tree */
virtual Literal
determineAnchor (UICoord const& path)
{
UNIMPLEMENTED ("resolve Anchor against GenNode tree");
}
/** evaluate to what extent a UIcoord spec matches the structure given as GenNode tree
*/
virtual size_t
determineCoverage (UICoord const& path)
{
UNIMPLEMENTED ("resolve explicitly given coordinates against GenNode tree");
}
/** get the sequence child IDs at a designated position in the backing GenNode tree
*/
virtual ChildIter
getChildren (UICoord const& path, size_t pos)
{
UNIMPLEMENTED ("child iterator to navigate a GenNode tree structure");
}
private:
};

47
src/gui/interact/ui-coord-resolver.hpp
View file

@ -76,17 +76,56 @@ namespace interact {
/**
* Interface to discover a backing structure for the purpose of
* path navigation and resolution.
* Interface to discover a backing structure for the purpose of path navigation and resolution.
* UICoord are meant to designate a position within the logical structure of an UI -- yet in fact
* they may be resolved against any tree-like topological structure, which can be queried through
* this interface.
* @see Navigator the implementation used in the Lumiera UI, as backed by actual GUI components
*/
class LocationQuery
{
public:
virtual ~LocationQuery() { } ///< this is an interface
using ChildIter = lib::IterSource<Literal>;
using ChildIter = lib::IterSource<Literal>::iterator;
/** */
/** make the real anchor point explicit.
* @param path an explicit UICoord spec to be anchored in the actual UI
* @return _explicit_ literal window name, where the path can be anchored
* Symbol::BOTTOM in case the given path can not be anchored currently.
* @remark here "to anchor" means to match and thus "attach" the starting point
* of the UIcoord path, i.e. the window spec, with an actual top-level
* window existing in the current UI configuration and state. This operation
* either confirms existence of a window given by explicit ID, or it supplies
* the current meaning of the meta specs `currentWindow` and `firstWindow`,
* again in the form of an explicit window name
*/
virtual Literal determineAnchor (UICoord const& path) =0;
/** evaluate to what extent a UIcoord spec matches the actual UI
* @return the depth to which the given spec is _"covered"_ by the actual UI
* Can be zero, in which case the given coordinates can not be resolved
* and addressed within the currently existing windows, panes and views.
* @note this operation does not perform any _resolution_ or interpolation of wildcards,
* it just matches explicit UI component names.
* @see UICoordResolver for a facility to perform such a resolution and to navigate paths.
*/
virtual size_t determineCoverage (UICoord const& path) =0;
/** get the sequence of child components at a designated position in the actual UI
* @param path an explicit UIcoord spec, expected to be anchored and at least partially
* covered within the current configuration and state of the UI
* @param pos depth where the given path shall be evaluated, starting with 0 at window level
* @return an iterator to enumerate all child components actually existing in the current
* UI below the location designated by path and pos.
* @remark the path is only evaluated up to (not including) the given depth. Especially
* when `pos == 0`, then the path is not evaluated and matched at all, rather
* just the current list of top-level windows is returned.
* @throw error::State when navigating the given path touches a non-existing element
*/
virtual ChildIter getChildren (UICoord const& path, size_t pos) =0;
};