1
// This defines the interface to the QsciLexerBash class.
3
// Copyright (c) 2008 Riverbank Computing Limited <info@riverbankcomputing.com>
5
// This file is part of QScintilla.
7
// This file may be used under the terms of the GNU General Public
8
// License versions 2.0 or 3.0 as published by the Free Software
9
// Foundation and appearing in the files LICENSE.GPL2 and LICENSE.GPL3
10
// included in the packaging of this file. Alternatively you may (at
11
// your option) use any later version of the GNU General Public
12
// License if such license has been publicly approved by Riverbank
13
// Computing Limited (or its successors, if any) and the KDE Free Qt
14
// Foundation. In addition, as a special exception, Riverbank gives you
15
// certain additional rights. These rights are described in the Riverbank
16
// GPL Exception version 1.1, which can be found in the file
17
// GPL_EXCEPTION.txt in this package.
19
// Please review the following information to ensure GNU General
20
// Public Licensing requirements will be met:
21
// http://trolltech.com/products/qt/licenses/licensing/opensource/. If
22
// you are unsure which license is appropriate for your use, please
23
// review the following information:
24
// http://trolltech.com/products/qt/licenses/licensing/licensingoverview
25
// or contact the sales department at sales@riverbankcomputing.com.
27
// This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
28
// INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
29
// A PARTICULAR PURPOSE. Trolltech reserves all rights not expressly
32
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
33
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
36
#ifndef QSCILEXERBASH_H
37
#define QSCILEXERBASH_H
45
#include <Qsci/qsciglobal.h>
46
#include <Qsci/qscilexer.h>
49
//! \brief The QsciLexerBash class encapsulates the Scintilla Bash lexer.
50
class QSCINTILLA_EXPORT QsciLexerBash : public QsciLexer
55
//! This enum defines the meanings of the different styles used by the
73
//! A double-quoted string.
74
DoubleQuotedString = 5,
76
//! A single-quoted string.
77
SingleQuotedString = 6,
88
//! Parameter expansion.
89
ParameterExpansion = 10,
94
//! A here document delimiter.
95
HereDocumentDelimiter = 12,
97
//! A single quoted here document.
98
SingleQuotedHereDocument = 13
101
//! Construct a QsciLexerBash with parent \a parent. \a parent is
102
//! typically the QsciScintilla instance.
103
QsciLexerBash(QObject *parent = 0);
105
//! Destroys the QsciLexerBash instance.
106
virtual ~QsciLexerBash();
108
//! Returns the name of the language.
109
const char *language() const;
111
//! Returns the name of the lexer. Some lexers support a number of
113
const char *lexer() const;
115
//! \internal Returns the style used for braces for brace matching.
116
int braceStyle() const;
118
//! \internal Returns the string of characters that comprise a word.
119
const char *wordCharacters() const;
121
//! Returns the foreground colour of the text for style number \a style.
123
//! \sa defaultPaper()
124
QColor defaultColor(int style) const;
126
//! Returns the end-of-line fill for style number \a style.
127
bool defaultEolFill(int style) const;
129
//! Returns the font for style number \a style.
130
QFont defaultFont(int style) const;
132
//! Returns the background colour of the text for style number \a style.
134
//! \sa defaultColor()
135
QColor defaultPaper(int style) const;
137
//! Returns the set of keywords for the keyword set \a set recognised
138
//! by the lexer as a space separated string.
139
const char *keywords(int set) const;
141
//! Returns the descriptive name for style number \a style. If the
142
//! style is invalid for this language then an empty QString is returned.
143
//! This is intended to be used in user preference dialogs.
144
QString description(int style) const;
146
//! Causes all properties to be refreshed by emitting the
147
//! propertyChanged() signal as required.
148
void refreshProperties();
150
//! Returns true if multi-line comment blocks can be folded.
152
//! \sa setFoldComments()
153
bool foldComments() const;
155
//! Returns true if trailing blank lines are included in a fold block.
157
//! \sa setFoldCompact()
158
bool foldCompact() const;
161
//! If \a fold is true then multi-line comment blocks can be folded.
162
//! The default is false.
164
//! \sa foldComments()
165
virtual void setFoldComments(bool fold);
167
//! If \a fold is true then trailing blank lines are included in a fold
168
//! block. The default is true.
170
//! \sa foldCompact()
171
virtual void setFoldCompact(bool fold);
174
//! The lexer's properties are read from the settings \a qs. \a prefix
175
//! (which has a trailing '/') should be used as a prefix to the key of
176
//! each setting. true is returned if there is no error.
178
bool readProperties(QSettings &qs,const QString &prefix);
180
//! The lexer's properties are written to the settings \a qs.
181
//! \a prefix (which has a trailing '/') should be used as a prefix to
182
//! the key of each setting. true is returned if there is no error.
184
bool writeProperties(QSettings &qs,const QString &prefix) const;
187
void setCommentProp();
188
void setCompactProp();
193
QsciLexerBash(const QsciLexerBash &);
194
QsciLexerBash &operator=(const QsciLexerBash &);
added
removed
src/qscintilla2/Qt4/Qsci/qscilexerbash.h
