AutosaveController Class Reference

Description

Triggers autosave request after some accumulated ammount of document changes.

Definition at line 25 of file AutosaveController.h.

Inheritance diagram for AutosaveController:

Collaboration diagram for AutosaveController:

Signals
void	autosaveRequest ()

Public Member Functions
	AutosaveController (QObject *parent=nullptr)
QString	autosaveDir () const
	The complete path to the autosave dir (e.g. '/projects/Untitled2/autosave'). More...
QString	autosaveName () const
void	removeAutosaveDir () const
	remove auto save directory for given project and all its content More...
void	setAutosaveTime (int timerInterval)
	Sets autosave time (in msec) More...
void	setDocument (ProjectDocument *document)

Private Slots
void	onDocumentDestroyed (QObject *object)
void	onDocumentModified ()
void	onTimerTimeout ()

Private Member Functions
bool	assureAutoSaveDirExists () const
	Tries to make sure that the directory for auto saving exists. Tries to create it if not existing so far. No creation, if project directory itself doesn't exist at all. Returns true, if the directory finally exists. More...
void	autosave ()

Private Attributes
ProjectDocument *	m_document
UpdateTimer *	m_timer

Constructor & Destructor Documentation

AutosaveController()

AutosaveController::AutosaveController ( QObject *  parent = nullptr )

explicit

Definition at line 26 of file AutosaveController.cpp.

    : QObject(parent)
    , m_document(nullptr)
    , m_timer(new UpdateTimer(update_every, this))
{
    connect(m_timer, &UpdateTimer::timeToUpdate, this, &AutosaveController::onTimerTimeout);
}

References m_timer, onTimerTimeout(), and UpdateTimer::timeToUpdate().

Here is the call graph for this function:

Member Function Documentation

assureAutoSaveDirExists()

bool AutosaveController::assureAutoSaveDirExists ( ) const

private

Tries to make sure that the directory for auto saving exists. Tries to create it if not existing so far. No creation, if project directory itself doesn't exist at all. Returns true, if the directory finally exists.

Definition at line 111 of file AutosaveController.cpp.

{
    if (m_document && m_document->hasValidNameAndPath()) {
        const QDir projectDir = m_document->projectDir();
        if (projectDir.exists() && !projectDir.exists(GUI::Project::Utils::autosaveSubdir()))
            projectDir.mkdir(GUI::Project::Utils::autosaveSubdir());
 
        return QDir(autosaveDir()).exists();
    }
 
    return false;
}

References autosaveDir(), GUI::Project::Utils::autosaveSubdir(), ProjectDocument::hasValidNameAndPath(), m_document, ProjectDocument::projectDir(), and GUI::Project::Utils::projectDir().

Referenced by autosave().

Here is the call graph for this function:

autosave()

void AutosaveController::autosave ( )

private

Definition at line 124 of file AutosaveController.cpp.

{
    try {
        if (!autosaveName().isEmpty() && assureAutoSaveDirExists())
            emit autosaveRequest();
    } catch (...) {
        // catch any exception - autosave itself never should cause a crash by an unhandled
        // exception
    }
}

References assureAutoSaveDirExists(), autosaveName(), and autosaveRequest().

Referenced by onTimerTimeout().

Here is the call graph for this function:

autosaveDir()

QString AutosaveController::autosaveDir

(

)

const

The complete path to the autosave dir (e.g. '/projects/Untitled2/autosave').

Returns the name of autosave directory.

Definition at line 64 of file AutosaveController.cpp.

{
    if (m_document && m_document->hasValidNameAndPath())
        return GUI::Project::Utils::autosaveDir(m_document->projectFileName());
 
    return "";
}

References GUI::Project::Utils::autosaveDir(), ProjectDocument::hasValidNameAndPath(), m_document, and ProjectDocument::projectFileName().

Referenced by assureAutoSaveDirExists(), and removeAutosaveDir().

Here is the call graph for this function:

autosaveName()

QString AutosaveController::autosaveName

(

)

const

Definition at line 72 of file AutosaveController.cpp.

