SaveService Class Reference

Description

Provides save/autosave of ProjectDocument in a thread.

Definition at line 26 of file SaveService.h.

Inheritance diagram for SaveService:

Collaboration diagram for SaveService:

Public Slots
void	onAutosaveRequest ()

Signals
void	projectSaved ()

Public Member Functions
	SaveService (QObject *parent=nullptr)
bool	isAutosaveEnabled () const
bool	isSaving () const
void	save (const QString &project_file_name)
void	setAutosaveEnabled (bool value)
void	setAutosaveTime (int timerInterval)
	Sets autosave time (in msec) More...
void	setDocument (ProjectDocument *document)
void	stopService ()

Private Slots
void	onProjectSaved ()

Private Member Functions
void	process_queue ()

Private Attributes
AutosaveController *	m_autosave
ProjectDocument *	m_document
bool	m_is_saving
QQueue< QString >	m_save_queue

Constructor & Destructor Documentation

SaveService()

SaveService::SaveService ( QObject *  parent = nullptr )

explicit

Definition at line 44 of file SaveService.cpp.

    : QObject(parent)
    , m_is_saving(false)
    , m_autosave(nullptr)
    , m_document(nullptr)
{
}

Member Function Documentation

isAutosaveEnabled()

bool SaveService::isAutosaveEnabled

(

)

const

Definition at line 84 of file SaveService.cpp.

{
    return m_autosave;
}

References m_autosave.

Referenced by ProjectManager::isAutosaveEnabled().

isSaving()

bool SaveService::isSaving

(

)

const

Definition at line 97 of file SaveService.cpp.

{
    return m_is_saving;
}

References m_is_saving.

Referenced by stopService().

onAutosaveRequest

void SaveService::onAutosaveRequest ( )

slot

Definition at line 126 of file SaveService.cpp.

{
    save(m_autosave->autosaveName());
}

References AutosaveController::autosaveName(), m_autosave, and save().

Referenced by setAutosaveEnabled().

Here is the call graph for this function:

onProjectSaved

void SaveService::onProjectSaved ( )

privateslot

Definition at line 131 of file SaveService.cpp.

{
    m_is_saving = false;
    emit projectSaved();
 
    // processing possible consequent saves
    process_queue();
}

References m_is_saving, process_queue(), and projectSaved().

Referenced by process_queue().

Here is the call graph for this function:

process_queue()

void SaveService::process_queue ( )

private

Definition at line 140 of file SaveService.cpp.

{
    if (m_is_saving)
        return;
 
    if (!m_save_queue.isEmpty()) {
        // use set/reset class to ensure correct resetting even in case of an exception
        AutoSetResetFlag autoSetReset(&m_is_saving);
 
        QString project_file_name = m_save_queue.dequeue();
 
        // saving project file in a main thread
        const bool isAutosave = project_file_name.contains(GUI::Project::Utils::autosaveSubdir());
        m_document->saveProjectFile(project_file_name, isAutosave);
 
        if (m_document->hasData()) {
            // saving heavy data in separate thread
            auto* saveThread = new SaveThread(this);
            saveThread->setSaveContext(m_document, project_file_name);
 
            connect(saveThread, &SaveThread::saveReady, this, &SaveService::onProjectSaved);
            connect(saveThread, &SaveThread::finished, saveThread, &QObject::deleteLater);
            saveThread->start();
        } else {
            onProjectSaved();
        }
    }
}

References GUI::Project::Utils::autosaveSubdir(), ProjectDocument::hasData(), m_document, m_is_saving, m_save_queue, onProjectSaved(), ProjectDocument::saveProjectFile(), and SaveThread::saveReady().

Referenced by onProjectSaved(), and save().

Here is the call graph for this function:

projectSaved

void SaveService::projectSaved ( )

signal

Referenced by onProjectSaved().

save()

void SaveService::save

(

const QString &

project_file_name

)

Definition at line 62 of file SaveService.cpp.

{
    ASSERT(m_document);
 
    m_save_queue.enqueue(project_file_name);
    process_queue();
}

References m_document, m_save_queue, and process_queue().

Referenced by onAutosaveRequest(), and ProjectManager::saveProject().

Here is the call graph for this function:

setAutosaveEnabled()

void SaveService::setAutosaveEnabled

(

bool

value

)

Definition at line 70 of file SaveService.cpp.

{
    if (value) {
        delete m_autosave;
        m_autosave = new AutosaveController(this);
        m_autosave->setDocument(m_document);
        connect(m_autosave, &AutosaveController::autosaveRequest, this,
                &SaveService::onAutosaveRequest);
    } else {
        delete m_autosave;
        m_autosave = nullptr;
    }
}

References AutosaveController::autosaveRequest(), m_autosave, m_document, onAutosaveRequest(), and AutosaveController::setDocument().

Referenced by ProjectManager::setAutosaveEnabled(), and setAutosaveTime().

Here is the call graph for this function:

setAutosaveTime()

void SaveService::setAutosaveTime

(

int

timerInterval

)

Sets autosave time (in msec)

Definition at line 89 of file SaveService.cpp.

{
    if (!m_autosave)
        setAutosaveEnabled(true);
 
    m_autosave->setAutosaveTime(timerInterval);
}

References m_autosave, setAutosaveEnabled(), and AutosaveController::setAutosaveTime().

Here is the call graph for this function:

setDocument()

void SaveService::setDocument

(

ProjectDocument *

document

)

Definition at line 52 of file SaveService.cpp.

{
    m_document = document;
 
    if (m_autosave)
        m_autosave->setDocument(document);
 
    m_save_queue.clear();
}

References m_autosave, m_document, m_save_queue, and AutosaveController::setDocument().

Referenced by ProjectManager::createNewProject(), and stopService().

Here is the call graph for this function:

stopService()

void SaveService::stopService

(

)

Definition at line 104 of file SaveService.cpp.

{
    QApplication::setOverrideCursor(Qt::WaitCursor);
 
    if (isSaving()) {
        QTime dieTime = QTime::currentTime().addSecs(60);
        while (QTime::currentTime() < dieTime) {
            QCoreApplication::processEvents(QEventLoop::AllEvents, 100);
            if (!isSaving())
                break;
        }
        if (isSaving())
            throw Error("SaveService::stopService() -> Error. Can't stop service. ");
    }
 
    if (m_autosave)
        m_autosave->removeAutosaveDir();
 
    setDocument(nullptr);
    QApplication::restoreOverrideCursor();
}

References Error, isSaving(), m_autosave, AutosaveController::removeAutosaveDir(), and setDocument().

Referenced by ProjectManager::deleteCurrentProject().

Here is the call graph for this function:

Member Data Documentation

m_autosave

AutosaveController* SaveService::m_autosave

private

Definition at line 60 of file SaveService.h.

Referenced by isAutosaveEnabled(), onAutosaveRequest(), setAutosaveEnabled(), setAutosaveTime(), setDocument(), and stopService().

m_document

ProjectDocument* SaveService::m_document

private

Definition at line 61 of file SaveService.h.

Referenced by process_queue(), save(), setAutosaveEnabled(), and setDocument().

m_is_saving

bool SaveService::m_is_saving

private

Definition at line 59 of file SaveService.h.

Referenced by isSaving(), onProjectSaved(), and process_queue().

m_save_queue

QQueue<QString> SaveService::m_save_queue

private

Definition at line 58 of file SaveService.h.

Referenced by process_queue(), save(), and setDocument().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Project/SaveService.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Project/SaveService.cpp