Lumiera 0.pre.04~rc.1
»edit your freedom«
Loading...
Searching...
No Matches
List of all members | Classes | Public Member Functions | Private Member Functions
DataCap Class Reference

#include "lib/diff/gen-node.hpp"

Description

Definition at line 154 of file gen-node.hpp.

Classes

struct  Locator
 

Public Member Functions

template<typename X >
 DataCap (X &&x)
 
 DataCap (DataCap const &)=default
 
 DataCap (DataCap &&)=default
 
 DataCap (DataCap &o)
 
DataCap & operator= (DataCap const &)=default
 
DataCap & operator= (DataCap &&)=default
 
bool matchData (DataCap const &) const
 Implementation of content equality test, delgating to content.
 
bool matchNum (int64_t) const
 
bool matchTxt (string const &) const
 
bool matchTime (time::TimeValue) const
 
bool matchBool (bool) const
 
bool matchDbl (double) const
 
bool matchLuid (hash::LuidH) const
 
bool matchRec (RecRef const &) const
 
bool matchRec (Rec const &) const
 
Locator expand () const
 
 operator string () const
 
template<typename X >
X & get ()
 
template<typename X >
X const & get () const
 
Rec::scopeIter childIter () const
 visit children of a nested Record<GenNode>
 
bool isNested () const
 determine if payload constitutes a nested scope ("object")
 
string recordType () const
 peek into the type field of a nested Record<GenNode>
 
template<typename X >
std::optional< X > retrieveAttribute (string key) const
 peek into the attributes of a nested Record
 
bool hasAttribute (string key) const
 
template<typename X >
X const & get () const
 
template<>
Rec & get ()
 especially when accessing for a Record, a payload of type RecordRef<Record<GenNode>> (aka RecRef) will be automatically dereferenced.
 
template<>
Rec const & get () const
 
- Public Member Functions inherited from Variant< DataValues >
 ~Variant ()
 
 Variant ()
 
 Variant (X &&x)
 
 Variant (Variant &ref)
 
 Variant (Variant const &ref)
 
 Variant (Variant &&rref)
 
Variant & operator= (X x)
 
Variant & operator= (Variant &ovar)
 
Variant & operator= (Variant const &ovar)
 
Variant & operator= (Variant &&rvar)
 
 operator string () const
 diagnostic helper
 
X & get ()
 
X const & get () const
 
void accept (Visitor &visitor)
 
bool accept (Predicate &visitor) const
 
string accept (Renderer &visitor) const
 

Private Member Functions

Rec * maybeAccessNestedRec ()
 

Additional Inherited Members

- Public Types inherited from Variant< DataValues >
enum  
 
using VisitorFunc = variant::VFunc< RET >::template VisitorInterface< DataValues >
 
using VisitorConstFunc = variant::VFunc< RET >::template VisitorInterface< meta::ConstAll< typename TYPES::List > >
 
using FirstMatching = variant::FirstMatchingType< DataValues, _P_ >
 Metafunction to pick the first of the variant's types, which satisfies the given trait or predicate template.
 
- Protected Member Functions inherited from Variant< DataValues >
Buffer & buffer ()
 
Buffer const & buffer () const
 
Buff< X > & buff ()
 
X * maybeGet ()
 

Constructor & Destructor Documentation

◆ DataCap() [1/4]

template<typename X >
DataCap ( X &&  x)
inline

Definition at line 159 of file gen-node.hpp.

◆ DataCap() [2/4]

DataCap ( DataCap const &  )
default

◆ DataCap() [3/4]

DataCap ( DataCap &&  )
default

◆ DataCap() [4/4]

DataCap ( DataCap &  o)
inline

Definition at line 166 of file gen-node.hpp.

Member Function Documentation

◆ operator=() [1/2]

DataCap & operator= ( DataCap const &  )
default

◆ operator=() [2/2]

DataCap & operator= ( DataCap &&  )
default

◆ matchData()

bool matchData ( DataCap const &  o) const

