Emit the state of the job with the Finished signals.
[dcpomatic.git] / src / lib / job.h
index d047913a0a750f9f82c57ee65a3dcdd86497732b..5562afc16cc89cae1e9dec8941ee837622598d8b 100644 (file)
@@ -36,17 +36,24 @@ class Film;
 /** @class Job
  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  */
-class Job : public std::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable
+class Job : public std::enable_shared_from_this<Job>, public Signaller
 {
 public:
        explicit Job (std::shared_ptr<const Film> film);
        virtual ~Job ();
 
+       Job (Job const&) = delete;
+       Job& operator= (Job const&) = delete;
+
        /** @return user-readable name of this job */
        virtual std::string name () const = 0;
        virtual std::string json_name () const = 0;
        /** Run this job in the current thread. */
        virtual void run () = 0;
+       /** @return true if it should be possible to notify when this job finishes */
+       virtual bool enable_notify () const {
+               return false;
+       }
 
        void start ();
        bool pause_by_user ();
@@ -78,18 +85,25 @@ public:
        void set_progress (float, bool force = false);
        void sub (std::string);
        boost::optional<float> progress () const;
+       boost::optional<float> seconds_since_last_progress_update () const;
 
        std::shared_ptr<const Film> film () const {
                return _film;
        }
 
-       void when_finished (boost::signals2::connection& connection, boost::function<void()> finished);
+       enum class Result {
+               RESULT_OK,
+               RESULT_ERROR,     // we can't have plain ERROR on Windows
+               RESULT_CANCELLED
+       };
+
+       void when_finished(boost::signals2::connection& connection, std::function<void(Result)> finished);
 
        boost::signals2::signal<void()> Progress;
        /** Emitted from the UI thread when the job is finished */
-       boost::signals2::signal<void()> Finished;
+       boost::signals2::signal<void (Result)> Finished;
        /** Emitted from the job thread when the job is finished */
-       boost::signals2::signal<void()> FinishedImmediate;
+       boost::signals2::signal<void (Result)> FinishedImmediate;
 
 protected:
 
@@ -106,8 +120,9 @@ protected:
                FINISHED_CANCELLED ///< the job was cancelled
        };
 
+       Result state_to_result(State state) const;
        void set_state (State);
-       void set_error (std::string s, std::string d);
+       void set_error (std::string s, std::string d = "");
        void set_message (std::string m);
        int elapsed_sub_time () const;
        void check_for_interruption_or_pause ();