umbrello  2.32.2
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
codegenerator.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 CODEGENERATOR_H
13 #define CODEGENERATOR_H
14 
15 #include "basictypes.h"
16 #include "codegenpolicyext.h"
17 #include "codegenerationpolicy.h"
18 #include "umlpackagelist.h"
19 #include "umlclassifierlist.h"
20 #include "codedocumentlist.h"
21 #include "codeviewerstate.h"
22 
23 #include <QDir>
24 #include <QHash>
25 #include <QList>
26 
27 class UMLDoc;
28 class UMLObject;
30 class CodeDocument;
31 class CodeViewerDialog;
32 class QDomDocument;
33 class QDomElement;
34 class QXmlStreamWriter;
35 
57 class CodeGenerator : public QObject
58 {
59  Q_OBJECT
60 public:
62  CodeGenerator();
63  virtual ~CodeGenerator();
64 
65  bool addCodeDocument(CodeDocument * add_object);
66  bool removeCodeDocument(CodeDocument * remove_object);
67 
69 
70  QString getUniqueID(CodeDocument * codeDoc);
71 
72  virtual void saveToXMI1(QXmlStreamWriter& writer);
73 
74  CodeDocument * findCodeDocumentByID(const QString &id);
75 
76  virtual void writeCodeToFile();
77  virtual void writeCodeToFile(UMLClassifierList &list);
78 
79  void setIncludeHeadings(bool i);
80  bool includeHeadings() const;
81 
82  void setHeadingFileDir(const QString &);
83  QString headingFileDir() const;
84 
85  void setForceDoc(bool f);
86  bool forceDoc() const;
87 
88  void setForceSections(bool f);
89  bool forceSections() const;
90 
91  virtual QString getHeadingFile(const QString &file);
92 
93  QString findFileName(CodeDocument * codeDocument);
94 
95  static QString cleanName(const QString &name);
96 
97  static QString formatDoc(const QString& text, const QString& linePrefix = QLatin1String(" *"), int lineWidth = 80);
98 
99  static QString formatSourceCode(const QString& code, const QString& indentation);
100 
101  static void findObjectsRelated(UMLClassifier *c, UMLPackageList &cList);
102 
107  virtual void loadFromXMI1(QDomElement & element);
108 
112  virtual Uml::ProgrammingLanguage::Enum language() const = 0;
113 
115 
116  virtual QStringList defaultDatatypes();
117 
118  virtual bool isReservedKeyword(const QString & keyword);
119 
120  virtual QStringList reservedKeywords() const;
121 
122  virtual void createDefaultStereotypes();
123 
127  virtual void initFromParentDocument() = 0;
128 
129 protected:
130  QString overwritableName(const QString& name, const QString &extension);
131 
132  bool openFile(QFile& file, const QString &name);
133 
135 
136  virtual void finalizeRun();
137 
138  // map of what code documents we currently have in this generator.
139  QHash<QString, CodeDocument*> m_codeDocumentDictionary;
140 
146 
151 
152 private:
155 
156  void loadCodeForOperation(const QString& id, const QDomElement& codeDocElement);
157 
158 public slots:
159  virtual void syncCodeToDocument();
160 
161 signals:
162  void codeGenerated(UMLClassifier* concept, bool generated);
164  void showGeneratedFile(const QString& filename);
165 };
166 
167 #endif // CODEGENERATOR_H
CodeGenerationPolicy::Ok
@ Ok
Definition: codegenerationpolicy.h:46
UMLObject::id
virtual Uml::ID::Type id() const
Definition: umlobject.cpp:425
umlattributelist.h
umlpackagelist.h
UMLClassifier::getOpList
UMLOperationList getOpList(bool includeInherited=false, UMLClassifierSet *alreadyTraversed=0)
Definition: classifier.cpp:939
CodeGenerator::finalizeRun
virtual void finalizeRun()
Definition: codegenerator.cpp:386
UMLObject::ObjectType
ObjectType
Definition: umlobject.h:80
CodeGenerator::m_codedocumentVector
CodeDocumentList m_codedocumentVector
Definition: codegenerator.h:153
Uml::ProgrammingLanguage::Enum
Enum
Definition: basictypes.h:322
UMLClassifier::isInterface
bool isInterface() const
Definition: classifier.cpp:118
CodeGenerator::loadCodeForOperation
void loadCodeForOperation(const QString &id, const QDomElement &codeDocElement)
Definition: codegenerator.cpp:221
UMLObject::asUMLOperation
UMLOperation * asUMLOperation()
Definition: umlobject.cpp:1408
CodeGenerationPolicy::Ask
@ Ask
Definition: codegenerationpolicy.h:46
UMLAttributeList
Definition: umlattributelist.h:26
umloperationlist.h
CodeGenerator::setForceDoc
void setForceDoc(bool f)
Definition: codegenerator.cpp:761
CodeGenerator::getHeadingFile
virtual QString getHeadingFile(const QString &file)
Definition: codegenerator.cpp:408
UMLCanvasObject::getAssociations
UMLAssociationList getAssociations()
Definition: umlcanvasobject.cpp:329
UMLOperation::getParmList
UMLAttributeList getParmList() const
Definition: operation.cpp:178
codedocumentlist.h
CodeGenerator::cleanName
static QString cleanName(const QString &name)
Definition: codegenerator.cpp:550
CodeGenerator::GenerationState
GenerationState
Definition: codegenerator.h:61
CodeGenerationPolicy::setCodeVerboseDocumentComments
void setCodeVerboseDocumentComments(bool new_var)
Definition: codegenerationpolicy.cpp:139
operation.h
UMLClassifierListItem::getType
UMLClassifier * getType() const
Definition: classifierlistitem.cpp:102
CodeGenerator::syncCodeToDocument
virtual void syncCodeToDocument()
Definition: codegenerator.cpp:286
CodeGenerationPolicy::setCodeVerboseSectionComments
void setCodeVerboseSectionComments(bool new_var)
Definition: codegenerationpolicy.cpp:115
codeviewerdialog.h
CodeGenerator::isReservedKeyword
virtual bool isReservedKeyword(const QString &keyword)
Definition: codegenerator.cpp:798
Uml::RoleType::A
@ A
Definition: basictypes.h:268
CodeGenerator::Generated
@ Generated
Definition: codegenerator.h:61
CodeGenerator::findObjectsRelated
static void findObjectsRelated(UMLClassifier *c, UMLPackageList &cList)
Definition: codegenerator.cpp:623
UMLApp::commonPolicy
CodeGenerationPolicy * commonPolicy() const
Definition: uml.cpp:2288
Uml::ID::toString
QString toString(const ID::Type &id)
Definition: basictypes.cpp:1331
association.h
CodeGenerationPolicy::Never
@ Never
Definition: codegenerationpolicy.h:46
UMLClassifierList
QList< UMLClassifier * > UMLClassifierList
Definition: umlclassifierlist.h:17
CodeGenerator::findCodeDocumentByID
CodeDocument * findCodeDocumentByID(const QString &id)
Definition: codegenerator.cpp:111
Uml::ID::Type
std::string Type
Definition: basictypes.h:402
CodeGenerator::findCodeDocumentByClassifier
CodeDocument * findCodeDocumentByClassifier(UMLClassifier *classifier)
Definition: codegenerator.cpp:301
CodeGenerator::findFileName
QString findFileName(CodeDocument *codeDocument)
Definition: codegenerator.cpp:566
CodeDocument::getFileExtension
QString getFileExtension() const
Definition: codedocument.cpp:83
CodeGenerator::setHeadingFileDir
void setHeadingFileDir(const QString &)
CodeDocument
Definition: codedocument.h:33
Uml::AssociationType::UniAssociation
@ UniAssociation
Definition: basictypes.h:136
CodeGenerationPolicy::setOverwritePolicy
void setOverwritePolicy(OverwritePolicy new_var)
Definition: codegenerationpolicy.cpp:74
UMLObject
The base class for UML objects.
Definition: umlobject.h:74
UMLObject::baseType
ObjectType baseType() const
Definition: umlobject.cpp:397
CodeGenerationPolicy::Cancel
@ Cancel
Definition: codegenerationpolicy.h:46
CodeGenerator::forceDoc
bool forceDoc() const
Definition: codegenerator.cpp:766
ClassifierCodeDocument
Definition: classifiercodedocument.h:32
CodeGenerator::m_codeDocumentDictionary
QHash< QString, CodeDocument * > m_codeDocumentDictionary
Definition: codegenerator.h:139
CodeGenerator::loadFromXMI1
virtual void loadFromXMI1(QDomElement &element)
Definition: codegenerator.cpp:179
CodeGenerator::writeCodeToFile
virtual void writeCodeToFile()
Definition: codegenerator.cpp:311
CodeGenerator::formatSourceCode
static QString formatSourceCode(const QString &code, const QString &indentation)
Definition: codegenerator.cpp:744
CodeDocument::getPath
virtual QString getPath()
Definition: codedocument.cpp:101
CodeGenerator::Skipped
@ Skipped
Definition: codegenerator.h:61
Uml::AssociationType::Aggregation
@ Aggregation
Definition: basictypes.h:125
CodeGenerator::reservedKeywords
virtual QStringList reservedKeywords() const
Definition: codegenerator.cpp:807
Uml::ProgrammingLanguage::toString
QString toString(Enum item)
Definition: basictypes.cpp:941
Uml::ID::fromString
ID::Type fromString(const QString &id)
Definition: basictypes.cpp:1336
CodeGenerator::setForceSections
void setForceSections(bool f)
Definition: codegenerator.cpp:771
UMLOperation::setSourceCode
void setSourceCode(const QString &code)
Definition: operation.cpp:499
CodeDocument::loadFromXMI1
virtual void loadFromXMI1(QDomElement &root)
Definition: codedocument.cpp:349
CodeGenerationPolicy::getHeadingFile
QString getHeadingFile(const QString &str)
Definition: codegenerationpolicy.cpp:546
CodeGenerator::showGeneratedFile
void showGeneratedFile(const QString &filename)
Definition: moc_codegenerator.cpp:181
UMLApp
Definition: uml.h:99
UMLDoc::findObjectById
UMLObject * findObjectById(Uml::ID::Type id)
Definition: umldoc.cpp:1039
attribute.h
CodeGenerator::initFromParentDocument
virtual void initFromParentDocument()=0
a
QString a
Definition: petalnode.cpp:18
uWarning
#define uWarning()
Definition: debug_utils.h:124
CodeGenerator::~CodeGenerator
virtual ~CodeGenerator()
Definition: codegenerator.cpp:68
i18n
#define i18n
Definition: main.cpp:39
classifiercodedocument.h
Uml::AssociationType::Association
@ Association
Definition: basictypes.h:127
umlclassifierlist.h
CodeGenerator::saveToXMI1
virtual void saveToXMI1(QXmlStreamWriter &writer)
Definition: codegenerator.cpp:246
CodeGenerator::formatDoc
static QString formatDoc(const QString &text, const QString &linePrefix=QLatin1String(" *"), int lineWidth=80)
Definition: codegenerator.cpp:713
basictypes.h
codegenerationpolicy.h
CodeGenerationPolicy
Definition: codegenerationpolicy.h:29
uDebug
#define uDebug()
Definition: debug_utils.h:122
SimpleCodeGenerator
Definition: simplecodegenerator.h:33
CodeGenerationPolicy::getCodeVerboseDocumentComments
bool getCodeVerboseDocumentComments() const
Definition: codegenerationpolicy.cpp:152
CodeGenerator::removeCodeDocument
bool removeCodeDocument(CodeDocument *remove_object)
Definition: codegenerator.cpp:151
Uml::RoleType::B
@ B
Definition: basictypes.h:269
CodeGenerator::headingFileDir
QString headingFileDir() const
UMLObject::toString
static QString toString(ObjectType ot)
Definition: umlobject.cpp:1184
CodeGenerator::includeHeadings
bool includeHeadings() const
Uml::AssociationType::Generalization
@ Generalization
Definition: basictypes.h:124
CodeGenerator::getCodeDocumentList
CodeDocumentList * getCodeDocumentList()
Definition: codegenerator.cpp:170
CodeGenerationPolicy::getOverwritePolicy
OverwritePolicy getOverwritePolicy() const
Definition: codegenerationpolicy.cpp:85
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:280
overwritedialog.h
UMLDoc
Definition: umldoc.h:74
UMLAttribute
Sets up attribute information.
Definition: attribute.h:27
UMLClassifier::getAttributeList
UMLAttributeList getAttributeList() const
Definition: classifier.cpp:436
UMLDoc::classesAndInterfaces
UMLClassifierList classesAndInterfaces(bool includeNested=true)
Definition: umldoc.cpp:2976
CodeViewerDialog
Definition: codeviewerdialog.h:27
CodeGenerator::getUniqueID
QString getUniqueID(CodeDocument *codeDoc)
Definition: codegenerator.cpp:79
UMLPackageList
QList< UMLPackage * > UMLPackageList
Definition: umlpackagelist.h:17
codedocument.h
CodeGenerator::m_applyToAllRemaining
bool m_applyToAllRemaining
Definition: codegenerator.h:145
CodeGenerator::codeGenerated
void codeGenerated(UMLClassifier *concept, bool generated)
Definition: moc_codegenerator.cpp:167
CodeGenerator::CodeGenerator
CodeGenerator()
Definition: codegenerator.cpp:53
ClassifierCodeDocument::getParentClassifier
UMLClassifier * getParentClassifier()
Definition: classifiercodedocument.cpp:276
classifier.h
uError
#define uError()
Definition: debug_utils.h:123
UMLOperation
Definition: operation.h:24
CodeDocument::getFileName
QString getFileName() const
Definition: codedocument.cpp:64
uml.h
CodeGenerator::defaultDatatypes
virtual QStringList defaultDatatypes()
Definition: codegenerator.cpp:785
CodeGenerationPolicy::getNewLineEndingChars
QString getNewLineEndingChars() const
Definition: codegenerationpolicy.cpp:253
UMLClassifier
Information for a non-graphical Concept/Class.
Definition: classifier.h:39
debug_utils.h
UMLAssociation
Sets up association information.
Definition: association.h:33
codeviewerstate.h
CodeGenerationPolicy::getOutputDirectory
QDir getOutputDirectory()
Definition: codegenerationpolicy.cpp:211
UMLObject::isUMLDatatype
bool isUMLDatatype()
Definition: umlobject.h:209
CodeGenerator::overwritableName
QString overwritableName(const QString &name, const QString &extension)
Definition: codegenerator.cpp:428
codegenpolicyext.h
umlobject.h
Uml::AssociationType::Composition
@ Composition
Definition: basictypes.h:134
CodeDocument::ID
QString ID() const
Definition: codedocument.cpp:144
CodeGenerator::language
virtual Uml::ProgrammingLanguage::Enum language() const =0
codegenerator.h
UMLObject::asUMLPackage
UMLPackage * asUMLPackage()
Definition: umlobject.cpp:1409
simplecodegenerator.h
uIgnoreZeroPointer
#define uIgnoreZeroPointer(a)
Definition: debug_utils.h:134
UMLObject::ot_Operation
@ ot_Operation
Definition: umlobject.h:94
CodeGenerator
Definition: codegenerator.h:57
OverwriteDialog
Definition: overwritedialog.h:29
CodeGenerator::m_lastIDIndex
int m_lastIDIndex
Definition: codegenerator.h:154
Uml::AssociationType::Dependency
@ Dependency
Definition: basictypes.h:126
CodeGenerator::forceSections
bool forceSections() const
Definition: codegenerator.cpp:776
UMLOperationList
QList< UMLOperation * > UMLOperationList
Definition: umloperationlist.h:18
CodeDocumentList
QList< CodeDocument * > CodeDocumentList
Definition: codedocumentlist.h:17
CodeGenerator::addCodeDocument
bool addCodeDocument(CodeDocument *add_object)
Definition: codegenerator.cpp:126
CodeGenerator::m_document
UMLDoc * m_document
Definition: codegenerator.h:150
CodeGenerator::createDefaultStereotypes
virtual void createDefaultStereotypes()
Definition: codegenerator.cpp:816
CodeGenerator::writeListedCodeDocsToFile
void writeListedCodeDocsToFile(CodeDocumentList *docs)
Definition: codegenerator.cpp:342
CodeDocument::setID
void setID(const QString &new_id)
Definition: codedocument.cpp:135
CodeGenerationPolicy::getCodeVerboseSectionComments
bool getCodeVerboseSectionComments() const
Definition: codegenerationpolicy.cpp:127
UMLAssociationList
QList< UMLAssociation * > UMLAssociationList
Definition: umlassociationlist.h:18
Uml::AssociationType::Realization
@ Realization
Definition: basictypes.h:135
umldoc.h
CodeGenerator::Failed
@ Failed
Definition: codegenerator.h:61
CodeGenerator::openFile
bool openFile(QFile &file, const QString &name)
Definition: codegenerator.cpp:524
UMLOperation::getSourceCode
QString getSourceCode() const
Definition: operation.cpp:507
UMLPackage
Non-graphical information for a Package.
Definition: package.h:32
CodeGenerator::setIncludeHeadings
void setIncludeHeadings(bool i)