initial & final vertexes in the doc interface + tests

cyberiadamlpp.cpp

@@ -668,6 +668,16 @@ size_t  ElementCollection::elements_count() const
 	return count;
 }
 
+bool ElementCollection::has_initial() const
+{
+	for (ElementList::const_iterator i = children.begin(); i != children.end(); i++) {
+		if ((*i)->get_type() == elementInitial) {
+			return true;
+		}
+	}
+	return false;
+}
+
 void ElementCollection::add_element(Element* e)
 {
 	CYB_ASSERT(e);
@@ -1182,6 +1192,8 @@ StateMachine* Document::new_state_machine(const String& sm_name, const Rect& r)
 
 StateMachine* Document::new_state_machine(const ID& _id, const String& sm_name, const Rect& r)
 {
+	check_id_uniqueness(_id);
+	
 	StateMachine* sm = new StateMachine(this, _id, sm_name, r); 
 	add_element(sm);
 	update_metainfo_element();
@@ -1190,6 +1202,8 @@ StateMachine* Document::new_state_machine(const ID& _id, const String& sm_name,
 
 State* Document::new_state(ElementCollection* _parent, const String& state_name, const Rect& r, const Color& _color)
 {
+	check_parent_element(_parent);
+	
 	State* state = new State(_parent, generate_vertex_id(_parent), state_name, r, _color);
 	_parent->add_element(state);
 	return state;
@@ -1197,11 +1211,73 @@ State* Document::new_state(ElementCollection* _parent, const String& state_name,
 
 State* Document::new_state(ElementCollection* _parent, const ID& state_id, const String& state_name, const Rect& r, const Color& _color)
 {
+	check_parent_element(_parent);
+	check_id_uniqueness(state_id);
+
 	State* state = new State(_parent, state_id, state_name, r, _color);
 	_parent->add_element(state);
 	return state;
 }
 
+InitialPseudostate* Document::new_initial(ElementCollection* _parent, const Point& p)
+{
+	check_parent_element(_parent);
+	check_single_initial(_parent);
+
+	InitialPseudostate* initial = new InitialPseudostate(_parent, generate_vertex_id(_parent), p);
+	_parent->add_element(initial);
+	return initial;
+}
+
+InitialPseudostate* Document::new_initial(ElementCollection* _parent, const Name& initial_name, const Point& p)
+{
+	check_parent_element(_parent);
+	check_single_initial(_parent);
+	
+	InitialPseudostate* initial = new InitialPseudostate(_parent, generate_vertex_id(_parent), initial_name, p);
+	_parent->add_element(initial);
+	return initial;
+}
+
+InitialPseudostate* Document::new_initial(ElementCollection* _parent, const ID& _id, const Name& initial_name, const Point& p)
+{
+	check_parent_element(_parent);
+	check_single_initial(_parent);
+	check_id_uniqueness(_id);
+	
+	InitialPseudostate* initial = new InitialPseudostate(_parent, _id, initial_name, p);
+	_parent->add_element(initial);
+	return initial;
+}
+
+FinalState* Document::new_final(ElementCollection* _parent, const Point& point)
+{
+	check_parent_element(_parent);
+
+	FinalState* fin = new FinalState(_parent, generate_vertex_id(_parent), point);
+	_parent->add_element(fin);
+	return fin;
+}
+
+FinalState* Document::new_final(ElementCollection* _parent, const Name& _name, const Point& point)
+{
+	check_parent_element(_parent);
+
+	FinalState* fin = new FinalState(_parent, generate_vertex_id(_parent), _name, point);
+	_parent->add_element(fin);
+	return fin;
+}
+
+FinalState* Document::new_final(ElementCollection* _parent, const ID& _id, const Name& _name, const Point& point)
+{
+	check_parent_element(_parent);
+	check_id_uniqueness(_id);
+
+	FinalState* fin = new FinalState(_parent, _id, _name, point);
+	_parent->add_element(fin);
+	return fin;	
+}
+
 void Document::check_cyberiada_error(int res, const String& msg) const
 {
 	switch (res) {
@@ -1217,6 +1293,27 @@ void Document::check_cyberiada_error(int res, const String& msg) const
 	}
 }
 
+void Document::check_parent_element(const ElementCollection* _parent) const
+{
+	if (!_parent) {
+		throw ParametersException("No parent element");
+	}
+}
+
+void Document::check_id_uniqueness(const ID& _id) const
+{
+	if (find_element_by_id(_id)) {
+		throw ParametersException(String("New element id ") + _id + " is not unique");
+	}
+}
+
+void Document::check_single_initial(const ElementCollection* _parent) const
+{
+	if (_parent->has_initial()) {
+		throw ParametersException("Parent already has initial element");
+	}
+}
+
 void Document::import_nodes_recursively(ElementCollection* collection, CyberiadaNode* nodes)
 {
 	CYB_ASSERT(collection);

cyberiadamlpp.h

@@ -285,6 +285,7 @@ namespace Cyberiada {
 		ConstElementList         find_elements_by_types(const ElementTypes& types) const;
 		ElementList              find_elements_by_type(ElementType type);
 		ElementList              find_elements_by_types(const ElementTypes& types);
+		bool                     has_initial() const;
 
 		virtual void             add_element(Element* e);
 		virtual void             add_first_element(Element* e);
@@ -543,7 +544,13 @@ namespace Cyberiada {
 												 const Rect& r = Rect(), const Color& color = Color());
 		State*                         new_state(ElementCollection* parent, const ID& id, const String& state_name,
 												 const Rect& r = Rect(), const Color& color = Color());
-		
+		InitialPseudostate*            new_initial(ElementCollection* parent, const Point& p = Point());
+		InitialPseudostate*            new_initial(ElementCollection* parent, const Name& initial_name, const Point& p = Point());
+		InitialPseudostate*            new_initial(ElementCollection* parent, const ID& id, const Name& initial_name, const Point& p = Point());
+		FinalState*                    new_final(ElementCollection* parent, const Point& point = Point());
+		FinalState*                    new_final(ElementCollection* parent, const Name& name, const Point& point = Point());
+		FinalState*                    new_final(ElementCollection* parent, const ID& id, const Name& name, const Point& point = Point());
+
 		void                           load(const String& path, DocumentFormat f = formatDetect);
 		void                           save(const String& path, DocumentFormat f = formatCyberiada10) const;
 
@@ -558,7 +565,6 @@ namespace Cyberiada {
 		virtual std::ostream&          dump(std::ostream& os) const;
 		
 	private:
-		void                           check_cyberiada_error(int res, const String& msg = "") const;
 		void                           update_metainfo_element();
 		ID                             generate_sm_id() const;
 		ID                             generate_vertex_id(const Element* parent) const;
@@ -568,6 +574,11 @@ namespace Cyberiada {
 		void                           export_edges(CyberiadaEdge** edges, const StateMachine* sm) const;
 		CyberiadaMetainformation*      export_meta() const;
 
+		void                           check_cyberiada_error(int res, const String& msg = "") const;
+		void                           check_parent_element(const ElementCollection* parent) const;
+		void                           check_id_uniqueness(const ID& id) const;
+		void                           check_single_initial(const ElementCollection* parent) const;
+		
 		String                         format;
 		DocumentMetainformation        metainfo;
 		Comment*                       metainfo_element;

tests/06-two-statemachines.cpp

@@ -29,6 +29,11 @@ int main(int argc, char** argv)
 {
 	Document d;
 	d.new_state_machine("SM1");
+	try {
+		// check id uniqueness
+		d.new_state_machine("G0", "SM2");
+	} catch (const Cyberiada::ParametersException&){
+	}
 	d.new_state_machine("SM2");
 	try {
 		cout << d << endl;

tests/08-state-hierarchy.cpp

@@ -33,7 +33,17 @@ int main(int argc, char** argv)
 	StateMachine* sm = d.new_state_machine("SM");
 
 	State* parent1 = d.new_state(sm, "Parent 0");
-	d.new_state(parent1, "State 0-0");	
+
+	try {
+		// check id uniqueness
+		d.new_state(sm, "n0", "test");
+	} catch (const Cyberiada::ParametersException&){
+	}
+	
+	CYB_ASSERT(parent1->is_simple_state());
+	d.new_state(parent1, "State 0-0");
+	CYB_ASSERT(parent1->is_composite_state());
+
 	State* subparent = d.new_state(parent1, "Subparent 0-1");
 	d.new_state(subparent, "State 0-1-0");
 	d.new_state(subparent, "State 0-1-1");
@@ -41,6 +51,12 @@ int main(int argc, char** argv)
 	State* parent2 = d.new_state(sm, "Parent 1");
 	d.new_state(parent2, "State 1-0");
 	d.new_state(parent2, "State 1-1");
+	try {
+		// check id uniqueness on the deep level
+		d.new_state(parent2, "n1::n1", "test");
+	} catch (const Cyberiada::ParametersException&){
+	}
+
 	try {
 		cout << d << endl;
 		d.save(string(argv[0]) + ".graphml", formatCyberiada10);

tests/09-initial.cpp

@@ -0,0 +1,57 @@
+/* -----------------------------------------------------------------------------
+ * The Cyberiada GraphML C++ library implemention
+ *
+ * The test
+ *
+ * Copyright (C) 2024 Alexey Fedoseev <aleksey@fedoseev.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see https://www.gnu.org/licenses/
+ * ----------------------------------------------------------------------------- */
+
+#include <iostream>
+#include "cyberiadamlpp.h"
+#include "testutils.h"
+
+using namespace Cyberiada;
+using namespace std;
+
+int main(int argc, char** argv)
+{
+	Document d;
+
+	StateMachine* sm = d.new_state_machine("SM");
+
+	d.new_initial(sm);
+	try {
+		// check id uniqueness
+		d.new_initial(sm, "n0");
+	} catch (const Cyberiada::ParametersException&){
+	}
+	
+	State* parent = d.new_state(sm, "State");
+	d.new_initial(parent, "Local init");
+	try {
+		// check double initial
+		d.new_initial(parent);
+	} catch (const Cyberiada::ParametersException&){
+	}
+	
+	try {
+		cout << d << endl;
+		d.save(string(argv[0]) + ".graphml", formatCyberiada10);
+	} catch (const Cyberiada::Exception&) {
+		return 1;
+	}
+	return 0;
+}

tests/09-initial.test-output.graphml

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<graphml xmlns="http://graphml.graphdrawing.org/xmlns">
+  <data key="gFormat">Cyberiada-GraphML-1.0</data>
+  <key id="gFormat" for="graphml" attr.name="format" attr.type="string"/>
+  <key id="dName" for="graph" attr.name="name" attr.type="string"/>
+  <key id="dName" for="node" attr.name="name" attr.type="string"/>
+  <key id="dStateMachine" for="graph" attr.name="stateMachine" attr.type="string"/>
+  <key id="dSubmachineState" for="node" attr.name="submachineState" attr.type="string"/>
+  <key id="dGeometry" for="graph" attr.name="geometry"/>
+  <key id="dGeometry" for="node" attr.name="geometry"/>
+  <key id="dGeometry" for="edge" attr.name="geometry"/>
+  <key id="dSourcePoint" for="edge" attr.name="sourcePoint"/>
+  <key id="dTargetPoint" for="edge" attr.name="targetPoint"/>
+  <key id="dLabelGeometry" for="edge" attr.name="labelGeometry"/>
+  <key id="dNote" for="node" attr.name="note" attr.type="string"/>
+  <key id="dVertex" for="node" attr.name="vertex" attr.type="string"/>
+  <key id="dData" for="node" attr.name="data" attr.type="string"/>
+  <key id="dData" for="edge" attr.name="data" attr.type="string"/>
+  <key id="dMarkup" for="node" attr.name="markup" attr.type="string"/>
+  <key id="dColor" for="node" attr.name="color" attr.type="string"/>
+  <key id="dColor" for="edge" attr.name="color" attr.type="string"/>
+  <key id="dPivot" for="edge" attr.name="pivot" attr.type="string"/>
+  <key id="dChunk" for="edge" attr.name="chunk" attr.type="string"/>
+  <graph id="G0" edgedefault="directed">
+    <data key="dName">SM</data>
+    <node id="nMeta">
+      <data key="dNote">formal</data>
+      <data key="dName">CGML_META</data>
+      <data key="dData">standardVersion/ 1.0
+
+transitionOrder/ transitionFirst
+
+eventPropagation/ block
+
+</data>
+    </node>
+    <node id="n0">
+      <data key="dVertex">initial</data>
+    </node>
+    <node id="n1">
+      <data key="dName">State</data>
+      <graph id="n1:" edgedefault="directed">
+        <node id="n1::n0">
+          <data key="dVertex">initial</data>
+          <data key="dName">Local init</data>
+        </node>
+      </graph>
+    </node>
+  </graph>
+</graphml>

tests/09-output.txt

@@ -0,0 +1 @@
+Document: {id: '', name: '', format: 'Cyberiada-GraphML-1.0', meta: {standard version: '1.0', transition order: transition first, event propagation: block events}, elements: {State Machine: {id: 'G0', name: 'SM', elements: {Initial: {id: 'n0'}, Composite State: {id: 'n1', name: 'State', elements: {Initial: {id: 'n1::n0', name: 'Local init'}}}}}}

tests/10-final.cpp

@@ -0,0 +1,52 @@
+/* -----------------------------------------------------------------------------
+ * The Cyberiada GraphML C++ library implemention
+ *
+ * The test
+ *
+ * Copyright (C) 2024 Alexey Fedoseev <aleksey@fedoseev.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see https://www.gnu.org/licenses/
+ * ----------------------------------------------------------------------------- */
+
+#include <iostream>
+#include "cyberiadamlpp.h"
+#include "testutils.h"
+
+using namespace Cyberiada;
+using namespace std;
+
+int main(int argc, char** argv)
+{
+	Document d;
+
+	StateMachine* sm = d.new_state_machine("SM");
+
+	d.new_final(sm);
+	try {
+		// check id uniqueness
+		d.new_final(sm, "n0", "test");
+	} catch (const Cyberiada::ParametersException&){
+	}
+	
+	State* parent = d.new_state(sm, "State");
+	d.new_final(parent, "Local exit");
+
+	try {
+		cout << d << endl;
+		d.save(string(argv[0]) + ".graphml", formatCyberiada10);
+	} catch (const Cyberiada::Exception&) {
+		return 1;
+	}
+	return 0;
+}

tests/10-final.test-output.graphml

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<graphml xmlns="http://graphml.graphdrawing.org/xmlns">
+  <data key="gFormat">Cyberiada-GraphML-1.0</data>
+  <key id="gFormat" for="graphml" attr.name="format" attr.type="string"/>
+  <key id="dName" for="graph" attr.name="name" attr.type="string"/>
+  <key id="dName" for="node" attr.name="name" attr.type="string"/>
+  <key id="dStateMachine" for="graph" attr.name="stateMachine" attr.type="string"/>
+  <key id="dSubmachineState" for="node" attr.name="submachineState" attr.type="string"/>
+  <key id="dGeometry" for="graph" attr.name="geometry"/>
+  <key id="dGeometry" for="node" attr.name="geometry"/>
+  <key id="dGeometry" for="edge" attr.name="geometry"/>
+  <key id="dSourcePoint" for="edge" attr.name="sourcePoint"/>
+  <key id="dTargetPoint" for="edge" attr.name="targetPoint"/>
+  <key id="dLabelGeometry" for="edge" attr.name="labelGeometry"/>
+  <key id="dNote" for="node" attr.name="note" attr.type="string"/>
+  <key id="dVertex" for="node" attr.name="vertex" attr.type="string"/>
+  <key id="dData" for="node" attr.name="data" attr.type="string"/>
+  <key id="dData" for="edge" attr.name="data" attr.type="string"/>
+  <key id="dMarkup" for="node" attr.name="markup" attr.type="string"/>
+  <key id="dColor" for="node" attr.name="color" attr.type="string"/>
+  <key id="dColor" for="edge" attr.name="color" attr.type="string"/>
+  <key id="dPivot" for="edge" attr.name="pivot" attr.type="string"/>
+  <key id="dChunk" for="edge" attr.name="chunk" attr.type="string"/>
+  <graph id="G0" edgedefault="directed">
+    <data key="dName">SM</data>
+    <node id="nMeta">
+      <data key="dNote">formal</data>
+      <data key="dName">CGML_META</data>
+      <data key="dData">standardVersion/ 1.0
+
+transitionOrder/ transitionFirst
+
+eventPropagation/ block
+
+</data>
+    </node>
+    <node id="n0">
+      <data key="dVertex">final</data>
+    </node>
+    <node id="n1">
+      <data key="dName">State</data>
+      <graph id="n1:" edgedefault="directed">
+        <node id="n1::n0">
+          <data key="dVertex">final</data>
+          <data key="dName">Local exit</data>
+        </node>
+      </graph>
+    </node>
+  </graph>
+</graphml>

tests/10-output.txt

@@ -0,0 +1 @@
+Document: {id: '', name: '', format: 'Cyberiada-GraphML-1.0', meta: {standard version: '1.0', transition order: transition first, event propagation: block events}, elements: {State Machine: {id: 'G0', name: 'SM', elements: {Final: {id: 'n0'}, Composite State: {id: 'n1', name: 'State', elements: {Final: {id: 'n1::n0', name: 'Local exit'}}}}}}