matthew/The-Powder-Toy
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Turn ThumbnailRendererTask into an AbandonableTask

Browse Source
This commit is contained in:
Tamás Bálint Misius 2019-03-08 15:53:18 +01:00 committed by jacob1
parent c09a7bb8d9
commit d3fe7e39a5
10 changed files with 225 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/client/ThumbnailRenderer.cpp → src/client/ThumbnailRendererTask.cpp
View File

@ -1,4 +1,4 @@
#include "ThumbnailRenderer.h"
#include "ThumbnailRendererTask.h"
#include <cmath>
@ -47,8 +47,10 @@ bool ThumbnailRendererTask::doWork()
}
}
std::unique_ptr<VideoBuffer> ThumbnailRendererTask::GetThumbnail()
std::unique_ptr<VideoBuffer> ThumbnailRendererTask::Finish()
{
return std::move(thumbnail);
auto ptr = std::move(thumbnail);
AbandonableTask::Finish();
return ptr;
}

6
src/client/ThumbnailRenderer.h → src/client/ThumbnailRendererTask.h
View File

@ -1,13 +1,13 @@
#ifndef THUMBNAILRENDERER_H
#define THUMBNAILRENDERER_H
#include "tasks/Task.h"
#include "tasks/AbandonableTask.h"
#include <memory>
class GameSave;
class VideoBuffer;
class ThumbnailRendererTask : public Task
class ThumbnailRendererTask : public AbandonableTask
{
std::unique_ptr<GameSave> Save;
int Width, Height;
@ -21,7 +21,7 @@ public:
virtual ~ThumbnailRendererTask();
virtual bool doWork() override;
std::unique_ptr<VideoBuffer> GetThumbnail();
std::unique_ptr<VideoBuffer> Finish();
};
#endif // THUMBNAILRENDERER_H

16
src/gui/interface/SaveButton.cpp
View File

@ -8,7 +8,7 @@
#include "SaveButton.h"
#include "client/Client.h"
#include "client/SaveInfo.h"
#include "client/ThumbnailRenderer.h"
#include "client/ThumbnailRendererTask.h"
#include "simulation/SaveRenderer.h"
#include "client/GameSave.h"
#include "simulation/SaveRenderer.h"
@ -23,6 +23,7 @@ SaveButton::SaveButton(Point position, Point size, SaveInfo * save):
isMouseInsideAuthor(false),
isMouseInsideHistory(false),
showVotes(false),
thumbnailRenderer(nullptr),
isButtonDown(false),
isMouseInside(false),
selected(false),
@ -96,6 +97,7 @@ SaveButton::SaveButton(Point position, Point size, SaveFile * file):
isMouseInsideAuthor(false),
isMouseInsideHistory(false),
showVotes(false),
thumbnailRenderer(nullptr),
isButtonDown(false),
isMouseInside(false),
selected(false),
@ -116,6 +118,10 @@ SaveButton::SaveButton(Point position, Point size, SaveFile * file):
SaveButton::~SaveButton()
{
if (thumbnailRenderer)
{
thumbnailRenderer->Abandon();
}
delete actionCallback;
delete save;
delete file;
@ -138,7 +144,7 @@ void SaveButton::Tick(float dt)
{
if(save->GetGameSave())
{
thumbnailRenderer = std::unique_ptr<ThumbnailRendererTask>(new ThumbnailRendererTask(save->GetGameSave(), thumbBoxSize.X, thumbBoxSize.Y));
thumbnailRenderer = new ThumbnailRendererTask(save->GetGameSave(), thumbBoxSize.X, thumbBoxSize.Y);
thumbnailRenderer->Start();
triedThumbnail = true;
}
@ -151,7 +157,7 @@ void SaveButton::Tick(float dt)
}
else if (file && file->GetGameSave())
{
thumbnailRenderer = std::unique_ptr<ThumbnailRendererTask>(new ThumbnailRendererTask(file->GetGameSave(), thumbBoxSize.X, thumbBoxSize.Y, true, true, false));
thumbnailRenderer = new ThumbnailRendererTask(file->GetGameSave(), thumbBoxSize.X, thumbBoxSize.Y, true, true, false);
thumbnailRenderer->Start();
triedThumbnail = true;
}
@ -164,8 +170,8 @@ void SaveButton::Tick(float dt)
thumbnailRenderer->Poll();
if (thumbnailRenderer->GetDone())
{
thumbnail = thumbnailRenderer->GetThumbnail();
thumbnailRenderer.reset();
thumbnail = thumbnailRenderer->Finish();
thumbnailRenderer = nullptr;
}
}

2
src/gui/interface/SaveButton.h
View File

@ -45,7 +45,7 @@ class SaveButton : public Component, public http::RequestMonitor<http::Thumbnail
bool isMouseInsideAuthor;
bool isMouseInsideHistory;
bool showVotes;
std::unique_ptr<ThumbnailRendererTask> thumbnailRenderer;
ThumbnailRendererTask *thumbnailRenderer;
public:
SaveButton(Point position, Point size, SaveInfo * save);
SaveButton(Point position, Point size, SaveFile * file);

