summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/element_import_handler.h
blob: 2401cf7a067ad0cb57b5880bb9a4043cdc8494ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
    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 __ardour_element_import_handler_h__
#define __ardour_element_import_handler_h__

#include <string>
#include <list>
#include <set>

#include <boost/shared_ptr.hpp>

class XMLTree;

namespace ARDOUR {

class Session;
class ElementImporter;

/// Virtual interface class for element import handlers 
class ElementImportHandler
{
  public:
	typedef boost::shared_ptr<ElementImporter> ElementPtr;
	typedef std::list<ElementPtr> ElementList;

	/** ElementImportHandler constructor
	 * The constructor should find everything from the XML Tree it can handle
	 * and create respective Elements stored in elements.
	 *
	 * @param source XML tree to be parsed
	 * @see elements
	 */
	ElementImportHandler (XMLTree const & source, ARDOUR::Session & session) :
	  source (source), session (session) { }
	
	virtual ~ElementImportHandler ();
	
	/** Gets a textual representation of the element type
	 * @return textual representation of element type
	 */
	virtual std::string get_info () const = 0;
	
	/// Elements this handler handles
	ElementList elements;
	
	/* For checking duplicates names against queued elements */
	
	/** Checks whether or not an element with some name is queued or not
	 * @param name name to check
	 * @return true if name is not used
	 */
	bool check_name (const std::string & name) const;
	
	/// Adds name to the list of used names
	void add_name (std::string name);
	
	/// Removes name from the list of used names
	void remove_name (const std::string & name);
	
	/// Checks wheter or not all elements can be imported cleanly
	static bool dirty () { return _dirty; }
	
	/// Sets handler dirty
	static void set_dirty () { _dirty = true; }
	
	/// Checks wheter or not all elements were imported cleanly
	static bool errors () { return _errors; }
	
	/// Sets handler dirty
	static void set_errors () { _errors = true; }

  protected:
	/// Source session XML tree
	XMLTree const &   source;
	
	/// Destination session
	ARDOUR::Session & session;
	
	/// Session XML readability
	static bool _dirty;
	
	/// Errors post initialization
	static bool _errors;
	
  private:
	/// Set of names for duplicate checking
	std::set<std::string> names;
};

} // namespace ARDOUR

#endif