ResInsight/Fwk/AppFwk/cafProjectDataModel/cafPdmDocument.cpp

//##################################################################################################
//
//   Custom Visualization Core library
//   Copyright (C) 2011-2013 Ceetron AS
//
//   This library may be used under the terms of either the GNU General Public License or
//   the GNU Lesser General Public License as follows:
//
//   GNU General Public License Usage
//   This library 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 library 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 at <<http://www.gnu.org/licenses/gpl.html>>
//   for more details.
//
//   GNU Lesser General Public License Usage
//   This library is free software; you can redistribute it and/or modify
//   it under the terms of the GNU Lesser General Public License as published by
//   the Free Software Foundation; either version 2.1 of the License, or
//   (at your option) any later version.
//
//   This library 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 Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
//   for more details.
//
//##################################################################################################

#include "cafPdmDocument.h"

#include <QFile>
#include <QXmlStreamReader>

namespace caf
{
CAF_PDM_SOURCE_INIT( PdmDocument, "PdmDocument" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
PdmDocument::PdmDocument()
{
    CAF_PDM_InitFieldNoDefault( &fileName, "DocumentFileName", "File Name" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmDocument::readFile()
{
    QFile xmlFile( fileName );
    if ( !xmlFile.open( QIODevice::ReadOnly | QIODevice::Text ) ) return;

    readFile( &xmlFile );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmDocument::readFile( QIODevice* xmlFile )
{
    QXmlStreamReader xmlStream( xmlFile );

    while ( !xmlStream.atEnd() )
    {
        xmlStream.readNext();
        if ( xmlStream.isStartElement() )
        {
            if ( !matchesClassKeyword( xmlStream.name().toString() ) )
            {
                // Error: This is not a Ceetron Pdm based xml document
                return;
            }
            readFields( xmlStream, PdmDefaultObjectFactory::instance(), false );
        }
    }

    // Ask all objects to initialize and set up internal datastructure and pointers
    // after everything is read from file

    resolveReferencesRecursively();
    beforeInitAfterRead();
    initAfterReadRecursively();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool PdmDocument::writeFile()
{
    QFile xmlFile( fileName );
    if ( !xmlFile.open( QIODevice::WriteOnly | QIODevice::Text ) ) return false;

    writeFile( &xmlFile );

    return true;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmDocument::writeFile( QIODevice* xmlFile )
{
    // Ask all objects to make them ready to write themselves to file
    setupBeforeSaveRecursively();

    QXmlStreamWriter xmlStream( xmlFile );
    xmlStream.setAutoFormatting( true );

    xmlStream.writeStartDocument();
    QString className = classKeyword();

    xmlStream.writeStartElement( "", className );
    writeFields( xmlStream );
    xmlStream.writeEndElement();

    xmlStream.writeEndDocument();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmDocument::updateUiIconStateRecursively( PdmObjectHandle* object )
{
    if ( object == nullptr ) return;
    std::vector<PdmFieldHandle*> fields = object->fields();

    std::vector<PdmObjectHandle*> children;
    for ( size_t fIdx = 0; fIdx < fields.size(); ++fIdx )
    {
        if ( fields[fIdx] )
        {
            auto fieldChildren = fields[fIdx]->children();
            children.insert( children.end(), fieldChildren.begin(), fieldChildren.end() );
        }
    }

    for ( size_t cIdx = 0; cIdx < children.size(); ++cIdx )
    {
        PdmDocument::updateUiIconStateRecursively( children[cIdx] );
    }

    PdmUiObjectHandle* uiObjectHandle = uiObj( object );
    if ( uiObjectHandle )
    {
        uiObjectHandle->updateUiIconFromToggleField();
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmDocument::beforeInitAfterRead()
{
}

} // End of namespace caf