1 // Scintilla source code edit control
    2 /** @file ILexer.h
    3  ** Interface between Scintilla and lexers.
    4  **/
    5 // Copyright 1998-2010 by Neil Hodgson <neilh@scintilla.org>
    6 // The License.txt file describes the conditions under which this software may be distributed.
    7 
    8 #ifndef ILEXER_H
    9 #define ILEXER_H
   10 
   11 #include "Sci_Position.h"
   12 
   13 #ifdef SCI_NAMESPACE
   14 namespace Scintilla {
   15 #endif
   16 
   17 #ifdef _WIN32
   18 	#define SCI_METHOD __stdcall
   19 #else
   20 	#define SCI_METHOD
   21 #endif
   22 
   23 enum { dvOriginal=0, dvLineEnd=1 };
   24 
   25 class IDocument {
   26 public:
   27 	virtual int SCI_METHOD Version() const = 0;
   28 	virtual void SCI_METHOD SetErrorStatus(int status) = 0;
   29 	virtual Sci_Position SCI_METHOD Length() const = 0;
   30 	virtual void SCI_METHOD GetCharRange(char *buffer, Sci_Position position, Sci_Position lengthRetrieve) const = 0;
   31 	virtual char SCI_METHOD StyleAt(Sci_Position position) const = 0;
   32 	virtual Sci_Position SCI_METHOD LineFromPosition(Sci_Position position) const = 0;
   33 	virtual Sci_Position SCI_METHOD LineStart(Sci_Position line) const = 0;
   34 	virtual int SCI_METHOD GetLevel(Sci_Position line) const = 0;
   35 	virtual int SCI_METHOD SetLevel(Sci_Position line, int level) = 0;
   36 	virtual int SCI_METHOD GetLineState(Sci_Position line) const = 0;
   37 	virtual int SCI_METHOD SetLineState(Sci_Position line, int state) = 0;
   38 	virtual void SCI_METHOD StartStyling(Sci_Position position, char mask) = 0;
   39 	virtual bool SCI_METHOD SetStyleFor(Sci_Position length, char style) = 0;
   40 	virtual bool SCI_METHOD SetStyles(Sci_Position length, const char *styles) = 0;
   41 	virtual void SCI_METHOD DecorationSetCurrentIndicator(int indicator) = 0;
   42 	virtual void SCI_METHOD DecorationFillRange(Sci_Position position, int value, Sci_Position fillLength) = 0;
   43 	virtual void SCI_METHOD ChangeLexerState(Sci_Position start, Sci_Position end) = 0;
   44 	virtual int SCI_METHOD CodePage() const = 0;
   45 	virtual bool SCI_METHOD IsDBCSLeadByte(char ch) const = 0;
   46 	virtual const char * SCI_METHOD BufferPointer() = 0;
   47 	virtual int SCI_METHOD GetLineIndentation(Sci_Position line) = 0;
   48 };
   49 
   50 class IDocumentWithLineEnd : public IDocument {
   51 public:
   52 	virtual Sci_Position SCI_METHOD LineEnd(Sci_Position line) const = 0;
   53 	virtual Sci_Position SCI_METHOD GetRelativePosition(Sci_Position positionStart, Sci_Position characterOffset) const = 0;
   54 	virtual int SCI_METHOD GetCharacterAndWidth(Sci_Position position, Sci_Position *pWidth) const = 0;
   55 };
   56 
   57 enum { lvOriginal=0, lvSubStyles=1 };
   58 
   59 class ILexer {
   60 public:
   61 	virtual int SCI_METHOD Version() const = 0;
   62 	virtual void SCI_METHOD Release() = 0;
   63 	virtual const char * SCI_METHOD PropertyNames() = 0;
   64 	virtual int SCI_METHOD PropertyType(const char *name) = 0;
   65 	virtual const char * SCI_METHOD DescribeProperty(const char *name) = 0;
   66 	virtual Sci_Position SCI_METHOD PropertySet(const char *key, const char *val) = 0;
   67 	virtual const char * SCI_METHOD DescribeWordListSets() = 0;
   68 	virtual Sci_Position SCI_METHOD WordListSet(int n, const char *wl) = 0;
   69 	virtual void SCI_METHOD Lex(Sci_PositionU startPos, Sci_Position lengthDoc, int initStyle, IDocument *pAccess) = 0;
   70 	virtual void SCI_METHOD Fold(Sci_PositionU startPos, Sci_Position lengthDoc, int initStyle, IDocument *pAccess) = 0;
   71 	virtual void * SCI_METHOD PrivateCall(int operation, void *pointer) = 0;
   72 };
   73 
   74 class ILexerWithSubStyles : public ILexer {
   75 public:
   76 	virtual int SCI_METHOD LineEndTypesSupported() = 0;
   77 	virtual int SCI_METHOD AllocateSubStyles(int styleBase, int numberStyles) = 0;
   78 	virtual int SCI_METHOD SubStylesStart(int styleBase) = 0;
   79 	virtual int SCI_METHOD SubStylesLength(int styleBase) = 0;
   80 	virtual int SCI_METHOD StyleFromSubStyle(int subStyle) = 0;
   81 	virtual int SCI_METHOD PrimaryStyleFromStyle(int style) = 0;
   82 	virtual void SCI_METHOD FreeSubStyles() = 0;
   83 	virtual void SCI_METHOD SetIdentifiers(int style, const char *identifiers) = 0;
   84 	virtual int SCI_METHOD DistanceToSecondaryStyles() = 0;
   85 	virtual const char * SCI_METHOD GetSubStyleBases() = 0;
   86 };
   87 
   88 class ILoader {
   89 public:
   90 	virtual int SCI_METHOD Release() = 0;
   91 	// Returns a status code from SC_STATUS_*
   92 	virtual int SCI_METHOD AddData(char *data, Sci_Position length) = 0;
   93 	virtual void * SCI_METHOD ConvertToDocument() = 0;
   94 };
   95 
   96 #ifdef SCI_NAMESPACE
   97 }
   98 #endif
   99 
  100 #endif