C++11 and whitespace cleanups.
[dcpomatic.git] / src / lib / job.cc
index 52558046ae8ec66ecd580194bf3f51558efd504e..50dcc336e2fd9029b3d659246165e06d3e303f10 100644 (file)
 
 */
 
+
 /** @file  src/job.cc
  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  */
 
-#include "job.h"
-#include "util.h"
+
+#include "compose.hpp"
 #include "cross.h"
+#include "dcpomatic_log.h"
 #include "exceptions.h"
 #include "film.h"
+#include "job.h"
 #include "log.h"
-#include "dcpomatic_log.h"
-#include "compose.hpp"
+#include "util.h"
 #include <dcp/exceptions.h>
 #include <sub/exceptions.h>
-#include <boost/thread.hpp>
-#include <boost/filesystem.hpp>
 #include <boost/date_time/posix_time/posix_time.hpp>
+#include <boost/filesystem.hpp>
+#include <boost/thread.hpp>
 #include <iostream>
 
 #include "i18n.h"
 
-using std::string;
-using std::list;
+
 using std::cout;
+using std::function;
+using std::list;
 using std::shared_ptr;
+using std::string;
 using boost::optional;
-using std::function;
 using namespace dcpomatic;
 
+
 /** @param film Associated film, or 0 */
 Job::Job (shared_ptr<const Film> film)
        : _film (film)
@@ -59,6 +63,7 @@ Job::Job (shared_ptr<const Film> film)
 
 }
 
+
 Job::~Job ()
 {
 #ifdef DCPOMATIC_DEBUG
@@ -67,6 +72,7 @@ Job::~Job ()
 #endif
 }
 
+
 void
 Job::stop_thread ()
 {
@@ -78,6 +84,7 @@ Job::stop_thread ()
        } catch (...) {}
 }
 
+
 /** Start the job in a separate thread, returning immediately */
 void
 Job::start ()
@@ -91,6 +98,7 @@ Job::start ()
 #endif
 }
 
+
 /** A wrapper for the ::run() method to catch exceptions */
 void
 Job::run_wrapper ()
@@ -251,6 +259,7 @@ Job::run_wrapper ()
        }
 }
 
+
 /** @return true if this job is new (ie has not started running) */
 bool
 Job::is_new () const
@@ -259,6 +268,7 @@ Job::is_new () const
        return _state == NEW;
 }
 
+
 /** @return true if the job is running */
 bool
 Job::running () const
@@ -267,6 +277,7 @@ Job::running () const
        return _state == RUNNING;
 }
 
+
 /** @return true if the job has finished (either successfully or unsuccessfully) */
 bool
 Job::finished () const
@@ -275,6 +286,7 @@ Job::finished () const
        return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
 }
 
+
 /** @return true if the job has finished successfully */
 bool
 Job::finished_ok () const
@@ -283,6 +295,7 @@ Job::finished_ok () const
        return _state == FINISHED_OK;
 }
 
+
 /** @return true if the job has finished unsuccessfully */
 bool
 Job::finished_in_error () const
@@ -291,6 +304,7 @@ Job::finished_in_error () const
        return _state == FINISHED_ERROR;
 }
 
+
 bool
 Job::finished_cancelled () const
 {
@@ -298,6 +312,7 @@ Job::finished_cancelled () const
        return _state == FINISHED_CANCELLED;
 }
 
+
 bool
 Job::paused_by_user () const
 {
@@ -305,6 +320,7 @@ Job::paused_by_user () const
        return _state == PAUSED_BY_USER;
 }
 
+
 bool
 Job::paused_by_priority () const
 {
@@ -312,6 +328,7 @@ Job::paused_by_priority () const
        return _state == PAUSED_BY_PRIORITY;
 }
 
+
 /** Set the state of this job.
  *  @param s New state.
  */
@@ -337,6 +354,7 @@ Job::set_state (State s)
        }
 }
 
+
 /** @return DCPTime (in seconds) that this sub-job has been running */
 int
 Job::elapsed_sub_time () const
@@ -348,6 +366,7 @@ Job::elapsed_sub_time () const
        return time (0) - _sub_start_time;
 }
 
+
 /** Check to see if this job has been interrupted or paused */
 void
 Job::check_for_interruption_or_pause ()
@@ -361,6 +380,22 @@ Job::check_for_interruption_or_pause ()
        }
 }
 
+
+optional<float>
+Job::seconds_since_last_progress_update () const
+{
+       boost::mutex::scoped_lock lm (_progress_mutex);
+       if (!_last_progress_update) {
+               return {};
+       }
+
+       struct timeval now;
+       gettimeofday (&now, 0);
+
+       return seconds(now) - seconds(*_last_progress_update);
+}
+
+
 /** 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.
@@ -376,8 +411,7 @@ Job::set_progress (float p, bool force)
                struct timeval now;
                gettimeofday (&now, 0);
                if (_last_progress_update && _last_progress_update->tv_sec > 0) {
-                       double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
-                               - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
+                       double const elapsed = seconds(now) - seconds(*_last_progress_update);
                        if (elapsed < 0.5) {
                                return;
                        }
@@ -388,6 +422,7 @@ Job::set_progress (float p, bool force)
        set_progress_common (p);
 }
 
+
 void
 Job::set_progress_common (optional<float> p)
 {
@@ -399,6 +434,7 @@ Job::set_progress_common (optional<float> p)
        emit (boost::bind (boost::ref (Progress)));
 }
 
+
 /** @return fractional progress of the current sub-job, if known */
 optional<float>
 Job::progress () const
@@ -407,6 +443,7 @@ Job::progress () const
        return _progress;
 }
 
+
 void
 Job::sub (string n)
 {
@@ -420,6 +457,7 @@ Job::sub (string n)
        _sub_start_time = time (0);
 }
 
+
 string
 Job::error_details () const
 {
@@ -427,6 +465,7 @@ Job::error_details () const
        return _error_details;
 }
 
+
 /** @return A summary of any error that the job has generated */
 string
 Job::error_summary () const
@@ -435,6 +474,7 @@ Job::error_summary () const
        return _error_summary;
 }
 
+
 /** Set the current error string.
  *  @param s New error string.
  *  @param d New error detail string.
@@ -451,6 +491,7 @@ Job::set_error (string s, string d)
        _error_details = d;
 }
 
+
 /** Say that this job's progress will be unknown until further notice */
 void
 Job::set_progress_unknown ()
@@ -459,6 +500,7 @@ Job::set_progress_unknown ()
        set_progress_common (optional<float> ());
 }
 
+
 /** @return Human-readable status of this job */
 string
 Job::status () const
@@ -508,6 +550,7 @@ Job::status () const
        return s;
 }
 
+
 string
 Job::json_status () const
 {
@@ -532,6 +575,7 @@ Job::json_status () const
        return "";
 }
 
+
 /** @return An estimate of the remaining time for this sub-job, in seconds */
 int
 Job::remaining_time () const
@@ -543,6 +587,7 @@ Job::remaining_time () const
        return elapsed_sub_time() / progress().get() - elapsed_sub_time();
 }
 
+
 void
 Job::cancel ()
 {
@@ -558,6 +603,7 @@ Job::cancel ()
        _thread.join ();
 }
 
+
 /** @return true if the job was paused, false if it was not running */
 bool
 Job::pause_by_user ()
@@ -581,6 +627,7 @@ Job::pause_by_user ()
        return paused;
 }
 
+
 void
 Job::pause_by_priority ()
 {
@@ -590,6 +637,7 @@ Job::pause_by_priority ()
        }
 }
 
+
 void
 Job::resume ()
 {
@@ -599,6 +647,7 @@ Job::resume ()
        }
 }
 
+
 void
 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
 {
@@ -610,6 +659,7 @@ Job::when_finished (boost::signals2::connection& connection, function<void()> fi
        }
 }
 
+
 optional<string>
 Job::message () const
 {
@@ -617,6 +667,7 @@ Job::message () const
        return _message;
 }
 
+
 void
 Job::set_message (string m)
 {