ProjectDocument Class Reference

Project document class handles all data related to the opened project (sample, jobModel, project specific windows settings) More...

Inheritance diagram for ProjectDocument:

Collaboration diagram for ProjectDocument:

Public Slots
void	onModelChanged ()

Signals
void	modified ()

Public Member Functions
	ProjectDocument (const QString &projectFileName="")
ProjectFlags::DocumentStatus	documentStatus () const
QString	documentVersion () const
bool	hasData () const
bool	hasErrors () const
bool	hasValidNameAndPath ()
bool	hasWarnings () const
bool	isModified ()
bool	isReady () const
void	load (const QString &project_file_name)
QString	projectDir () const
QString	projectFileName () const
QString	projectName () const
void	save (const QString &project_file_name, bool autoSave=false)
void	save_project_data (const QString &project_file_name)
void	save_project_file (const QString &project_file_name, bool autoSave=false)
void	setApplicationModels (ApplicationModels *applicationModels)
void	setLogger (MessageService *messageService)
void	setModified (bool flag)
void	setProjectDir (const QString &text)
void	setProjectFileName (const QString &text)
void	setProjectName (const QString &text)

Static Public Member Functions
static QString	projectFileExtension ()

Private Member Functions
void	connectModels ()
void	disconnectModels ()
void	readFrom (QIODevice *device)
void	writeTo (QIODevice *device)

Private Attributes
ApplicationModels *	m_applicationModels
QString	m_currentVersion
OutputDataIOService *	m_dataService
ProjectFlags::DocumentStatus	m_documentStatus
MessageService *	m_messageService
bool	m_modified
QString	m_project_dir
QString	m_project_name

Detailed Description

Project document class handles all data related to the opened project (sample, jobModel, project specific windows settings)

e.g. if project file is /home/users/development/Untitled/Untitled.pro projectName() - 'Untitled' projectDir() - '/home/users/development/Untitled projectFileName() - '/home/users/development/Untitled/Untitled.pro'

Definition at line 40 of file projectdocument.h.

Constructor & Destructor Documentation

ProjectDocument()

ProjectDocument::ProjectDocument

(

const QString &

projectFileName = ""

)

Definition at line 30 of file projectdocument.cpp.

    : m_applicationModels(nullptr)
    , m_modified(false)
    , m_documentStatus(ProjectFlags::STATUS_OK)
    , m_messageService(nullptr)
    , m_dataService(new OutputDataIOService(this))
{
    setObjectName("ProjectDocument");
    if (!projectFileName.isEmpty())
        setProjectFileName(projectFileName);
}

References projectFileName(), and setProjectFileName().

Here is the call graph for this function:

Member Function Documentation

connectModels()

void ProjectDocument::connectModels ( )

private

Definition at line 295 of file projectdocument.cpp.

{
    if (m_applicationModels)
        connect(m_applicationModels, &ApplicationModels::modelChanged, this,
                &ProjectDocument::onModelChanged, Qt::UniqueConnection);
}

References m_applicationModels, ApplicationModels::modelChanged(), and onModelChanged().

Referenced by load(), and setApplicationModels().

Here is the call graph for this function:

disconnectModels()

void ProjectDocument::disconnectModels ( )

private

Definition at line 288 of file projectdocument.cpp.

{
    if (m_applicationModels)
        disconnect(m_applicationModels, &ApplicationModels::modelChanged, this,
                   &ProjectDocument::onModelChanged);
}

References m_applicationModels, ApplicationModels::modelChanged(), and onModelChanged().

Referenced by load(), and setApplicationModels().

Here is the call graph for this function:

documentStatus()

ProjectFlags::DocumentStatus ProjectDocument::documentStatus

(

)

const

Definition at line 186 of file projectdocument.cpp.

{
    return m_documentStatus;
}

References m_documentStatus.

documentVersion()

QString ProjectDocument::documentVersion

(

)

const

Definition at line 211 of file projectdocument.cpp.

{
    QString result(m_currentVersion);
    if (result.isEmpty())
        result = GUIHelpers::getBornAgainVersionString();
    return result;
}

References GUIHelpers::getBornAgainVersionString(), and m_currentVersion.

Referenced by ProjectManager::riseProjectLoadWarningDialog().

Here is the call graph for this function:

hasData()

bool ProjectDocument::hasData

(

)

const

Definition at line 206 of file projectdocument.cpp.

{
    return !m_dataService->nonXMLItems().isEmpty();
}

References m_dataService, and OutputDataIOService::nonXMLItems().

Referenced by SaveService::process_queue().

Here is the call graph for this function:

hasErrors()

bool ProjectDocument::hasErrors

(

)

const

Definition at line 201 of file projectdocument.cpp.

{
    return m_documentStatus.testFlag(ProjectFlags::STATUS_FAILED);
}

