src/Operation/ThreadedOperationEnvironment.hpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #ifndef XCSOAR_THREAD_OPERATION_HPP
  25 #define XCSOAR_THREAD_OPERATION_HPP
  26
  27 #include "Operation/Operation.hpp"
  28 #include "Event/DelayedNotify.hpp"
  29 #include "Thread/Mutex.hpp"
  30 #include "Thread/Trigger.hpp"
  31 #include "Util/StaticString.hpp"
  32
  33 /**
  34  * This is an OperationEnvironment implementation that can be run in
  35  * any thread, and passes the method calls to the main thread.  Useful
  36  * to show a progress bar in the UI thread for a job that runs in
  37  * another thread.
  38  */
  39 class ThreadedOperationEnvironment
  40   : public OperationEnvironment,
  41     protected DelayedNotify {
  42   struct Data {
  43     StaticString<256u> error;
  44     StaticString<128u> text;
  45
  46     unsigned progress_range, progress_position;
  47
  48     bool update_error;
  49     bool update_text, update_progress_range, update_progress_position;
  50
  51     Data()
  52       :text(_T("")),
  53        progress_range(0u), progress_position(0u),
  54        update_error(false), update_text(false),
  55        update_progress_range(false), update_progress_position(false) {}
  56
  57     void SetErrorMessage(const TCHAR *_error) {
  58       error = _error;
  59       update_error = true;
  60     }
  61
  62     void SetText(const TCHAR *_text) {
  63       text = _text;
  64       update_text = true;
  65     }
  66
  67     bool SetProgressRange(unsigned range) {
  68       if (range == progress_range)
  69         return false;
  70
  71       progress_range = range;
  72       update_progress_range = true;
  73       return true;
  74     }
  75
  76     bool SetProgressPosition(unsigned position) {
  77       if (position == progress_position)
  78         return false;
  79
  80       progress_position = position;
  81       update_progress_position = true;
  82       return true;
  83     }
  84
  85     void ClearUpdate() {
  86       update_error = false;
  87       update_text = false;
  88       update_progress_range = update_progress_position = false;
  89     }
  90   };
  91
  92   OperationEnvironment &other;
  93
  94   Mutex mutex;
  95
  96   Data data;
  97
  98   Trigger cancelled;
  99
 100 public:
 101   ThreadedOperationEnvironment(OperationEnvironment &_other);
 102
 103   void Cancel() {
 104     cancelled.Signal();
 105   }
 106
 107 public:
 108   /* virtual methods from class OperationEnvironment */
 109   virtual bool IsCancelled() const override;
 110   virtual void Sleep(unsigned ms) override;
 111   virtual void SetErrorMessage(const TCHAR *error) override;
 112   virtual void SetText(const TCHAR *text) override;
 113   virtual void SetProgressRange(unsigned range) override;
 114   virtual void SetProgressPosition(unsigned position) override;
 115
 116 protected:
 117   /* virtual methods from class Notify */
 118   virtual void OnNotification() override;
 119 };
 120
 121 #endif