diff --git a/doc/doctrees/environment.pickle b/doc/doctrees/environment.pickle
index b0bf010..a65f29a 100644
Binary files a/doc/doctrees/environment.pickle and b/doc/doctrees/environment.pickle differ
diff --git a/doc/doctrees/tutorials/custom_types.doctree b/doc/doctrees/tutorials/custom_types.doctree
index 5f0a456..46a4fd0 100644
Binary files a/doc/doctrees/tutorials/custom_types.doctree and b/doc/doctrees/tutorials/custom_types.doctree differ
diff --git a/doc/html/_sources/tutorials/custom_types.txt b/doc/html/_sources/tutorials/custom_types.txt
index 7137f07..da62c91 100644
--- a/doc/html/_sources/tutorials/custom_types.txt
+++ b/doc/html/_sources/tutorials/custom_types.txt
@@ -20,8 +20,9 @@ Constructor
D:YAML uses the `Constructor <../api/dyaml.constructor.html>`_ class to process
each node to hold data type corresponding to its tag. *Constructor* stores a
function for each supported tag to process it. These functions are supplied by
-the user using the *addConstructor()* method. *Constructor* is then passed to
-*Loader*, which parses YAML input.
+the user using the *addConstructorXXX()* methods, where *XXX* is *Scalar*,
+*Sequence* or *Mapping*. *Constructor* is then passed to *Loader*, which parses
+YAML input.
Struct types have no specific requirements for YAML support. Class types should
define the *opEquals()* operator, as this is used in equality comparisons of
@@ -41,17 +42,20 @@ following struct:
}
First, we need a function to construct our data type. It must take two *Mark*
-structs, which store position of the node in the file, and either a *string*, an
-array of *Node* or of *Node.Pair*, depending on whether we're constructing our
-value from a scalar, sequence, or mapping, respectively. In this tutorial, we
-have functions to construct a color from a scalar, using HTML-like format,
-RRGGBB, or from a mapping, where we use the following format:
-{r:RRR, g:GGG, b:BBB} . Code of these functions:
+structs, which store position of the node in the file, and a reference to *Node*
+to construct from. The node is guaranteed to contain either a *string*, an array
+of *Node* or of *Node.Pair*, depending on whether we're constructing our value
+from a scalar, sequence, or mapping, respectively. In this tutorial, we have
+functions to construct a color from a scalar, using CSS-like format, RRGGBB, or
+from a mapping, where we use the following format: {r:RRR, g:GGG, b:BBB} . Code
+of these functions:
.. code-block:: d
- Color constructColorScalar(Mark start, Mark end, string value)
+ Color constructColorScalar(Mark start, Mark end, ref Node node)
{
+ string value = node.get!string;
+
if(value.length != 6)
{
throw new ConstructorException("Invalid color: " ~ value, start, end);
@@ -82,30 +86,21 @@ RRGGBB, or from a mapping, where we use the following format:
return result;
}
- Color constructColorMapping(Mark start, Mark end, Node.Pair[] pairs)
+ Color constructColorMapping(Mark start, Mark end, ref Node node)
{
- int r, g, b;
- r = g = b = -1;
- bool error = pairs.length != 3;
+ int r,g,b;
+ bool error = false;
- foreach(ref pair; pairs)
+ //Might throw if a value is missing or is not an integer.
+ try
{
- //Key might not be a string, and value might not be an int,
- //so we need to check for that
- try
- {
- switch(pair.key.get!string)
- {
- case "r": r = pair.value.get!int; break;
- case "g": g = pair.value.get!int; break;
- case "b": b = pair.value.get!int; break;
- default: error = true;
- }
- }
- catch(NodeException e)
- {
- error = true;
- }
+ r = node["r"].get!int;
+ g = node["g"].get!int;
+ b = node["b"].get!int;
+ }
+ catch(NodeException e)
+ {
+ error = true;
}
if(error || r < 0 || r > 255 || g < 0 || g > 255 || b < 0 || b > 255)
@@ -146,8 +141,8 @@ Finally, the code to put it all together:
{
auto constructor = new Constructor;
//both functions handle the same tag, but one handles scalar, one mapping.
- constructor.addConstructor("!color", &constructColorScalar);
- constructor.addConstructor("!color-mapping", &constructColorMapping);
+ constructor.addConstructorScalar("!color", &constructColorScalar);
+ constructor.addConstructorMapping("!color-mapping", &constructColorMapping);
auto loader = Loader("input.yaml");
loader.constructor = constructor;
@@ -284,7 +279,7 @@ With the following code, we will add support for dumping the our Color type.
}
First we get the *Color* from the node. Then we convert it to a string with the
-HTML-like format we've used before. Finally, we use the *representScalar()*
+CSS-like format we've used before. Finally, we use the *representScalar()*
method of *Representer* to get a scalar node ready for output.
There are corresponding *representMapping()* and *representSequence()* methods
as well, with examples in the
diff --git a/doc/html/api/dyaml.constructor.html b/doc/html/api/dyaml.constructor.html
index 697ca19..27b96d6 100644
--- a/doc/html/api/dyaml.constructor.html
+++ b/doc/html/api/dyaml.constructor.html
@@ -94,14 +94,15 @@
-void addConstructor(T, U)(in string tag, T function(Mark, Mark, U) ctor);
+void addConstructorScalar(T)(in string tag, T function(Mark, Mark, ref Node) ctor);
-Add a constructor function.
+
Add a constructor function from scalar.
-The function passed must two Marks (determining start and end positions of
- the node in file) and either a string (if constructing from scalar),
- an array of Nodes (from sequence) or an array of Node.Pair (from mapping).
- The value returned by this function will be stored in the resulring node.
+
The function must take two Marks (start and end positions of
+ the node in file) and a reference to Node to construct from.
+ The node contains a string for scalars, Node[] for sequences and
+ Node.Pair[] for mappings.
+ The value returned by this function will be stored in the resulting node.
Only one constructor function can be set for one tag.
@@ -113,47 +114,61 @@
Constructor function. |
+
+void addConstructorSequence(T)(in string tag, T function(Mark, Mark, ref Node) ctor);
+
+Add a constructor function from sequence.
+
+See Also:addConstructorScalar
+
+
+void addConstructorMapping(T)(in string tag, T function(Mark, Mark, ref Node) ctor);
+
+Add a constructor function from a mapping.
+
+See Also:addConstructorScalar
+
-YAMLNull constructNull(Mark start, Mark end, string value);
+YAMLNull constructNull(Mark start, Mark end, ref Node node);
-Construct a null node.
+Construct a null node.
-YAMLMerge constructMerge(Mark start, Mark end, string value);
+YAMLMerge constructMerge(Mark start, Mark end, ref Node node);
-Construct a merge node - a node that merges another node into a mapping.
+Construct a merge node - a node that merges another node into a mapping.
-bool constructBool(Mark start, Mark end, string value);
+bool constructBool(Mark start, Mark end, ref Node node);
-Construct a boolean node.
+Construct a boolean node.
-long constructLong(Mark start, Mark end, string value);
+long constructLong(Mark start, Mark end, ref Node node);
-Construct an integer (long) node.
+Construct an integer (long) node.
-real constructReal(Mark start, Mark end, string value);
+real constructReal(Mark start, Mark end, ref Node node);
-Construct a floating point (real) node.
+Construct a floating point (real) node.
-ubyte[] constructBinary(Mark start, Mark end, string value);
+ubyte[] constructBinary(Mark start, Mark end, ref Node node);
-Construct a binary (base64) node.
+Construct a binary (base64) node.
-SysTime constructTimestamp(Mark start, Mark end, string value);
+SysTime constructTimestamp(Mark start, Mark end, ref Node node);
-Construct a timestamp (SysTime) node.
+Construct a timestamp (SysTime) node.
-string constructString(Mark start, Mark end, string value);
+string constructString(Mark start, Mark end, ref Node node);
-Construct a string node.
+Construct a string node.
Pair[] getPairs(string type, Mark start, Mark end, Node[] nodes);
@@ -161,29 +176,29 @@
Convert a sequence of single-element mappings into a sequence of pairs.
-Pair[] constructOrderedMap(Mark start, Mark end, Node[] nodes);
+Pair[] constructOrderedMap(Mark start, Mark end, ref Node node);
-Construct an ordered map (ordered sequence of key:value pairs without duplicates) node.
+Construct an ordered map (ordered sequence of key:value pairs without duplicates) node.
-Pair[] constructPairs(Mark start, Mark end, Node[] nodes);
+Pair[] constructPairs(Mark start, Mark end, ref Node node);
-Construct a pairs (ordered sequence of key: value pairs allowing duplicates) node.
+Construct a pairs (ordered sequence of key: value pairs allowing duplicates) node.
-Node[] constructSet(Mark start, Mark end, Pair[] pairs);
+Node[] constructSet(Mark start, Mark end, ref Node node);
-Construct a set node.
+Construct a set node.
-Node[] constructSequence(Mark start, Mark end, Node[] nodes);
+Node[] constructSequence(Mark start, Mark end, ref Node node);
-Construct a sequence (array) node.
+Construct a sequence (array) node.
-Pair[] constructMap(Mark start, Mark end, Pair[] pairs);
+Pair[] constructMap(Mark start, Mark end, ref Node node);
-Construct an unordered map (unordered set of key: value pairs without duplicates) node.
+Construct an unordered map (unordered set of key: value pairs without duplicates) node.
diff --git a/doc/html/articles/spec_differences.html b/doc/html/articles/spec_differences.html
index e0b8e1f..dd6c7fb 100644
--- a/doc/html/articles/spec_differences.html
+++ b/doc/html/articles/spec_differences.html
@@ -138,7 +138,7 @@ struct appears in Phobos.
diff --git a/doc/html/index.html b/doc/html/index.html
index 4e17f43..b18e041 100644
--- a/doc/html/index.html
+++ b/doc/html/index.html
@@ -104,7 +104,7 @@