References m_documentStatus, and ProjectFlags::STATUS_FAILED.

Referenced by ProjectManager::openProject().

hasValidNameAndPath()

bool ProjectDocument::hasValidNameAndPath

(

)

Definition at line 164 of file projectdocument.cpp.

{
    return (!m_project_name.isEmpty() && !m_project_dir.isEmpty());
}

References m_project_dir, and m_project_name.

Referenced by AutosaveController::assureAutoSaveDirExists(), AutosaveController::autosaveDir(), AutosaveController::autosaveName(), AutosaveController::onDocumentModified(), ProjectManager::projectDir(), and ProjectManager::saveProject().

hasWarnings()

bool ProjectDocument::hasWarnings

(

)

const

Definition at line 196 of file projectdocument.cpp.

{
    return m_documentStatus.testFlag(ProjectFlags::STATUS_WARNING);
}

References m_documentStatus, and ProjectFlags::STATUS_WARNING.

Referenced by ProjectManager::openProject().

isModified()

bool ProjectDocument::isModified

(

)

Definition at line 169 of file projectdocument.cpp.

{
    return m_modified;
}

References m_modified.

Referenced by ProjectManager::closeCurrentProject(), AutosaveController::onDocumentModified(), ProjectManager::onDocumentModified(), and AutosaveController::onTimerTimeout().

isReady()

bool ProjectDocument::isReady

(

)

const

Definition at line 191 of file projectdocument.cpp.

{
    return (m_documentStatus == ProjectFlags::STATUS_OK);
}

References m_documentStatus, and ProjectFlags::STATUS_OK.

Referenced by ProjectManager::openProject().

load()

void ProjectDocument::load

(

const QString &

project_file_name

)

Definition at line 129 of file projectdocument.cpp.

{
    QElapsedTimer timer1, timer2;
    timer1.start();
 
    m_documentStatus = ProjectFlags::STATUS_OK;
    setProjectFileName(project_file_name);
 
    QFile file(projectFileName());
    if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
        QString message = QString("Open file error '%1'").arg(file.errorString());
        m_messageService->send_error(this, message);
        ProjectFlags::setFlag(m_documentStatus, ProjectFlags::STATUS_FAILED);
        return;
    }
 
    try {
        disconnectModels();
        readFrom(&file);
        file.close();
 
        timer2.start();
        m_dataService->load(projectDir(), m_messageService);
        connectModels();
 
        if (m_messageService->warningCount())
            ProjectFlags::setFlag(m_documentStatus, ProjectFlags::STATUS_WARNING);
 
    } catch (const std::exception& ex) {
        QString message = QString("Exception thrown '%1'").arg(QString(ex.what()));
        m_messageService->send_error(this, message);
        ProjectFlags::setFlag(m_documentStatus, ProjectFlags::STATUS_FAILED);
    }
}

References connectModels(), disconnectModels(), OutputDataIOService::load(), m_dataService, m_documentStatus, m_messageService, projectDir(), projectFileName(), readFrom(), MessageService::send_error(), ProjectFlags::setFlag(), setProjectFileName(), ProjectFlags::STATUS_FAILED, ProjectFlags::STATUS_OK, ProjectFlags::STATUS_WARNING, and MessageService::warningCount().

Referenced by ProjectManager::loadProject().

Here is the call graph for this function:

modified

void ProjectDocument::modified ( )

signal

Referenced by ProjectManager::createNewProject(), onModelChanged(), save_project_file(), AutosaveController::setDocumentConnected(), setModified(), and setProjectName().

onModelChanged

void ProjectDocument::onModelChanged ( )

slot

Definition at line 219 of file projectdocument.cpp.

{
    m_modified = true;
    emit modified();
}

References m_modified, and modified().

Referenced by connectModels(), and disconnectModels().

projectDir()

QString ProjectDocument::projectDir

(

)

const

Definition at line 55 of file projectdocument.cpp.

{
    return m_project_dir;
}

References m_project_dir.

Referenced by AutosaveController::assureAutoSaveDirExists(), load(), ProjectManager::projectDir(), and projectFileName().

projectFileExtension()

QString ProjectDocument::projectFileExtension ( )

static

Definition at line 79 of file projectdocument.cpp.

{
    return ".pro";
}

Referenced by ProjectUtils::autosaveName(), NewProjectDialog::getProjectFileName(), and projectFileName().

projectFileName()

QString ProjectDocument::projectFileName

(

)

const

Definition at line 65 of file projectdocument.cpp.

{
    if (!projectName().isEmpty())
        return projectDir() + "/" + projectName() + projectFileExtension();
    else
        return "";
}

References projectDir(), projectFileExtension(), and projectName().

