CepGenerator.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK 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 version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/

#ifndef CEPGENERATOR_H
#define CEPGENERATOR_H

// includes from STL (for Linux) for std::auto_ptr
#include <memory>

// includes from Qt
#include <QDir>
#include <QString>
#include <QFileInfo>
#include <QVector>

// Hide warning for Exception + declspec(nothrow)
#if defined(_WIN32) && !defined(__MINGW32__) // MSVC only
#pragma warning( disable : 4290 )
#endif // MSVC only

// Dependency from cepcoreschema
// Declaration here to avoid declaration in dependant projects.
namespace cepcoreschema {
class Cep;
}

class ExtensionGenerator;

class CepGenerator {
public :

    CepGenerator(QString xmlFilename, QString devDirectoryName);

    CepGenerator(std::unique_ptr<cepcoreschema::Cep> domCep, QString devDirectoryName);

    CepGenerator();

    ~CepGenerator();

    void process();

    virtual void setXmlFileName(QString xmlFileName);

    virtual void createDomTree();

    virtual void setDevDirectoryName(QString devDirectoryName);

    virtual void serializeManifest(QString fileName = "");

protected:

    virtual void generateDirectoryTree();

    virtual void generateGlobalCMakeLists();

    virtual void generateCopyright();

    virtual void generateReadme();

    virtual void copyFindCamiTK();

    virtual void generateActionsDirectory();

    virtual void generateApplicationsDirectory();

    virtual void generateComponentsDirectory();

    virtual void generateLibrariesDirectory();

    virtual void setLicence();
    virtual void createActionExtensionDoms();

    virtual void createComponentExtensionDoms();

    virtual void createLibrarieDoms();

    virtual void generateExtensions();

private:
    std::unique_ptr<cepcoreschema::Cep> domCep;

    QFileInfo xmlFileName;

    QDir devDirectoryName;

    QString cepDirectoryName;

    QVector<ExtensionGenerator*> extensions;

    QString licence;

};

#endif // CEPGENERATOR_H