Mike-Solar
bb40b4923e
Automated with clang-tidy readability-identifier-naming (config added to .clang-tidy) plus scripted passes, per the updated rules now documented in CONTRIBUTING.md: - types (class/struct/enum/alias/template params): PascalCase - functions, variables, members: snake_case (incl. rational -> Rational) - private/protected members: trailing underscore; static member variables likewise (instance_, available_themes_) - constants and enum values: snake_case (kLinear -> k_linear, F32P -> f32p); ALL_CAPS reserved for macros - macros: OAK_ prefix (OLIVE_ADD_TEST/OLIVE_ASSERT/OLIVE_CONFIG -> OAK_ADD_TEST/OAK_ASSERT/OAK_CONFIG, GL_PREAMBLE -> OAK_GL_PREAMBLE, include guards -> OAK_*) - file names: all lowercase (Current/Plugin/OliveHost/OliveClip/ OlivePluginInstance -> current/plugin/olivehost/oliveclip/ oliveplugininstance) - getters share the member name sans underscore, setters set_foo() - Qt and third-party (OpenFX) virtual overrides and framework callbacks keep their original names (exempt in .clang-tidy) Manual follow-ups required where automation could not reach: - string-based QMetaObject/SIGNAL/SLOT references updated to renamed methods (AddTask, CreatedFile, DeleteSpecificFile, moveSelectionUp, ...) - macro bodies referencing renamed methods (OLIVE_CONFIG, NODE_DEFAULT_DESTRUCTOR, MANAGEDDISPLAYWIDGET_*) - self-shadowing locals renamed where signals/methods became same-named (size_changed, worker_count, selected_items, import param, filters) - third_party OFX member/namespace usages restored (OFX::Host::*, _created, _clipPrefsDirty, createInstance, clearPersistentMessage) - STL protocol aliases restored (const_iterator) with .clang-tidy ignore rules; qHash overloads restored Full build and test suite pass: ctest 4/4, ~1960 gtest cases green.
142 lines
3.4 KiB
C++
142 lines
3.4 KiB
C++
/***
|
|
|
|
Olive - Non-Linear Video Editor
|
|
Copyright (C) 2022 Olive Team
|
|
Modifications Copyright (C) 2025 mikesolar
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
***/
|
|
|
|
#ifndef OAK_TASKMANAGER_H
|
|
#define OAK_TASKMANAGER_H
|
|
|
|
#include <QtConcurrent/QtConcurrent>
|
|
#include <QVector>
|
|
#include <QUndoCommand>
|
|
|
|
#include "task/task.h"
|
|
|
|
namespace olive
|
|
{
|
|
|
|
/**
|
|
* @brief An object that manages background Task objects, handling their start and end
|
|
*
|
|
* TaskManager handles the life of a Task object. After a new Task is created, it should be sent to TaskManager through
|
|
* AddTask(). TaskManager will take ownership of the task and add it to a queue until it system resources are available
|
|
* for it to run. Currently, TaskManager will run no more Tasks than there are threads on the system (one task per
|
|
* thread). As Tasks finished, TaskManager will start the next in the queue.
|
|
*/
|
|
class TaskManager : public QObject {
|
|
Q_OBJECT
|
|
public:
|
|
/**
|
|
* @brief TaskManager Constructor
|
|
*/
|
|
TaskManager();
|
|
|
|
/**
|
|
* @brief TaskManager Destructor
|
|
*
|
|
* Ensures all Tasks are deleted
|
|
*/
|
|
virtual ~TaskManager();
|
|
|
|
static void create_instance();
|
|
|
|
static void destroy_instance();
|
|
|
|
static TaskManager *instance();
|
|
|
|
int get_task_count() const;
|
|
|
|
Task *get_first_task() const;
|
|
|
|
void cancel_task_and_wait(Task *t);
|
|
|
|
public slots:
|
|
/**
|
|
* @brief Add a new Task
|
|
*
|
|
* Adds a new Task to the queue. If there are available threads to run it, it'll also run immediately. Otherwise,
|
|
* it'll be placed into the queue and run when resources are available.
|
|
*
|
|
* NOTE: This function is NOT thread-safe and is currently intended to only be used from the main/GUI thread.
|
|
*
|
|
* NOTE: A Task object should only be added once. Adding the same Task object more than once will result in undefined
|
|
* behavior.
|
|
*
|
|
* @param t
|
|
*
|
|
* The task to add and run. TaskManager takes ownership of this Task and will be responsible for freeing it.
|
|
*/
|
|
void add_task(Task *t);
|
|
|
|
void cancel_task(Task *t);
|
|
|
|
signals:
|
|
/**
|
|
* @brief Signal emitted when a Task is added by AddTask()
|
|
*
|
|
* @param t
|
|
*
|
|
* Task that was added
|
|
*/
|
|
void task_added(Task *t);
|
|
|
|
/**
|
|
* @brief Signal emitted when any change to the running task list has been made
|
|
*/
|
|
void task_list_changed();
|
|
|
|
/**
|
|
* @brief Signal emitted when a task is deleted
|
|
*/
|
|
void task_removed(Task *t);
|
|
|
|
/**
|
|
* @brief Signal emitted when a task fails
|
|
*/
|
|
void task_failed(Task *t);
|
|
|
|
private:
|
|
/**
|
|
* @brief Internal task array
|
|
*/
|
|
QHash<QFutureWatcher<bool> *, Task *> tasks_;
|
|
|
|
/**
|
|
* @brief Internal list of failed tasks
|
|
*/
|
|
std::list<Task *> failed_tasks_;
|
|
|
|
/**
|
|
* @brief Task thread pool
|
|
*/
|
|
QThreadPool thread_pool_;
|
|
|
|
/**
|
|
* @brief TaskManager singleton instance_
|
|
*/
|
|
static TaskManager *instance_;
|
|
|
|
private slots:
|
|
void task_finished();
|
|
};
|
|
|
|
}
|
|
|
|
#endif // OAK_TASKMANAGER_H
|