umbrello  2.39.2
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
dwriter.h
Go to the documentation of this file.
1 /*
2  SPDX-License-Identifier: GPL-2.0-or-later
3 
4  SPDX-FileCopyrightText: 2007 Jari-Matti Mäkelä <jmjm@iki.fi>
5  SPDX-FileCopyrightText: 2008-2022 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
6 */
7 
8 #ifndef DWRITER_H
9 #define DWRITER_H
10 
11 #include "simplecodegenerator.h"
12 #include "umloperationlist.h"
13 #include "umlattributelist.h"
14 #include "umlassociationlist.h"
15 
16 class UMLOperation;
17 
29 {
30 public:
31 
32  DWriter();
33  virtual ~DWriter();
34 
35  virtual void writeClass(UMLClassifier *c);
36 
38 
39  QStringList defaultDatatypes() const;
40 
41 private:
42 
46  void writeModuleDecl(UMLClassifier *c, QTextStream &d);
47 
51  void writeModuleImports(UMLClassifier *c, QTextStream &d);
52 
57  void writeClassDecl(UMLClassifier *c, QTextStream &d);
58 
62  void writeConstructor(UMLClassifier *c, QTextStream &d);
63 
69  static bool compareDMethod(UMLOperation *op1, UMLOperation *op2);
70 
76  static bool dMethodInList(UMLOperation *umlOp, UMLOperationList &opl);
77 
86  void getSuperImplementedOperations(UMLClassifier *c, UMLOperationList &yetImplementedOpList,
87  UMLOperationList &toBeImplementedOpList, bool noClassInPath = true);
88 
95 
101  void writeOperations(UMLClassifier *c, QTextStream &j);
102 
108  void writeOperations(UMLOperationList &list, QTextStream &j);
109 
115  void writeAttributes(UMLClassifier *c, QTextStream &j);
116 
123 
132 
141  UMLAttributeList &atpriv, QTextStream &d);
142 
146  void writeAssociationDecls(UMLAssociationList associations, Uml::ID::Type id, QTextStream &d);
147 
151  void writeAssociationRoleDecl(QString fieldClassName, QString roleName, QString multi,
152  QString doc, Uml::Visibility::Enum visib, QTextStream &d);
153 
158 
162  void writeAssociationMethods(UMLAssociationList associations, UMLClassifier *thisClass,
163  QTextStream &d);
164 
170  void writeAssociationRoleMethod(QString fieldClassName, QString roleName, QString multi,
172  QTextStream &d);
173 
177  void writeSingleAttributeAccessorMethods(QString fieldClassName, QString fieldVarName,
178  QString fieldName, QString description,
180  bool isFinal, QTextStream &d);
181 
185  void writeVectorAttributeAccessorMethods(QString fieldClassName, QString fieldVarName,
186  QString fieldName, QString description,
188  QTextStream &d);
189 
193  void writeComment(const QString &text, const QString &indent, QTextStream &d, bool dDocStyle=false);
194 
198  void writeDocumentation(QString header, QString body, QString end, QString indent, QTextStream &d);
199 
203  QString getUMLObjectName(UMLObject *obj);
204 
208  QString deCapitaliseFirstLetter(const QString& str);
209 
213  QString pluralize(const QString& string);
214 
218  QString unPluralize(const QString& str);
219 
223  QString fixTypeName(const QString& string);
224 
228  QString fixInitialStringDeclValue(const QString& val, const QString& type);
229 
233  void writeBlankLine(QTextStream& d);
234 
235  QString startline;
236  bool isInterface;
237 
238 };
239 
240 #endif // DWRITER_H
Definition: dwriter.h:29
void writeComment(const QString &text, const QString &indent, QTextStream &d, bool dDocStyle=false)
Definition: dwriter.cpp:436
void writeProtectionMod(Uml::Visibility::Enum visibility, QTextStream &d)
Definition: dwriter.cpp:372
void writeOperations(UMLClassifier *c, QTextStream &j)
Definition: dwriter.cpp:826
void writeAttributeDecl(Uml::Visibility::Enum visibility, UMLAttributeList &atlist, QTextStream &d)
Definition: dwriter.cpp:377
bool isInterface
whether or not this concept is an interface
Definition: dwriter.h:236
void writeClassDecl(UMLClassifier *c, QTextStream &d)
Definition: dwriter.cpp:280
void writeConstructor(UMLClassifier *c, QTextStream &d)
Definition: dwriter.cpp:690
void writeAssociationRoleMethod(QString fieldClassName, QString roleName, QString multi, QString description, Uml::Visibility::Enum visib, Uml::Changeability::Enum change, QTextStream &d)
Definition: dwriter.cpp:593
QString fixInitialStringDeclValue(const QString &val, const QString &type)
Definition: dwriter.cpp:941
QString deCapitaliseFirstLetter(const QString &str)
Definition: dwriter.cpp:960
void writeAttributeDecls(UMLAttributeList &atpub, UMLAttributeList &atprot, UMLAttributeList &atpriv, QTextStream &d)
Definition: dwriter.cpp:413
QStringList defaultDatatypes() const
Definition: dwriter.cpp:729
void writeModuleDecl(UMLClassifier *c, QTextStream &d)
Definition: dwriter.cpp:54
void writeDocumentation(QString header, QString body, QString end, QString indent, QTextStream &d)
Definition: dwriter.cpp:469
void writeAssociationDecls(UMLAssociationList associations, Uml::ID::Type id, QTextStream &d)
Definition: dwriter.cpp:486
void writeBlankLine(QTextStream &d)
Definition: dwriter.cpp:987
QString startline
a , used at the end of each line
Definition: dwriter.h:235
QString fixTypeName(const QString &string)
Definition: dwriter.cpp:709
void writeSingleAttributeAccessorMethods(QString fieldClassName, QString fieldVarName, QString fieldName, QString description, Uml::Visibility::Enum visibility, Uml::Changeability::Enum change, bool isFinal, QTextStream &d)
Definition: dwriter.cpp:660
virtual Uml::ProgrammingLanguage::Enum language() const
Definition: dwriter.cpp:48
void getSuperImplementedOperations(UMLClassifier *c, UMLOperationList &yetImplementedOpList, UMLOperationList &toBeImplementedOpList, bool noClassInPath=true)
Definition: dwriter.cpp:793
virtual void writeClass(UMLClassifier *c)
Definition: dwriter.cpp:98
void writeAssociationRoleDecl(QString fieldClassName, QString roleName, QString multi, QString doc, Uml::Visibility::Enum visib, QTextStream &d)
Definition: dwriter.cpp:521
virtual ~DWriter()
Definition: dwriter.cpp:40
QString unPluralize(const QString &str)
Definition: dwriter.cpp:972
void writeAssociationMethods(UMLAssociationList associations, UMLClassifier *thisClass, QTextStream &d)
Definition: dwriter.cpp:559
QString getUMLObjectName(UMLObject *obj)
Definition: dwriter.cpp:955
void writeModuleImports(UMLClassifier *c, QTextStream &d)
Definition: dwriter.cpp:62
void writeAttributes(UMLClassifier *c, QTextStream &j)
DWriter()
Definition: dwriter.cpp:31
static bool dMethodInList(UMLOperation *umlOp, UMLOperationList &opl)
Definition: dwriter.cpp:783
static bool compareDMethod(UMLOperation *op1, UMLOperation *op2)
Definition: dwriter.cpp:761
void writeAttributeMethods(UMLAttributeList &atpub, Uml::Visibility::Enum visibility, QTextStream &d)
Definition: dwriter.cpp:422
void getInterfacesOperationsToBeImplemented(UMLClassifier *c, UMLOperationList &opl)
Definition: dwriter.cpp:814
QString pluralize(const QString &string)
Definition: dwriter.cpp:967
void writeVectorAttributeAccessorMethods(QString fieldClassName, QString fieldVarName, QString fieldName, QString description, Uml::Visibility::Enum visibility, Uml::Changeability::Enum change, QTextStream &d)
Definition: dwriter.cpp:610
Definition: simplecodegenerator.h:30
QString indent()
Definition: simplecodegenerator.cpp:69
Definition: umlattributelist.h:21
Information for a non-graphical Concept/Class.
Definition: classifier.h:35
The base class for UML objects.
Definition: umlobject.h:70
Definition: operation.h:20
static const char description[]
Definition: main.cpp:32
Enum
Definition: basictypes.h:202
std::string Type
Definition: basictypes.h:371
Enum
Definition: basictypes.h:291
Enum
Definition: basictypes.h:45
Definition: visibility.py:1
QList< UMLAssociation * > UMLAssociationList
Definition: umlassociationlist.h:12
QList< UMLOperation * > UMLOperationList
Definition: umloperationlist.h:12