Implementation of content equality test, delgating to content.

Exceptions
error::Logicwhen the given other DataCap does not hold a value of the same type than this DataCap.
Remarks
since the GenNode::ID is generated including a type hash, the equality operator of GenNode ensures this content test is only called on a compatible DataCap.

special treatment to allow matching a RecRef with an Record or RecRef on the other side

Definition at line 78 of file gen-node.cpp.

References Variant< DataValues >::accept(), DERIVE_EQUALITY, and DataCap::matchRec().

Referenced by GenNode_test::equalityMatch().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ matchNum()

bool matchNum ( int64_t  num) const

Definition at line 122 of file gen-node.cpp.

References Variant< DataValues >::accept(), and MATCH_NUMBER.

Referenced by GenNode::matches(), GenNode::matches(), GenNode::matches(), and GenNode::matches().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ matchTxt()

bool matchTxt ( string const &  text) const

Definition at line 178 of file gen-node.cpp.

References Variant< DataValues >::accept(), and MATCH_STRING.

Referenced by GenNode::matches(), and GenNode::matches().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ matchTime()

bool matchTime ( time::TimeValue  time) const

Definition at line 209 of file gen-node.cpp.

References Variant< DataValues >::accept(), and MATCH_TIME.

Referenced by GenNode::matches().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ matchBool()

bool matchBool ( bool  b) const

Definition at line 237 of file gen-node.cpp.

Referenced by GenNode::matches().

+ Here is the caller graph for this function:

◆ matchDbl()

bool matchDbl ( double  d) const

Definition at line 150 of file gen-node.cpp.

References Variant< DataValues >::accept(), and MATCH_DOUBLE.

Referenced by GenNode::matches().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ matchLuid()

bool matchLuid ( hash::LuidH  hash) const

Definition at line 245 of file gen-node.cpp.

References hash.

Referenced by GenNode::matches().

+ Here is the caller graph for this function:

◆ matchRec() [1/2]

bool matchRec ( RecRef const &  ref) const

Definition at line 253 of file gen-node.cpp.

References RecordRef< VAL >::empty(), RecordRef< VAL >::get(), and DataCap::matchRec().

Referenced by DataCap::matchData(), GenNode::matches(), GenNode::matches(), and DataCap::matchRec().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ matchRec() [2/2]

bool matchRec ( Rec const &  rec) const

Definition at line 266 of file gen-node.cpp.

References RecordRef< VAL >::get().

+ Here is the call graph for this function:

◆ expand()

DataCap::Locator expand ( ) const
inline

Core operation to expand nested scopes recursively

Definition at line 653 of file gen-node.hpp.

◆ operator string()

operator string ( ) const

Definition at line 280 of file gen-node.cpp.

◆ get() [1/5]

template<typename X >
X & get ( )
inline

Definition at line 694 of file gen-node.hpp.

Referenced by SimulatedCommandHandler::SimulatedCommandHandler(), TestNexus::act(), CoreService::act(), ChangeOperation< PAR, CLO >::assignElm(), ObjectTypeHandler< PAR >::assignElm(), _DefaultBinding< ELM, enable_if< can_wrap_in_GenNode< ELM > > >::attachTo(), DiffTreeMutationListener_test::buildMutator(), lib::diff::test::anonymous_namespace{diff-tree-application-simple-test.cpp}::contents(), Tangible::doMark(), NotificationHub::doMark(), DataSource< diff::GenNode >::findNode(), DiffIgnoreChanges_test::fish_for_content(), ChangeOperation< PAR, CLO >::injectNew(), ObjectTypeHandler< PAR >::injectNew(), WrappedStandardExeBuilder::invokeOriginalBuilder(), Tangible::mark(), TreeMutatorBinding_test::mutateGenNode(), GenNode_test::objectShortcut(), stage::model::test::anonymous_namespace{abstract-tangible-test.cpp}::processCommandInvocation(), DiffComplexApplication_test::run(), GenNode_test::simpleUsage(), GenNode_test::symbolReference(), and stage::interact::anonymous_namespace{interaction-director.cpp}::verifyDiffStructure_and_extract_RootTrack().

