From 24ac7c2923e2de7bc3d60679e7b6755f7a7077f3 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Sat, 19 Jan 2013 13:27:58 +1100 Subject: Implement provisional category and place Unicode line ends and substyles into it. --- doc/ScintillaDoc.html | 44 +++++++++++++++++++++++++++++++++++++------- 1 file changed, 37 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index ec26db627..6e9b11cc7 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -61,6 +61,9 @@ color: #000000; font-size: 10pt; } + .provisional { + background: #FFB000; + } /*]]>*/ --> @@ -317,15 +320,18 @@ o GTK+ + o Provisional messages + o Deprecated messages - o Edit messages never - supported by Scintilla - + o Edit messages never + supported by Scintilla + o Building Scintilla + @@ -2176,8 +2182,8 @@ struct Sci_TextToFind {

Line endings

-

Scintilla can handle the major line end conventions and, depending on settings and - the current lexer also support additional Unicode line ends.

+

Scintilla can handle the major line end conventions and, depending on settings and + the current lexer also support additional Unicode line ends.

Scintilla can interpret any of the Macintosh (\r), Unix (\n) and Windows (\r\n) line ends. @@ -2187,10 +2193,12 @@ struct Sci_TextToFind { entire document to one of these line endings with SCI_CONVERTEOLS. Finally, you can choose to display the line endings with SCI_SETVIEWEOL.

+

For the UTF-8 encoding, three additional Unicode line ends, Next Line (NEL=U+0085), Line Separator (LS=U+2028), and Paragraph Separator (PS=U+2029) may optionally be interpreted when Unicode line ends is turned on and the current lexer also supports Unicode line ends.

+
SCI_SETEOLMODE(int eolMode)
SCI_GETEOLMODE
@@ -2198,10 +2206,12 @@ struct Sci_TextToFind { SCI_SETVIEWEOL(bool visible)
SCI_GETVIEWEOL
+
SCI_GETLINEENDTYPESSUPPORTED
SCI_SETLINEENDTYPESALLOWED(int lineEndBitSet)
SCI_GETLINEENDTYPESALLOWED
SCI_GETLINEENDTYPESACTIVE
+

SCI_SETEOLMODE(int eolMode)
@@ -2224,6 +2234,9 @@ struct Sci_TextToFind { (CR), (LF), or (CR)(LF). SCI_GETVIEWEOL returns the current state.

+
+ These features are provisional
+

SCI_GETLINEENDTYPESSUPPORTED
SCI_GETLINEENDTYPESSUPPORTED reports the different types of line ends supported by the current lexer. This is a bit set although there is currently only a single choice @@ -2240,6 +2253,7 @@ struct Sci_TextToFind {

SCI_GETLINEENDTYPESACTIVE
SCI_GETLINEENDTYPESACTIVE reports the set of line ends currently interpreted by Scintilla. It is SCI_GETLINEENDTYPESSUPPORTED & SCI_GETLINEENDTYPESALLOWED.

+

Styling

@@ -5672,6 +5686,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ *keyWordList)
SCI_GETSTYLEBITSNEEDED
+
SCI_GETSUBSTYLEBASES(<unused>, char *styles)
SCI_DISTANCETOSECONDARYSTYLES
SCI_ALLOCATESUBSTYLES(int styleBase, int numberStyles)
@@ -5679,6 +5694,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETSUBSTYLESSTART(int styleBase)
SCI_GETSUBSTYLESLENGTH(int styleBase)
SCI_SETIDENTIFIERS(int style, const char *identifiers)
+
@@ -5825,7 +5841,9 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ to SCI_SETSTYLEBITS.

+

Substyles

+ These features are provisional

Lexers may support several different sublanguages and each sublanguage may want to style some number of sets of identifiers (or similar lexemes such as documentation keywords) uniquely. Preallocating a large number for each purpose would exhaust the number of allowed styles quickly. @@ -5852,6 +5870,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETIDENTIFIERS(int style, const char *identifiers)
Similar to SCI_SETKEYWORDS but for substyles.

+

Lexer Objects

@@ -5967,9 +5986,9 @@ needs to be folded as this allowed fixing up the last line from the previous fol The new approach allows the lexer to decide whether to backtrack or to handle this more efficiently.

-

ILexerWithSubStyles

+

ILexerWithSubStyles

-

+

To allow lexers to report which line ends they support, and to support substyles, Ilexer is extended to ILexerWithSubStyles.

@@ -7058,6 +7077,17 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next

void scintilla_release_resources()
Call this to free any remaining resources after all the Scintilla widgets have been destroyed.

+

Provisional messages

+ +

Complex new features may be added as 'provisional' to allow further changes to the API. + Provisional features may even be removed if experience shows they are a mistake.

+ +

Provisional features are displayed in this document with a distinctive background colour.

+ +

Some developers may want to only use features that are stable and have graduated from + provisional status. To avoid using provisional messages compile with the symbol + SCI_DISABLE_PROVISIONAL defined.

+

Deprecated messages and notifications

The following messages are currently supported to emulate existing Windows controls, but -- cgit v1.2.3