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::cout;
  35 using boost::shared_ptr;
  36 using boost::weak_ptr;
  37
  38 class JobRecord
  39 {
  40 public:
  41         JobRecord (shared_ptr<Job> job, wxScrolledWindow* window, wxPanel* panel, wxFlexGridSizer* table, bool pause)
  42                 : _job (job)
  43                 , _window (window)
  44                 , _panel (panel)
  45                 , _table (table)
  46         {
  47                 int n = 0;
  48
  49                 wxStaticText* m = new wxStaticText (panel, wxID_ANY, std_to_wx (_job->name ()));
  50                 table->Insert (n, m, 0, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  51                 ++n;
  52
  53                 _gauge = new wxGauge (panel, wxID_ANY, 100);
  54                 table->Insert (n, _gauge, 1, wxEXPAND | wxLEFT | wxRIGHT);
  55                 ++n;
  56
  57                 _message = new wxStaticText (panel, wxID_ANY, std_to_wx (""));
  58                 table->Insert (n, _message, 1, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  59                 ++n;
  60
  61                 _cancel = new wxButton (panel, wxID_ANY, _("Cancel"));
  62                 _cancel->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::cancel_clicked, this);
  63                 table->Insert (n, _cancel, 1, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  64                 ++n;
  65
  66                 if (pause) {
  67                         _pause = new wxButton (_panel, wxID_ANY, _("Pause"));
  68                         _pause->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::pause_clicked, this);
  69                         table->Insert (n, _pause, 1, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  70                         ++n;
  71                 }
  72
  73                 _details = new wxButton (_panel, wxID_ANY, _("Details..."));
  74                 _details->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobRecord::details_clicked, this);
  75                 _details->Enable (false);
  76                 table->Insert (n, _details, 1, wxALIGN_CENTER_VERTICAL | wxALL, 6);
  77                 ++n;
  78
  79                 job->Progress.connect (boost::bind (&JobRecord::progress, this));
  80                 job->Finished.connect (boost::bind (&JobRecord::finished, this));
  81
  82                 table->Layout ();
  83                 panel->FitInside ();
  84         }
  85
  86 private:
  87
  88         void progress ()
  89         {
  90                 float const p = _job->overall_progress ();
  91                 if (p >= 0) {
  92                         checked_set (_message, _job->status ());
  93                         _gauge->SetValue (p * 100);
  94                 } else {
  95                         checked_set (_message, wx_to_std (_("Running")));
  96                         _gauge->Pulse ();
  97                 }
  98
  99                 _table->Layout ();
 100                 _window->FitInside ();
 101         }
 102
 103         void finished ()
 104         {
 105                 checked_set (_message, _job->status ());
 106                 if (!_job->finished_cancelled ()) {
 107                         _gauge->SetValue (100);
 108                 }
 109
 110                 _cancel->Enable (false);
 111                 if (!_job->error_details().empty ()) {
 112                         _details->Enable (true);
 113                 }
 114
 115                 _table->Layout ();
 116                 _window->FitInside ();
 117         }
 118
 119         void details_clicked (wxCommandEvent &)
 120         {
 121                 string s = _job->error_summary();
 122                 s[0] = toupper (s[0]);
 123                 error_dialog (_window, std_to_wx (String::compose ("%1.\n\n%2", s, _job->error_details())));
 124         }
 125
 126         void cancel_clicked (wxCommandEvent &)
 127         {
 128                 _job->cancel ();
 129         }
 130
 131         void pause_clicked (wxCommandEvent &)
 132         {
 133                 if (_job->paused()) {
 134                         _job->resume ();
 135                         _pause->SetLabel (_("Pause"));
 136                 } else {
 137                         _job->pause ();
 138                         _pause->SetLabel (_("Resume"));
 139                 }
 140         }
 141
 142         boost::shared_ptr<Job> _job;
 143         wxScrolledWindow* _window;
 144         wxPanel* _panel;
 145         wxFlexGridSizer* _table;
 146         wxGauge* _gauge;
 147         wxStaticText* _message;
 148         wxButton* _cancel;
 149         wxButton* _pause;
 150         wxButton* _details;
 151 };
 152
 153 /** Must be called in the GUI thread */
 154 JobManagerView::JobManagerView (wxWindow* parent, Buttons buttons)
 155         : wxScrolledWindow (parent)
 156         , _buttons (buttons)
 157 {
 158         _panel = new wxPanel (this);
 159         wxSizer* sizer = new wxBoxSizer (wxVERTICAL);
 160         sizer->Add (_panel, 1, wxEXPAND);
 161         SetSizer (sizer);
 162
 163         int N = 5;
 164         if (buttons & PAUSE) {
 165                 ++N;
 166         }
 167
 168         _table = new wxFlexGridSizer (N, 6, 6);
 169         _table->AddGrowableCol (1, 1);
 170         _panel->SetSizer (_table);
 171
 172         SetScrollRate (0, 32);
 173
 174         JobManager::instance()->JobAdded.connect (bind (&JobManagerView::job_added, this, _1));
 175 }
 176
 177 void
 178 JobManagerView::job_added (weak_ptr<Job> j)
 179 {
 180         shared_ptr<Job> job = j.lock ();
 181         if (job) {
 182                 _job_records.push_back (shared_ptr<JobRecord> (new JobRecord (job, this, _panel, _table, _buttons & PAUSE)));
 183         }
 184 }
 185