codegenerator.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
 
    SPDX-FileCopyrightText: 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov>
    SPDX-FileCopyrightText: 2004-2021 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/
 
#ifndef CODEGENERATOR_H
#define CODEGENERATOR_H
 
#include "basictypes.h"
#include "codegenpolicyext.h"
#include "codegenerationpolicy.h"
#include "umlpackagelist.h"
#include "umlclassifierlist.h"
#include "codedocumentlist.h"
#include "codeviewerstate.h"
 
#include <QDir>
#include <QHash>
#include <QList>
 
class UMLDoc;
class UMLObject;
class ClassifierCodeDocument;
class CodeDocument;
class CodeViewerDialog;
class QDomDocument;
class QDomElement;
class QXmlStreamWriter;
 
class CodeGenerator : public QObject
{
    Q_OBJECT
public:
    typedef enum {Generated, Failed, Skipped } GenerationState;
    CodeGenerator();
    virtual ~CodeGenerator();
 
    bool addCodeDocument(CodeDocument * add_object);
    bool removeCodeDocument(CodeDocument * remove_object);
 
    CodeDocumentList * getCodeDocumentList();
 
    QString getUniqueID(CodeDocument * codeDoc);
 
    virtual void saveToXMI(QXmlStreamWriter& writer);
 
    CodeDocument * findCodeDocumentByID(const QString &id);
 
    virtual void writeCodeToFile();
    virtual void writeCodeToFile(UMLClassifierList &list);
 
    void setIncludeHeadings(bool i);
    bool includeHeadings() const;
 
    void setHeadingFileDir(const QString &);
    QString headingFileDir() const;
 
    void setForceDoc(bool f);
    bool forceDoc() const;
 
    void setForceSections(bool f);
    bool forceSections() const;
 
    virtual QString getHeadingFile(const QString &file);
 
    QString findFileName(CodeDocument * codeDocument);
 
    static QString cleanName(const QString &name);
 
    static QString formatDoc(const QString& text, const QString& linePrefix = QLatin1String(" *"), int lineWidth = 80);
 
    static QString formatSourceCode(const QString& code, const QString& indentation);
 
    static void findObjectsRelated(UMLClassifier *c, UMLPackageList &cList);
 
    virtual void loadFromXMI(QDomElement & element);
 
    virtual Uml::ProgrammingLanguage::Enum language() const = 0;
 
    CodeDocument * findCodeDocumentByClassifier(UMLClassifier * classifier);
 
    virtual QStringList defaultDatatypes() const;
 
    virtual bool isReservedKeyword(const QString & keyword);
 
    virtual QStringList reservedKeywords() const;
 
    virtual void createDefaultStereotypes();
 
    virtual void initFromParentDocument() = 0;
 
protected:
    QString overwritableName(const QString& name, const QString &extension);
 
    bool openFile(QFile& file, const QString &name);
 
    void writeListedCodeDocsToFile(CodeDocumentList * docs);
 
    virtual void finalizeRun();
 
    // map of what code documents we currently have in this generator.
    QHash<QString, CodeDocument*> m_codeDocumentDictionary;
 
    bool m_applyToAllRemaining;
 
    UMLDoc* m_document;
 
private:
    CodeDocumentList m_codedocumentVector;
    int m_lastIDIndex;
 
    void loadCodeForOperation(const QString& id, const QDomElement& codeDocElement);
 
public slots:
    virtual void syncCodeToDocument();
 
signals:
    void codeGenerated(UMLClassifier* concept, bool generated);
    void codeGenerated(UMLClassifier* concept, CodeGenerator::GenerationState result);
    void showGeneratedFile(const QString& filename);
};
 
#endif // CODEGENERATOR_H