JetBrains.Platform.DocumentModel A serializable entity representing an operation to be recorded in the undo/redo stack. All inheritors should have the RdType attribute for discovery. Instances of this interface are produces by the features and placed on the undo bus. Document id is required to make a connection with a corresponding undo manager. Produces a reverse operation for current undo record, which is placed on the redo stack

Id of a document open in the editor

Id of the not locked document

Represents an action, which will be asynchronously executed on backend when undo command is called in IDE. As any other should be serializable. Represents an action, which will be asynchronously executed on backend when undo command is called in IDE. As any other should be serializable. A signal on backend to subscribe to events from features, when undoable action record is being executed. A signal fired when an undoable asynchronous backend action is requested to be executed. Execute provided action and place reversed copy of it to undo stack. In supported environment executing this method from featurus also places a reverse record of action to undo stack, which will be executed when undo action is being called Queue execution of provided action (redo part) and place undo part action in the undo stack. NOTE: these actions will be executed not in the same stack, but in guarded context on main thread. Implementation of should never modify documents, change selection or move caret. For undoing/redoing document changes use commands , to set caret position use .

Provides access to current document.

Provides access to caret offset and continuous selection range.

Type disambig for . Represents zero-based column indices in the document stream. This does not correspond directly to the text control view lines and columns because of the collapsed regions and other view transformations.

Type disambig for . Represents zero-based line indices in the document stream. This does not correspond directly to the text control view lines and columns because of the collapsed regions and other view transformations.

Ranges two .

Initializes a new instance of the class.

Creates a zero-length range at the given position.

Indicates whether this instance and a specified object are equal.

true if and this instance are the same type and represent the same value; otherwise, false. Another object to compare to. 2

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance. 2

Indicates whether the current object is equal to another object of the same type.

true if the current object is equal to the parameter; otherwise, false. An object to compare with this object.

Denotes a change to the document text. Possible changes are: characters inserted, characters deleted, characters replaced. All these are represented as replacements, e.g. deletion is replacing a range with an empty string, and insertion is replacing an empty range with some text.

This constructor is used for delta-changes

Gets the document affected by the change.

Offset at which the replacement operation is performed. The range being removed by the replacement is [, + ). The range of the new text after the replacement is performed is [, + ).

The replacement text. It is characters long and occupies the [, + ) range after the replacement is performed.

Length of the affected text before the replacement is performed. The range being removed by the replacement is [, + ). The range of the new text after the replacement is performed is [, + ).

The range of the replacement text. The range being removed by the replacement is [, + ). The range of the new text after the replacement is performed is [, + ).

Length of the affected text after the replacement is performed. Essentialy equal to the 's The range being removed by the replacement is [, + ). The range of the new text after the replacement is performed is [, + ).

The affected text range, before the replacement is performed. The range being removed by the replacement is [, + ). The range of the new text after the replacement is performed is [, + ).

General-purpose range translator delegate An interface to translate ranges between different modification stamps of the documetns on backend. Note that at this time the history of changes is only kept as long as the document is alive. (see for implementation details) If document is reacreated after being collected, the history will be lost. Attempt to create a range translator from provided modification stamps Can return null if there is no information about either or is stored in the document history.

Try parse string representation of coordinates.

Parse string representation of coordinates.

Zero-based line of the document. VS displays one-based line numbers, so add 1 to get consistent result.

Zero-based column of the document. VS displays one-based column numbers, so add 1 to get consistent result.

Indicates whether the current object is equal to another object of the same type.

true if the current object is equal to the parameter; otherwise, false. An object to compare with this object.

Indicates whether this instance and a specified object are equal.

true if and this instance are the same type and represent the same value; otherwise, false. Another object to compare to. 2

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance. 2

Range is empty if there is no selection

Checks that text of projectFile is a subset of (chars in lines and lines themselves) text of file from disk ignoring trailing whitespaces

document to get text path to file from disk true for every line of document it is a subset of line from disk (ignoring trailing whitespaces)

Returns -1 for tabs, 0 for "not sure" and indent length otherwise

Gets the very first line ending of the document.

Gets the end offset of the given line. The possible line-break characters at the end of the line are included by this method.

Line number.

Scans the line endings of the document, returns the most popular one. NOTE: if you got a document object, call the overload on the document for better perf.

Text offset in document

Text range in document

Ranges [2,4) and [1,3) intersects. Ranges [2,4) and [1,2) contacts. See for strict intersection

Calculates range of intersection with given range

range to intersect with Range of intersection if current range intersects with given range. Empty range if current range contacts with given range (ie [1,2) and [2,3) ). Invalid range otherwise

Returns the distance between the and the nearest point that belongs to the range.

RangeMarkers () associated with corresponding document (). Note, if a document is bound to a project file its range markers are stored in the project file so when the document is collected and a new one is created range markers survive.

For document implementations which are connected to a remote end and have a sync status with them, tells about this status on the back end. Sending ranges is only relevant on document revisions which will have a sync moment on the remote end.

for all documents.