+ Here is the caller graph for this function:

◆ get() [2/5]

template<typename X >
X const & get ( ) const

Referenced by WrappedStandardExeBuilder::invokeOriginalBuilder().

+ Here is the caller graph for this function:

◆ childIter()

Rec::scopeIter childIter ( ) const
inline

visit children of a nested Record<GenNode>

Definition at line 195 of file gen-node.hpp.

References Record< VAL >::scope().

Referenced by GenNode::getChildren(), and GenNode::hasChildren().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isNested()

bool isNested ( ) const
inline

determine if payload constitutes a nested scope ("object")

Definition at line 769 of file gen-node.hpp.

Referenced by _DefaultBinding< GenNode >::attachTo(), InteractionDirector::buildMutator(), TimelineController::buildMutator(), Opaque::buildMutator(), MockElm::buildMutator(), GenNode::isNested(), and stage::interact::anonymous_namespace{interaction-director.cpp}::verifyDiffStructure_and_extract_RootTrack().

+ Here is the caller graph for this function:

◆ recordType()

string recordType ( ) const
inline

peek into the type field of a nested Record<GenNode>

Returns
either the contents of a nested record's type field or the util::BOTTOM_INDICATOR, when not a record.
Remarks
this function never raises an error, even if the element in fact doesn't constitute a nested scope. Effectively this allows to "peek" into the contents to some degree.

Definition at line 761 of file gen-node.hpp.

References Record< VAL >::getType().

Referenced by TrackPresenter::buildMutator(), ClipPresenter::buildMutator(), and GenNode_test::convenienceRecAccess().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ retrieveAttribute()

template<typename X >
std::optional< X > retrieveAttribute ( string  key) const
inline

peek into the attributes of a nested Record

Definition at line 777 of file gen-node.hpp.

References Record< VAL >::get(), and Record< VAL >::hasAttribute().

Referenced by GenNode::retrieveAttribute().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasAttribute()

bool hasAttribute ( string  key) const
inline

Definition at line 793 of file gen-node.hpp.

References Record< VAL >::hasAttribute().

Referenced by GenNode::hasAttribute().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ maybeAccessNestedRec()

Rec * maybeAccessNestedRec ( )
inlineprivate

helper to possibly peek into a nested record

Definition at line 741 of file gen-node.hpp.

References RecordRef< VAL >::empty(), and RecordRef< VAL >::get().

+ Here is the call graph for this function:

◆ get() [3/5]

template<typename X >
X const & get ( ) const
inline

Definition at line 701 of file gen-node.hpp.

Referenced by WrappedStandardExeBuilder::invokeOriginalBuilder().

+ Here is the caller graph for this function:

◆ get() [4/5]

template<>
Rec & get ( )
inline

especially when accessing for a Record, a payload of type RecordRef<Record<GenNode>> (aka RecRef) will be automatically dereferenced.

Effectively this allows a GenNode with a RecRef payload to "stand in" for a node holding a full Record inline. And it allows the construction of a special Ref-GenNode , which even shares the identity (the ID) of the referenced record-GenNode.

Note
effectively this opens an indirect loophole to const correctness, since it is possible explicitly to retrieve the RecRef from a const GenNode and then to access the referred-to Record without const. In case this turns out to be problematic, we'd have to alter the semantics of RecRef

Definition at line 721 of file gen-node.hpp.

Referenced by WrappedStandardExeBuilder::invokeOriginalBuilder().

+ Here is the caller graph for this function:

◆ get() [5/5]

template<>
Rec const & get ( ) const
inline

Definition at line 731 of file gen-node.hpp.

Referenced by WrappedStandardExeBuilder::invokeOriginalBuilder().

+ Here is the caller graph for this function:
+ Inheritance diagram for DataCap:
+ Collaboration diagram for DataCap:
The documentation for this class was generated from the following files: