src/wx/job_manager_view.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/job_manager_view.cc
  21  *  @brief Class generating a GTK widget to show the progress of jobs.
  22  */
  23
  24 #include "lib/job_manager.h"
  25 #include "lib/job.h"
  26 #include "lib/util.h"
  27 #include "lib/exceptions.h"
  28 #include "job_manager_view.h"
  29 #include "wx_util.h"
  30
  31 using std::string;
  32 using std::list;
  33 using std::map;
  34 using std::min;
  35 using std::cout;
  36 using boost::shared_ptr;
  37 using boost::weak_ptr;
  38
  39 class JobRecord : public boost::noncopyable
  40 {
  41 public:
  42         JobRecord (shared_ptr<Job> job, wxScrolledWindow* window, wxPanel* panel, wxFlexGridSizer* table)
  43                 : _job (job)
  44                 , _window (window)
  45                 , _panel (panel)
  46                 , _table (table)
  47         {
  48                 int n = 0;
  49
  50                 wxBoxSizer* gauge_message = new wxBoxSizer (wxVERTICAL);
  51                 _gauge = new wxGauge (panel, wxID_ANY, 100);
  52                 /* This seems to be required to allow the gauge to shrink under OS X */
  53                 _gauge->SetMinSize (wxSize (0, -1));
  54                 gauge_message->Add (_gauge, 1, wxEXPAND | wxLEFT | wxRIGHT);
  55                 _message = new wxStaticText (panel, wxID_ANY, wxT (""), wxDefaultPosition, wxDefaultSize, wxST_ELLIPSIZE_END);
  56                 gauge_message->Add (_message, 1, wxEXPAND | wxALIGN_CENTER_VERTICAL | wxALL, 6);
  57                 table->Insert (n, gauge_message, 1, wxEXPAND | wxLEFT | wxRIGHT);
  58                 ++n;
  59
  60                 _cancel = new wxButton (panel, wxID_ANY, _("Cancel"));
  61                 _cancel->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::cancel_clicked, this);
  62                 table->Insert (n, _cancel, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
  63                 ++n;
  64
  65                 _pause = new wxButton (_panel, wxID_ANY, _("Pause"));
  66                 _pause->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::pause_clicked, this);
  67                 table->Insert (n, _pause, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
  68                 ++n;
  69
  70                 _details = new wxButton (_panel, wxID_ANY, _("Details..."));
  71                 _details->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::details_clicked, this);
  72                 _details->Enable (false);
  73                 table->Insert (n, _details, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
  74                 ++n;
  75
  76                 _progress_connection = job->Progress.connect (boost::bind (&JobRecord::progress, this));
  77                 _finished_connection = job->Finished.connect (boost::bind (&JobRecord::finished, this));
  78
  79                 table->Layout ();
  80         }
  81
  82         void maybe_pulse ()
  83         {
  84                 if (_job->running() && !_job->progress ()) {
  85                         _gauge->Pulse ();
  86                 }
  87         }
  88
  89 private:
  90
  91         void progress ()
  92         {
  93                 string whole = "<b>" + _job->name () + "</b>: " + _job->sub_name() + " " + _job->status ();
  94                 if (whole != _last_message) {
  95                         _message->SetLabelMarkup (whole);
  96                         _last_message = whole;
  97                 }
  98                 if (_job->progress ()) {
  99                         _gauge->SetValue (min (100.0f, _job->progress().get() * 100));
 100                 }
 101         }
 102
 103         void finished ()
 104         {
 105                 progress ();
 106
 107                 if (!_job->finished_cancelled ()) {
 108                         _gauge->SetValue (100);
 109                 }
 110
 111                 _cancel->Enable (false);
 112                 _pause->Enable (false);
 113                 if (!_job->error_details().empty ()) {
 114                         _details->Enable (true);
 115                 }
 116         }
 117
 118         void details_clicked (wxCommandEvent &)
 119         {
 120                 string s = _job->error_summary();
 121                 s[0] = toupper (s[0]);
 122                 error_dialog (_window, std_to_wx (String::compose ("%1.\n\n%2", s, _job->error_details())));
 123         }
 124
 125         void cancel_clicked (wxCommandEvent &)
 126         {
 127                 _job->cancel ();
 128         }
 129
 130         void pause_clicked (wxCommandEvent &)
 131         {
 132                 if (_job->paused()) {
 133                         _job->resume ();
 134                         _pause->SetLabel (_("Pause"));
 135                 } else {
 136                         _job->pause ();
 137                         _pause->SetLabel (_("Resume"));
 138                 }
 139         }
 140
 141         boost::shared_ptr<Job> _job;
 142         wxScrolledWindow* _window;
 143         wxPanel* _panel;
 144         wxFlexGridSizer* _table;
 145         wxGauge* _gauge;
 146         wxStaticText* _message;
 147         wxButton* _cancel;
 148         wxButton* _pause;
 149         wxButton* _details;
 150         std::string _last_message;
 151
 152         boost::signals2::scoped_connection _progress_connection;
 153         boost::signals2::scoped_connection _finished_connection;
 154 };
 155
 156 /** Must be called in the GUI thread */
 157 JobManagerView::JobManagerView (wxWindow* parent)
 158         : wxScrolledWindow (parent)
 159 {
 160         _panel = new wxPanel (this);
 161         wxSizer* sizer = new wxBoxSizer (wxVERTICAL);
 162         sizer->Add (_panel, 1, wxEXPAND);
 163         SetSizer (sizer);
 164
 165         _table = new wxFlexGridSizer (4, 4, 6);
 166         _table->AddGrowableCol (0, 1);
 167         _panel->SetSizer (_table);
 168
 169         SetScrollRate (0, 32);
 170         EnableScrolling (false, true);
 171
 172         Bind (wxEVT_TIMER, boost::bind (&JobManagerView::periodic, this));
 173         _timer.reset (new wxTimer (this));
 174         _timer->Start (1000);
 175
 176         JobManager::instance()->JobAdded.connect (bind (&JobManagerView::job_added, this, _1));
 177 }
 178
 179 void
 180 JobManagerView::job_added (weak_ptr<Job> j)
 181 {
 182         shared_ptr<Job> job = j.lock ();
 183         if (job) {
 184                 _job_records.push_back (shared_ptr<JobRecord> (new JobRecord (job, this, _panel, _table)));
 185         }
 186 }
 187
 188 void
 189 JobManagerView::periodic ()
 190 {
 191         for (list<shared_ptr<JobRecord> >::iterator i = _job_records.begin(); i != _job_records.end(); ++i) {
 192                 (*i)->maybe_pulse ();
 193         }
 194 }