{
    if (m_document && m_document->hasValidNameAndPath())
        return GUI::Project::Utils::autosaveName(m_document->projectFileName());
 
    return "";
}

References GUI::Project::Utils::autosaveName(), ProjectDocument::hasValidNameAndPath(), m_document, and ProjectDocument::projectFileName().

Referenced by autosave(), and SaveService::onAutosaveRequest().

Here is the call graph for this function:

autosaveRequest

void AutosaveController::autosaveRequest ( )

signal

Referenced by autosave(), and SaveService::setAutosaveEnabled().

onDocumentDestroyed

void AutosaveController::onDocumentDestroyed ( QObject *  object )

privateslot

Definition at line 95 of file AutosaveController.cpp.

{
    Q_UNUSED(object);
    m_timer->reset();
    m_document = nullptr;
}

References m_document, m_timer, and UpdateTimer::reset().

Referenced by setDocument().

Here is the call graph for this function:

onDocumentModified

void AutosaveController::onDocumentModified ( )

privateslot

Definition at line 102 of file AutosaveController.cpp.

{
    if (!m_document)
        return;
 
    if (m_document->isModified() && m_document->hasValidNameAndPath())
        m_timer->scheduleUpdate();
}

References ProjectDocument::hasValidNameAndPath(), ProjectDocument::isModified(), m_document, m_timer, and UpdateTimer::scheduleUpdate().

Referenced by setDocument().

Here is the call graph for this function:

onTimerTimeout

void AutosaveController::onTimerTimeout ( )

privateslot

Definition at line 89 of file AutosaveController.cpp.

{
    if (m_document->isModified())
        autosave();
}

References autosave(), ProjectDocument::isModified(), and m_document.

Referenced by AutosaveController().

Here is the call graph for this function:

removeAutosaveDir()

void AutosaveController::removeAutosaveDir

(

)

const

remove auto save directory for given project and all its content

Definition at line 80 of file AutosaveController.cpp.

{
    if (autosaveDir().isEmpty())
        return;
 
    QDir dir(autosaveDir());
    dir.removeRecursively();
}

References autosaveDir().

Referenced by SaveService::stopService().

Here is the call graph for this function:

setAutosaveTime()

void AutosaveController::setAutosaveTime

(

int

timerInterval

)

Sets autosave time (in msec)

Definition at line 56 of file AutosaveController.cpp.

{
    m_timer->reset();
    m_timer->setWallclockTimer(timerInterval);
}

References m_timer, UpdateTimer::reset(), and UpdateTimer::setWallclockTimer().

Referenced by SaveService::setAutosaveTime().

Here is the call graph for this function:

setDocument()

void AutosaveController::setDocument

(

ProjectDocument *

document

)

Definition at line 34 of file AutosaveController.cpp.

{
    if (document == m_document)
        return;
 
    m_timer->reset();
 
    if (m_document)
        m_document->disconnect(this);
 
    m_document = document;
 
    if (m_document) {
        connect(m_document, &ProjectDocument::destroyed, this,
                &AutosaveController::onDocumentDestroyed, Qt::UniqueConnection);
        connect(m_document, &ProjectDocument::modified, this,
                &AutosaveController::onDocumentModified, Qt::UniqueConnection);
    }
 
    onDocumentModified();
}

References m_document, m_timer, ProjectDocument::modified(), onDocumentDestroyed(), onDocumentModified(), and UpdateTimer::reset().

Referenced by SaveService::setAutosaveEnabled(), and SaveService::setDocument().

Here is the call graph for this function:

Member Data Documentation

m_document

ProjectDocument* AutosaveController::m_document

private

Definition at line 58 of file AutosaveController.h.

Referenced by assureAutoSaveDirExists(), autosaveDir(), autosaveName(), onDocumentDestroyed(), onDocumentModified(), onTimerTimeout(), and setDocument().

m_timer

UpdateTimer* AutosaveController::m_timer

private

Definition at line 59 of file AutosaveController.h.

Referenced by AutosaveController(), onDocumentDestroyed(), onDocumentModified(), setAutosaveTime(), and setDocument().

---

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

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