Fix long-standing spelling bug.
[ardour.git] / libs / ardour / ardour / file_source.h
index 01fa6adb749e645cdcf3e42200436a5217b8de0c..00fb74b426114370723a717526744c9ea78f0451 100644 (file)
 
 namespace ARDOUR {
 
-class MissingSource : public std::exception 
+class LIBARDOUR_API MissingSource : public std::exception
 {
   public:
-        MissingSource (const std::string& p, DataType t) throw ()
-                : path (p), type (t) {}
-        ~MissingSource() throw() {}
+       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;
+       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:
-       virtual ~FileSource () {}
-       
+       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 ();
+        void mark_immutable_except_write();
        void mark_nonremovable ();
 
        const std::string& take_id ()        const { return _take_id; }
@@ -64,31 +65,42 @@ public:
        int set_source_name (const std::string& newname, bool destructive);
 
        static bool find (Session&, DataType type, const std::string& path,
-                          bool must_exist, bool& is_new, uint16_t& chan,
-                          std::string& found_path);
+                         bool must_exist, bool& is_new, uint16_t& chan,
+                         std::string& found_path);
 
        static bool find_2X (Session&, DataType type, const std::string& path,
-                             bool must_exist, bool& is_new, uint16_t& chan,
-                             std::string& found_path);
+                            bool must_exist, bool& is_new, uint16_t& chan,
+                            std::string& found_path);
 
-        void inc_use_count ();
+       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 ();
 
-        const std::string& origin() const { return _origin; }
+       /** Rename the file on disk referenced by this source to \param newname
+        */
+       int rename (const std::string& name);
 
-       static PBD::Signal3<int,std::string,std::string,std::vector<std::string> > AmbiguousFileName;
+       virtual void close () = 0;
 
-protected:
+  protected:
        FileSource (Session& session, DataType type,
-                    const std::string& path, 
-                    const std::string& origin,
-                    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 std::string& idstr, bool must_exist);
 
-        virtual void set_path (const std::string&);
        virtual int move_dependents_to_trash() { return 0; }
        void set_within_session_from_path (const std::string&);
 
@@ -97,10 +109,7 @@ protected:
        bool        _file_is_new;
        uint16_t    _channel;
        bool        _within_session;
-        std::string _origin;
-        bool        _open;
-        
-        void prevent_deletion ();
+       std::string _origin;
 };
 
 } // namespace ARDOUR