1 files changed, 99 insertions, 0 deletions
diff --git a/ingen/client/ObjectModel.hpp b/ingen/client/ObjectModel.hpp
new file mode 100644
index 00000000..94906dec
--- /dev/null
+++ b/ingen/client/ObjectModel.hpp
@@ -0,0 +1,99 @@
+/*
+  This file is part of Ingen.
+  Copyright 2007-2015 David Robillard <http://drobilla.net/>
+
+  Ingen is free software: you can redistribute it and/or modify it under the
+  terms of the GNU Affero General Public License as published by the Free
+  Software Foundation, either version 3 of the License, or any later version.
+
+  Ingen 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 Affero General Public License for details.
+
+  You should have received a copy of the GNU Affero General Public License
+  along with Ingen.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+   @defgroup IngenClient Client-Side Models and Utilities
+*/
+
+#ifndef INGEN_CLIENT_OBJECTMODEL_HPP
+#define INGEN_CLIENT_OBJECTMODEL_HPP
+
+#include "ingen/Node.hpp"
+#include "ingen/URI.hpp"
+#include "ingen/URIs.hpp"
+#include "ingen/client/signal.hpp"
+#include "ingen/ingen.h"
+#include "ingen/types.hpp"
+#include "raul/Path.hpp"
+#include "raul/Symbol.hpp"
+
+namespace ingen {
+
+class Atom;
+
+namespace client {
+
+/** Base class for all Node models (BlockModel, GraphModel, PortModel).
+ *
+ * There are no non-const public methods intentionally, models are not allowed
+ * to be manipulated directly by anything (but the Store) because of the
+ * asynchronous nature of engine control.  To change something, use the
+ * controller (which the model probably shouldn't have a reference to but oh
+ * well, it reduces Collection Hell) and wait for the result (as a signal
+ * from this Model).
+ *
+ * @ingroup IngenClient
+ */
+class INGEN_API ObjectModel : public Node
+{
+public:
+	bool is_a(const URIs::Quark& type) const;
+
+	const Atom& get_property(const URI& key) const override;
+
+	void on_property(const URI& uri, const Atom& value) override;
+	void on_property_removed(const URI& uri, const Atom& value) override;
+
+	const Raul::Path&   path()   const override { return _path; }
+	const Raul::Symbol& symbol() const override { return _symbol; }
+
+	SPtr<ObjectModel> parent()     const { return _parent; }
+	bool              polyphonic() const;
+
+	Node* graph_parent() const override { return _parent.get(); }
+
+	// Signals
+	INGEN_SIGNAL(new_child, void, SPtr<ObjectModel>);
+	INGEN_SIGNAL(removed_child, void, SPtr<ObjectModel>);
+	INGEN_SIGNAL(property, void, const URI&, const Atom&);
+	INGEN_SIGNAL(property_removed, void, const URI&, const Atom&);
+	INGEN_SIGNAL(destroyed, void);
+	INGEN_SIGNAL(moved, void);
+
+protected:
+	friend class ClientStore;
+
+	ObjectModel(URIs& uris, const Raul::Path& path);
+	ObjectModel(const ObjectModel& copy);
+
+	void set_path(const Raul::Path& p) override;
+	virtual void set_parent(SPtr<ObjectModel> p);
+	virtual void add_child(SPtr<ObjectModel> c) {}
+	virtual bool remove_child(SPtr<ObjectModel> c) { return true; }
+
+	virtual void set(SPtr<ObjectModel> o);
+
+	SPtr<ObjectModel> _parent;
+
+private:
+	Raul::Path   _path;
+	Raul::Symbol _symbol;
+};
+
+} // namespace client
+} // namespace ingen
+
+#endif // INGEN_CLIENT_OBJECTMODEL_HPP