new files from sakari, missed last time

git-svn-id: svn://localhost/ardour2/branches/3.0@3738 d708f5d6-7413-0410-9779-e7cbd77b26cf

1 files changed, 276 insertions, 0 deletions

diff --git a/gtk2_ardour/session_metadata_dialog.h b/gtk2_ardour/session_metadata_dialog.h
new file mode 100644
index 0000000000..ffbb7a0930
--- /dev/null
+++ b/gtk2_ardour/session_metadata_dialog.h
@@ -0,0 +1,276 @@
+/*
+    Copyright (C) 2008 Paul Davis 
+    Author: Sakari Bergen
+
+    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 2 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, write to the Free Software Foundation, Inc.,
+    675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#ifndef __session_metadata_dialog_h__
+#define __session_metadata_dialog_h__
+
+#include "ardour_dialog.h"
+
+#include <gtkmm.h>
+#include <boost/shared_ptr.hpp>
+
+#include <string>
+#include <list>
+
+#include <ardour/session_metadata.h>
+
+using std::string;
+using Glib::ustring;
+
+class MetadataField;
+typedef boost::shared_ptr<MetadataField> MetadataPtr; 
+
+/// Wraps a metadata field to be used in a GUI
+class MetadataField {
+  public:
+	MetadataField (ustring const & field_name);
+	virtual ~MetadataField();
+	virtual MetadataPtr copy () = 0;
+	
+	virtual void save_data (ARDOUR::SessionMetadata & data) const = 0;
+	virtual void load_data (ARDOUR::SessionMetadata const & data) = 0;
+	
+	virtual ustring name() { return _name; }
+	virtual ustring value() { return _value; }
+	
+	/// Get widget containing name of field
+	virtual Gtk::Widget & name_widget () = 0;
+	/// Get label containing value of field
+	virtual Gtk::Widget & value_widget () = 0;
+	/// Get widget for editing value
+	virtual Gtk::Widget & edit_widget () = 0;
+  protected:
+	ustring _name;
+	ustring _value;
+};
+
+/// MetadataField that contains text
+class TextMetadataField : public MetadataField {
+  private:
+	typedef ustring (ARDOUR::SessionMetadata::*Getter) () const;
+	typedef void (ARDOUR::SessionMetadata::*Setter) (ustring const &);
+  public:
+	TextMetadataField (Getter getter, Setter setter, ustring const & field_name, guint width = 50);
+	MetadataPtr copy ();
+	
+	void save_data (ARDOUR::SessionMetadata & data) const;
+	void load_data (ARDOUR::SessionMetadata const & data);
+	
+	Gtk::Widget & name_widget ();
+	Gtk::Widget & value_widget ();
+	Gtk::Widget & edit_widget ();
+  private:
+	void update_value ();
+	
+	Getter getter;
+	Setter setter;
+	
+	Gtk::Label* label;
+	Gtk::Label* value_label;
+	Gtk::Entry* entry;
+	
+	uint width;
+};
+
+/// MetadataField that accepts only numbers
+class NumberMetadataField : public MetadataField {
+  private:
+	typedef uint32_t (ARDOUR::SessionMetadata::*Getter) () const;
+	typedef void (ARDOUR::SessionMetadata::*Setter) (uint32_t);
+  public:
+	NumberMetadataField (Getter getter, Setter setter, ustring const & field_name, guint numbers, guint width = 50);
+	MetadataPtr copy ();
+	
+	void save_data (ARDOUR::SessionMetadata & data) const;
+	void load_data (ARDOUR::SessionMetadata const & data);
+	
+	Gtk::Widget & name_widget ();
+	Gtk::Widget & value_widget ();
+	Gtk::Widget & edit_widget ();
+  private:
+	void update_value ();
+	ustring uint_to_str (uint32_t i) const;
+	uint32_t str_to_uint (ustring const & str) const;
+	
+	Getter getter;
+	Setter setter;
+	
+	Gtk::Label* label;
+	Gtk::Label* value_label;
+	Gtk::Entry* entry;
+	
+	guint numbers;
+	guint width;
+};
+
+/// Interface for MetadataFields
+class SessionMetadataSet {
+  public:
+	SessionMetadataSet (ustring const & name);
+	virtual ~SessionMetadataSet () {};
+	
+	void add_data_field (MetadataPtr field);
+	
+	/// Sets session, into which the data is eventually saved
+	virtual void set_session (ARDOUR::Session * s) { session = s; }
+	/// allows loading extra data into data sets (for importing etc.)
+	virtual void load_extra_data (ARDOUR::SessionMetadata const & data) { }
+	/// Saves data to session
+	virtual void save_data () = 0;
+	
+	virtual Gtk::Widget & get_widget () = 0;
+	virtual Gtk::Widget & get_tab_widget () = 0;
+	
+  protected:
+	typedef std::list<MetadataPtr> DataList;
+	DataList list;
+	ustring name;
+	ARDOUR::Session *session;
+};
+
+/// Contains MetadataFields for editing
+class SessionMetadataSetEditable : public SessionMetadataSet {
+  public:
+	SessionMetadataSetEditable (ustring const & name);
+	
+	Gtk::Widget & get_widget () { return table; }
+	Gtk::Widget & get_tab_widget ();
+	
+	/// Sets session and loads data
+	void set_session (ARDOUR::Session * s);
+	/// Saves from MetadataFields into data
+	void save_data ();
+	
+  private:
+	Gtk::Table table;
+	Gtk::Label tab_widget;
+};
+
+/// Contains MetadataFields for importing
+class SessionMetadataSetImportable : public SessionMetadataSet {
+  public:
+	SessionMetadataSetImportable (ustring const & name);
+	
+	Gtk::Widget & get_widget () { return tree_view; }
+	Gtk::Widget & get_tab_widget ();
+	Gtk::Widget & get_select_all_widget ();
+	
+	/// Loads importable data from data
+	void load_extra_data (ARDOUR::SessionMetadata const & data);
+	/// Saves from importable data (see load_data) to session_data
+	void save_data ();
+	
+  private:
+	DataList & session_list; // References MetadataSet::list
+	DataList import_list;
+	
+	struct Columns : public Gtk::TreeModel::ColumnRecord
+	{
+	  public:
+		Gtk::TreeModelColumn<ustring>     field;
+		Gtk::TreeModelColumn<ustring>     values;
+		Gtk::TreeModelColumn<bool>        import;
+		Gtk::TreeModelColumn<MetadataPtr> data;
+	
+		Columns() { add (field); add (values); add (import); add (data); }
+	};
+	
+	Glib::RefPtr<Gtk::ListStore>  tree;
+	Columns                       tree_cols;
+	Gtk::TreeView                 tree_view;
+	
+	Gtk::Label                    tab_widget;	
+	Gtk::CheckButton              select_all_check;
+	
+	void select_all ();
+	void selection_changed (ustring const & path);
+};
+
+/// Metadata dialog interface
+/**
+ * The DataSets are initalized in this class so that all
+ * Dialogs have the same sets of data in the same order.
+ */
+template <typename DataSet>
+class SessionMetadataDialog : public ArdourDialog
+{
+  public:
+	SessionMetadataDialog (ustring const & name);
+
+  protected:
+	void init_data ();
+	void load_extra_data (ARDOUR::SessionMetadata const & data);
+	void save_data ();
+	
+	virtual void init_gui () = 0;
+	virtual void save_and_close ();
+	virtual void end_dialog ();
+	
+	void warn_user (ustring const & string);
+	
+	typedef std::list<Gtk::Widget *> WidgetList;
+	typedef boost::shared_ptr<WidgetList> WidgetListPtr;
+	typedef Gtk::Widget & (DataSet::*WidgetFunc) ();
+	
+	/// Returns list of widgets gathered by calling f for each data set
+	WidgetListPtr get_custom_widgets (WidgetFunc f);
+	
+	/// Adds a widget to the table (vertical stacking) with automatic spacing
+	void add_widget (Gtk::Widget & widget);
+
+	Gtk::Notebook     notebook;
+
+  private:
+	void init_track_data ();
+	void init_album_data ();
+	void init_people_data ();
+
+	typedef boost::shared_ptr<SessionMetadataSet> DataSetPtr;
+	typedef std::list<DataSetPtr> DataSetList;
+	DataSetList data_list;
+	
+	Gtk::Button *     save_button;
+	Gtk::Button *     cancel_button;
+};
+
+class SessionMetadataEditor : public SessionMetadataDialog<SessionMetadataSetEditable> {
+  public:
+	SessionMetadataEditor ();
+	~SessionMetadataEditor ();
+	void run ();
+  private:
+	void init_gui ();
+};
+
+class SessionMetadataImporter : public SessionMetadataDialog<SessionMetadataSetImportable> {
+  public:
+	SessionMetadataImporter ();
+	~SessionMetadataImporter ();
+	void run ();
+
+  private:
+	void init_gui ();
+	
+	// Select all from -widget
+	Gtk::HBox    selection_hbox;
+	Gtk::Label   selection_label;
+	
+};
+
+#endif