codedocument.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 CODEDOCUMENT_H
#define CODEDOCUMENT_H
 
#include "codegenobjectwithtextblocks.h"
#include "hierarchicalcodeblock.h"
 
#include <QMap>
#include <QObject>
#include <QString>
 
class CodeBlockWithComments;
class CodeComment;
class QXmlStreamWriter;
class TextBlock;
class UMLPackage;
 
class CodeDocument : public QObject, public CodeGenObjectWithTextBlocks
{
    friend class HierarchicalCodeBlock;
    Q_OBJECT
public:
 
    CodeDocument ();
    virtual ~CodeDocument ();
 
    void setFileExtension (const QString &new_var);
    QString getFileExtension () const;
 
    void setFileName (const QString &new_var);
    QString getFileName () const;
 
    void setPackage (UMLPackage *new_var);
    QString getPackage () const;
 
    virtual QString getPath () const;
 
    void setID (const QString &new_id);
    QString ID () const;
 
    void setWriteOutCode (bool new_var);
    bool getWriteOutCode () const;
 
    void setHeader (CodeComment * comment);
    CodeComment * getHeader () const;
 
    bool insertTextBlock (TextBlock * newBlock, TextBlock * existingBlock, bool after = true);
 
    TextBlock * findTextBlockByTag(const QString &tag, bool descendIntoChildren = false) const;
 
    virtual QString toString () const;
 
    virtual void saveToXMI(QXmlStreamWriter& writer);
    virtual void loadFromXMI (QDomElement & root);
 
    virtual CodeBlock * newCodeBlock ();
    virtual HierarchicalCodeBlock * newHierarchicalCodeBlock ();
    virtual CodeBlockWithComments * newCodeBlockWithComments ();
 
    virtual QString getUniqueTag(const QString& prefix = QString());
 
    QString cleanName (const QString &name);
 
    virtual void synchronize();
 
    virtual void updateContent();
 
    friend QDebug operator<<(QDebug os, const CodeDocument& obj);
 
protected:
 
    virtual void setAttributesOnNode (QXmlStreamWriter& writer);
 
    virtual void setAttributesFromNode (QDomElement & element);
 
    // these next 2 are needed by child hierarchical code blocks so
    // that when they call getUniqueTag, we really get a unique tag
    // Also, it allows 'findTextBlockByTag' To find any tagged text block
    // anywhere in the document, whether directly owned by the document OR
    // by some child hierarchical textblock
    void addChildTagToMap (const QString &tag, TextBlock * tb);
    void removeChildTagFromMap (const QString &tag);
 
    void updateHeader ();
 
    void resetTextBlocks();
 
    virtual TextBlock * findCodeClassFieldTextBlockByTag(const QString &tag);
 
private:
 
    int m_lastTagIndex;
    QString m_filename;
    QString m_fileExtension;
    QString m_ID;
    QString m_pathName;
    UMLPackage *m_package;
 
    bool m_writeOutCode; // Whether or not to write out this code document
                         // and any codeblocks, etc that it owns.
 
    CodeComment * m_header;
 
    // for recording all of the textblocks held by child hierarchical codeblocks
    QMap<QString, TextBlock *> m_childTextBlockTagMap;
 
};
 
#endif // CODEDOCUMENT_H