umbrello  2.32.2
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
codegenobjectwithtextblocks.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 CODEGENOBJECTWITHTEXTBLOCKS_H
13 #define CODEGENOBJECTWITHTEXTBLOCKS_H
14 
15 #include "codeaccessormethod.h"
16 #include "textblocklist.h"
17 
18 #include <QMap>
19 
20 class CodeBlock;
22 class CodeClassField;
23 class CodeComment;
24 class CodeDocument;
26 class QXmlStreamWriter;
27 class TextBlock;
28 
33 {
34 public:
35 
36  explicit CodeGenObjectWithTextBlocks(CodeDocument *parent);
38 
39  virtual bool addTextBlock(TextBlock * add_object);
40 
41  virtual bool removeTextBlock(TextBlock * remove_object);
42 
47  virtual bool insertTextBlock(TextBlock * newBlock, TextBlock * existingBlock, bool after) = 0;
48 
50 
51  virtual HierarchicalCodeBlock * getHierarchicalCodeBlock(const QString &tag, const QString &comment, int indentLevel);
52 
53  virtual CodeBlockWithComments * getCodeBlockWithComments(const QString &tag, const QString &comment, int indentLevel);
54 
55  CodeComment * addOrUpdateTaggedCodeComment(const QString &tag = QString(), const QString &text = QString(), int indentationLevel = 0);
56 
58  (const QString &tag, const QString &text, const QString &ctext,
59  int indentLevel, bool forceUserBlockUpdate);
60 
61  TextBlock * findTextBlockByTag(const QString &tag);
62 
67  virtual QString getUniqueTag(const QString& prefix = QString()) = 0;
68 
72  virtual CodeBlock * newCodeBlock() = 0;
75 
77 
78 protected:
79 
80  virtual void setAttributesOnNode(QXmlStreamWriter& writer);
81 
82  virtual void setAttributesFromNode(QDomElement & element);
83 
85 
86  virtual void loadChildTextBlocksFromNode(QDomElement & root);
87 
88  virtual void resetTextBlocks();
89 
94  virtual TextBlock * findCodeClassFieldTextBlockByTag(const QString &tag) = 0;
95 
96  QMap<QString, TextBlock *> m_textBlockTagMap;
98 
99 private:
100 
101  // needed in order to use findTextBlocksByTag
103 
104 };
105 
106 #endif // CODEGENOBJECTWITHTEXTBLOCKS_H
CodeGenObjectWithTextBlocks::resetTextBlocks
virtual void resetTextBlocks()
Definition: codegenobjectwithtextblocks.cpp:326
CodeGenObjectWithTextBlocks::findParentObjectForTaggedTextBlock
CodeGenObjectWithTextBlocks * findParentObjectForTaggedTextBlock(const QString &tag)
Definition: codegenobjectwithtextblocks.cpp:145
CodeGenObjectWithTextBlocks::findCodeClassFieldTextBlockByTag
virtual TextBlock * findCodeClassFieldTextBlockByTag(const QString &tag)=0
textblocklist.h
codegenfactory.h
CodeGenObjectWithTextBlocks::getCodeBlockWithComments
virtual CodeBlockWithComments * getCodeBlockWithComments(const QString &tag, const QString &comment, int indentLevel)
Definition: codegenobjectwithtextblocks.cpp:212
CodeBlock::loadFromXMI1
virtual void loadFromXMI1(QDomElement &root)
Definition: codeblock.cpp:91
CodeGenObjectWithTextBlocks::addOrUpdateTaggedCodeBlockWithComments
CodeBlockWithComments * addOrUpdateTaggedCodeBlockWithComments(const QString &tag, const QString &text, const QString &ctext, int indentLevel, bool forceUserBlockUpdate)
Definition: codegenobjectwithtextblocks.cpp:283
UMLObject::asUMLOperation
UMLOperation * asUMLOperation()
Definition: umlobject.cpp:1408
CodeGenObjectWithTextBlocks::m_textBlockTagMap
QMap< QString, TextBlock * > m_textBlockTagMap
Definition: codegenobjectwithtextblocks.h:96
CodeGenObjectWithTextBlocks::removeTextBlock
virtual bool removeTextBlock(TextBlock *remove_object)
Definition: codegenobjectwithtextblocks.cpp:95
hierarchicalcodeblock.h
namespace_enum_literal::test
test
Definition: namespace-enum-literal.h:3
CodeGenObjectWithTextBlocks::findTextBlockByTag
TextBlock * findTextBlockByTag(const QString &tag)
Definition: codegenobjectwithtextblocks.cpp:125
CodeComment
Definition: codecomment.h:23
TextBlock::setWriteOutText
void setWriteOutText(bool write)
Definition: textblock.cpp:131
CodeGenObjectWithTextBlocks::addTextBlock
virtual bool addTextBlock(TextBlock *add_object)
Definition: codegenobjectwithtextblocks.cpp:60
CodeGenObjectWithTextBlocks::newHierarchicalCodeBlock
virtual HierarchicalCodeBlock * newHierarchicalCodeBlock()=0
CodeBlockWithComments::getComment
CodeComment * getComment() const
Definition: codeblockwithcomments.cpp:50
TextBlock::setTag
void setTag(const QString &value)
Definition: textblock.cpp:121
CodeClassField
Definition: codeclassfield.h:29
CodeDocument
Definition: codedocument.h:33
UMLObject
The base class for UML objects.
Definition: umlobject.h:74
CodeGenObjectWithTextBlocks::getTextBlockList
TextBlockList * getTextBlockList() const
Definition: codegenobjectwithtextblocks.cpp:49
codeoperation.h
CodeBlock
Definition: codeblock.h:20
ClassifierCodeDocument
Definition: classifiercodedocument.h:32
CodeOperation::loadFromXMI1
virtual void loadFromXMI1(QDomElement &root)
Definition: codeoperation.cpp:86
CodeGenObjectWithTextBlocks::addOrUpdateTaggedCodeComment
CodeComment * addOrUpdateTaggedCodeComment(const QString &tag=QString(), const QString &text=QString(), int indentationLevel=0)
Definition: codegenobjectwithtextblocks.cpp:243
Uml::ID::fromString
ID::Type fromString(const QString &id)
Definition: basictypes.cpp:1336
CodeBlockWithComments::setOverallIndentationLevel
void setOverallIndentationLevel(int level)
Definition: codeblockwithcomments.cpp:167
CodeBlockWithComments::setComment
void setComment(CodeComment *object)
Definition: codeblockwithcomments.cpp:42
CodeGenObjectWithTextBlocks
Definition: codegenobjectwithtextblocks.h:32
CodeGenObjectWithTextBlocks::m_pCodeDoc
CodeDocument * m_pCodeDoc
Definition: codegenobjectwithtextblocks.h:102
CodeGenObjectWithTextBlocks::m_textblockVector
TextBlockList m_textblockVector
Definition: codegenobjectwithtextblocks.h:97
CodeGenFactory::newCodeComment
CodeComment * newCodeComment(CodeDocument *cd)
Definition: codegenfactory.cpp:412
UMLDoc::findObjectById
UMLObject * findObjectById(Uml::ID::Type id)
Definition: umldoc.cpp:1039
CodeGenObjectWithTextBlocks::CodeGenObjectWithTextBlocks
CodeGenObjectWithTextBlocks(CodeDocument *parent)
Definition: codegenobjectwithtextblocks.cpp:32
HierarchicalCodeBlock::loadFromXMI1
virtual void loadFromXMI1(QDomElement &root)
Definition: hierarchicalcodeblock.cpp:272
uWarning
#define uWarning()
Definition: debug_utils.h:124
classifiercodedocument.h
CodeGenObjectWithTextBlocks::getUniqueTag
virtual QString getUniqueTag(const QString &prefix=QString())=0
CodeBlockWithComments::loadFromXMI1
virtual void loadFromXMI1(QDomElement &root)
Definition: codeblockwithcomments.cpp:100
TextBlock::setIndentationLevel
void setIndentationLevel(int level)
Definition: textblock.cpp:152
uDebug
#define uDebug()
Definition: debug_utils.h:122
CodeGenObjectWithTextBlocks::newCodeBlock
virtual CodeBlock * newCodeBlock()=0
CodeBlockWithComments
Definition: codeblockwithcomments.h:23
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:280
CodeGenObjectWithTextBlocks::insertTextBlock
virtual bool insertTextBlock(TextBlock *newBlock, TextBlock *existingBlock, bool after)=0
CodeGenObjectWithTextBlocks::setAttributesFromNode
virtual void setAttributesFromNode(QDomElement &element)
Definition: codegenobjectwithtextblocks.cpp:376
CodeBlock::contentType
ContentType contentType() const
Definition: codeblock.cpp:54
CodeBlock::AutoGenerated
@ AutoGenerated
the content was generated by code generation itself
Definition: codeblock.h:46
CodeGenObjectWithTextBlocks::getHierarchicalCodeBlock
virtual HierarchicalCodeBlock * getHierarchicalCodeBlock(const QString &tag, const QString &comment, int indentLevel)
Definition: codegenobjectwithtextblocks.cpp:180
codegenobjectwithtextblocks.h
codedocument.h
HierarchicalCodeBlock
Definition: hierarchicalcodeblock.h:24
uError
#define uError()
Definition: debug_utils.h:123
UMLOperation
Definition: operation.h:24
CodeOperation
Definition: codeoperation.h:23
CodeGenObjectWithTextBlocks::setAttributesFromObject
void setAttributesFromObject(CodeGenObjectWithTextBlocks *obj)
Definition: codegenobjectwithtextblocks.cpp:342
uml.h
debug_utils.h
TextBlockList
QList< TextBlock * > TextBlockList
Definition: textblocklist.h:17
TextBlock::saveToXMI1
virtual void saveToXMI1(QXmlStreamWriter &writer)=0
codeaccessormethod.h
TextBlock::getParentDocument
CodeDocument * getParentDocument() const
Definition: textblock.cpp:70
CodeGenObjectWithTextBlocks::setAttributesOnNode
virtual void setAttributesOnNode(QXmlStreamWriter &writer)
Definition: codegenobjectwithtextblocks.cpp:358
CodeComment::loadFromXMI1
virtual void loadFromXMI1(QDomElement &root)
Definition: codecomment.cpp:42
TextBlock
Definition: textblock.h:26
TextBlock::setText
void setText(const QString &text)
Definition: textblock.cpp:80
CodeGenObjectWithTextBlocks::~CodeGenObjectWithTextBlocks
virtual ~CodeGenObjectWithTextBlocks()
Definition: codegenobjectwithtextblocks.cpp:40
CodeGenObjectWithTextBlocks::newCodeBlockWithComments
virtual CodeBlockWithComments * newCodeBlockWithComments()=0
CodeGenFactory::newCodeOperation
CodeOperation * newCodeOperation(ClassifierCodeDocument *ccd, UMLOperation *op)
Definition: codegenfactory.cpp:232
UMLApp::document
UMLDoc * document() const
Definition: uml.cpp:1068
CodeGenObjectWithTextBlocks::loadChildTextBlocksFromNode
virtual void loadChildTextBlocksFromNode(QDomElement &root)
Definition: codegenobjectwithtextblocks.cpp:393
TextBlock::getTag
QString getTag() const
Definition: textblock.cpp:110
umldoc.h
HierarchicalCodeBlock::removeTextBlock
bool removeTextBlock(TextBlock *remove_object)
Definition: hierarchicalcodeblock.cpp:172