src/Tool_Abstract.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // LameXP - Audio Encoder Front-End
   3 // Copyright (C) 2004-2023 LoRd_MuldeR <MuldeR2@GMX.de>
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU GENERAL PUBLIC LICENSE as published by
   7 // the Free Software Foundation; either version 2 of the License, or
   8 // (at your option) any later version; always including the non-optional
   9 // LAMEXP GNU GENERAL PUBLIC LICENSE ADDENDUM. See "License.txt" file!
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License along
  17 // with this program; if not, write to the Free Software Foundation, Inc.,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20 // http://www.gnu.org/licenses/gpl-2.0.txt
  21 ///////////////////////////////////////////////////////////////////////////////
  22
  23 #pragma once
  24
  25 #include <MUtils\Global.h>
  26 #include <QObject>
  27 #include <functional>
  28
  29 class QMutex;
  30 class QProcess;
  31 class QElapsedTimer;
  32
  33 namespace MUtils
  34 {
  35         class JobObject;
  36 }
  37
  38 class AbstractTool : public QObject
  39 {
  40         Q_OBJECT
  41
  42 public:
  43         AbstractTool(void);
  44         ~AbstractTool(void);
  45
  46 signals:
  47         void statusUpdated(int progress);
  48         void messageLogged(const QString &line);
  49
  50 protected:
  51         static const int m_processTimeoutInterval = 600000;
  52
  53         typedef enum
  54         {
  55                 RESULT_ABORTED = -2,
  56                 RESULT_TIMEOUT = -1,
  57                 RESULT_FAILURE =  0,
  58                 RESULT_SUCCESS =  1
  59         }
  60         result_t;
  61
  62         static __forceinline bool CHECK_FLAG(QAtomicInt &flag)
  63         {
  64                 return MUTILS_BOOLIFY(flag);
  65         }
  66
  67         static __forceinline int NEXT_PROGRESS(const int &progress)
  68         {
  69                 return (progress < 99) ? qMax(0, progress + 1) : qMin(100, progress);
  70         }
  71
  72         static QString commandline2string(const QString &program, const QStringList &arguments);
  73
  74         bool startProcess(QProcess &process, const QString &program, const QStringList &args, const QString &workingDir = QString());
  75         result_t awaitProcess(QProcess &process, QAtomicInt &abortFlag, int *const exitCode = NULL);
  76         result_t awaitProcess(QProcess &process, QAtomicInt &abortFlag, std::function<bool(const QString &text)> &&handler, int *const exitCode = NULL);
  77
  78 private:
  79         static QScopedPointer<MUtils::JobObject> s_jobObjectInstance;
  80         static QScopedPointer<QElapsedTimer>     s_startProcessTimer;
  81
  82         static QMutex s_startProcessMutex;
  83         static QMutex s_createObjectMutex;
  84
  85         static quint64 s_referenceCounter;
  86
  87         bool m_firstLaunch;
  88 };