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

Commands: change implementation frame to include the command-ID

Browse source 
while the initial design treated the commands in a strictly top-down manner,
where the ID is known solely to the CommandRegistry, this change and information
duplication became necessary now, since by default we now always enqueue and
dispatch anonymous clone copies from the original command definition (prototype).

This implementation uses the trick to tag this command-ID when a command-hanlde
is activated, which is also the moment when it is tracked in the registry.
This commit is contained in:
Fischlurch 2017-04-17 03:09:12 +02:00
parent 471fa5b9c4
commit 876c1dd1fd
7 changed files with 90 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/proc/control/command-impl.hpp
View file

@ -137,15 +137,22 @@ namespace control {
CommandImpl (CommandImpl const& orig
,UndoMutation const& newUndo
,shared_ptr<CmdClosure> const& newClosure)
: do_(orig.do_)
, undo_(newUndo)
, pClo_(newClosure)
, defaultPatt_(orig.defaultPatt_)
: do_{orig.do_}
, undo_{newUndo}
, pClo_{newClosure}
, defaultPatt_{orig.defaultPatt_}
, cmdID{orig.cmdID}
{ }
explicit operator bool() const { return isValid(); }
/** human-readable marker for diagnostics,
* will be (re)assigned when activating this CommandImpl
*/
Symbol cmdID;
/** assist with building a clone copy of this CommandImpl.
* By accepting the clone builder as a visitor and dispatching
* this visitation down into the concrete closure, the builder

5
src/proc/control/command-registry.hpp
View file

@ -31,7 +31,8 @@
** to the TypedAllocationManager
** - maintaining an index to find pre-built command definitions (prototypes)
**
** \par Services during command lifecycle
** ## Services during command lifecycle
**
** Each command starts out as command definition, accessed by client code through CommandDef.
** While collecting the necessary parts of such a definition, there is just an empty (pending)
** Command (smart-ptr frontend), which is not yet usable, being held within the CommandDef.
@ -167,7 +168,7 @@ namespace control {
/** remove the given command registration.
* @return \c true if actually removed an entry
* @return `true` if actually removed an entry
* @note existing command instances remain valid;
* storage will be freed at zero use-count */
bool

17
src/proc/control/command.cpp
View file

@ -188,7 +188,10 @@ namespace control {
_Handle::activate (move (implFrame));
if (cmdID)
CommandRegistry::instance().track (cmdID, *this);
{
CommandRegistry::instance().track (cmdID, *this);
impl().cmdID = cmdID;
}
TRACE (command, "%s defined OK", cStr(*this));
}
@ -386,17 +389,11 @@ namespace control {
}
namespace {
const Symbol ANONYMOUS_CMD_SYMBOL("_anonymous_");
}
Symbol
Command::getID() const
Command::getID() const noexcept
{
////////////////////////////////////////////////////////////////////TODO do we need no-throw guarantee here?
Symbol id = CommandRegistry::instance().findDefinition (*this);
return id? id
: ANONYMOUS_CMD_SYMBOL;
return isValid()? impl().cmdID
: Symbol::FAILURE;
}

2
src/proc/control/command.hpp
View file

@ -206,7 +206,7 @@ namespace control {
void duplicate_detected (Symbol) const;
Symbol getID() const;
Symbol getID() const noexcept;
bool isAnonymous() const;
operator string() const;

18
tests/45controller.tests
View file

@ -89,20 +89,20 @@ END
TEST "Command argument binding" CommandBinding_test <<END
out: Command\("test.command3.2"\) \{exec\}
out-lit: Command("test.command3.2") {exec}
return: 0
END
TEST "Command usage aspects I" CommandUse1_test <<END
out: Command\("test.command1.1"\) \{undo\}
out: Command\("test.command1.2"\) \{undo\}
out: Command\("test.command1.3"\) \{undo\}
out: Command\("test.command1.4"\) \{undo\}
out: Command\("_anonymous_"\) NIL
out: Command\("test.command1.5"\) \{def\}
out: Command\("test.command1.5"\) \{exec\}
out: Command\("test.command1.5"\) \{undo\}
out-lit: Command("test.command1.1") {undo}
out-lit: Command("test.command1.2") {def}
out-lit: Command("test.command1.3") {undo}
out-lit: Command("test.command1.4") {def}
out-lit: Command("↯") NIL
out-lit: Command("test.command1.5") {def}
out-lit: Command("test.command1.5") {exec}
out-lit: Command("test.command1.5") {undo}
return: 0
END

8
wiki/renderengine.html
View file

@ -1529,7 +1529,7 @@ By design, commands are single-serving value objects; executing an operation rep
&amp;rarr; more details regarding [[command implementation|CommandImpl]]
</pre>
</div>
<div title="CommandImpl" modifier="Ichthyostega" created="200909291424" modified="201703171927" tags="spec impl" changecount="2">
<div title="CommandImpl" modifier="Ichthyostega" created="200909291424" modified="201704170059" tags="spec impl" changecount="4">
<pre>Commands are separated in a handle (the {{{control::Command}}}-object), to be used by the client code, and an implementation level, which is managed transparently behind the stages. Client code is assumed to build a CommandDefinition at some point, and from then on to access the command ''by ID'', yielding the command handle.
Binding of arguments, invocation and UNDO all are accessible through this frontend.
@ -1542,6 +1542,12 @@ To support this handling scheme, some infrastructure is in place:
** a closure, implemented through an argument holder
** an undo state capturing mechanism, based on a capturing function provided on definition
* performing the actual execution is delegated to a handling pattern object, accessed by name.
;~Command-ID
:this ID is the primary access key for stored command definitions within the registry. When a command is //activated,// the command implementation record is also tagged with that ID; this is done for diagnostic purposes, e.g. to find out what commands in the command log of the session can be undone.
;prototypes
:while, technically, any command record in the registry can be outfitted with arguments and executed right away, the standard usage pattern is to treat the //globally known, named entries// in this registry as prototype objects, from which the actual //instances for execution// are created by cloning. This is done to circumvent concurrency problems with argument binding.
;named and anonymous instances
:any command entry in the registry can be clone-copied. There are two flavours of this functionality: either, the new entry can be stored under a different name in the global registry, or alternatively just an unnamed copy can be created and returned. Since such an anonymous copy is not tracked in the registry, its lifetime is controlled solely by the ref-count of the handle returned from this {{{Command::newInstance()}}} call. Please note that the {{{CommandImpl}}} record managed by this handle still bears a copy of the original ~Command-ID, which helps with diagnostics when invoking such an instance. But the presence of this ID in the implementation record does not mean the command is known to the registry; to find out about that, use the {{{Command::isAnonymous()}}} predicate.
!Definition and usage
In addition to the technical specification regarding the command, memento and undo functors, some additional conventions are established

77
wiki/thinkPad.ichthyo.mm
View file

@ -11742,7 +11742,7 @@
<icon BUILTIN="forward"/>
</node>
</node>
<node CREATED="1491008040105" ID="ID_662216926" MODIFIED="1491618848217" TEXT="Implementierung">
<node CREATED="1491008040105" FOLDED="true" ID="ID_662216926" MODIFIED="1492391159562" TEXT="Implementierung">
<icon BUILTIN="button_ok"/>
<node COLOR="#338800" CREATED="1491008045936" ID="ID_1071153669" MODIFIED="1491008146180" TEXT="CommandInstanceManager_test">
<icon BUILTIN="button_ok"/>
@ -11817,7 +11817,7 @@
</node>
</node>
</node>
<node CREATED="1491753027936" HGAP="35" ID="ID_118278209" MODIFIED="1491757400403" TEXT="Refactoring" VSHIFT="2">
<node CREATED="1491753027936" FOLDED="true" HGAP="35" ID="ID_118278209" MODIFIED="1492391157505" TEXT="Refactoring" VSHIFT="2">
<icon BUILTIN="button_ok"/>
<node CREATED="1491753036895" ID="ID_1029946389" MODIFIED="1491753047201" TEXT="fall-back auf Command integrieren"/>
<node CREATED="1491753645531" ID="ID_597184850" MODIFIED="1491753650607" TEXT="maybeGet entfernen"/>
@ -11883,8 +11883,8 @@
</node>
</node>
</node>
<node BACKGROUND_COLOR="#eee5c3" COLOR="#990000" CREATED="1491656361886" HGAP="62" ID="ID_1269299900" MODIFIED="1492293109808" TEXT="Einbindung" VSHIFT="12">
<icon BUILTIN="flag-yellow"/>
<node CREATED="1491656361886" FOLDED="true" HGAP="62" ID="ID_1269299900" MODIFIED="1492391155180" TEXT="Einbindung" VSHIFT="12">
<icon BUILTIN="button_ok"/>
<node COLOR="#338800" CREATED="1491659172438" HGAP="34" ID="ID_1103739498" MODIFIED="1491757376165" TEXT="in SessionCommandService" VSHIFT="-3">
<icon BUILTIN="button_ok"/>
<node CREATED="1491659191155" ID="ID_586991718" MODIFIED="1491659216131" TEXT="Nutzung des Instance-Managers ist optional"/>
@ -11955,8 +11955,8 @@
</node>
<node CREATED="1491692398913" HGAP="27" ID="ID_1349137025" MODIFIED="1491753610374" TEXT="in UI-Bus" VSHIFT="6">
<icon BUILTIN="help"/>
<node BACKGROUND_COLOR="#eee5c3" COLOR="#990000" CREATED="1491692419958" ID="ID_411638678" MODIFIED="1491753600586" TEXT="#1058 consider expanding UI-Bus protocol for command cloning">
<icon BUILTIN="flag-yellow"/>
<node BACKGROUND_COLOR="#eee5c3" COLOR="#990000" CREATED="1491692419958" ID="ID_411638678" MODIFIED="1492391112135" TEXT="#1058 consider expanding UI-Bus protocol for command cloning">
<icon BUILTIN="button_cancel"/>
</node>
<node CREATED="1491692431021" ID="ID_1526880552" MODIFIED="1491692436375" TEXT="wollen wir das?"/>
<node CREATED="1491692438907" ID="ID_1137204114" MODIFIED="1491692452509" TEXT="oder nur f&#xfc;r explizite Spezialisierungen?"/>
@ -12051,11 +12051,15 @@
</node>
</node>
</node>
<node CREATED="1491659180516" ID="ID_655217923" MODIFIED="1491659189047" TEXT="in CmdAccess"/>
<node CREATED="1491659180516" ID="ID_655217923" MODIFIED="1492391121444" TEXT="in CmdAccess">
<icon BUILTIN="button_cancel"/>
<node CREATED="1492391124070" ID="ID_1515597578" MODIFIED="1492391129921" TEXT="nicht mehr notwendig"/>
<node CREATED="1492391131173" ID="ID_1089257513" MODIFIED="1492391139944" TEXT="CmdAccess wird komplett on top arbeiten"/>
</node>
<node CREATED="1492293088861" HGAP="28" ID="ID_1660020661" MODIFIED="1492293257532" TEXT="&#xdc;berarbeitung" VSHIFT="14">
</node>
<node CREATED="1492293088861" FOLDED="true" HGAP="28" ID="ID_1660020661" MODIFIED="1492391152645" TEXT="&#xdc;berarbeitung" VSHIFT="14">
<linktarget COLOR="#626a9e" DESTINATION="ID_1660020661" ENDARROW="Default" ENDINCLINATION="-324;0;" ID="Arrow_ID_876356993" SOURCE="ID_220910293" STARTARROW="None" STARTINCLINATION="-687;0;"/>
<icon BUILTIN="pencil"/>
<icon BUILTIN="button_ok"/>
<node CREATED="1492293139398" ID="ID_1274577545" MODIFIED="1492293146721" TEXT="als Folge der Design-Kritik"/>
<node CREATED="1492293282803" ID="ID_1858980532" MODIFIED="1492293285150" TEXT="Ziel">
<node CREATED="1492293286802" ID="ID_980352671" MODIFIED="1492293292141" TEXT="weitgehend automatisch"/>
@ -12192,8 +12196,8 @@
</node>
</node>
</node>
<node BACKGROUND_COLOR="#eee5c3" COLOR="#990000" CREATED="1492359501220" ID="ID_1889001956" MODIFIED="1492359517024" TEXT="Test anpassen">
<icon BUILTIN="pencil"/>
<node COLOR="#338800" CREATED="1492359501220" ID="ID_1889001956" MODIFIED="1492391055336" TEXT="Test anpassen">
<icon BUILTIN="button_ok"/>
</node>
</node>
</node>
@ -12264,7 +12268,7 @@
</node>
</node>
</node>
<node CREATED="1492095433567" HGAP="69" ID="ID_1208499974" MODIFIED="1492281782930" TEXT="DSL schaffen" VSHIFT="1">
<node CREATED="1492095433567" FOLDED="true" HGAP="69" ID="ID_1208499974" MODIFIED="1492391333882" TEXT="DSL schaffen" VSHIFT="1">
<richcontent TYPE="NOTE"><html>
<head>
@ -12463,27 +12467,50 @@
</node>
</node>
<node CREATED="1491005020528" ID="ID_1665806173" MODIFIED="1491005024747" TEXT="zu kl&#xe4;ren">
<node BACKGROUND_COLOR="#eee5c3" COLOR="#990000" CREATED="1491005025928" FOLDED="true" ID="ID_1805144008" MODIFIED="1492167945765" STYLE="fork" TEXT="duplikate Instanzen">
<node CREATED="1491005025928" FOLDED="true" ID="ID_1805144008" MODIFIED="1492391293816" TEXT="duplikate Instanzen">
<linktarget COLOR="#ca978d" DESTINATION="ID_1805144008" ENDARROW="Default" ENDINCLINATION="594;0;" ID="Arrow_ID_191915626" SOURCE="ID_1575553505" STARTARROW="None" STARTINCLINATION="594;0;"/>
<icon BUILTIN="messagebox_warning"/>
<node CREATED="1491005039414" ID="ID_378645276" MODIFIED="1491005470990" TEXT="mehrfach newInstance() mit gleicher ID"/>
<node CREATED="1491005054595" ID="ID_1987692266" MODIFIED="1491495289915" TEXT="drei M&#xf6;glichkeiten">
<icon BUILTIN="button_ok"/>
<node CREATED="1491005039414" ID="ID_378645276" MODIFIED="1492391288793" TEXT="mehrfach newInstance() mit gleicher ID"/>
<node CREATED="1491005054595" ID="ID_1987692266" MODIFIED="1492391288793" TEXT="drei M&#xf6;glichkeiten">
<icon BUILTIN="info"/>
<node CREATED="1491005058931" ID="ID_1108733153" MODIFIED="1491005470990" TEXT="mit neuem Klon &#xfc;berschreiben"/>
<node CREATED="1491495291966" ID="ID_703254591" MODIFIED="1491495302281" TEXT="stillschweigend bestehende Instanz ausgeben"/>
<node CREATED="1491005066706" ID="ID_1990482123" MODIFIED="1491495433236" TEXT="Fehler ausl&#xf6;sen">
<node CREATED="1491005058931" ID="ID_1108733153" MODIFIED="1492391288793" TEXT="mit neuem Klon &#xfc;berschreiben"/>
<node CREATED="1491495291966" ID="ID_703254591" MODIFIED="1492391288793" TEXT="stillschweigend bestehende Instanz ausgeben"/>
<node CREATED="1491005066706" ID="ID_1990482123" MODIFIED="1492391288793" TEXT="Fehler ausl&#xf6;sen">
<icon BUILTIN="forward"/>
<node CREATED="1491495356533" ID="ID_1948190107" MODIFIED="1491495397512" TEXT="einzig sichere Variante">
<node CREATED="1491495356533" ID="ID_1948190107" MODIFIED="1492391288793" TEXT="einzig sichere Variante">
<icon BUILTIN="idea"/>
</node>
<node CREATED="1491495398895" ID="ID_1958544932" MODIFIED="1491495404395" TEXT="es gibt jetzt auch getInstance"/>
<node CREATED="1491495405151" ID="ID_988620199" MODIFIED="1491495425552" TEXT="der Client mu&#xdf; geht von Exclusivit&#xe4;t aus"/>
<node CREATED="1491495398895" ID="ID_1958544932" MODIFIED="1492391288793" TEXT="es gibt jetzt auch getInstance"/>
<node CREATED="1491495405151" ID="ID_988620199" MODIFIED="1492391288793" TEXT="der Client mu&#xdf; geht von Exclusivit&#xe4;t aus"/>
</node>
</node>
<node CREATED="1491005071634" ID="ID_178338289" MODIFIED="1491005470990" TEXT="zur Kl&#xe4;rung">
<node CREATED="1491005071634" ID="ID_178338289" MODIFIED="1492391288793" TEXT="zur Kl&#xe4;rung">
<icon BUILTIN="bell"/>
<node CREATED="1491005078409" ID="ID_1515823316" MODIFIED="1491005470990" TEXT="...mu&#xdf; ich wissen, wie newInstance verwendet wird"/>
<node CREATED="1491005491226" ID="ID_1986906306" MODIFIED="1491005499069" TEXT="und das h&#xe4;ngt von InvocationTrail ab"/>
<node CREATED="1491005078409" ID="ID_1515823316" MODIFIED="1492391288793" TEXT="...mu&#xdf; ich wissen, wie newInstance verwendet wird"/>
<node CREATED="1491005491226" ID="ID_1986906306" MODIFIED="1492391288793" TEXT="und das h&#xe4;ngt von InvocationTrail ab"/>
<node CREATED="1492391213458" ID="ID_1535150206" MODIFIED="1492391288793" TEXT="Differenzierung">
<icon BUILTIN="messagebox_warning"/>
<node CREATED="1492391217961" ID="ID_1152426430" MODIFIED="1492391288793" TEXT="wir erzeugen nun Instanzen transparent">
<icon BUILTIN="info"/>
</node>
<node CREATED="1492391227720" ID="ID_475537616" MODIFIED="1492391288793" TEXT="d.h. eine reine Command-ID wird stillschweigend geklont"/>
<node CREATED="1492391240086" ID="ID_687060412" MODIFIED="1492391288793">
<richcontent TYPE="NODE"><html>
<head>
</head>
<body>
<p>
allerdings, wenn man eine <b>explizite</b>&#160;Instanz-ID angibt,
</p>
<p>
bleibt es bei der stringenten Fehlerbehandlung
</p>
</body>
</html>
</richcontent>
</node>
</node>
</node>
</node>
<node CREATED="1491494748185" FOLDED="true" ID="ID_1589354901" MODIFIED="1492167953036" TEXT="Instanzen registrieren">