The OpenD Programming Language

FileLineGetter

This is a line getter that customizes the tab completion to fill in file names separated by spaces, like a command line thing.

class FileLineGetter : LineGetter {}

Members

Variables

searchDirectory
string searchDirectory;

You can set this property to tell it where to search for the files to complete.

Inherited Members

From LineGetter

dispose
void dispose()

Call this before letting LineGetter die so it can do any necessary cleanup and save the updated history to a file.

historyFileDirectory
string historyFileDirectory()

Override this to change the directory where history files are stored

suggestionForeground
Color suggestionForeground;
regularForeground
Color regularForeground;
background
Color background;
promptColor
Color promptColor;
specialCharBackground
Color specialCharBackground;

You can customize the colors here. You should set these after construction, but before calling startGettingLine or getline.

prompt
string prompt [@property setter]
string prompt [@property getter]

Set this if you want a prompt to be drawn with the line. It does NOT support color in string.

autoSuggest
bool autoSuggest;

Turn on auto suggest if you want a greyed thing of what tab would be able to fill in as you type.

hadInput
bool hadInput()

Returns true if there was any input in the buffer. Can be checked in the case of a UserInterruptionException.

historyFilter
string historyFilter(string candidate)

Override this if you don't want all lines added to the history. You can return null to not add it at all, or you can transform it.

HistoryCommitMode
enum HistoryCommitMode
historyCommitMode
HistoryCommitMode historyCommitMode;

History is normally only committed to the file when the program is terminating, but if you are losing data due to crashes, you might want to change this to historyCommitMode = HistoryCommitMode.afterEachLine;.

saveSettingsAndHistoryToFile
void saveSettingsAndHistoryToFile()

You may override this to do nothing. If so, you should also override appendHistoryToFile if you ever change historyCommitMode.

appendHistoryToFile
void appendHistoryToFile(string item)

If historyCommitMode is HistoryCommitMode.afterEachLine, this line is called after each line to append to the file instead of saveSettingsAndHistoryToFile.

loadSettingsAndHistoryFromFile
void loadSettingsAndHistoryFromFile()

You may override this to do nothing

historyFileExtension
string historyFileExtension()
historyPath
string historyPath()

semi-private, do not rely upon yet

tabComplete
string[] tabComplete(dchar[] candidate, dchar[] afterCursor)

Override this to provide tab completion. You may use the candidate argument to filter the list, but you don't have to (LineGetter will do it for you on the values you return). This means you can ignore the arguments if you like.

tabCompleteStartPoint
size_t tabCompleteStartPoint(dchar[] candidate, dchar[] afterCursor)

Override this to provide a different tab competition starting point. The default is 0, always completing the complete line, but you may return the index of another character of candidate to provide a new split.

tabCompleteHelp
string tabCompleteHelp(string candidate)

This gives extra information for an item when displaying tab competition details.

showTabCompleteList
void showTabCompleteList(string[] list)

Override this to provide a custom display of the tab completion list.

showHelp
void showHelp()

Called by the default event loop when the user presses F1. Override showHelp to change the UI, override helpMessage if you just want to change the message.

helpMessage
string helpMessage()
editLineInEditor
dchar[] editLineInEditor(dchar[] line, size_t cursorPosition)
line may have private data packed into the dchar bits if you enabled enableAutoCloseBrackets. Use ch & ~PRIVATE_BITS_MASK to get standard dchars.
getline
string getline(RealTimeConsoleInput* input)

One-call shop for the main workhorse If you already have a RealTimeConsoleInput ready to go, you should pass a pointer to yours here. Otherwise, LineGetter will make its own.

HistoryRecallFilterMethod
enum HistoryRecallFilterMethod

Set in historyRecallFilterMethod.

historyRecallFilterMethod
HistoryRecallFilterMethod historyRecallFilterMethod;

Controls what happens when the user presses the up key, etc., to recall history entries. See HistoryRecallMethod for the options.

enableAutoCloseBrackets
string enableAutoCloseBrackets()

Enables automatic closing of brackets like (, {, and [ when the user types. Specifically, you subclass and return a string of the completions you want to do, so for that set, return "()[]{}"

PRIVATE_BITS_MASK
enum PRIVATE_BITS_MASK;

If enableAutoCloseBrackets does not return null, you should ignore these bits in the line.

syntaxHighlightMatch
SyntaxHighlightMatch syntaxHighlightMatch(dchar[] line, size_t currentDrawPosition, size_t currentCursorPosition)
SyntaxHighlightMatch
struct SyntaxHighlightMatch

Subclasses that implement this function can enable syntax highlighting in the line as you edit it.

addChar
void addChar(dchar ch)

Adds a character at the current position in the line. You can call this too if you hook events for hotkeys or something. You'll probably want to call redraw() after adding chars.

addString
void addString(string s)

.

deleteChar
void deleteChar()

Deletes the character at the current position in the line. You'll probably want to call redraw() after deleting chars.

deleteToEndOfLine
void deleteToEndOfLine()
isWordSeparatorCharacter
bool isWordSeparatorCharacter(dchar d)

Used by the word movement keys (e.g. alt+backspace) to find a word break.

echoChar
dchar echoChar;

Controls the input echo setting.

maximumDrawWidth
int maximumDrawWidth [@property getter]

If you are implementing a subclass, use this instead of terminal.width to see how far you can draw. Use care to remember this is a width, not a right coordinate.

maximumDrawWidth
int maximumDrawWidth [@property setter]

Sets the maximum width the line getter will use. Set to 0 to disable, in which case it will use the entire width of the terminal.

maximumDrawHeight
int maximumDrawHeight [@property getter]

Returns the maximum vertical space available to draw.

startGettingLine
void startGettingLine()

Starts getting a new line. Call workOnLine and finishGettingLine afterward.

pastePreprocessor
string delegate(string s) pastePreprocessor;
lastLineWasRetained
bool lastLineWasRetained()

Returns true if the last line was retained by the user via the F9 or ctrl+enter key which runs it but keeps it in the edit buffer.

cancelHistorySearch
void cancelHistorySearch()

Cancels an in-progress history search immediately, discarding the result, returning to the normal prompt.

workOnLine
bool workOnLine(InputEvent e, RealTimeConsoleInput* rtti)

for integrating into another event loop you can pass individual events to this and the line getter will work on it

handleLinkEvent
void delegate(LinkEvent ev, LineGetter lg) handleLinkEvent;

Gives a convenience hook for subclasses to handle my terminal's hyperlink extension.

replaceLine
void replaceLine(dchar[] line)
void replaceLine(char[] line)

Replaces the line currently being edited with the given line and positions the cursor inside it.

lineAsString
string lineAsString()

Gets the current line buffer as a duplicated string.

finishGettingLine
string finishGettingLine()

Meta