JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Member Functions | List of all members
CodeDocument Class Reference

A class for storing and manipulating a source code file. More...

Classes

class  Iterator
 Iterates the text in a CodeDocument. More...
 
class  Listener
 An object that receives callbacks from the CodeDocument when its text changes. More...
 
class  Position
 A position in a code document. More...
 

Public Member Functions

 CodeDocument ()
 Creates a new, empty document.
 
 ~CodeDocument ()
 Destructor.
 
String getAllContent () const
 Returns the full text of the document.
 
String getTextBetween (const Position &start, const Position &end) const
 Returns a section of the document's text.
 
String getLine (int lineIndex) const noexcept
 Returns a line from the document.
 
int getNumCharacters () const noexcept
 Returns the number of characters in the document.
 
int getNumLines () const noexcept
 Returns the number of lines in the document.
 
int getMaximumLineLength () noexcept
 Returns the number of characters in the longest line of the document.
 
void deleteSection (const Position &startPosition, const Position &endPosition)
 Deletes a section of the text.
 
void deleteSection (int startIndex, int endIndex)
 Deletes a section of the text.
 
void insertText (const Position &position, const String &text)
 Inserts some text into the document at a given position.
 
void insertText (int insertIndex, const String &text)
 Inserts some text into the document at a given position.
 
void replaceSection (int startIndex, int endIndex, const String &newText)
 Replaces a section of the text with a new string.
 
void replaceAllContent (const String &newContent)
 Clears the document and replaces it with some new text.
 
void applyChanges (const String &newContent)
 Analyses the changes between the current content and some new text, and applies those changes.
 
bool loadFromStream (InputStream &stream)
 Replaces the editor's contents with the contents of a stream.
 
bool writeToStream (OutputStream &stream)
 Writes the editor's current contents to a stream.
 
String getNewLineCharacters () const noexcept
 Returns the preferred new-line characters for the document.
 
void setNewLineCharacters (const String &newLine) noexcept
 Sets the new-line characters that the document should use.
 
void newTransaction ()
 Begins a new undo transaction.
 
void undo ()
 Undo the last operation.
 
void redo ()
 Redo the last operation.
 
void clearUndoHistory ()
 Clears the undo history.
 
UndoManagergetUndoManager () noexcept
 Returns the document's UndoManager.
 
void setSavePoint () noexcept
 Makes a note that the document's current state matches the one that is saved.
 
bool hasChangedSinceSavePoint () const noexcept
 Returns true if the state of the document differs from the state it was in when setSavePoint() was last called.
 
Position findWordBreakAfter (const Position &position) const noexcept
 Searches for a word-break.
 
Position findWordBreakBefore (const Position &position) const noexcept
 Searches for a word-break.
 
void findTokenContaining (const Position &pos, Position &start, Position &end) const noexcept
 Finds the token that contains the given position.
 
void findLineContaining (const Position &pos, Position &start, Position &end) const noexcept
 Finds the line that contains the given position.
 
void addListener (Listener *listener) noexcept
 Registers a listener object to receive callbacks when the document changes.
 
void removeListener (Listener *listener) noexcept
 Deregisters a listener.
 

Detailed Description

A class for storing and manipulating a source code file.

When using a CodeEditorComponent, it takes one of these as its source object.

The CodeDocument stores its content as an array of lines, which makes it quick to insert and delete.

See Also
CodeEditorComponent

Constructor & Destructor Documentation

CodeDocument::CodeDocument ( )

Creates a new, empty document.

CodeDocument::~CodeDocument ( )

Destructor.

Member Function Documentation

String CodeDocument::getAllContent ( ) const

Returns the full text of the document.

String CodeDocument::getTextBetween ( const Position start,
const Position end 
) const

Returns a section of the document's text.

String CodeDocument::getLine ( int  lineIndex) const
noexcept

Returns a line from the document.

int CodeDocument::getNumCharacters ( ) const
noexcept

Returns the number of characters in the document.