Gets whether the current revision of the document has or will have a sync moment with its remote counterpart. For document implementations without a remote counterpart, always True. Free-threaded. If you see a True value under a reader lock, it will hold until you release the lock.

Retunrns a modification stamp for the last (sorted by modification stamps) known sync moment. If there is not syncmoment available null value will be returned

An Signal which fires when the inner state of sync moments is changed. Free-threaded.

Like (in with-retry mode), with an extra condition that is True for your . Since reader lock is held, this will hold for the whole action. Check for interrupts as usual.

Gets the document moniker (an arbitrary string that helps with identifying this document).

Gets the number of characters in the document. This is the maximum possible offset (inclusive) for methods that take an offset, including text ranges.

Gets the whole range of the document, from 0 to .

Gets the start offset of the given line.

Line number.

Gets the end offset of the given line. The possible line-break characters at the end of the line are NOT included by this method.

Line number.

Gets the end offset of the given line. The possible line-break characters at the end of the line are included by this method.

Line number.

Gets the length of the document line.

Gets the number of lines in the document. This is the maximum possible line number (non-inclusive) for methods that take a line number. A document has at least one line. An empty document has exactly one zero-length line.

Gets document coordinates (line and column) by flat document offset. The column number is forced within line length limits (inclusive) in case the offset falls on the line-break characters. In this case the offset/line-col might not roundtrip.

Offset in document, must be non-negative and less than or equal to document text length. DocumentCoords.

Gets offset in the document by document coordinates (line and column)

Coordinates in document offset in document, or -1 if coordinates are not within the document

Get clearance for write access to the document, for example, at the Source Code Control. You MUST scope document modifications with the return value of this method (dispose of the return value when done).

The cookie that must be disposed of immediately after you're done with writing to the document. You're only allowed to write while it's alive and if its is .

'real' document is changed. This event is raised at the end of transaction. Consider subscribing to and filtering events sent by

Before 'real' document is changed. This event is raised at the end of transaction.

Checks whether portions of the document are locked from being edited.

Locks a document range temporarily to prevent it from being edited. To unlock, dispose of the return value.

Text documents support.

An interface on the entity which can create documents, and for such documents defines various strategies for their operations. Each gives out it's as a property.

Enables caching of data necessary to restore / validate on current stack frame for massive access to document pointers or something of the kind

Lifetime of the caching. Normally should be used like Document, pointers to which should be cached for the specified

Represents a document without necessarily holding it in the memory. Can restore and return the document on demand. Examples are documents bound to project model or file system paths, which can be read from files / Visual Studio as needed.

Creates uncontrolled documents based on string that can be edited in IDE editor.

Creates uncontrolled (not bound to any real source like project file) documents based on string that can be edited in IDE editor. In tests, that would be a simple implementation. In VS, that would be a VS text buffer.

Document lifetime. Document text. Document moniker that uniquely identifies this document. Queries whether the document is allowed to be written.

Creates uncontrolled documents based on string.

Creates an from the given text. This is always the simple implementation of the standalone string-based document.

Document text. Document moniker that uniquely identifies this document.

Base class for document implementations

Gets the document moniker (an arbitrary string that helps with identifying this document).

Gets the whole range of the document, from 0 to .

Maps lines to their flat offsets. Lazy-initialized when first requested. Free-threaded access, must be init-protected.

Apply change caused by operation on the document (e.g. )

Apply external change

Called by document implementations when they'd like to modify the document to assert that modification is allowed at the moment.

Non-thread-safe init, changes are primary-thread-related only. Lazy: this field n/a when document is used from PSI for readonly background access.

For documents that are wrapping some underlying store (e.g. Visual Studio documents over Text Buffers), marks a state when we expect modification callbacks from the underlying store. This relaxes some limitations on document modifications, as those are actual changes to the underlying store we MUST apply to be in sync. The limitations include e.g. Modification Cookies that must be taken for all file-based documents on the Solution so that they could be cleared with SCC. These do not apply when the changes are coming from the underlying store.

Locks a document range temporarily to prevent it from being edited. To unlock, dispose of the return value.

Returns a that represents the current .

A that represents the current . 2

Reads text from a file on disk.

The file to read. Whether to throw on failures (e.g. missing file), otherwise, an empty string will be returned.

Reads text from a file on disk.

The file to read. Whether to throw on failures (eg missing file), otherwise, an empty string will be returned. Detected file encoding Optional default encoding to read the file with

IEditableBuffer implementation

Point where we expect text to be inserted

Buffer to hold the subsequent characters being inserted

The rest of the text except for the insert point

Cache of file text. For performance purposes only

Returns cached file text and encoding. When missed in cache reads the file and stores the value

File path to read text from Default encoding to use when reading the file File text and encoding

Array-based implementation of line index. Mapping between one-dimensional (offsets) to two-dimensional (lines and columns) coordinate systems. This class is not thread-safe, the caller should take care of locking the read and write operations apart. This class has no implicit writes on reads.

Maps line number to TextRange containing start and end offsets of the line.

The number of lines in the index. There's always at least one line.

Gets line-col by the flat document offset. The column number is forced within line length limits (inclusive) in case the offset falls on the line-break characters. In this case the offset/line-col might not roundtrip.