13
src/gui/save/LocalSaveActivity.cpp
View File

@ -11,7 +11,7 @@
#include "gui/interface/Button.h"
#include "gui/interface/Label.h"
#include "gui/interface/Textbox.h"
#include "client/ThumbnailRenderer.h"
#include "client/ThumbnailRendererTask.h"
class LocalSaveActivity::CancelAction: public ui::ButtonAction
@ -39,6 +39,7 @@ public:
LocalSaveActivity::LocalSaveActivity(SaveFile save, FileSavedCallback * callback) :
WindowActivity(ui::Point(-1, -1), ui::Point(220, 200)),
save(save),
thumbnailRenderer(nullptr),
callback(callback)
{
ui::Label * titleLabel = new ui::Label(ui::Point(4, 5), ui::Point(Size.X-8, 16), "Save to computer:");
@ -71,7 +72,7 @@ LocalSaveActivity::LocalSaveActivity(SaveFile save, FileSavedCallback * callback
if(save.GetGameSave())
{
thumbnailRenderer = std::unique_ptr<ThumbnailRendererTask>(new ThumbnailRendererTask(save.GetGameSave(), Size.X-16, -1, false, true, false));
thumbnailRenderer = new ThumbnailRendererTask(save.GetGameSave(), Size.X-16, -1, false, true, false);
thumbnailRenderer->Start();
}
}
@ -83,8 +84,8 @@ void LocalSaveActivity::OnTick(float dt)
thumbnailRenderer->Poll();
if (thumbnailRenderer->GetDone())
{
thumbnail = thumbnailRenderer->GetThumbnail();
thumbnailRenderer.reset();
thumbnail = thumbnailRenderer->Finish();
thumbnailRenderer = nullptr;
}
}
}
@ -168,5 +169,9 @@ void LocalSaveActivity::OnDraw()
LocalSaveActivity::~LocalSaveActivity()
{
if (thumbnailRenderer)
{
thumbnailRenderer->Abandon();
}
delete callback;
}

2
src/gui/save/LocalSaveActivity.h
View File

