Scintilla User Guide (2) - Full text search and modification

In Scintilla, each character is followed by a byte representing the character style. The character byte and the style byte together form a character unit. The 8 bits of the style byte are divided into two parts: character style and character indicator. The character indicator of a piece of text can be set through the SCI_INDICATORFILLRANGE message. By default, the lower 5 bits are the character style and the higher 3 bits are the character indicator. Therefore, there can be 32 character styles. 3 independent character indicators that can be used to indicate syntax errors, deprecated names, bad indentation and other information. You can use the SCI_SETSTYLEBITS message to set character style bits up to 7 bits, and the rest will be assigned to the character indicator.
Position indicates the position of the character or the blank point before the character in Scintilla. The first character's position is 0, the second is 1, and so on. If the document contains nLen characters, the position of the last character is nLen – 1. The cursor exists between two characters and can be positioned before the first character (0) and after the last character (nLen).
When two characters are treated as one character, the cursor cannot exist between the two characters. This situation usually occurs when multi-byte characters such as Chinese or when the line terminator is CRLF. The constant INVALID_POSITION (-1) represents an illegal position.
For performance reasons, all lines of text have the same height: the height of the largest font in the current style.

SCI_GETTEXT, SCI_SETTEXT

1) SCI_GETTEXT(int length, char *text)
Get text:
(1) When text is 0, return the entire document length len + 1;
(2) When length is 0, return 0;
(3) When text is not 0 and length is greater than 0, return length – 1, text is filled with length – 1 characters starting from position 0 and a 0 terminator. If length is greater than the document length, the extra positions will be filled with null characters 0.

unsigned int len = SendMessage(SCI_GETTEXT, 0, 0);
char *chText = new char[len];
SendMessage(SCI_GETTEXT, len, (LPARAM)chText);
…
delete [] chText;

2) SCI_SETTEXT(, const char *text)
Set the document text to text, which is a constant string ending with 0. If text is 0, return FALSE (0), otherwise return TRUE (1).

SCI_SETSAVEPOINT
SCI_SETSAVEPOINT

Set the save point, the document status will become unmodified, and TRUE (1) will be returned. The SCI_SETSAVEPOINT message will trigger the SCN_SAVEPOINTREACHED event notification. When the document status changes to modified, the SCN_SAVEPOINTLEFT event notification will be triggered.

SCI_GETLINE

SCI_GETLINE(int line, char *text)
Get the text of the specified line and return the length of the text of the specified line (including the line terminator). The line number line starts from 0. If the line number is greater than the maximum line number, 0 will be returned. When text is 0, the length of the specified line of text is returned directly; when text is not 0, text will be filled with the specified line of text, but the terminator 0 will not be automatically set.

unsigned int len = SendMessage(SCI_GETLINE, 1, 0);
char *chText = new char[len + 1];
memset(chText, 0, len + 1);SendMessage(SCI_GETLINE, 1, (LPARAM)chText);
…delete [] chText;

SCI_REPLACESEL

SCI_REPLACESEL(, const char *text)
Replace the selected text, text is a constant string ending with 0. When no text is selected, text will be inserted at the current position. After replacement, the cursor will be behind the inserted text and the view will automatically scroll so that the text is visible. When text is 0, return FALSE (0), otherwise return TRUE (1).

SCI_SETREADONLY, SCI_GETREADONLY

1) SCI_SETREADONLY(bool readOnly)
Set the document as read-only and return TRUE (1). When the document is in a read-only state, when the document is modified, the SCN_MODIFYATTEMPTRO event notification will be triggered.
2) SCI_GETREADONLY
Get the read-only status of the document and return TRUE (1) or FALSE (0).

SCI_GETTEXTRANGE

SCI_GETTEXTRANGE(, TextRange *tr)
Get the specified range of text, if tr is 0, return 0, otherwise return the text length (not including 0 terminator), and fills tr.lpstrText with the specified range of text and a 0 terminator. When tr.chrg.cpMax is -1, it means the end of the document. You must ensure that the tr.lpstrText character buffer is large enough ((tr.chrg.cpMax - tr.chrg.cpMin) + 1).

SCI_GETSTYLEDTEXT

SCI_GETSTYLEDTEXT(, TextRange *tr)
Get the specified range of style text, similar to SCI_GETTEXTRANGE, but the required character buffer size is SCI_GETTEXTRANGE 2 times (2 * (tr.chrg.cpMax - tr.chrg.cpMin) + 2). Scintilla will automatically append two zero terminators to the end of tr.lpstrText.

SCI_ALLOCATE

SCI_ALLOCATE(int bytes, )
Allocate a buffer large enough to accommodate bytes of the specified size, return TRUE (1). The buffer will be reallocated only if the specified size is greater than the current buffer size, otherwise no processing will be done.

SCI_ADDTEXT

SCI_ADDTEXT(int length, const char *s)
Insert the specified length of the specified text at the current position, s is a constant string ending with 0, return 0. After inserting text, the current position is behind the inserted text, but the view does not automatically scroll to make it visible.

SCI_ADDSTYLEDTEXT

SCI_ADDSTYLEDTEXT(int length, cell *s)
Insert style text at the current position, the processing method is similar to SCI_ADDTEXT, and 0 is returned.

SCI_APPENDTEXT

SCI_APPENDTEXT(int length, const char *s)
Insert text at the end of the document. The processing method is similar to SCI_ADDTEXT, and 0 is returned.

SCI_INSERTTEXT

SCI_INSERTTEXT(int pos, const char *text)
Insert text at the specified position. The processing method is similar to SCI_ADDTEXT and returns 0. When pos is -1, it means inserting at the current position.

SCI_CLEARALL

SCI_CLEARALL
Unless the document is read-only, delete all characters from the document and return 0.

SCI_CLEARDOCUMENTSTYLE

SCI_CLEARDOCUMENTSTYLE
Clear all style information of the document and return 0. This is typically used when the document needs to be restyled.

SCI_GETCHARAT

SCI_GETCHARAT(int position)
Returns the character at the specified position. When position is less than 0 or greater than the end of the document, 0 is returned.

SCI_GETSTYLEAT

SCI_GETSTYLEAT(int position)
Returns the style at the specified position. When position is less than 0 or greater than the end of the document, 0 is returned.

SCI_SETSTYLEBITS, SCI_GETSTYLEBITS

1) SCI_SETSTYLEBITS(int bits)
Set the style bit width in bytes and return TRUE (1). The default is 5 bits, and the maximum can be set to 7 bits. The remaining bits will be used to represent character indicators.
2) SCI_GETSTYLEBITS
Returns the style bit width in bytes.

SCI_TARGETASUTF8 *

SCI_TARGETASUTF8(, char *s)
Convert the target string to UTF8 encoding format, return the encoded text length, and encode the bytes are filled into s. This message is only available on the GTK+ platform.

SCI_ENCODEDFROMUTF8 *

SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded)
Convert UTF8 format string to document encoding format and return the converted byte length, And fill the converted bytes into encoded. This message is only available on the GTK+ platform.

SCI_SETLENGTHFORENCODE

SCI_SETLENGTHFORENCODE(int bytes)
Set the document encoding length and return 0.

The above is the content of Scintilla User Guide (2) - Full-text search and modification. For more related content, please pay attention to the PHP Chinese website (m.sbmmt.com)!