Gets the text of the line, not including any line break characters.

Accommodates a document change incrementally

Binary-searches the line segments. Static because it cannot rely on object state (e.g. myBuffer) because the state could be inconsistent due to a text change being accommodated (when buffer is already changed and segments array is not yet).

This implementation of document performs operations using 'document transactions'.

Initiates change that can be made in some external storage (like VS doc) This method handles internal changes (psi, document write operations, etc.)

Handle modification, raise events

Creates an from the given text. In tests, that would be a simple implementation (). In VS, that would be a VS text buffer.

Document lifetime. Document text. Document moniker that uniquely identifies this document. Queries whether the document is allowed to be written.

Creates an from the text if the given file. The file encoding is retained so that it could be re-applied when the file is saved. This is always the simple implementation of the standalone string-based document. The file path is used as the document moniker. Throws exception when file does not exist or there is any other IO problem. If the document should be returned despite any IO problem use

Creates an from the text if the given file. The file encoding is retained so that it could be re-applied when the file is saved. This is always the simple implementation of the standalone string-based document. Document text stream. Document moniker that uniquely identifies this document.

Represents a common interface for range markers

Gets the current text range corresponding to the range marker. Unlike this property returns the valid range if the associated document got removed.

Gets the current text range corresponding to the range marker. Unlike this property returns if the associated document got removed.

Gets the associated document. Asserts that document exists.

Gets or set a value indicating whether the range marker is valid Setting works only for invalidating marker

Indicates whether the range market is greedy to left

Indicates whether the range market is greedy to right

Currently IsGreedyToLeft/IsGreedyToRight sometimes are not greedy, and there are dependencies on that weird behaviour, so

Fired when range marker changed

Provider for tool-tips appearing when the mouse cursor hovers over the area covered by a range marker

Set of documents currently used and protected from garbage collection.

Locks the document by . Consequent calls from the same and does not have any effect. Document can be locked by several document owners.

Locks the document by The owner of the document lock Id of the document to refer to the document to

Releases the document lock by the If all the locks are released the document may be garbage collected

Id of the document obtained from Document owner that releases the lock

Searches for locked document by its id

Id of the document Document with corresponding or null

Returns document it assigned to the if it is locked

Document Id of the locked document or

Implementation of the interface.

Stores range before transaction

Timestamp of the last sync with document

Indicates whether the range marker is valid or not

sync object to protect range marker update when called from different threads protects and

Indicates whether the range marker is greedy to left

Indicates whether the range marker is greedy to right

Fired when range marker changed. NB if marker became invalid the event is fired. In the case access to will throw an exception

Gets or set a value indicating whether the range marker is valid Setting works only for invalidating marker

Notifies a range marker about document change

Locks a document range temporarily to prevent it from being edited. To unlock, dispose of the return value.

Gets the document moniker (an arbitrary string that helps with identifying this document).

This is an empty implementation which can be factored within the Document Model zone solely. All functional implementations require the Project Model zone.

Helpers for to handle storing its content in some external media, such as disk files, Visual Studio Running Documents Table, or remote IDEA documents. This basic interface is not bound to a project model or VS or anything and only operates on the document model. Implementations do have additional zoning requirements.

Saves the specified document

Returns all unsaved documents.

Returns true if the specified document has not been saved since the last modification

Saves all documents.

Raised after a document has been saved.

Raised before a document has been saved. The handlers of this event are given a chance to cancel save.

Raised before a document has been changed externally. The handlers of this event are given a chance to cancel the external change.

Forces synchronizing the document with its content source. For standalone documents or VS documents not opened in the editor, these are external files. For open VS documents, this is the RDT document content. Requires a writer lock.

Implements the standalone case for . Forces disk file sync even if another storage is available.

Converts series of sequential document changes to optimized final document change map

Sorted

When all changes are consumed, make final optimization

Try to find the right segment in the modified document Returns true if the point is inside modified segment, and contains the segment index Returns false if the point is outside modified segment, and contains the previous segment index

If the replaced text is the same at the beginning/ending, then do not modify that portion of text

Return a range in which is calculated by removing common prefix and suffix of both and For example, for two strings "ahellob" and "atestb" the resulting range will be TextRange.FromLength(1, 5), indicating a "hello" string in . For strings without common prefix and suffix the whole TextRange of will be returned.

Range. A component to manage undo scopes on the backend side. A signal, which is fired before user explicitly run "Undo action". You should terminate long-living activities on this signal. Indicates that there is opened long-living undo unit, that can be closed using signal. Opens an undo unit, which is being closed and commit with the disposing of returned cookie. Note, that the "Undo" action will not be available in IDE until the cookie isn't disposed (applicable to Visual Studio) Opens global undo scope, which isn't bound to any specific text control. All actions, which were executed while this cookie is opened, will be undone together and will be presented in the undo manager with the provided name. *Note* the undo action will not be available to user during opened global scope. It makes this method isn't suitable for long operations. Best practice is register your operation as long-living in and close your feature (together with undo units) when asked via