scintilla/lexlib/LexerModule.h

   1 // Scintilla source code edit control
   2 /** @file LexerModule.h
   3  ** Colourise for particular languages.
   4  **/
   5 // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
   6 // The License.txt file describes the conditions under which this software may be distributed.
   7
   8 #ifndef LEXERMODULE_H
   9 #define LEXERMODULE_H
  10
  11 #ifdef SCI_NAMESPACE
  12 namespace Scintilla {
  13 #endif
  14
  15 class Accessor;
  16 class WordList;
  17
  18 typedef void (*LexerFunction)(Sci_PositionU startPos, Sci_Position lengthDoc, int initStyle,
  19                   WordList *keywordlists[], Accessor &styler);
  20 typedef ILexer *(*LexerFactoryFunction)();
  21
  22 /**
  23  * A LexerModule is responsible for lexing and folding a particular language.
  24  * The class maintains a list of LexerModules which can be searched to find a
  25  * module appropriate to a particular language.
  26  */
  27 class LexerModule {
  28 protected:
  29         int language;
  30         LexerFunction fnLexer;
  31         LexerFunction fnFolder;
  32         LexerFactoryFunction fnFactory;
  33         const char * const * wordListDescriptions;
  34
  35 public:
  36         const char *languageName;
  37         LexerModule(int language_,
  38                 LexerFunction fnLexer_,
  39                 const char *languageName_=0,
  40                 LexerFunction fnFolder_=0,
  41                 const char * const wordListDescriptions_[] = NULL);
  42         LexerModule(int language_,
  43                 LexerFactoryFunction fnFactory_,
  44                 const char *languageName_,
  45                 const char * const wordListDescriptions_[] = NULL);
  46         virtual ~LexerModule() {
  47         }
  48         int GetLanguage() const { return language; }
  49
  50         // -1 is returned if no WordList information is available
  51         int GetNumWordLists() const;
  52         const char *GetWordListDescription(int index) const;
  53
  54         ILexer *Create() const;
  55
  56         virtual void Lex(Sci_PositionU startPos, Sci_Position length, int initStyle,
  57                   WordList *keywordlists[], Accessor &styler) const;
  58         virtual void Fold(Sci_PositionU startPos, Sci_Position length, int initStyle,
  59                   WordList *keywordlists[], Accessor &styler) const;
  60
  61         friend class Catalogue;
  62 };
  63
  64 inline int Maximum(int a, int b) {
  65         return (a > b) ? a : b;
  66 }
  67
  68 // Shut up annoying Visual C++ warnings:
  69 #ifdef _MSC_VER
  70 #pragma warning(disable: 4244 4456 4457)
  71 #endif
  72
  73 // Turn off shadow warnings for lexers as may be maintained by others
  74 #if defined(__GNUC__)
  75 #pragma GCC diagnostic ignored "-Wshadow"
  76 #endif
  77
  78 #ifdef SCI_NAMESPACE
  79 }
  80 #endif
  81
  82 #endif