ILexer.h 4.1 KB

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