1 // Scintilla source code edit control
3 ** Text document that handles notifications, DBCS, styling, words and end of line.
5 // Copyright 1998-2003 by Neil Hodgson <neilh@scintilla.org>
6 // The License.txt file describes the conditions under which this software may be distributed.
12 * A Position is a position within a document between two characters or at the beginning or end.
13 * Sometimes used as a character index where it identifies the character after the position.
16 const Position invalidPosition
= -1;
19 * The range class represents a range of text in a document.
20 * The two values are not sorted as one end may be more significant than the other
21 * as is the case for the selection where the end position is the position of the caret.
22 * If either position is invalidPosition then the range is invalid and most operations will fail.
29 Range(Position pos
=0) :
30 start(pos
), end(pos
) {
32 Range(Position start_
, Position end_
) :
33 start(start_
), end(end_
) {
37 return (start
!= invalidPosition
) && (end
!= invalidPosition
);
40 // Is the position within the range?
41 bool Contains(Position pos
) const {
43 return (pos
>= start
&& pos
<= end
);
45 return (pos
<= start
&& pos
>= end
);
49 // Is the character after pos within the range?
50 bool ContainsCharacter(Position pos
) const {
52 return (pos
>= start
&& pos
< end
);
54 return (pos
< start
&& pos
>= end
);
58 bool Contains(Range other
) const {
59 return Contains(other
.start
) && Contains(other
.end
);
62 bool Overlaps(Range other
) const {
64 Contains(other
.start
) ||
65 Contains(other
.end
) ||
66 other
.Contains(start
) ||
72 class DocModification
;
80 /** Used to pair watcher pointer with user data. */
81 class WatcherWithUserData
{
85 WatcherWithUserData() {
91 enum charClassification
{ ccSpace
, ccNewLine
, ccWord
, ccPunctuation
};
96 charClassification charClass
[256];
101 int enteredReadOnlyCount
;
103 WatcherWithUserData
*watchers
;
115 /// Can also be SC_CP_UTF8 to enable UTF-8 mode
119 int actualIndentInChars
;
122 bool backspaceUnindents
;
130 int LineFromPosition(int pos
);
131 int ClampPositionIntoDocument(int pos
);
132 bool IsCrLf(int pos
);
133 int LenChar(int pos
);
134 int MovePositionOutsideChar(int pos
, int moveDir
, bool checkLineEnd
=true);
136 // Gateways to modifying document
137 bool DeleteChars(int pos
, int len
);
138 bool InsertStyledString(int position
, char *s
, int insertLength
);
141 bool CanUndo() { return cb
.CanUndo(); }
142 bool CanRedo() { return cb
.CanRedo(); }
143 void DeleteUndoHistory() { cb
.DeleteUndoHistory(); }
144 bool SetUndoCollection(bool collectUndo
) {
145 return cb
.SetUndoCollection(collectUndo
);
147 bool IsCollectingUndo() { return cb
.IsCollectingUndo(); }
148 void BeginUndoAction() { cb
.BeginUndoAction(); }
149 void EndUndoAction() { cb
.EndUndoAction(); }
151 bool IsSavePoint() { return cb
.IsSavePoint(); }
153 int GetLineIndentation(int line
);
154 void SetLineIndentation(int line
, int indent
);
155 int GetLineIndentPosition(int line
);
156 int GetColumn(int position
);
157 int FindColumn(int line
, int column
);
158 void Indent(bool forwards
, int lineBottom
, int lineTop
);
159 void ConvertLineEnds(int eolModeSet
);
160 void SetReadOnly(bool set
) { cb
.SetReadOnly(set
); }
161 bool IsReadOnly() { return cb
.IsReadOnly(); }
163 bool InsertChar(int pos
, char ch
);
164 bool InsertString(int position
, const char *s
);
165 bool InsertString(int position
, const char *s
, size_t insertLength
);
166 void ChangeChar(int pos
, char ch
);
167 void DelChar(int pos
);
168 void DelCharBack(int pos
);
170 char CharAt(int position
) { return cb
.CharAt(position
); }
171 void GetCharRange(char *buffer
, int position
, int lengthRetrieve
) {
172 cb
.GetCharRange(buffer
, position
, lengthRetrieve
);
174 char StyleAt(int position
) { return cb
.StyleAt(position
); }
175 int GetMark(int line
) { return cb
.GetMark(line
); }
176 int AddMark(int line
, int markerNum
);
177 void DeleteMark(int line
, int markerNum
);
178 void DeleteMarkFromHandle(int markerHandle
);
179 void DeleteAllMarks(int markerNum
);
180 int LineFromHandle(int markerHandle
) { return cb
.LineFromHandle(markerHandle
); }
181 int LineStart(int line
);
182 int LineEnd(int line
);
183 int LineEndPosition(int position
);
184 int VCHomePosition(int position
);
186 int SetLevel(int line
, int level
);
187 int GetLevel(int line
) { return cb
.GetLevel(line
); }
188 void ClearLevels() { cb
.ClearLevels(); }
189 int GetLastChild(int lineParent
, int level
=-1);
190 int GetFoldParent(int line
);
192 void Indent(bool forwards
);
193 int ExtendWordSelect(int pos
, int delta
, bool onlyWordCharacters
=false);
194 int NextWordStart(int pos
, int delta
);
195 int NextWordEnd(int pos
, int delta
);
196 int Length() { return cb
.Length(); }
197 void Allocate(int newSize
) { cb
.Allocate(newSize
*2); }
198 long FindText(int minPos
, int maxPos
, const char *s
,
199 bool caseSensitive
, bool word
, bool wordStart
, bool regExp
, bool posix
, int *length
);
200 long FindText(int iMessage
, unsigned long wParam
, long lParam
);
201 const char *SubstituteByPosition(const char *text
, int *length
);
204 void ChangeCase(Range r
, bool makeUpperCase
);
206 void SetDefaultCharClasses(bool includeWordClass
);
207 void SetCharClasses(const unsigned char *chars
, charClassification newCharClass
);
208 void SetStylingBits(int bits
);
209 void StartStyling(int position
, char mask
);
210 bool SetStyleFor(int length
, char style
);
211 bool SetStyles(int length
, char *styles
);
212 int GetEndStyled() { return endStyled
; }
213 bool EnsureStyledTo(int pos
);
214 int GetStyleClock() { return styleClock
; }
215 void IncrementStyleClock();
217 int SetLineState(int line
, int state
) { return cb
.SetLineState(line
, state
); }
218 int GetLineState(int line
) { return cb
.GetLineState(line
); }
219 int GetMaxLineState() { return cb
.GetMaxLineState(); }
221 bool AddWatcher(DocWatcher
*watcher
, void *userData
);
222 bool RemoveWatcher(DocWatcher
*watcher
, void *userData
);
223 const WatcherWithUserData
*GetWatchers() const { return watchers
; }
224 int GetLenWatchers() const { return lenWatchers
; }
226 bool IsWordPartSeparator(char ch
);
227 int WordPartLeft(int pos
);
228 int WordPartRight(int pos
);
229 int ExtendStyleRange(int pos
, int delta
, bool singleLine
= false);
231 int ParaDown(int pos
);
232 int IndentSize() { return actualIndentInChars
; }
235 charClassification
WordCharClass(unsigned char ch
);
236 bool IsWordStartAt(int pos
);
237 bool IsWordEndAt(int pos
);
238 bool IsWordAt(int start
, int end
);
239 void ModifiedAt(int pos
);
241 void NotifyModifyAttempt();
242 void NotifySavePoint(bool atSavePoint
);
243 void NotifyModified(DocModification mh
);
247 * To optimise processing of document modifications by DocWatchers, a hint is passed indicating the
248 * scope of the change.
249 * If the DocWatcher is a document view then this can be used to optimise screen updating.
251 class DocModification
{
253 int modificationType
;
256 int linesAdded
; /**< Negative if lines deleted. */
257 const char *text
; /**< Only valid for changes to text, not for changes to style. */
262 DocModification(int modificationType_
, int position_
=0, int length_
=0,
263 int linesAdded_
=0, const char *text_
=0) :
264 modificationType(modificationType_
),
267 linesAdded(linesAdded_
),
273 DocModification(int modificationType_
, const Action
&act
, int linesAdded_
=0) :
274 modificationType(modificationType_
),
275 position(act
.position
/ 2),
277 linesAdded(linesAdded_
),
285 * A class that wants to receive notifications from a Document must be derived from DocWatcher
286 * and implement the notification methods. It can then be added to the watcher list with AddWatcher.
290 virtual ~DocWatcher() {}
292 virtual void NotifyModifyAttempt(Document
*doc
, void *userData
) = 0;
293 virtual void NotifySavePoint(Document
*doc
, void *userData
, bool atSavePoint
) = 0;
294 virtual void NotifyModified(Document
*doc
, DocModification mh
, void *userData
) = 0;
295 virtual void NotifyDeleted(Document
*doc
, void *userData
) = 0;
296 virtual void NotifyStyleNeeded(Document
*doc
, void *userData
, int endPos
) = 0;