Fix long-standing spelling bug.

[ardour.git] / libs / ardour / ardour / file_source.h

diff --git a/libs/ardour/ardour/file_source.h b/libs/ardour/ardour/file_source.h
index fdf7473c63fb4c847d28e71709c3c1a2407a17f5..00fb74b426114370723a717526744c9ea78f0451 100644 (file)
--- a/libs/ardour/ardour/file_source.h
+++ b/libs/ardour/ardour/file_source.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2006-2009 Paul Davis 
+    Copyright (C) 2006-2009 Paul Davis
 
     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
@@ -17,65 +17,99 @@
 
 */
 
-#ifndef __ardour_filesource_h__ 
+#ifndef __ardour_filesource_h__
 #define __ardour_filesource_h__
 
+#include <list>
+#include <string>
 #include <exception>
 #include <time.h>
 #include "ardour/source.h"
 
 namespace ARDOUR {
 
-class MissingSource : public std::exception {
-public:
+class LIBARDOUR_API MissingSource : public std::exception
+{
+  public:
+       MissingSource (const std::string& p, DataType t) throw ()
+               : path (p), type (t) {}
+       ~MissingSource() throw() {}
+
        virtual const char *what() const throw() { return "source file does not exist"; }
+
+       std::string path;
+       DataType type;
 };
 
 /** A source associated with a file on disk somewhere */
-class FileSource : virtual public Source {
+class LIBARDOUR_API FileSource : virtual public Source {
 public:
-       const Glib::ustring& path() const { return _path; }
+       virtual ~FileSource ();
+
+       const std::string& path() const { return _path; }
+
+       virtual bool safe_file_extension (const std::string& path) const = 0;
+
+       int  move_to_trash (const std::string& trash_dir_name);
+       void mark_take (const std::string& id);
+        void mark_immutable ();
+        void mark_immutable_except_write();
+       void mark_nonremovable ();
+
+       const std::string& take_id ()        const { return _take_id; }
+       bool                 within_session () const { return _within_session; }
+       uint16_t             channel()         const { return _channel; }
+
+       int set_state (const XMLNode&, int version);
+
+       int set_source_name (const std::string& newname, bool destructive);
 
-       virtual bool safe_file_extension (const Glib::ustring& path) const = 0;
-       
-       int  move_to_trash (const Glib::ustring& trash_dir_name);
-       void mark_take (const Glib::ustring& id);
-       void mark_immutable ();
-       
-       const Glib::ustring& take_id ()     const { return _take_id; }
-       bool                 is_embedded () const { return _is_embedded; }
-       uint16_t             channel()      const { return _channel; }
+       static bool find (Session&, DataType type, const std::string& path,
+                         bool must_exist, bool& is_new, uint16_t& chan,
+                         std::string& found_path);
 
-       int set_state (const XMLNode&);
+       static bool find_2X (Session&, DataType type, const std::string& path,
+                            bool must_exist, bool& is_new, uint16_t& chan,
+                            std::string& found_path);
 
-       int set_source_name (const Glib::ustring& newname, bool destructive);
-       
-       static void set_search_path (DataType type, const Glib::ustring& path);
+       void inc_use_count ();
+       bool removable () const;
+        bool is_stub () const;
+
+       const std::string& origin() const { return _origin; }
+
+       virtual void set_path (const std::string&);
+
+       static PBD::Signal2<int,std::string,std::vector<std::string> > AmbiguousFileName;
+
+       void existence_check ();
+       virtual void prevent_deletion ();
 
-       static bool find (DataType type, const Glib::ustring& path,
-                         bool must_exist, bool& is_new, uint16_t& chan,
-                         Glib::ustring& found_path);
+       /** Rename the file on disk referenced by this source to \param newname
+        */
+       int rename (const std::string& name);
 
-protected:
+       virtual void close () = 0;
+
+  protected:
        FileSource (Session& session, DataType type,
-                       const Glib::ustring& path, bool embedded,
-                       Source::Flag flags = Source::Flag(0));
-       
+                   const std::string& path,
+                   const std::string& origin,
+                   Source::Flag flags = Source::Flag(0));
+
        FileSource (Session& session, const XMLNode& node, bool must_exist);
 
-       virtual int init (const Glib::ustring& idstr, bool must_exist);
-       
+       virtual int init (const std::string& idstr, bool must_exist);
+
        virtual int move_dependents_to_trash() { return 0; }
-       
-       bool removable () const;
-       
-       Glib::ustring _path;
-       Glib::ustring _take_id;
-       bool          _file_is_new;
-       uint16_t      _channel;
-       bool          _is_embedded;
-
-       static std::map<DataType, Glib::ustring> search_paths;
+       void set_within_session_from_path (const std::string&);
+
+       std::string _path;
+       std::string _take_id;
+       bool        _file_is_new;
+       uint16_t    _channel;
+       bool        _within_session;
+       std::string _origin;
 };
 
 } // namespace ARDOUR