File: astyle_formatter.h

package info (click to toggle)
kdevelop 4%3A24.12.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 71,888 kB
  • sloc: cpp: 290,869; python: 3,626; javascript: 3,518; sh: 1,316; ansic: 703; xml: 401; php: 95; lisp: 66; makefile: 31; sed: 12
file content (110 lines) | stat: -rw-r--r-- 4,196 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
    SPDX-FileCopyrightText: 2008 CÃ ©dric Pasteur <cedric.pasteur@free.fr>
    SPDX-FileCopyrightText: 2001 Matthias Hölzer-Klüpfel <mhk@caldera.de>

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

#ifndef ASTYLEFORMATTER_H
#define ASTYLEFORMATTER_H

#include <QVariant>
#include <QString>

#include "astyle.h"

namespace AStyleOptionKey {
QString forceTabs();
QString tabSpaceConversion();
QString fillEmptyLines();
QString bracesAdd();
}

class AStyleFormatter
{
public:
    /** Creates an empty AStyleFormatter with C style by default.
    */
    AStyleFormatter();

    QString formatSource(const QString& text, const QString& leftContext = QString(), const QString& rightContext = QString());

    QVariant option(const QString &name) const;

    bool predefinedStyle(const QString &name);
    void loadStyle(const QString &content);
    QString saveStyle() const;

    // The following 3 setters specify the programming language of the code that is being formatted.
    // A source file's MIME type should be used to autodetect the language. Knowing the programming language
    // allows the formatter to identify language-specific syntax, such as classes, templates and keywords.
    void setCStyle();
    void setJavaStyle();
    void setSharpStyle();

    // fill
    /// Indents using one tab per indentation and disables tab-space conversion.
    void setTabIndentation(int length, bool forceTabs);
    /// Indents using {@p length per indentation} spaces and sets tab-space conversion to @p tabSpaceConversion.
    void setSpaceIndentationAndTabSpaceConversion(int length, bool tabSpaceConversion);
    /// Indents using {@p length per indentation} spaces and disables tab-space conversion.
    void setSpaceIndentationNoConversion(int length);
    void setEmptyLineFill(bool on);
    // indent+continuation
    void setBlockIndent(bool on);
    void setBracketIndent(bool on);
    void setCaseIndent(bool on);
    void setClassIndent(bool on);
    void setLabelIndent(bool on);
    void setNamespaceIndent(bool on);
    void setPreprocessorIndent(bool on);
    void setSwitchIndent(bool on);
    void setMaxInStatementIndentLength(int max);
    void setMinConditionalIndentLength(int min);
    void setAfterParens(bool on);
    void setContinuation(int n);
    //brackets
    void setBracketFormatMode(astyle::BraceMode mode);
    void setBreakClosingHeaderBracketsMode(bool state);
    void setAddBracesMode(bool state);
    //blocks
    void setBreakBlocksMode(bool state);
    void setBreakElseIfsMode(bool state);
    void setBreakClosingHeaderBlocksMode(bool state);
    //padding
    void setOperatorPaddingMode(bool mode);
    void setParensOutsidePaddingMode(bool mode);
    void setParensInsidePaddingMode(bool mode);
    void setParensHeaderPaddingMode(bool mode);
    void setParensUnPaddingMode(bool state);
    //oneliners
    void setBreakOneLineBlocksMode(bool state);
    void setBreakOneLineStatementsMode(bool state);
    //pointer
    void setPointerAlignment(astyle::PointerAlign alignment);

private:
    class Engine : public astyle::ASFormatter
    {
    public:
        // ASBeautifier::setBlockIndent() and ASBeautifier::setBraceIndent() became protected in 2011.
        // The upstream commit https://sourceforge.net/p/astyle/code/285 "removes" them
        // ("Remove indent-brackets and indent-blocks options.") with the following suggestions:
        // --indent-brackets: THIS IS NO LONGER A VALID OPTION. Instead use style=whitesmith or style=banner.
        // --indent-blocks: THIS IS NO LONGER A VALID OPTION. Instead use style=gnu.
        // Still, the now-protected functions work just fine. They are called internally by ASFormatter
        // for STYLE_WHITESMITH and STYLE_GNU. In order to make our predefined styles match the
        // upstream built-in styles, we need to call these protected functions, and so inherit
        // this class Engine from ASFormatter to make them public.
        using astyle::ASFormatter::setBlockIndent;
        using astyle::ASFormatter::setBraceIndent;
    };

    void updateFormatter();
    void resetStyle();

    QVariantMap m_options;
    Engine m_engine;
};

#endif // ASTYLEFORMATTER_H