Referenced by ProjectDocument(), ProjectManager::addToRecentProjects(), AutosaveController::autosaveDir(), AutosaveController::autosaveName(), load(), ProjectManager::riseProjectLoadFailedDialog(), ProjectManager::saveProject(), and setProjectFileName().

Here is the call graph for this function:

projectName()

QString ProjectDocument::projectName

(

)

const

Definition at line 42 of file projectdocument.cpp.

{
    return m_project_name;
}

References m_project_name.

Referenced by ProjectManager::onDocumentModified(), projectFileName(), and writeTo().

readFrom()

void ProjectDocument::readFrom ( QIODevice *  device )

private

Definition at line 225 of file projectdocument.cpp.

{
    ASSERT(m_messageService);
    QXmlStreamReader reader(device);
 
    while (!reader.atEnd()) {
        reader.readNext();
        if (reader.isStartElement()) {
            if (reader.name() == ProjectDocumentXML::BornAgainTag) {
                m_currentVersion = reader.attributes()
                                       .value(ProjectDocumentXML::BornAgainVersionAttribute)
                                       .toString();
 
                if (!GUIHelpers::isVersionMatchMinimal(m_currentVersion,
                                                       minimal_supported_version)) {
                    ProjectFlags::setFlag(m_documentStatus, ProjectFlags::STATUS_FAILED);
                    QString message = QString("Can't open document version '%1', "
                                              "minimal supported version '%2'")
                                          .arg(m_currentVersion)
                                          .arg(minimal_supported_version);
                    m_messageService->send_error(this, message);
                    return;
                }
 
                while (reader.readNextStartElement())
                    if (reader.name() == ProjectDocumentXML::InfoTag)
                        reader.skipCurrentElement();
                    else
                        m_applicationModels->readFrom(&reader, m_messageService);
 
                if (m_messageService->messageCount(m_applicationModels) > 0)
                    ProjectFlags::setFlag(m_documentStatus, ProjectFlags::STATUS_WARNING);
            }
        }
    }
 
    if (reader.hasError()) {
        ProjectFlags::setFlag(m_documentStatus, ProjectFlags::STATUS_FAILED);
        QString message = QString("Format error '%1'").arg(reader.errorString());
        m_messageService->send_error(this, message);
        return;
    }
}

References ASSERT, ProjectDocumentXML::BornAgainTag(), ProjectDocumentXML::BornAgainVersionAttribute(), ProjectDocumentXML::InfoTag(), GUIHelpers::isVersionMatchMinimal(), m_applicationModels, m_currentVersion, m_documentStatus, m_messageService, MessageService::messageCount(), ApplicationModels::readFrom(), MessageService::send_error(), ProjectFlags::setFlag(), ProjectFlags::STATUS_FAILED, and ProjectFlags::STATUS_WARNING.

Referenced by load().

Here is the call graph for this function:

save()

void ProjectDocument::save	(	const QString &	project_file_name,
		bool	autoSave = false
	)

Definition at line 94 of file projectdocument.cpp.

{
    save_project_data(project_file_name);
    save_project_file(project_file_name, autoSave);
}

References save_project_data(), and save_project_file().

Here is the call graph for this function:

save_project_data()

void ProjectDocument::save_project_data

(

const QString &

project_file_name

)

Definition at line 121 of file projectdocument.cpp.

{
    QElapsedTimer timer;
    timer.start();
 
    m_dataService->save(ProjectUtils::projectDir(project_file_name));
}

References m_dataService, ProjectUtils::projectDir(), and OutputDataIOService::save().

Referenced by SaveThread::run(), and save().

Here is the call graph for this function:

save_project_file()

void ProjectDocument::save_project_file	(	const QString &	project_file_name,
		bool	autoSave = false
	)

Definition at line 100 of file projectdocument.cpp.

{
    QElapsedTimer timer;
    timer.start();
 
    QFile file(project_file_name);
    if (!file.open(QFile::ReadWrite | QIODevice::Truncate | QFile::Text))
        throw GUIHelpers::Error("ProjectDocument::save_project_file() -> Error. Can't open "
                                "file '"
                                + project_file_name + "' for writing.");
 
    writeTo(&file);
    file.close();
 
    if (!autoSave) {
        setProjectFileName(project_file_name);
        m_modified = false;
        emit modified();
    }
}

References m_modified, modified(), setProjectFileName(), and writeTo().

Referenced by SaveService::process_queue(), and save().

Here is the call graph for this function:

setApplicationModels()

void ProjectDocument::setApplicationModels

(

ApplicationModels *

applicationModels

)

Definition at line 84 of file projectdocument.cpp.

{
    if (applicationModels != m_applicationModels) {
        disconnectModels();
        m_applicationModels = applicationModels;
        m_dataService->setApplicationModels(m_applicationModels);
        connectModels();
    }
}

