experimenting with 'reserved uids'

2014-08-07 21:52:50 +02:00
parent efc4e502cf
commit 9e1d9e568f
77 changed files with 509 additions and 1482 deletions
--- a/doc/class/AddName.html
+++ b/doc/class/AddName.html
@@ -142,7 +142,7 @@ only one will AddName operation will be executed.</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/Delete.html
+++ b/doc/class/Delete.html
@@ -157,7 +157,7 @@ This result can be sent to other clients.</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/Delimiter.html
+++ b/doc/class/Delimiter.html
@@ -118,7 +118,7 @@ of the Engine is empty.</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/Engine.html
+++ b/doc/class/Engine.html
@@ -72,6 +72,11 @@
      </a>
    </span>
    <span class='desc'>
+      <p>ops = [] for o in ops_json ops.push @parseOperation o
+for o in ops @HB.addOperation o
+for o in ops if not o.execute()
+    @unprocessed_ops.push o
+@tryUnprocessed()</p>
    </span>
  </li>
  <li>
@@ -125,7 +130,16 @@
 <b>applyOp</b><span>(op_json)</span>
      <br>
    </p>
-    
+    <div class='docstring'>
+  <p>ops = []
+for o in ops_json ops.push @parseOperation o
+for o in ops @HB.addOperation o
+for o in ops if not o.execute()
+    @unprocessed_ops.push o
+@tryUnprocessed()</p>
+</div>
+<div class='tags'>
+</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='tryUnprocessed-dynamic'>
@@ -139,7 +153,7 @@
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/HistoryBuffer.html
+++ b/doc/class/HistoryBuffer.html
@@ -57,6 +57,18 @@
      Get the user id with wich the History Buffer was initialized. 
    </span>
  </li>
+  <li>
+    <span class='signature'>
+      <a href='#getReservedUniqueIdentifier-dynamic'>
+        #
+(void)
+<b>getReservedUniqueIdentifier</b><span>()</span>
+      </a>
+    </span>
+    <span class='desc'>
+      There is only one reserved unique identifier (uid), so use it wisely. 
+    </span>
+  </li>
  <li>
    <span class='signature'>
      <a href='#getOperationCounter-dynamic'>
@@ -159,6 +171,22 @@
  <p>Get the user id with wich the History Buffer was initialized.</p>
 </div>
 <div class='tags'>
+</div>
+  </div>
+  <div class='method_details'>
+    <p class='signature' id='getReservedUniqueIdentifier-dynamic'>
+      #
+(void)
+<b>getReservedUniqueIdentifier</b><span>()</span>
+      <br>
+    </p>
+    <div class='docstring'>
+  <p>There is only one reserved unique identifier (uid), so use it wisely.
+I propose to use it in your Framework, to create something like a root element.
+An operation with this identifier is not propagated to other clients.
+This is why everybode must create the same operation with this uid.</p>
+</div>
+<div class='tags'>
 </div>
  </div>
  <div class='method_details'>
@@ -228,7 +256,7 @@ other operations (it wont executed)</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/ImmutableObject.html
+++ b/doc/class/ImmutableObject.html
@@ -93,7 +93,7 @@
    <p class='signature' id='constructor-dynamic'>
      #
 (void)
-<b>constructor</b><span>(uid, content = &quot;&quot;, prev, next, origin)</span>
+<b>constructor</b><span>(uid, content, prev, next, origin)</span>
      <br>
    </p>
    <div class='tags'>
@@ -156,7 +156,7 @@
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/Insert.html
+++ b/doc/class/Insert.html
@@ -256,7 +256,7 @@ TODO (Unused)</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/IwcConnector.html
+++ b/doc/class/IwcConnector.html
@@ -168,7 +168,7 @@
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/JsonType.html
+++ b/doc/class/JsonType.html
@@ -286,7 +286,7 @@
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/JsonWrapper.html
+++ b/doc/class/JsonWrapper.html
@@ -121,7 +121,7 @@ console.log(w.newProperty == &quot;Awesome&quot;) # true!</code></pre>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/JsonYatta.html
+++ b/doc/class/JsonYatta.html
@@ -250,7 +250,7 @@ JsonYatta was initialized (Depending on the HistoryBuffer implementation).</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/ListManager.html
+++ b/doc/class/ListManager.html
@@ -208,7 +208,7 @@ Doesn&#39;t return left-right delimiter.</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/MapManager.html
+++ b/doc/class/MapManager.html
@@ -99,7 +99,7 @@
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/Operation.html
+++ b/doc/class/Operation.html
@@ -284,7 +284,7 @@ an easy way to refer to these operations via an uid or object reference.</p><p>F
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/ReplaceManager.html
+++ b/doc/class/ReplaceManager.html
@@ -189,7 +189,7 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/Replaceable.html
+++ b/doc/class/Replaceable.html
@@ -191,7 +191,7 @@ This result can be send to other clients.</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/TestConnector.html
+++ b/doc/class/TestConnector.html
@@ -219,7 +219,7 @@
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/TextDelete.html
+++ b/doc/class/TextDelete.html
@@ -53,7 +53,7 @@
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/TextInsert.html
+++ b/doc/class/TextInsert.html
@@ -173,7 +173,7 @@ This result can be send to other clients.</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/TextYatta.html
+++ b/doc/class/TextYatta.html
@@ -239,7 +239,7 @@
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
--- a/doc/class/Word.html
+++ b/doc/class/Word.html
@@ -126,7 +126,7 @@
    <p class='signature' id='constructor-dynamic'>
      #
 (void)
-<b>constructor</b><span>(uid, initial_content, beginning, end, prev, next, origin)</span>
+<b>constructor</b><span>(uid, beginning, end, prev, next, origin)</span>
      <br>
    </p>
    <div class='tags'>
@@ -142,14 +142,6 @@
      &mdash;
      <span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
    </li>
-    <li>
-      <span class='name'>initial_content</span>
-      <span class='type'>
-        (
-          <tt>String</tt>
-        )
-      </span>
-    </li>
  </ul>
 </div>
  </div>
@@ -241,7 +233,7 @@ to provide replace functionality.</p>
 </div>
    </div>
    <div id='footer'>
-  August 05, 14 20:37:47 by
+  August 07, 14 21:48:38 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>