@ -24,7 +24,7 @@ public:
class LocalSaveActivity: public WindowActivity
{
SaveFile save;
std::unique_ptr<ThumbnailRendererTask> thumbnailRenderer;
ThumbnailRendererTask *thumbnailRenderer;
std::unique_ptr<VideoBuffer> thumbnail;
ui::Textbox * filenameField;
class CancelAction;

14
src/gui/save/ServerSaveActivity.cpp
View File

@ -13,7 +13,7 @@
#include "gui/Style.h"
#include "client/GameSave.h"
#include "images.h"
#include "client/ThumbnailRenderer.h"
#include "client/ThumbnailRendererTask.h"
class ServerSaveActivity::CancelAction: public ui::ButtonAction
{
@ -104,6 +104,7 @@ public:
ServerSaveActivity::ServerSaveActivity(SaveInfo save, ServerSaveActivity::SaveUploadedCallback * callback) :
WindowActivity(ui::Point(-1, -1), ui::Point(440, 200)),
thumbnailRenderer(nullptr),
save(save),
callback(callback),
saveUploadTask(NULL)
@ -184,13 +185,14 @@ ServerSaveActivity::ServerSaveActivity(SaveInfo save, ServerSaveActivity::SaveUp
if (save.GetGameSave())
{
thumbnailRenderer = std::unique_ptr<ThumbnailRendererTask>(new ThumbnailRendererTask(save.GetGameSave(), (Size.X/2)-16, -1, false, false, true));
thumbnailRenderer = new ThumbnailRendererTask(save.GetGameSave(), (Size.X/2)-16, -1, false, false, true);
thumbnailRenderer->Start();
}
}
ServerSaveActivity::ServerSaveActivity(SaveInfo save, bool saveNow, ServerSaveActivity::SaveUploadedCallback * callback) :
WindowActivity(ui::Point(-1, -1), ui::Point(200, 50)),
thumbnailRenderer(nullptr),
save(save),
callback(callback),
saveUploadTask(NULL)
@ -407,8 +409,8 @@ void ServerSaveActivity::OnTick(float dt)
thumbnailRenderer->Poll();
if (thumbnailRenderer->GetDone())
{
thumbnail = thumbnailRenderer->GetThumbnail();
thumbnailRenderer.reset();
thumbnail = thumbnailRenderer->Finish();
thumbnailRenderer = nullptr;
}
}
@ -435,6 +437,10 @@ void ServerSaveActivity::OnDraw()
ServerSaveActivity::~ServerSaveActivity()
{
if (thumbnailRenderer)
{
thumbnailRenderer->Abandon();
}
delete saveUploadTask;
delete callback;
}

2
src/gui/save/ServerSaveActivity.h
View File

@ -40,7 +40,7 @@ public:
protected:
void AddAuthorInfo();
virtual void NotifyDone(Task * task);
std::unique_ptr<ThumbnailRendererTask> thumbnailRenderer;
ThumbnailRendererTask *thumbnailRenderer;
std::unique_ptr<VideoBuffer> thumbnail;
SaveInfo save;
SaveUploadedCallback * callback;

163
src/tasks/AbandonableTask.cpp Normal file
View File

@ -0,0 +1,163 @@
#include "AbandonableTask.h"
#include "Platform.h"
#ifdef DEBUG
# define DEBUGTHREADS
// * Uncomment above if AbandonableTasks cause issues.
// * Three outputs should be possible:
// * The task is properly finished:
// AbandonableTask @ [ptr] ctor
// AbandonableTask @ [ptr] created
// ...
// AbandonableTask @ [ptr] finished
// AbandonableTask @ [ptr] joined
// AbandonableTask @ [ptr] dtor
// * The task is abandoned but its thread has finished:
// AbandonableTask @ [ptr] ctor
// AbandonableTask @ [ptr] created
// ...
// AbandonableTask @ [ptr] abandoned
// AbandonableTask @ [ptr] joined
// AbandonableTask @ [ptr] dtor
// * The task is abandoned before its thread has finished:
// AbandonableTask @ [ptr] ctor
// AbandonableTask @ [ptr] created
// ...
// AbandonableTask @ [ptr] abandoned
// ...
// AbandonableTask @ [ptr] detached
// AbandonableTask @ [ptr] dtor
// * Anything other than those means something is broken.
#endif
#ifdef DEBUGTHREADS
# include <iostream>
#endif
void AbandonableTask::Start()
{
thDone = false;
done = false;
thAbandoned = false;
progress = 0;
status = "";
//taskMutex = PTHREAD_MUTEX_INITIALIZER;
before();
pthread_mutex_init (&taskMutex, NULL);
pthread_create(&doWorkThread, 0, &AbandonableTask::doWork_helper, this);
#ifdef DEBUGTHREADS
std::cerr << "AbandonableTask @ " << this << " created" << std::endl;
#endif
}
TH_ENTRY_POINT void * AbandonableTask::doWork_helper(void * ref)
{
Task::doWork_helper(ref);
AbandonableTask *task = (AbandonableTask *)ref;
pthread_mutex_lock(&task->taskMutex);
bool abandoned = task->thAbandoned;
pthread_mutex_unlock(&task->taskMutex);
if (abandoned)
{
pthread_detach(task->doWorkThread);
pthread_mutex_destroy(&task->taskMutex);
#ifdef DEBUGTHREADS
std::cerr << "AbandonableTask @ " << ref << " detached" << std::endl;
#endif
// We've done Task::~Task's job already.
task->done = true;
delete task;
}
return NULL;
}
void AbandonableTask::Finish()
{
while (!GetDone())
{
Poll();
Platform::Millisleep(1);
}
#ifdef DEBUGTHREADS
std::cerr << "AbandonableTask @ " << this << " finished" << std::endl;
#endif
delete this;
}
void AbandonableTask::Abandon()
{
bool delete_this = false;
pthread_mutex_lock(&taskMutex);
if (thDone)
{
// If thDone is true, the thread has already finished. We're
// not calling Poll because it may call callbacks, which
// an abandoned task shouldn't do. Instead we just delete the
// AbandonableTask after unlocking the mutex, which will
// take care of the thread if another Poll hasn't already
// (i.e. if done is false despite thDone being true).
delete_this = true;
}
else
{
// If at this point thDone is still false, the thread is still
// running, meaning we can safely set thAbandoned and let
// AbandonableTask::doWork_helper detach the thread
// and delete the AbandonableTask later.
thAbandoned = true;
}
pthread_mutex_unlock(&taskMutex);
#ifdef DEBUGTHREADS
std::cerr << "AbandonableTask @ " << this << " abandoned" << std::endl;
#endif
if (delete_this)
{
delete this;
}
}
void AbandonableTask::Poll()
{
#ifdef DEBUGTHREADS
bool old_done = done;
#endif
Task::Poll();
#ifdef DEBUGTHREADS
if (done != old_done)
{
std::cerr << "AbandonableTask @ " << this << " joined" << std::endl;
}
#endif
}
AbandonableTask::AbandonableTask()
{
#ifdef DEBUGTHREADS
std::cerr << "AbandonableTask @ " << this << " ctor" << std::endl;
#endif
}
AbandonableTask::~AbandonableTask()
{
#ifdef DEBUGTHREADS
if (!done)
{
// Actually it'll be joined later in Task::~Task, but the debug
// messages look more consistent this way.
std::cerr << "AbandonableTask @ " << this << " joined" << std::endl;
}
std::cerr << "AbandonableTask @ " << this << " dtor" << std::endl;
#endif
}

21
src/tasks/AbandonableTask.h Normal file
View File

@ -0,0 +1,21 @@
#ifndef ABANDONABLETASK_H_
#define ABANDONABLETASK_H_
#include "Task.h"
class AbandonableTask : public Task
{
public:
void Start();
void Finish();
void Abandon();
void Poll();
AbandonableTask();
virtual ~AbandonableTask();
protected:
bool thAbandoned;
TH_ENTRY_POINT static void * doWork_helper(void * ref);
};
#endif /* ABANDONABLETASK_H_ */