Define Position and invalidPosition inside the Sci namespace for internal use.

1 files changed, 11 insertions, 4 deletions

diff --git a/src/Position.h b/src/Position.h
index 4ef655263..120b92f62 100644
--- a/src/Position.h
+++ b/src/Position.h
@@ -1,6 +1,6 @@
 // Scintilla source code edit control
 /** @file Position.h
- ** Will define global type name Position in the Sci internal namespace.
+ ** Defines global type name Position in the Sci internal namespace.
  **/
 // Copyright 2015 by Neil Hodgson <neilh@scintilla.org>
 // The License.txt file describes the conditions under which this software may be distributed.
@@ -8,14 +8,21 @@
 #ifndef POSITION_H
 #define POSITION_H
 
+/**
+ * A Position is a position within a document between two characters or at the beginning or end.
+ * Sometimes used as a character index where it identifies the character after the position.
+ */
+
 namespace Sci {
 
-// After 3.6.0:
-// typedef int Position;
+typedef int Position;
 
 // A later version (4.x) of this file may:
 //#if defined(SCI_LARGE_FILE_SUPPORT)
-//typedef ptrdiff_t Position;
+//typedef std::ptrdiff_t Position;
+// or may allow runtime choice between different position sizes.
+
+const Position invalidPosition = -1;
 
 }