umbrello  2.39.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  SPDX-License-Identifier: GPL-2.0-or-later
3 
4  SPDX-FileCopyrightText: 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov>
5  SPDX-FileCopyrightText: 2004-2022 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
6 */
7 
8 #ifndef CODEGENERATOR_H
9 #define CODEGENERATOR_H
10 
11 #include "basictypes.h"
12 #include "codegenpolicyext.h"
13 #include "codegenerationpolicy.h"
14 #include "umlpackagelist.h"
15 #include "umlclassifierlist.h"
16 #include "codedocumentlist.h"
17 #include "codeviewerstate.h"
18 
19 #include <QDir>
20 #include <QHash>
21 #include <QList>
22 
23 class UMLDoc;
24 class UMLObject;
26 class CodeDocument;
27 class CodeViewerDialog;
28 class QDomDocument;
29 class QDomElement;
30 class QXmlStreamWriter;
31 
53 class CodeGenerator : public QObject
54 {
55  Q_OBJECT
56 public:
58  CodeGenerator();
59  virtual ~CodeGenerator();
60 
61  bool addCodeDocument(CodeDocument * add_object);
62  bool removeCodeDocument(CodeDocument * remove_object);
63 
65 
66  QString getUniqueID(CodeDocument * codeDoc);
67 
68  virtual void saveToXMI(QXmlStreamWriter& writer);
69 
70  CodeDocument * findCodeDocumentByID(const QString &id);
71 
72  virtual void writeCodeToFile();
73  virtual void writeCodeToFile(UMLClassifierList &list);
74 
75  void setIncludeHeadings(bool i);
76  bool includeHeadings() const;
77 
78  void setHeadingFileDir(const QString &);
79  QString headingFileDir() const;
80 
81  void setForceDoc(bool f);
82  bool forceDoc() const;
83 
85  bool forceSections() const; // TODO change to WriteSectionCommentsPolicy
86 
87  virtual QString getHeadingFile(const QString &file);
88 
89  QString findFileName(CodeDocument * codeDocument);
90 
91  static QString cleanName(const QString &name);
92 
93  static QString formatDoc(const QString& text, const QString& linePrefix = QStringLiteral(" *"), int lineWidth = 80);
94  static QString formatFullDocBlock(const QString &text,
95  const QString &blockHeader = QStringLiteral("/* "),
96  const QString &blockFooter = QStringLiteral(" */"),
97  const QString &linePrefix = QStringLiteral(" *"), 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 loadFromXMI(QDomElement & element);
108 
113 
115 
116  virtual QStringList defaultDatatypes() const;
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* classifier, bool generated);
164  void showGeneratedFile(const QString& filename);
165 };
166 
167 #endif // CODEGENERATOR_H
Definition: classifiercodedocument.h:29
Definition: codedocument.h:30
WriteSectionCommentsPolicy
Definition: codegenerationpolicy.h:44
Definition: codegenerator.h:54
virtual QStringList defaultDatatypes() const
Definition: codegenerator.cpp:838
CodeDocument * findCodeDocumentByID(const QString &id)
Definition: codegenerator.cpp:109
virtual void initFromParentDocument()=0
GenerationState
Definition: codegenerator.h:57
@ Failed
Definition: codegenerator.h:57
@ Generated
Definition: codegenerator.h:57
@ Skipped
Definition: codegenerator.h:57
virtual void syncCodeToDocument()
Definition: codegenerator.cpp:284
bool includeHeadings() const
static QString cleanName(const QString &name)
Definition: codegenerator.cpp:536
CodeDocument * findCodeDocumentByClassifier(UMLClassifier *classifier)
Definition: codegenerator.cpp:299
virtual void loadFromXMI(QDomElement &element)
Definition: codegenerator.cpp:177
virtual void finalizeRun()
Definition: codegenerator.cpp:384
bool removeCodeDocument(CodeDocument *remove_object)
Definition: codegenerator.cpp:149
QString findFileName(CodeDocument *codeDocument)
Definition: codegenerator.cpp:552
bool forceSections() const
Definition: codegenerator.cpp:829
void loadCodeForOperation(const QString &id, const QDomElement &codeDocElement)
Definition: codegenerator.cpp:219
void setSectionCommentPolicy(CodeGenerationPolicy::WriteSectionCommentsPolicy f)
Definition: codegenerator.cpp:824
bool m_applyToAllRemaining
Definition: codegenerator.h:145
virtual QString getHeadingFile(const QString &file)
Definition: codegenerator.cpp:406
virtual void writeCodeToFile()
Definition: codegenerator.cpp:309
static void findObjectsRelated(UMLClassifier *c, UMLPackageList &cList)
Definition: codegenerator.cpp:609
void writeListedCodeDocsToFile(CodeDocumentList *docs)
Definition: codegenerator.cpp:340
void setHeadingFileDir(const QString &)
CodeDocumentList * getCodeDocumentList()
Definition: codegenerator.cpp:168
int m_lastIDIndex
Definition: codegenerator.h:154
QString headingFileDir() const
static QString formatFullDocBlock(const QString &text, const QString &blockHeader=QStringLiteral("/* "), const QString &blockFooter=QStringLiteral(" */"), const QString &linePrefix=QStringLiteral(" *"), int lineWidth=80)
Definition: codegenerator.cpp:734
bool openFile(QFile &file, const QString &name)
Definition: codegenerator.cpp:510
CodeGenerator()
Definition: codegenerator.cpp:51
virtual Uml::ProgrammingLanguage::Enum language() const =0
QHash< QString, CodeDocument * > m_codeDocumentDictionary
Definition: codegenerator.h:139
void codeGenerated(UMLClassifier *classifier, bool generated)
Definition: moc_codegenerator.cpp:167
virtual bool isReservedKeyword(const QString &keyword)
Definition: codegenerator.cpp:851
CodeDocumentList m_codedocumentVector
Definition: codegenerator.h:153
static QString formatDoc(const QString &text, const QString &linePrefix=QStringLiteral(" *"), int lineWidth=80)
Definition: codegenerator.cpp:699
virtual void saveToXMI(QXmlStreamWriter &writer)
Definition: codegenerator.cpp:244
void setIncludeHeadings(bool i)
QString overwritableName(const QString &name, const QString &extension)
Definition: codegenerator.cpp:426
bool forceDoc() const
Definition: codegenerator.cpp:819
virtual ~CodeGenerator()
Definition: codegenerator.cpp:66
void setForceDoc(bool f)
Definition: codegenerator.cpp:814
UMLDoc * m_document
Definition: codegenerator.h:150
static QString formatSourceCode(const QString &code, const QString &indentation)
Definition: codegenerator.cpp:797
virtual void createDefaultStereotypes()
Definition: codegenerator.cpp:869
bool addCodeDocument(CodeDocument *add_object)
Definition: codegenerator.cpp:124
void showGeneratedFile(const QString &filename)
Definition: moc_codegenerator.cpp:181
QString getUniqueID(CodeDocument *codeDoc)
Definition: codegenerator.cpp:77
virtual QStringList reservedKeywords() const
Definition: codegenerator.cpp:860
Definition: codeviewerdialog.h:23
Information for a non-graphical Concept/Class.
Definition: classifier.h:35
Definition: umldoc.h:63
The base class for UML objects.
Definition: umlobject.h:70
QList< CodeDocument * > CodeDocumentList
Definition: codedocumentlist.h:12
Enum
Definition: basictypes.h:291
QList< UMLClassifier * > UMLClassifierList
Definition: umlclassifierlist.h:12
QList< UMLPackage * > UMLPackageList
Definition: umlpackagelist.h:11