Various Doxygen fixes.
[dcpomatic.git] / src / lib / job.cc
index 1676928632164410582e179c97d5e3c5e7842c33..31f336b6565500633c5479e1d01ba85c155a927f 100644 (file)
@@ -34,6 +34,7 @@
 #include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
 #include <boost/foreach.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
 #include <iostream>
 
 #include "i18n.h"
@@ -238,10 +239,17 @@ Job::finished_cancelled () const
 }
 
 bool
-Job::paused () const
+Job::paused_by_user () const
 {
        boost::mutex::scoped_lock lm (_state_mutex);
-       return _state == PAUSED;
+       return _state == PAUSED_BY_USER;
+}
+
+bool
+Job::paused_by_priority () const
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+       return _state == PAUSED_BY_PRIORITY;
 }
 
 /** Set the state of this job.
@@ -286,7 +294,7 @@ Job::check_for_interruption_or_pause ()
        boost::this_thread::interruption_point ();
 
        boost::mutex::scoped_lock lm (_state_mutex);
-       while (_state == PAUSED) {
+       while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
                emit (boost::bind (boost::ref (Progress)));
                _pause_changed.wait (lm);
        }
@@ -294,6 +302,7 @@ Job::check_for_interruption_or_pause ()
 
 /** Set the progress of the current part of the job.
  *  @param p Progress (from 0 to 1)
+ *  @param force Do not ignore this update, even if it hasn't been long since the last one.
  */
 void
 Job::set_progress (float p, bool force)
@@ -366,7 +375,8 @@ Job::error_summary () const
 }
 
 /** Set the current error string.
- *  @param e New error string.
+ *  @param s New error string.
+ *  @param d New error detail string.
  */
 void
 Job::set_error (string s, string d)
@@ -411,9 +421,22 @@ Job::status () const
                s += buffer;
 
                if (t > 10 && r > 0) {
-                       /// TRANSLATORS: remaining here follows an amount of time that is remaining
-                       /// on an operation.
-                       s += "; " + seconds_to_approximate_hms (r) + " " + _("remaining");
+                       boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
+                       boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
+                       char finish_string[6];
+                       snprintf (finish_string, sizeof(finish_string), "%02d:%02d", finish.time_of_day().hours(), finish.time_of_day().minutes());
+                       string day;
+                       if (now.date() != finish.date()) {
+                               /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
+                               /// to say what day a job will finish.
+                               day = String::compose (_(" on %1"), finish.date().day_of_week().as_long_string());
+                       }
+                       /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
+                       /// on an operation; after it is an estimated wall-clock completion time.
+                       s += String::compose(
+                               _("; %1 remaining; finishing at %2%3"),
+                               seconds_to_approximate_hms(r), finish_string, day
+                               );
                }
        } else if (finished_ok ()) {
                s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
@@ -436,7 +459,8 @@ Job::json_status () const
                return N_("new");
        case RUNNING:
                return N_("running");
-       case PAUSED:
+       case PAUSED_BY_USER:
+       case PAUSED_BY_PRIORITY:
                return N_("paused");
        case FINISHED_OK:
                return N_("finished_ok");
@@ -467,7 +491,7 @@ Job::cancel ()
                return;
        }
 
-       if (paused ()) {
+       if (paused_by_user() || paused_by_priority()) {
                resume ();
        }
 
@@ -479,10 +503,19 @@ Job::cancel ()
 }
 
 void
-Job::pause ()
+Job::pause_by_user ()
+{
+       if (running ()) {
+               set_state (PAUSED_BY_USER);
+               _pause_changed.notify_all ();
+       }
+}
+
+void
+Job::pause_by_priority ()
 {
        if (running ()) {
-               set_state (PAUSED);
+               set_state (PAUSED_BY_PRIORITY);
                _pause_changed.notify_all ();
        }
 }
@@ -490,7 +523,7 @@ Job::pause ()
 void
 Job::resume ()
 {
-       if (paused ()) {
+       if (paused_by_user() || paused_by_priority()) {
                set_state (RUNNING);
                _pause_changed.notify_all ();
        }