2 Copyright (C) 2006-2009 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_filesource_h__
21 #define __ardour_filesource_h__
27 #include "ardour/source.h"
31 class LIBARDOUR_API MissingSource : public std::exception
34 MissingSource (const std::string& p, DataType t) throw ()
35 : path (p), type (t) {}
36 ~MissingSource() throw() {}
38 virtual const char *what() const throw() { return "source file does not exist"; }
44 /** A source associated with a file on disk somewhere */
45 class LIBARDOUR_API FileSource : virtual public Source {
47 virtual ~FileSource ();
49 virtual const std::string& path() const { return _path; }
51 virtual bool safe_file_extension (const std::string& path) const = 0;
53 int move_to_trash (const std::string& trash_dir_name);
54 void mark_take (const std::string& id);
55 void mark_immutable ();
56 void mark_immutable_except_write();
57 void mark_nonremovable ();
59 const std::string& take_id () const { return _take_id; }
60 bool within_session () const { return _within_session; }
61 uint16_t channel() const { return _channel; }
63 int set_state (const XMLNode&, int version);
65 int set_source_name (const std::string& newname, bool destructive);
67 static bool find (Session&, DataType type, const std::string& path,
68 bool must_exist, bool& is_new, uint16_t& chan,
69 std::string& found_path);
71 static bool find_2X (Session&, DataType type, const std::string& path,
72 bool must_exist, bool& is_new, uint16_t& chan,
73 std::string& found_path);
75 void inc_use_count ();
76 bool removable () const;
77 bool is_stub () const;
79 const std::string& origin() const { return _origin; }
81 virtual void set_path (const std::string&);
83 static PBD::Signal2<int,std::string,std::vector<std::string> > AmbiguousFileName;
85 void existence_check ();
86 virtual void prevent_deletion ();
89 FileSource (Session& session, DataType type,
90 const std::string& path,
91 const std::string& origin,
92 Source::Flag flags = Source::Flag(0));
94 FileSource (Session& session, const XMLNode& node, bool must_exist);
96 virtual int init (const std::string& idstr, bool must_exist);
98 virtual int move_dependents_to_trash() { return 0; }
99 void set_within_session_from_path (const std::string&);
102 std::string _take_id;
105 bool _within_session;
111 } // namespace ARDOUR
113 #endif /* __ardour_filesource_h__ */