Add some basic JSON stuff.

[dcpomatic.git] / src / lib / job.h

diff --git a/src/lib/job.h b/src/lib/job.h
index 802bf468da24d71a723fc31929d1fcdd0810cca0..489464558764bc348d85f741f0ddd634ddbdb9b0 100644 (file)
--- a/src/lib/job.h
+++ b/src/lib/job.h
@@ -21,53 +21,66 @@
  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  */
 
-#ifndef DVDOMATIC_JOB_H
-#define DVDOMATIC_JOB_H
+#ifndef DCPOMATIC_JOB_H
+#define DCPOMATIC_JOB_H
 
 #include <string>
 #include <boost/thread/mutex.hpp>
 #include <boost/enable_shared_from_this.hpp>
-#include <sigc++/sigc++.h>
+#include <boost/signals2.hpp>
+#include <boost/thread.hpp>
 
-class Log;
-class FilmState;
-class Options;
+class Film;
 
 /** @class Job
  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  */
-class Job : public boost::enable_shared_from_this<Job>
+class Job : public boost::enable_shared_from_this<Job>, public boost::noncopyable
 {
 public:
-       Job (boost::shared_ptr<const FilmState> s, boost::shared_ptr<const Options> o, Log* l);
+       Job (boost::shared_ptr<const Film>);
+       virtual ~Job() {}
 
        /** @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;
        
        void start ();
+       void pause ();
+       void resume ();
+       void cancel ();
 
+       bool is_new () const;
        bool running () const;
        bool finished () const;
        bool finished_ok () const;
        bool finished_in_error () const;
+       bool finished_cancelled () const;
+       bool paused () const;
 
-       std::string error () const;
+       std::string error_summary () const;
+       std::string error_details () const;
 
        int elapsed_time () const;
        virtual std::string status () const;
+       std::string json_status () const;
+       std::string sub_name () const {
+               return _sub_name;
+       }
 
        void set_progress_unknown ();
-       void set_progress (float);
-       void ascend ();
-       void descend (float);
-       float overall_progress () const;
+       void set_progress (float, bool force = false);
+       void sub (std::string);
+       float progress () const;
+       bool progress_unknown () const {
+               return !_progress;
+       }
 
-       void emit_finished ();
-
-       /** Emitted from the GUI thread */
-       sigc::signal0<void> Finished;
+       boost::signals2::signal<void()> Progress;
+       /** Emitted from the UI thread when the job is finished */
+       boost::signals2::signal<void()> Finished;
 
 protected:
 
@@ -75,50 +88,40 @@ protected:
 
        /** Description of a job's state */
        enum State {
-               NEW,           ///< the job hasn't been started yet
-               RUNNING,       ///< the job is running
-               FINISHED_OK,   ///< the job has finished successfully
-               FINISHED_ERROR ///< the job has finished in error
+               NEW,            ///< the job hasn't been started yet
+               RUNNING,        ///< the job is running
+               PAUSED,         ///< the job has been paused
+               FINISHED_OK,    ///< the job has finished successfully
+               FINISHED_ERROR, ///< the job has finished in error
+               FINISHED_CANCELLED ///< the job was cancelled
        };
        
        void set_state (State);
-       void set_error (std::string e);
+       void set_error (std::string s, std::string d);
 
-       /** FilmState for this job */
-       boost::shared_ptr<const FilmState> _fs;
-       /** options in use for this job */
-       boost::shared_ptr<const Options> _opt;
-       /** a log that this job can write to */
-       Log* _log;
+       boost::shared_ptr<const Film> _film;
 
 private:
 
        void run_wrapper ();
 
+       boost::thread* _thread;
+
        /** mutex for _state and _error */
        mutable boost::mutex _state_mutex;
        /** current state of the job */
        State _state;
-       /** message for an error that has occurred (when state == FINISHED_ERROR) */
-       std::string _error;
+       /** summary of an error that has occurred (when state == FINISHED_ERROR) */
+       std::string _error_summary;
+       std::string _error_details;
 
-       /** time that this job was started */
+       /** time that this sub-job was started */
        time_t _start_time;
+       std::string _sub_name;
 
-       /** mutex for _stack and _progress_unknown */
+       /** mutex for _progress */
        mutable boost::mutex _progress_mutex;
-
-       struct Level {
-               Level (float a) : allocation (a), normalised (0) {}
-
-               float allocation;
-               float normalised;
-       };
-
-       std::list<Level> _stack;
-
-       /** true if this job's progress will always be unknown */
-       bool _progress_unknown;
+       boost::optional<float> _progress;
 
        int _ran_for;
 };