You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tqscintilla/qt/qextscintillalexerbash.h

191 lines
5.0 KiB

// This defines the interface to the QextScintillaLexerBash class.
//
// Copyright (c) 2006
// Riverbank Computing Limited <info@riverbankcomputing.co.uk>
//
// This file is part of TQScintilla.
//
// This copy of TQScintilla 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, or (at your option) any
// later version.
//
// TQScintilla is supplied in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License along with
// TQScintilla; see the file LICENSE. If not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#ifndef TQEXTSCINTILLALEXERBASH_H
#define TQEXTSCINTILLALEXERBASH_H
#include <tqobject.h>
#include <qextscintillaglobal.h>
#include <qextscintillalexer.h>
//! \brief The QextScintillaLexerBash class encapsulates the Scintilla Bash
//! lexer.
class TQEXTSCINTILLA_EXPORT QextScintillaLexerBash : public QextScintillaLexer
{
Q_OBJECT
TQ_OBJECT
public:
//! This enum defines the meanings of the different styles used by the
//! Bash lexer.
enum {
//! The default.
Default = 0,
//! \deprecated White space.
WhiteSpace = Default,
//! An error.
Error = 1,
//! A comment.
Comment = 2,
//! A number.
Number = 3,
//! A keyword.
Keyword = 4,
//! A double-quoted string.
DoubleQuotedString = 5,
//! A single-quoted string.
SingleQuotedString = 6,
//! An operator.
Operator = 7,
//! An identifier
Identifier = 8,
//! A scalar.
Scalar = 9,
//! Parameter expansion.
ParameterExpansion = 10,
//! Backticks.
Backticks = 11,
//! A here document delimiter.
HereDocumentDelimiter = 12,
//! A single quoted here document.
SingleQuotedHereDocument = 13
};
//! Construct a QextScintillaLexerBash with parent \a parent and name
//! \a name. \a parent is typically the QextScintilla instance.
QextScintillaLexerBash(TQObject *parent = 0,const char *name = 0);
//! Destroys the QextScintillaLexerBash instance.
virtual ~QextScintillaLexerBash();
//! Returns the name of the language.
const char *language() const;
//! Returns the name of the lexer. Some lexers support a number of
//! languages.
const char *lexer() const;
//! \internal Returns the style used for braces for brace matching.
int braceStyle() const;
//! \internal Returns the string of characters that comprise a word.
const char *wordCharacters() const;
//! Returns the foreground colour of the text for style number
//! \a style.
//!
//! \sa paper()
TQColor color(int style) const;
//! Returns the end-of-line fill for style number \a style.
bool eolFill(int style) const;
//! Returns the font for style number \a style.
TQFont font(int style) const;
//! Returns the set of keywords for the keyword set \a set recognised
//! by the lexer as a space separated string.
const char *keywords(int set) const;
//! Returns the descriptive name for style number \a style. If the
//! style is invalid for this language then TQString() is returned.
//! This is intended to be used in user preference dialogs.
TQString description(int style) const;
//! Returns the background colour of the text for style number
//! \a style.
//!
//! \sa color()
TQColor paper(int style) const;
//! Causes all properties to be refreshed by emitting the
//! propertyChanged() signal as required.
void refreshProperties();
//! Returns TRUE if multi-line comment blocks can be folded.
//!
//! \sa setFoldComments()
bool foldComments() const;
//! Returns TRUE if trailing blank lines are included in a fold block.
//!
//! \sa setFoldCompact()
bool foldCompact() const;
public slots:
//! If \a fold is TRUE then multi-line comment blocks can be folded.
//! The default is FALSE.
//!
//! \sa foldComments()
virtual void setFoldComments(bool fold);
//! If \a fold is TRUE then trailing blank lines are included in a fold
//! block. The default is TRUE.
//!
//! \sa foldCompact()
virtual void setFoldCompact(bool fold);
protected:
//! The lexer's properties are read from the settings \a qs. \a prefix
//! (which has a trailing '/') should be used as a prefix to the key of
//! each setting. TRUE is returned if there is no error.
//!
bool readProperties(TQSettings &qs,const TQString &prefix);
//! The lexer's properties are written to the settings \a qs.
//! \a prefix (which has a trailing '/') should be used as a prefix to
//! the key of each setting. TRUE is returned if there is no error.
//!
bool writeProperties(TQSettings &qs,const TQString &prefix) const;
private:
void setCommentProp();
void setCompactProp();
bool fold_comments;
bool fold_compact;
#if defined(TQ_DISABLE_COPY)
QextScintillaLexerBash(const QextScintillaLexerBash &);
QextScintillaLexerBash &operator=(const QextScintillaLexerBash &);
#endif
};
#endif