xbmc/dialogs/GUIDialogBusy.cpp

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #include "GUIDialogBusy.h"
  10
  11 #include "ServiceBroker.h"
  12 #include "guilib/GUIComponent.h"
  13 #include "guilib/GUIWindowManager.h"
  14 #include "threads/IRunnable.h"
  15 #include "threads/Thread.h"
  16 #include "utils/log.h"
  17
  18 using namespace std::chrono_literals;
  19
  20 class CBusyWaiter : public CThread
  21 {
  22   std::shared_ptr<CEvent> m_done;
  23   IRunnable *m_runnable;
  24 public:
  25   explicit CBusyWaiter(IRunnable *runnable) :
  26   CThread(runnable, "waiting"), m_done(new CEvent()),  m_runnable(runnable) { }
  27
  28   ~CBusyWaiter() override { StopThread(); }
  29
  30   bool Wait(unsigned int displaytime, bool allowCancel)
  31   {
  32     std::shared_ptr<CEvent> e_done(m_done);
  33
  34     Create();
  35     auto start = std::chrono::steady_clock::now();
  36     if (!CGUIDialogBusy::WaitOnEvent(*e_done, displaytime, allowCancel))
  37     {
  38       m_runnable->Cancel();
  39
  40       auto end = std::chrono::steady_clock::now();
  41       auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(end - start);
  42
  43       unsigned int remaining =
  44           (duration.count() >= displaytime) ? 0 : displaytime - duration.count();
  45       CGUIDialogBusy::WaitOnEvent(*e_done, remaining, false);
  46       return false;
  47     }
  48     return true;
  49   }
  50
  51   // 'this' is actually deleted from the thread where it's on the stack
  52   void Process() override
  53   {
  54     std::shared_ptr<CEvent> e_done(m_done);
  55
  56     CThread::Process();
  57     (*e_done).Set();
  58   }
  59
  60 };
  61
  62 bool CGUIDialogBusy::Wait(IRunnable *runnable, unsigned int displaytime, bool allowCancel)
  63 {
  64   if (!runnable)
  65     return false;
  66   CBusyWaiter waiter(runnable);
  67   if (!waiter.Wait(displaytime, allowCancel))
  68   {
  69     return false;
  70   }
  71   return true;
  72 }
  73
  74 bool CGUIDialogBusy::WaitOnEvent(CEvent &event, unsigned int displaytime /* = 100 */, bool allowCancel /* = true */)
  75 {
  76   bool cancelled = false;
  77   if (!event.Wait(std::chrono::milliseconds(displaytime)))
  78   {
  79     // throw up the progress
  80     CGUIDialogBusy* dialog = CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogBusy>(WINDOW_DIALOG_BUSY);
  81     if (dialog)
  82     {
  83       if (dialog->IsDialogRunning())
  84       {
  85         CLog::Log(LOGFATAL, "Logic error due to two concurrent busydialogs, this is a known issue. "
  86                             "The application will exit.");
  87         throw std::logic_error("busy dialog already running");
  88       }
  89
  90       dialog->Open();
  91
  92       while (!event.Wait(1ms))
  93       {
  94         dialog->ProcessRenderLoop(false);
  95         if (allowCancel && dialog->IsCanceled())
  96         {
  97           cancelled = true;
  98           break;
  99         }
 100       }
 101
 102       dialog->Close(true);
 103     }
 104   }
 105   return !cancelled;
 106 }
 107
 108 CGUIDialogBusy::CGUIDialogBusy(void)
 109   : CGUIDialog(WINDOW_DIALOG_BUSY, "DialogBusy.xml", DialogModalityType::MODAL)
 110 {
 111   m_loadType = LOAD_ON_GUI_INIT;
 112   m_bCanceled = false;
 113 }
 114
 115 CGUIDialogBusy::~CGUIDialogBusy(void) = default;
 116
 117 void CGUIDialogBusy::Open_Internal(bool bProcessRenderLoop, const std::string& param /* = "" */)
 118 {
 119   m_bCanceled = false;
 120   m_bLastVisible = true;
 121
 122   CGUIDialog::Open_Internal(false, param);
 123 }
 124
 125
 126 void CGUIDialogBusy::DoProcess(unsigned int currentTime, CDirtyRegionList &dirtyregions)
 127 {
 128   bool visible = CServiceBroker::GetGUI()->GetWindowManager().IsModalDialogTopmost(WINDOW_DIALOG_BUSY);
 129   if(!visible && m_bLastVisible)
 130     dirtyregions.push_back(CDirtyRegion(m_renderRegion));
 131   m_bLastVisible = visible;
 132
 133   CGUIDialog::DoProcess(currentTime, dirtyregions);
 134 }
 135
 136 void CGUIDialogBusy::Render()
 137 {
 138   if(!m_bLastVisible)
 139     return;
 140   CGUIDialog::Render();
 141 }
 142
 143 bool CGUIDialogBusy::OnBack(int actionID)
 144 {
 145   m_bCanceled = true;
 146   return true;
 147 }