int CodeDocument::getNumLines ( ) const
noexcept

Returns the number of lines in the document.

int CodeDocument::getMaximumLineLength ( )
noexcept

Returns the number of characters in the longest line of the document.

void CodeDocument::deleteSection ( const Position startPosition,
const Position endPosition 
)

Deletes a section of the text.

This operation is undoable.

void CodeDocument::deleteSection ( int  startIndex,
int  endIndex 
)

Deletes a section of the text.

This operation is undoable.

void CodeDocument::insertText ( const Position position,
const String text 
)

Inserts some text into the document at a given position.

This operation is undoable.

void CodeDocument::insertText ( int  insertIndex,
const String text 
)

Inserts some text into the document at a given position.

This operation is undoable.

void CodeDocument::replaceSection ( int  startIndex,
int  endIndex,
const String newText 
)

Replaces a section of the text with a new string.

This operation is undoable.

void CodeDocument::replaceAllContent ( const String newContent)

Clears the document and replaces it with some new text.

This operation is undoable - if you're trying to completely reset the document, you might want to also call clearUndoHistory() and setSavePoint() after using this method.

void CodeDocument::applyChanges ( const String newContent)

Analyses the changes between the current content and some new text, and applies those changes.

bool CodeDocument::loadFromStream ( InputStream stream)

Replaces the editor's contents with the contents of a stream.

This will also reset the undo history and save point marker.

bool CodeDocument::writeToStream ( OutputStream stream)

Writes the editor's current contents to a stream.

String CodeDocument::getNewLineCharacters ( ) const
noexcept

Returns the preferred new-line characters for the document.

This will be either "\n", "\r\n", or (rarely) "\r".

See Also
setNewLineCharacters
void CodeDocument::setNewLineCharacters ( const String newLine)
noexcept

Sets the new-line characters that the document should use.

The string must be either "\n", "\r\n", or (rarely) "\r".

See Also
getNewLineCharacters
void CodeDocument::newTransaction ( )

Begins a new undo transaction.

The document itself will not call this internally, so relies on whatever is using the document to periodically call this to break up the undo sequence into sensible chunks.

See Also
UndoManager::beginNewTransaction
void CodeDocument::undo ( )

Undo the last operation.

See Also
UndoManager::undo
void CodeDocument::redo ( )

Redo the last operation.

See Also
UndoManager::redo
void CodeDocument::clearUndoHistory ( )

Clears the undo history.

See Also
UndoManager::clearUndoHistory
UndoManager& CodeDocument::getUndoManager ( )
noexcept

Returns the document's UndoManager.

void CodeDocument::setSavePoint ( )
noexcept

Makes a note that the document's current state matches the one that is saved.

After this has been called, hasChangedSinceSavePoint() will return false until the document has been altered, and then it'll start returning true. If the document is altered, but then undone until it gets back to this state, hasChangedSinceSavePoint() will again return false.

See Also
hasChangedSinceSavePoint
bool CodeDocument::hasChangedSinceSavePoint ( ) const
noexcept

Returns true if the state of the document differs from the state it was in when setSavePoint() was last called.

See Also
setSavePoint
Position CodeDocument::findWordBreakAfter ( const Position position) const
noexcept

Searches for a word-break.

Position CodeDocument::findWordBreakBefore ( const Position position) const
noexcept

Searches for a word-break.

void CodeDocument::findTokenContaining ( const Position pos,
Position start,
Position end 
) const
noexcept

Finds the token that contains the given position.

void CodeDocument::findLineContaining ( const Position pos,
Position start,
Position end 
) const
noexcept

Finds the line that contains the given position.

void CodeDocument::addListener ( Listener listener)
noexcept

Registers a listener object to receive callbacks when the document changes.

If the listener is already registered, this method has no effect.

See Also
removeListener
void CodeDocument::removeListener ( Listener listener)
noexcept

Deregisters a listener.

See Also
addListener

The documentation for this class was generated from the following file: