Start building a common (client/server) abstract interface for graph objects.

git-svn-id: http://svn.drobilla.net/lad/ingen@834 a436a847-0d15-0410-975c-d299462d15a1

2 files changed, 54 insertions, 0 deletions

diff --git a/src/common/interface/EngineInterface.hpp b/src/common/interface/EngineInterface.hpp
index b3827a74..46359972 100644
--- a/src/common/interface/EngineInterface.hpp
+++ b/src/common/interface/EngineInterface.hpp
@@ -33,6 +33,8 @@ namespace Shared {
 /** The (only) interface clients use to communicate with the engine.
  *
  * Purely virtual (except for the destructor).
+ *
+ * \ingroup interface
  */
 class EngineInterface
 {
diff --git a/src/common/interface/GraphObject.hpp b/src/common/interface/GraphObject.hpp
new file mode 100644
index 00000000..65ffef88
--- /dev/null
+++ b/src/common/interface/GraphObject.hpp
@@ -0,0 +1,52 @@
+/* This file is part of Ingen.
+ * Copyright (C) 2007 Dave Robillard <http://drobilla.net>
+ * 
+ * Ingen 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 2 of the License, or (at your option) 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 General Public License for details.
+ * 
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef GRAPHOBJECT_H
+#define GRAPHOBJECT_H
+
+#include <string>
+#include <map>
+#include <raul/Deletable.hpp>
+#include <raul/Path.hpp>
+#include <raul/Atom.hpp>
+
+namespace Ingen {
+namespace Shared {
+
+
+/** An object on the audio graph - Patch, Node, Port, etc.
+ *
+ * Purely virtual (except for the destructor).
+ *
+ * \ingroup interface
+ */
+class GraphObject : public Raul::Deletable
+{
+public:
+	typedef std::map<std::string, Raul::Atom> MetadataMap;
+
+	virtual const Raul::Path   path()       const = 0;
+	virtual const std::string& name()       const = 0;
+	virtual const MetadataMap& metadata()   const = 0;
+	virtual bool               polyphonic() const = 0;
+};
+
+
+} // namespace Shared
+} // namespace Ingen
+
+#endif // GRAPHOBJECT_H