diff options
Diffstat (limited to 'include/Accessor.h')
| -rw-r--r-- | include/Accessor.h | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/include/Accessor.h b/include/Accessor.h index 3c858093d..5254d2264 100644 --- a/include/Accessor.h +++ b/include/Accessor.h @@ -1,5 +1,7 @@ -// SciTE - Scintilla based Text Editor -// Accessor.h - rapid easy access to contents of a Scintilla +// Scintilla source code edit control +/** @file Accessor.h + ** Rapid easy access to contents of a Scintilla. + **/ // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org> // The License.txt file describes the conditions under which this software may be distributed. @@ -9,12 +11,16 @@ class Accessor; typedef bool (*PFNIsCommentLeader)(Accessor &styler, int pos, int len); -// Interface to data in a Scintilla +/** + * Interface to data in a Scintilla. + */ class Accessor { protected: enum {extremePosition=0x7FFFFFFF}; - // bufferSize is a trade off between time taken to copy the characters and retrieval overhead - // slopSize positions the buffer before the desired position in case there is some backtracking + /** @a bufferSize is a trade off between time taken to copy the characters + * and retrieval overhead. + * @a slopSize positions the buffer before the desired position + * in case there is some backtracking. */ enum {bufferSize=4000, slopSize=bufferSize/8}; char buf[bufferSize+1]; int startPos; @@ -23,6 +29,7 @@ protected: virtual bool InternalIsLeadByte(char ch)=0; virtual void Fill(int position)=0; + public: Accessor() : startPos(extremePosition), endPos(0), codePage(0) {} virtual ~Accessor() {} @@ -32,8 +39,8 @@ public: } return buf[position - startPos]; } + /** Safe version of operator[], returning a defined value for invalid position. */ char SafeGetCharAt(int position, char chDefault=' ') { - // Safe version of operator[], returning a defined value for invalid position if (position < startPos || position >= endPos) { Fill(position); if (position < startPos || position >= endPos) { @@ -67,4 +74,3 @@ public: virtual void SetLevel(int line, int level)=0; virtual int IndentAmount(int line, int *flags, PFNIsCommentLeader pfnIsCommentLeader = 0)=0; }; - |