umbrello API Documentation
	Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

codegenerator.h

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   copyright (C) 2004-2006                                               *
 *   Umbrello UML Modeller Authors <uml-devel@uml.sf.net>                  *
 ***************************************************************************/

/*  This code generated by:
 *      Author : thomas
 *      Date   : Thu Jun 19 2003
 *  Bugs and comments to uml-devel@lists.sf.net or http://bugs.kde.org
 */


#ifndef CODEGENERATOR_H
#define CODEGENERATOR_H

#include <qdict.h>
#include <qdir.h>

#include "codegenerators/codegenpolicyext.h"
#include "codegenerationpolicy.h"
#include "umlpackagelist.h"
#include "umlclassifierlist.h"
#include "codedocumentlist.h"
#include "codeviewerstate.h"
#include "umlnamespace.h"

class UMLAttribute;
class UMLDoc;
class UMLObject;
class UMLRole;
class UMLOperation;

class ClassifierCodeDocument;
class CodeAccessorMethod;
class CodeBlock;
class CodeBlockWithComments;
class CodeClassField;
class CodeClassFieldDeclarationBlock;
class CodeComment;
class CodeDocument;
class CodeOperation;
class CodeViewerDialog;

class KConfig;

class CodeGenerator : public QObject {
    Q_OBJECT

public:

    // Constructors/Destructors
    //

    CodeGenerator ();

    CodeGenerator (QDomElement & element );

    virtual ~CodeGenerator ( );

    // Public attribute accessor methods
    //

    bool addCodeDocument ( CodeDocument * add_object );

    // bool replaceCodeDocument (  CodeDocument * replace_doc=0, bool addIfPriorDocumentNotPresent=true,
    //                                bool deleteReplacedDocument=true );

    bool removeCodeDocument ( CodeDocument * remove_object );

    CodeDocumentList * getCodeDocumentList ( );

    // get a unique id for this codedocument
    QString getUniqueID ( CodeDocument * codeDoc );

    virtual void saveToXMI ( QDomDocument & doc, QDomElement & root );

    CodeDocument * findCodeDocumentByID (const QString &id );

    virtual void writeCodeToFile ( );

    // this method is here to provide class wizard the
    // ability to write out only those classes which
    // are selected by the user.
    virtual void writeCodeToFile(UMLClassifierList &list);

    // these are utility methods for accessing the default
    // code gen policy object and *perhaps* should go away when we
    // finally implement the CodeGenDialog class -b.t.

    void setModifyNamePolicy(CodeGenerationPolicy::ModifyNamePolicy p);
    CodeGenerationPolicy::ModifyNamePolicy modifyNamePolicy()const;

    void setIncludeHeadings(bool i);
    bool includeHeadings() const;

    void setHeadingFileDir(const QString &);
    QString headingFileDir() const;

    void setForceDoc(bool f);
    bool forceDoc() const;

    void setForceSections(bool f);
    bool forceSections() const;


    virtual QString getHeadingFile (const QString &file );

    virtual QString findFileName(CodeDocument * doc);

    static QString cleanName ( const QString &name );

    QString formatDoc (const QString & text, const QString & linePrefix = " *", int lineWidth = 80 );

    static void findObjectsRelated(UMLClassifier *c, UMLPackageList &cList);

    // a series of accessor method constructors that we need to define
    // for any particular language.
    virtual CodeDocument * newClassifierCodeDocument (UMLClassifier * classifier ) = 0;

    virtual void loadFromXMI (QDomElement & element );

    virtual CodeDocument * newCodeDocument ( );

    virtual Uml::Programming_Language getLanguage() = 0;

    //FIX
    // NOTE: this should be 'protected' or we could have problems with CPP code generator
    CodeDocument * findCodeDocumentByClassifier (UMLClassifier * classifier );

    virtual QStringList defaultDatatypes();

    virtual CodeViewerDialog * getCodeViewerDialog( QWidget* parent, CodeDocument * doc,
            Settings::CodeViewerState state);

    virtual bool isReservedKeyword(const QString & rPossiblyReservedKeyword);

    virtual const QStringList reservedKeywords() const;

    virtual void createDefaultStereotypes ();

    virtual void initFromParentDocument( );

    void connect_newcodegen_slots();

protected:

    // void removeAndDeleteAllAutoGeneratedCodeDocuments ( bool deleteRemovedDocs=true );

    QString overwritableName (const QString& name, const QString &extension );

    bool openFile (QFile& file, const QString &name);

    void writeListedCodeDocsToFile(CodeDocumentList * docs);

    static const char * hierarchicalCodeBlockNodeName;

    // map of what code documents we currently have in this generator.
    QDict<CodeDocument> m_codeDocumentDictionary;

    bool m_applyToAllRemaining;

    UMLDoc* m_document;

private:

    // this seems silly and overkill now. -b.t.
    // QMap<CodeDocument*,QString> *m_fileMap;

    CodeDocumentList m_codedocumentVector;
    int lastIDIndex;

    void initFields() ;

public slots:

    virtual void checkAddUMLObject (UMLObject * obj);
    virtual void checkRemoveUMLObject (UMLObject * obj);

    virtual void syncCodeToDocument ( );

signals:

    void codeGenerated(UMLClassifier* concept, bool generated);

};

#endif // CODEGENERATOR_H

This file is part of the documentation for umbrello Version 3.1.0.

Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:07:55 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003