codegenerationpolicy.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later

    SPDX-FileCopyrightText: 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov>
    SPDX-FileCopyrightText: 2004-2020 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/

#ifndef CODEGENERATIONPOLICY_H
#define CODEGENERATIONPOLICY_H

#include "basictypes.h"

#include <QDir>
#include <QObject>

class QWidget;
class CodeGenerationPolicyPage;

class CodeGenerationPolicy : public QObject
{
    Q_OBJECT
public:

    enum OverwritePolicy {Ok=0, Ask, Never, Cancel};
    enum ModifyNamePolicy {No=0, Underscore, Capitalise};
    enum WriteSectionCommentsPolicy { None=0, WhenNonEmpty, Always };
    enum NewLineType {UNIX=0, DOS, MAC};
    enum IndentationType {NONE=0, TAB, SPACE};
    enum CommentStyle { SingleLine=0, MultiLine };

    explicit CodeGenerationPolicy(CodeGenerationPolicy * clone);
    CodeGenerationPolicy();

    virtual ~CodeGenerationPolicy();

    void setOverwritePolicy(OverwritePolicy new_var);
    OverwritePolicy getOverwritePolicy() const;

    void setSectionCommentsPolicy(WriteSectionCommentsPolicy new_var);
    WriteSectionCommentsPolicy getSectionCommentsPolicy() const;

    void setCodeVerboseDocumentComments(bool new_var);
    bool getCodeVerboseDocumentComments() const;

    void setHeadingFileDir(const QString & path);
    QString getHeadingFileDir() const;

    void setIncludeHeadings(bool new_var);
    bool getIncludeHeadings() const;

    void setOutputDirectory(QDir new_var);
    QDir getOutputDirectory();

    void setLineEndingType(NewLineType type);
    NewLineType getLineEndingType();

    QString getNewLineEndingChars() const;

    void setIndentationType(IndentationType type);
    IndentationType getIndentationType();

    void setIndentationAmount(int amount);
    int getIndentationAmount();

    QString getIndentation() const;

    void setModifyPolicy(ModifyNamePolicy new_var);
    ModifyNamePolicy getModifyPolicy() const;

    void setAutoGenerateConstructors(bool var);
    bool getAutoGenerateConstructors();

    void setAttributeAccessorScope(Uml::Visibility::Enum var);
    Uml::Visibility::Enum getAttributeAccessorScope();

    void setAssociationFieldScope(Uml::Visibility::Enum var);
    Uml::Visibility::Enum getAssociationFieldScope();

    virtual CodeGenerationPolicyPage * createPage(QWidget *parent = nullptr, const char *name = nullptr);

    QString getHeadingFile(const QString& str);

    virtual void setDefaults(CodeGenerationPolicy * defaults, bool emitUpdateSignal = true);
    virtual void setDefaults(bool emitUpdateSignal = true);

    virtual void writeConfig();

    void emitModifiedCodeContentSig();

    void setCommentStyle(CommentStyle new_var);
    CommentStyle getCommentStyle();

Q_SIGNALS:

    void modifiedCodeContent();

protected:

/*
    // Policy of how to deal with overwriting existing files. Allowed values are "ask", "yes" and "no".
    OverwritePolicy m_overwritePolicy;

    // Whether or not verbose code commenting for sections is desired.
    // If true, comments for sections will be written even if the section is empty.
    WriteSectionCommentsPolicy m_sectionCommentsPolicy;

    // Whether or not verbose code commenting for documentation is desired.
    // If true, documentation for various code will be written even if no
    //code would normally be created at that point in the file.
    bool m_codeVerboseDocumentComments;

    QDir m_headingFiles; // location of the header file template.
    bool m_includeHeadings;
    QDir m_outputDirectory; // location of where output files will go.
    NewLineType m_lineEndingType; // What type of line ending characters to use.
    IndentationType m_indentationType; // The amount and type of whitespace to indent with.
    int m_indentationAmount; // The amount of units to indent with.
    ModifyNamePolicy m_modifyPolicy;
    bool m_autoGenerateConstructors;
    CommentStyle m_commentStyle;
    Uml::Visibility::Value m_attributeAccessorScope;
    Uml::Visibility::Value m_associationFieldScope;
*/

    // these 2 private fields 'cache' the string values of other fields we may frequently call for
    QString m_lineEndingChars;
    QString m_indentation;

    void calculateIndentation();

/*
protected:

    void initFields();
*/
};

#endif // CODEGENERATIONPOLICY_H