umbrello  2.32.2
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
codedocument.h
Go to the documentation of this file.
1 /***************************************************************************
2  * This program is free software; you can redistribute it and/or modify *
3  * it under the terms of the GNU General Public License as published by *
4  * the Free Software Foundation; either version 2 of the License, or *
5  * (at your option) any later version. *
6  * *
7  * copyright (C) 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov> *
8  * copyright (C) 2004-2020 *
9  * Umbrello UML Modeller Authors <umbrello-devel@kde.org> *
10  ***************************************************************************/
11 
12 #ifndef CODEDOCUMENT_H
13 #define CODEDOCUMENT_H
14 
16 #include "hierarchicalcodeblock.h"
17 
18 #include <QMap>
19 #include <QObject>
20 #include <QString>
21 
23 class CodeComment;
24 class QXmlStreamWriter;
25 class TextBlock;
26 class UMLPackage;
27 
33 class CodeDocument : public QObject, public CodeGenObjectWithTextBlocks
34 {
35  friend class HierarchicalCodeBlock;
36  Q_OBJECT
37 public:
38 
39  CodeDocument ();
40  virtual ~CodeDocument ();
41 
42  void setFileExtension (const QString &new_var);
43  QString getFileExtension () const;
44 
45  void setFileName (const QString &new_var);
46  QString getFileName () const;
47 
48  void setPackage (UMLPackage *new_var);
49  QString getPackage () const;
50 
51  virtual QString getPath ();
52 
53  void setID (const QString &new_id);
54  QString ID () const;
55 
56  void setWriteOutCode (bool new_var);
57  bool getWriteOutCode ();
58 
59  void setHeader (CodeComment * comment);
61 
62  bool insertTextBlock (TextBlock * newBlock, TextBlock * existingBlock, bool after = true);
63 
64  TextBlock * findTextBlockByTag(const QString &tag, bool descendIntoChildren = false);
65 
66  virtual QString toString ();
67 
68  virtual void saveToXMI1(QXmlStreamWriter& writer);
69  virtual void loadFromXMI1 (QDomElement & root);
70 
71  virtual CodeBlock * newCodeBlock ();
74 
75  virtual QString getUniqueTag(const QString& prefix = QString());
76 
77  QString cleanName (const QString &name);
78 
79  virtual void synchronize();
80 
81  virtual void updateContent();
82 
83  friend QDebug operator<<(QDebug os, const CodeDocument& obj);
84 
85 protected:
86 
87  virtual void setAttributesOnNode (QXmlStreamWriter& writer);
88 
89  virtual void setAttributesFromNode (QDomElement & element);
90 
91  // these next 2 are needed by child hierarchical code blocks so
92  // that when they call getUniqueTag, we really get a unique tag
93  // Also, it allows 'findTextBlockByTag' To find any tagged text block
94  // anywhere in the document, whether directly owned by the document OR
95  // by some child hierarchical textblock
96  void addChildTagToMap (const QString &tag, TextBlock * tb);
97  void removeChildTagFromMap (const QString &tag);
98 
99  void updateHeader ();
100 
101  void resetTextBlocks();
102 
103  virtual TextBlock * findCodeClassFieldTextBlockByTag(const QString &tag);
104 
105 private:
106 
108  QString m_filename;
110  QString m_ID;
111  QString m_pathName;
113 
114  bool m_writeOutCode; // Whether or not to write out this code document
115  // and any codeblocks, etc that it owns.
116 
118 
119  // for recording all of the textblocks held by child hierarchical codeblocks
120  QMap<QString, TextBlock *> m_childTextBlockTagMap;
121 
122 };
123 
124 #endif // CODEDOCUMENT_H
UMLObject::id
virtual Uml::ID::Type id() const
Definition: umlobject.cpp:425
CodeDocument::m_header
CodeComment * m_header
Definition: codedocument.h:117
CodeGenObjectWithTextBlocks::resetTextBlocks
virtual void resetTextBlocks()
Definition: codegenobjectwithtextblocks.cpp:326
CodeDocument::setWriteOutCode
void setWriteOutCode(bool new_var)
Definition: codedocument.cpp:155
TextBlock::getWriteOutText
bool getWriteOutText() const
Definition: textblock.cpp:141
CodeDocument::resetTextBlocks
void resetTextBlocks()
Definition: codedocument.cpp:339
CodeDocument::m_childTextBlockTagMap
QMap< QString, TextBlock * > m_childTextBlockTagMap
Definition: codedocument.h:120
CodeDocument::newHierarchicalCodeBlock
virtual HierarchicalCodeBlock * newHierarchicalCodeBlock()
Definition: codedocument.cpp:479
TextBlock::toString
virtual QString toString() const
Definition: textblock.cpp:405
UMLObject::name
QString name() const
Definition: umlobject.cpp:211
CodeDocument::addChildTagToMap
void addChildTagToMap(const QString &tag, TextBlock *tb)
Definition: codedocument.cpp:491
CodeGenerator::cleanName
static QString cleanName(const QString &name)
Definition: codegenerator.cpp:550
CodeGenObjectWithTextBlocks::m_textBlockTagMap
QMap< QString, TextBlock * > m_textBlockTagMap
Definition: codegenobjectwithtextblocks.h:96
hierarchicalcodeblock.h
CodeDocument::saveToXMI1
virtual void saveToXMI1(QXmlStreamWriter &writer)
Definition: codedocument.cpp:438
CodeDocument::setFileName
void setFileName(const QString &new_var)
Definition: codedocument.cpp:54
CodeComment
Definition: codecomment.h:23
TextBlock::setWriteOutText
void setWriteOutText(bool write)
Definition: textblock.cpp:131
CodeComment::saveToXMI1
virtual void saveToXMI1(QXmlStreamWriter &writer)
Definition: codecomment.cpp:31
Uml::ID::None
const Type None
special value for uninitialized ID
Definition: basictypes.h:404
CodeDocument::operator<<
friend QDebug operator<<(QDebug os, const CodeDocument &obj)
Definition: codedocument.cpp:527
CodeDocument::setFileExtension
void setFileExtension(const QString &new_var)
Definition: codedocument.cpp:73
UMLApp::commonPolicy
CodeGenerationPolicy * commonPolicy() const
Definition: uml.cpp:2288
Uml::ID::toString
QString toString(const ID::Type &id)
Definition: basictypes.cpp:1331
CodeDocument::m_pathName
QString m_pathName
Definition: codedocument.h:111
TextBlock::setTag
void setTag(const QString &value)
Definition: textblock.cpp:121
Uml::ID::Type
std::string Type
Definition: basictypes.h:402
CodeDocument::getFileExtension
QString getFileExtension() const
Definition: codedocument.cpp:83
CodeDocument
Definition: codedocument.h:33
CodeDocument::removeChildTagFromMap
void removeChildTagFromMap(const QString &tag)
Definition: codedocument.cpp:486
UMLObject
The base class for UML objects.
Definition: umlobject.h:74
CodeDocument::CodeDocument
CodeDocument()
Definition: codedocument.cpp:30
CodeGenObjectWithTextBlocks::getTextBlockList
TextBlockList * getTextBlockList() const
Definition: codegenobjectwithtextblocks.cpp:49
CodeDocument::toString
virtual QString toString()
Definition: codedocument.cpp:303
CodeBlock
Definition: codeblock.h:20
CodeDocument::getPackage
QString getPackage() const
Definition: codedocument.cpp:124
CodeDocument::m_fileExtension
QString m_fileExtension
Definition: codedocument.h:109
CodeDocument::getPath
virtual QString getPath()
Definition: codedocument.cpp:101
Uml::ID::fromString
ID::Type fromString(const QString &id)
Definition: basictypes.cpp:1336
CodeDocument::HierarchicalCodeBlock
friend class HierarchicalCodeBlock
Definition: codedocument.h:35
CodeDocument::loadFromXMI1
virtual void loadFromXMI1(QDomElement &root)
Definition: codedocument.cpp:349
CodeGenerationPolicy::getHeadingFile
QString getHeadingFile(const QString &str)
Definition: codegenerationpolicy.cpp:546
CodeGenObjectWithTextBlocks
Definition: codegenobjectwithtextblocks.h:32
CodeGenObjectWithTextBlocks::m_textblockVector
TextBlockList m_textblockVector
Definition: codegenobjectwithtextblocks.h:97
UMLDoc::findObjectById
UMLObject * findObjectById(Uml::ID::Type id)
Definition: umldoc.cpp:1039
CodeDocument::setAttributesOnNode
virtual void setAttributesOnNode(QXmlStreamWriter &writer)
Definition: codedocument.cpp:358
uWarning
#define uWarning()
Definition: debug_utils.h:124
CodeDocument::setPackage
void setPackage(UMLPackage *new_var)
Definition: codedocument.cpp:92
CodeBlockWithComments
Definition: codeblockwithcomments.h:23
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:280
UMLDoc
Definition: umldoc.h:74
operator<<
QDebug operator<<(QDebug os, const CodeDocument &obj)
Definition: codedocument.cpp:527
CodeDocument::m_writeOutCode
bool m_writeOutCode
Definition: codedocument.h:114
CodeDocument::synchronize
virtual void synchronize()
Definition: codedocument.cpp:330
CodeDocument::updateContent
virtual void updateContent()
Definition: codedocument.cpp:452
CodeGenObjectWithTextBlocks::setAttributesFromNode
virtual void setAttributesFromNode(QDomElement &element)
Definition: codegenobjectwithtextblocks.cpp:376
CodeDocument::insertTextBlock
bool insertTextBlock(TextBlock *newBlock, TextBlock *existingBlock, bool after=true)
Definition: codedocument.cpp:217
CodeDocument::cleanName
QString cleanName(const QString &name)
Definition: codedocument.cpp:271
CodeDocument::newCodeBlock
virtual CodeBlock * newCodeBlock()
Definition: codedocument.cpp:461
codegenobjectwithtextblocks.h
codedocument.h
CodeDocument::updateHeader
void updateHeader()
Definition: codedocument.cpp:280
CodeDocument::~CodeDocument
virtual ~CodeDocument()
Definition: codedocument.cpp:41
HierarchicalCodeBlock::insertTextBlock
bool insertTextBlock(TextBlock *newBlock, TextBlock *existingBlock, bool after=true)
Definition: hierarchicalcodeblock.cpp:110
UMLDoc::findUMLObject
UMLObject * findUMLObject(const QString &name, UMLObject::ObjectType type=UMLObject::ot_UMLObject, UMLObject *currentObj=0)
Definition: umldoc.cpp:1068
HierarchicalCodeBlock
Definition: hierarchicalcodeblock.h:24
CodeDocument::m_lastTagIndex
int m_lastTagIndex
Definition: codedocument.h:107
CodeDocument::m_filename
QString m_filename
Definition: codedocument.h:108
CodeDocument::getFileName
QString getFileName() const
Definition: codedocument.cpp:64
uml.h
debug_utils.h
CodeDocument::newCodeBlockWithComments
virtual CodeBlockWithComments * newCodeBlockWithComments()
Definition: codedocument.cpp:470
TextBlockList
QList< TextBlock * > TextBlockList
Definition: textblocklist.h:17
CodeGenObjectWithTextBlocks::setAttributesOnNode
virtual void setAttributesOnNode(QXmlStreamWriter &writer)
Definition: codegenobjectwithtextblocks.cpp:358
CodeComment::loadFromXMI1
virtual void loadFromXMI1(QDomElement &root)
Definition: codecomment.cpp:42
CodeDocument::ID
QString ID() const
Definition: codedocument.cpp:144
TextBlock
Definition: textblock.h:26
codegenerator.h
CodeDocument::setHeader
void setHeader(CodeComment *comment)
Definition: codedocument.cpp:175
UMLObject::asUMLPackage
UMLPackage * asUMLPackage()
Definition: umlobject.cpp:1409
CodeDocument::getWriteOutCode
bool getWriteOutCode()
Definition: codedocument.cpp:166
TextBlock::setText
void setText(const QString &text)
Definition: textblock.cpp:80
CodeDocument::getHeader
CodeComment * getHeader()
Definition: codedocument.cpp:184
package.h
CodeDocument::findCodeClassFieldTextBlockByTag
virtual TextBlock * findCodeClassFieldTextBlockByTag(const QString &tag)
Definition: codedocument.cpp:521
CodeDocument::setID
void setID(const QString &new_id)
Definition: codedocument.cpp:135
UMLApp::document
UMLDoc * document() const
Definition: uml.cpp:1068
TextBlock::getTag
QString getTag() const
Definition: textblock.cpp:110
umldoc.h
CodeDocument::setAttributesFromNode
virtual void setAttributesFromNode(QDomElement &element)
Definition: codedocument.cpp:389
CodeDocument::findTextBlockByTag
TextBlock * findTextBlockByTag(const QString &tag, bool descendIntoChildren=false)
Definition: codedocument.cpp:504
CodeDocument::m_package
UMLPackage * m_package
Definition: codedocument.h:112
CodeDocument::getUniqueTag
virtual QString getUniqueTag(const QString &prefix=QString())
Definition: codedocument.cpp:194
CodeDocument::m_ID
QString m_ID
Definition: codedocument.h:110
UMLPackage
Non-graphical information for a Package.
Definition: package.h:32