References connectModels(), disconnectModels(), m_applicationModels, m_dataService, and OutputDataIOService::setApplicationModels().

Referenced by ProjectManager::createNewProject().

Here is the call graph for this function:

setLogger()

void ProjectDocument::setLogger

(

MessageService *

messageService

)

Definition at line 181 of file projectdocument.cpp.

{
    m_messageService = messageService;
}

References m_messageService.

Referenced by ProjectManager::createNewProject().

setModified()

void ProjectDocument::setModified

(

bool

flag

)

Definition at line 174 of file projectdocument.cpp.

{
    m_modified = flag;
    if (m_modified)
        emit modified();
}

References m_modified, and modified().

Referenced by ProjectManager::loadProject().

setProjectDir()

void ProjectDocument::setProjectDir

(

const QString &

text

)

Definition at line 60 of file projectdocument.cpp.

{
    m_project_dir = text;
}

References m_project_dir.

Referenced by setProjectFileName().

setProjectFileName()

void ProjectDocument::setProjectFileName

(

const QString &

text

)

Definition at line 73 of file projectdocument.cpp.

{
    setProjectName(ProjectUtils::projectName(projectFileName));
    setProjectDir(ProjectUtils::projectDir(projectFileName));
}

References ProjectUtils::projectDir(), projectFileName(), ProjectUtils::projectName(), setProjectDir(), and setProjectName().

Referenced by ProjectDocument(), load(), ProjectManager::loadProject(), and save_project_file().

Here is the call graph for this function:

setProjectName()

void ProjectDocument::setProjectName

(

const QString &

text

)

Definition at line 47 of file projectdocument.cpp.

{
    if (m_project_name != text) {
        m_project_name = text;
        emit modified();
    }
}

References m_project_name, and modified().

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

writeTo()

void ProjectDocument::writeTo ( QIODevice *  device )

private

Definition at line 269 of file projectdocument.cpp.

{
    QXmlStreamWriter writer(device);
    writer.setAutoFormatting(true);
    writer.writeStartDocument();
    writer.writeStartElement(ProjectDocumentXML::BornAgainTag);
    QString version_string = GUIHelpers::getBornAgainVersionString();
    writer.writeAttribute(ProjectDocumentXML::BornAgainVersionAttribute, version_string);
 
    writer.writeStartElement(ProjectDocumentXML::InfoTag);
    writer.writeAttribute(ProjectDocumentXML::InfoNameAttribute, projectName());
    writer.writeEndElement(); // InfoTag
 
    m_applicationModels->writeTo(&writer);
 
    writer.writeEndElement(); // BornAgain tag
    writer.writeEndDocument();
}

References ProjectDocumentXML::BornAgainTag(), ProjectDocumentXML::BornAgainVersionAttribute(), GUIHelpers::getBornAgainVersionString(), ProjectDocumentXML::InfoNameAttribute(), ProjectDocumentXML::InfoTag(), m_applicationModels, projectName(), and ApplicationModels::writeTo().

Referenced by save_project_file().

Here is the call graph for this function:

Member Data Documentation

m_applicationModels

ApplicationModels* ProjectDocument::m_applicationModels

private

Definition at line 100 of file projectdocument.h.

Referenced by connectModels(), disconnectModels(), readFrom(), setApplicationModels(), and writeTo().

m_currentVersion

QString ProjectDocument::m_currentVersion

private

Definition at line 104 of file projectdocument.h.

Referenced by documentVersion(), and readFrom().

m_dataService

OutputDataIOService* ProjectDocument::m_dataService

private

Definition at line 105 of file projectdocument.h.

Referenced by hasData(), load(), save_project_data(), and setApplicationModels().

m_documentStatus

ProjectFlags::DocumentStatus ProjectDocument::m_documentStatus

private

Definition at line 102 of file projectdocument.h.

Referenced by documentStatus(), hasErrors(), hasWarnings(), isReady(), load(), and readFrom().

m_messageService

MessageService* ProjectDocument::m_messageService

private

Definition at line 103 of file projectdocument.h.

Referenced by load(), readFrom(), and setLogger().

m_modified

bool ProjectDocument::m_modified

private

Definition at line 101 of file projectdocument.h.

Referenced by isModified(), onModelChanged(), save_project_file(), and setModified().

m_project_dir

QString ProjectDocument::m_project_dir

private

Definition at line 98 of file projectdocument.h.

Referenced by hasValidNameAndPath(), projectDir(), and setProjectDir().

m_project_name

QString ProjectDocument::m_project_name

private

Definition at line 99 of file projectdocument.h.

Referenced by hasValidNameAndPath(), projectName(), and setProjectName().

---

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

• /home/www/ba/GUI/coregui/mainwindow/projectdocument.h
• /home/www/ba/GUI/coregui/mainwindow/projectdocument.cpp