src/wx/job_manager_view.cc

   1 /*
   2     Copyright (C) 2012 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
  40 {
  41 public:
  42         JobRecord (shared_ptr<Job> job, wxScrolledWindow* window, wxPanel* panel, wxFlexGridSizer* table, bool pause)
  43                 : _job (job)
  44                 , _window (window)
  45                 , _panel (panel)
  46                 , _table (table)
  47         {
  48                 int n = 0;
  49
  50                 _name = new wxStaticText (panel, wxID_ANY, "");
  51                 _name->SetLabelMarkup ("<b>" + _job->name () + "</b>");
  52                 table->Insert (n, _name, 0, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  53                 ++n;
  54
  55                 _gauge = new wxGauge (panel, wxID_ANY, 100);
  56                 /* This seems to be required to allow the gauge to shrink under OS X */
  57                 _gauge->SetMinSize (wxSize (0, -1));
  58                 table->Insert (n, _gauge, 1, wxEXPAND | wxLEFT | wxRIGHT);
  59                 ++n;
  60
  61                 _message = new wxStaticText (panel, wxID_ANY, std_to_wx (""));
  62                 table->Insert (n, _message, 1, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  63                 ++n;
  64
  65                 _cancel = new wxButton (panel, wxID_ANY, _("Cancel"));
  66                 _cancel->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::cancel_clicked, this);
  67                 table->Insert (n, _cancel, 1, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  68                 ++n;
  69
  70                 if (pause) {
  71                         _pause = new wxButton (_panel, wxID_ANY, _("Pause"));
  72                         _pause->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::pause_clicked, this);
  73                         table->Insert (n, _pause, 1, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  74                         ++n;
  75                 }
  76
  77                 _details = new wxButton (_panel, wxID_ANY, _("Details..."));
  78                 _details->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::details_clicked, this);
  79                 _details->Enable (false);
  80                 table->Insert (n, _details, 1, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  81                 ++n;
  82
  83                 job->Progress.connect (boost::bind (&JobRecord::progress, this));
  84                 job->Finished.connect (boost::bind (&JobRecord::finished, this));
  85
  86                 table->Layout ();
  87                 panel->FitInside ();
  88         }
  89
  90         void maybe_pulse ()
  91         {
  92                 if (_job->running() && _job->progress_unknown ()) {
  93                         _gauge->Pulse ();
  94                 }
  95         }
  96
  97 private:
  98
  99         void update_job_name ()
 100         {
 101                 string n = "<b>" + _job->name () + "</b>";
 102                 if (!_job->sub_name().empty ()) {
 103                         n += "\n" + _job->sub_name ();
 104                 }
 105
 106                 if (n != _last_name) {
 107                         _name->SetLabelMarkup (std_to_wx (n));
 108                         _last_name = n;
 109                 }
 110         }
 111
 112         void progress ()
 113         {
 114                 float const p = _job->progress ();
 115                 if (p >= 0) {
 116                         checked_set (_message, _job->status ());
 117                         update_job_name ();
 118                         int const pp = min (100.0f, p * 100);
 119                         _gauge->SetValue (pp);
 120                 }
 121
 122                 _table->Layout ();
 123                 _window->FitInside ();
 124         }
 125
 126         void finished ()
 127         {
 128                 checked_set (_message, _job->status ());
 129                 update_job_name ();
 130
 131                 if (!_job->finished_cancelled ()) {
 132                         _gauge->SetValue (100);
 133                 }
 134
 135                 _cancel->Enable (false);
 136                 if (!_job->error_details().empty ()) {
 137                         _details->Enable (true);
 138                 }
 139
 140                 _table->Layout ();
 141                 _window->FitInside ();
 142         }
 143
 144         void details_clicked (wxCommandEvent &)
 145         {
 146                 string s = _job->error_summary();
 147                 s[0] = toupper (s[0]);
 148                 error_dialog (_window, std_to_wx (String::compose ("%1.\n\n%2", s, _job->error_details())));
 149         }
 150
 151         void cancel_clicked (wxCommandEvent &)
 152         {
 153                 _job->cancel ();
 154         }
 155
 156         void pause_clicked (wxCommandEvent &)
 157         {
 158                 if (_job->paused()) {
 159                         _job->resume ();
 160                         _pause->SetLabel (_("Pause"));
 161                 } else {
 162                         _job->pause ();
 163                         _pause->SetLabel (_("Resume"));
 164                 }
 165         }
 166
 167         boost::shared_ptr<Job> _job;
 168         wxScrolledWindow* _window;
 169         wxPanel* _panel;
 170         wxFlexGridSizer* _table;
 171         wxStaticText* _name;
 172         wxGauge* _gauge;
 173         wxStaticText* _message;
 174         wxButton* _cancel;
 175         wxButton* _pause;
 176         wxButton* _details;
 177         std::string _last_name;
 178 };
 179
 180 /** Must be called in the GUI thread */
 181 JobManagerView::JobManagerView (wxWindow* parent, Buttons buttons)
 182         : wxScrolledWindow (parent)
 183         , _buttons (buttons)
 184 {
 185         _panel = new wxPanel (this);
 186         wxSizer* sizer = new wxBoxSizer (wxVERTICAL);
 187         sizer->Add (_panel, 1, wxEXPAND);
 188         SetSizer (sizer);
 189
 190         int N = 5;
 191         if (buttons & PAUSE) {
 192                 ++N;
 193         }
 194
 195         _table = new wxFlexGridSizer (N, 6, 6);
 196         _table->AddGrowableCol (1, 1);
 197         _panel->SetSizer (_table);
 198
 199         SetScrollRate (0, 32);
 200
 201         Bind (wxEVT_TIMER, boost::bind (&JobManagerView::periodic, this));
 202         _timer.reset (new wxTimer (this));
 203         _timer->Start (1000);
 204
 205         JobManager::instance()->JobAdded.connect (bind (&JobManagerView::job_added, this, _1));
 206 }
 207
 208 void
 209 JobManagerView::job_added (weak_ptr<Job> j)
 210 {
 211         shared_ptr<Job> job = j.lock ();
 212         if (job) {
 213                 _job_records.push_back (shared_ptr<JobRecord> (new JobRecord (job, this, _panel, _table, _buttons & PAUSE)));
 214         }
 215 }
 216
 217 void
 218 JobManagerView::periodic ()
 219 {
 220         for (list<shared_ptr<JobRecord> >::iterator i = _job_records.begin(); i != _job_records.end(); ++i) {
 221                 (*i)->maybe_pulse ();
 222         }
 223 }