Wing IDE Reference Manual
   
Wing IDE Reference Manual

Version 1.1.10


next up previous contents
Next: B. Wing Tips Up: Reference Manual Wing IDE Previous: 6. Debugger


Subsections


A. Command Reference

This appendix enumerates the entire top-level Wing command set.

A.1 Overview

Any of the commands listed here may be used in custom menus, tools, or key equivalents that can be set up as described in chapter 2. In emacs emulation mode, commands may also be entered by name within the command entry area that is displayed with alt-x or esc-x.

Although many commands accept no parameters, some commands are defined to accept optional typed parameters. The type of a parameter can be any of those defined in Python's types module, or a file name string.

Some parameters defined have special meaning to Wing, according to the name of the parameter:

All other parameters on commands are considered to be user-entered values, such as the search and replace strings given to the query-replace command. Such parameters are collected from the user if they are missing when the command is invoked (as they would be when commands are used in menus, tools, or key equivalents).

Command parameters will also be used in future versions of Wing to support scripting the IDE. This reference will be expanded at that time to describe how commands are defined within Wing and how scripts can access command definition information.

Since commands act as the formal public API into the Wing source base, they will be maintained for compatibility in all future releases of Wing IDE. Note that more of the commands will take parameters in the future, but should continue to behave as they currently do when invoked without parameters.

A.2 Top Level

The following commands are defined by the guimgr subsystem in the class guimanager.CTopLevelCommands.

Command Name Description Parameters
quit Quit Wing IDE, prompting to save any unsaved documents.  
about-application Display the application about box.  
open Prompt to open a document from disk. This may either prompt graphically or using the emacs mode interaction manager.  
open-gui Prompt to open a document from disk. This always uses a graphical file open box.  
new-file Create a new blank document.  
close Close the current or given document. Also closes the window if the last view in the window is being closed. active_view: The view reference
close-all Close all the open source editors windows (but not other windows).  
save Save the current or given document. active_view: The view reference
save-as Save the current or given document to another location. active_view: The view reference
save-all Save all unsaved altered documents to disk. This will prompt only for names of items that have not yet been assigned a name.  
print-view Print the current or given view. active_view: The view reference
page-setup Run page setup for the current or given view. Only available on Windows. active_view: The view reference
switch-document Switch to display one of the selected open documents document_name: The name of document to open; either full path or last path component only
previous-document Switch to display the most recent previously displayed document  
command-by-name Prompt user to enter a command for execution by name  
clone-window Open a new source window with secondary views into all the views that are open in the current window.  
new-window Open a new blank source window. Subsequently opened or created source views will be placed into the window.  
move-editor-to-new-window Open a new source window and move the current editor view into it, removing it from its current window. This is only available if there is more than one view in the current window.  
delete-window Delete current window, closing any views not found in any other window.  
search-manager Display the graphical search manager window.  
show-font-size-dialog Display the font/size selection dialog for altering the font and size used in a single text file or in all text files in the project.  
show-analysis-env Display informational dialog that contains the current interpreter and python path information being used for source code analysis throughout the project.  
show-manual-html Show the HTML version of the Wing IDE users manual  
show-manual-pdf Show the PDF version of the Wing IDE users manual  
show-python-manual-html Show the python manual for the version of Python that is being used for source analysis and debugging  
show-support-html Show the Wing IDE support website  
show-python-org-html Show the python.org website  
initiate-repeat-0 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '0'  
initiate-repeat-1 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '1'  
initiate-repeat-2 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '2'  
initiate-repeat-3 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '3'  
initiate-repeat-4 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '4'  
initiate-repeat-5 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '5'  
initiate-repeat-6 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '6'  
initiate-repeat-7 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '7'  
initiate-repeat-8 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '8'  
initiate-repeat-9 Start emacs-mode interaction for entering a repeat value for command or keystroke repetition; starts value entry with '9'  

A.3 Project Manager

The following commands are defined in the proj subsystem in the class managergui.CProjectCommands.

Command Name Description Parameters
show-project-window Bring the project manager window to front.  
new-project Create a new project file; this causes the current open project file to be closed, and user is prompted to save the project if altered.  
open-project Open a project file; the current project file is closed, and user is prompted to save the project if altered.  
close-project Close the project file, prompting user to save if altered.  
save-project Save the project file to disk.  
save-project-as Save the project file to another location on disk; prompts user to enter the location.  
add-file-to-project Prompt user to select a file to add to the open project.  
add-package-to-project Prompt user to select a directory to add to the open project. All enclosed files of types configured with the proj.package-file-types and proj.package-omit-types preference will be presented to the user for optional individual selection.  
add-tree-to-project Prompt user to select a directory to add to the open project. All enclosed files of types configured with the proj.package-file-types and proj.package-omit-types preference will be added in one operation.  
add-current-file-to-project Add the file associated with the frontmost view to the project manager.  
remove-selection-from-project Remove the currently selected file or package from the project.  
browse-project-modules Switch to the source code browser, showing all modules and files in the currently open project.  
set-project-main-debug-file Set the main debug file for open project. This is the file that is executed by default by the debugger.  
set-current-as-main-debug-file Set the file associated with the current frontmost view as the main debug file for open project. This is the file that is executed by default by the debugger.  
clear-project-main-debug-file Clear the main debug file for open project. The debugger will execute the frontmost window when this is cleared.  
open-selected-from-project Open the currently selected item in the project manager window.  
debug-selected-from-project Launch a debug session for the item currently selected in the project manager window.  
execute-selected-from-project Execute the item currently selected in the project manager window. Makefiles, Python code, and any executable file may be executed in this way outside of the debugger.  
choose-file-debug-args Display the debug properties dialog box for the file currently selected in the project manager window.  
sort-project-by-directory Group items in the project manager window by directory, sorting the top-level directory list alphabetically.  
sort-project-by-file-type Group items in the project manager window by file type, soring the top-level mime type list alphabetically.  
use-normal-project Switch the project disk storage format to a single file containing all project data.  
use-shared-project Switch the project disk storage format to use two files, one containing user-specific data, and the other containing data that can be shared by all developers on a project.  
view-project-properties Display the project-wide properties dialog.  
show-analysis-stats Display the analysis statistics dialog.  

A.4 Source Code Editor

The following commands are defined in edit subsystem in the class editor.CEditorCommands.

Command Name Description Parameters
cut Cut the current text selection to system-wide clipboard.  
copy Copy the current text selection to system-wide clipboard.  
clear Clear (delete) the current text selection.  
paste Paste the current contents of the system-wide clipboard to replace the current text selection.  
undo Undo the most recent command or typing action.  
redo Redo the most recently undone action.  
kill-line Remove text from the cursor to the end of the current line and place it into the kill buffer with any other contiguously removed lines. End-of-line is removed only if there is nothing between the cursor and the end of the line.  
yank-line Paste the contents of the kill buffer into current position in the editor. This will paste the system-wide clipboard instead if the kill buffer is empty.  
beginning-of-line Move the cursor to the beginning of the current line. Issuing this repeatedly will alternate between the very beginning of the line and the first non-blank character.  
beginning-of-line-extend Move the cursor to the beginning of the current line and extend the current selection to that point.  
end-of-line Move to the cursor to the end of the current line.  
end-of-line-extend Move the cursor to the end of the current line and extend the current selection to that point.  
next-line Move cursor to the next line.  
next-line-extend Move cursor to the next line, extending the current selection to that point.  
previous-line Move cursor to the previous line.  
previous-line-extend Move cursor to the previous line, extending the current selection to that point.  
forward-char Move the cursor forward one character.  
forward-char-extend Move the cursor forward one character, extending the current selection to that point.  
backward-char Move the cursor backward one character.  
backward-char-extend Move the cursor backward one character, extending the current selection to that point.  
forward-word Move the cursor forward one word.  
forward-word-extend Move the cursor forward one word, extending the current selection to that point.  
backward-word Move the cursor backward one word.  
backward-word-extend Move the cursor backward one word, extending the current selection to that point.  
forward-page Move the cursor forward one page.  
forward-page-extend Move the cursor forward one page, extending the current selection to that point.  
backward-page Move the cursor backward one page.  
backward-page-extend Move the cursor backward one page, extending the current selection to that point.  
start-of-document Move cursor to start of document.  
start-of-document-extend Move cursor to start of document, extending the current selection to that point.  
end-of-document Move cursor to end of document.  
end-of-document-extend Move cursor to end of document, extending the current selection to that point.  
brace-match Match brace at current cursor position, selecting all text between the two and highlighting the braces.  
set-mark-command Set start of text marking for selection at current cursor position. Subsequently, all cursor move operations will automatically extend the text selection until stop-mark-command is issued.  
stop-mark-command Stop text marking for selection at current cursor position, leaving the selection set as is. Subsequent cursor move operations will deselect the range and set selection to cursor position.  
forward-delete-char Delete one character in front of the cursor.  
backward-delete-char Delete one character behind the cursor.  
forward-delete-word Delete one word in front of the cursor.  
backward-delete-word Delete one word behind the cursor.  
select-all Select the entire document.  
forward-tab Place a forward tab at the current cursor position.  
backward-tab Place a backward tab at the current cursor position.  
new-line Insert a new line at the current cursor position.  
form-feed Insert a form feed character at the cursor position.  
search-forward Initiate interactive forward search from the cursor position.  
search-backward Initiate interactive backward search from the cursor position.  
search-sel Initiate interactive search from current cursor position, using the current selection or nearest word as the search string.  
search-sel-forward Initiate forward interactive search from current cursor position, using the current selection or nearest word as the search string. This immediately searches for the next match.  
search-sel-backward Initiate backward interactive search from current cursor position, using the current selection or nearest word as the search string. This immediately searches for the next match.  
query-replace Initiate interactive (prompted) query/replace from the cursor position.  
replace-string Replace all occurrences of a string after current cursor position to the end of the file.  
replace-and-search Replace current found search occurrence from search manager and search again on the search string.  
zoom-in Increase font sizes in display by one unit.  
zoom-out Decrease font sizes in display by one unit.  
toggle-overtype Toggle between overtype and insert mode.  
show-all-whitespace Show all white space with visible whitespace characters, including spaces, tabs and end-of-line characters.  
hide-all-whitespace Show white space without any visible whitespace characters.  
show-whitespace Show white space with visible space and tab characters.  
hide-whitespace Show white space without visible space and tab characters.  
show-eol Show end of line characters with a visible character.  
hide-eol Hide visible end of line characters.  
scroll-to-cursor Scroll as necessary to make sure that the cursor is visible on screen.  
center-cursor Center the cursor on the display.  
show-selection Turn on display of the current text selection.  
hide-selection Turn off display of the current text selection.  
save-buffer Save the current text file to disk.  
kill-buffer Close the current text file.  
cancel Cancel current editor command.  
insert-file Insert a file at given cursor position. filename: The file to insert.
goto-line Go to a selected line by number. lineno: The line number.
start-kbd-macro Start recording a keyboard and command macro.  
stop-kbd-macro Stop recording a keyboard and command macro.  
execute-kbd-macro Execute the most recently recorded keyboard macro.  
indent-region Increase indentation of selected region by one level.  
outdent-region Outdent indentation of selected region by one level.  
comment-out-region Comment out the selected region. This operates on whole lines, extending the current selection if necessary.  
uncomment-out-region Remove comments around lines in the selected region. This operates on whole lines, extending the current selection if necessary. Does nothing if commenting is not present.  
fill-paragraph Rejustify the paragraph of text surrounding the current start of selection. This operates on whole lines, and is most useful in reformatting comments, long strings, or documentation.  
indent-to-match Indent the current line or selection to match indentation of the preceding non-blank line, adding or subtracting indentation as needed for the current context.  
complete-autocompletion Complete the current autocompletion, inserting text as appropriate at insertion point.  
show-popup-menu Display the editor's popup menu.  
goto-selected-symbol-defn Display the point of definition of the most recently clicked-upon symbol in the source.  
show-indent-manager Display the indentation manager dialog for the current source window.  
convert-indents-to-spaces-only Convert all indentation in the text file to use only spaces. Tabs are converted according to configured edit.tab-size and edit.indent-size preferences. Tab size is forced to 8 for all Python files unless the file previously contained only tabs in indents, in which case edit.tab-size is used in the conversion.  
convert-indents-to-tabs-only Convert all indentation in a text file to use tabs only. Units of edit.indent-size spaces are converted into one tab each, and any remainder of space is converted into one tab. After conversion, the file is shown with tabs set to size edit.tab-size even for Python files (where tab size is otherwise forced to 8).  
convert-indents-to-mixed Convert all indentation in a text file to use a mixture of tabs and spaces, using tab size as configured with preference edit.tab-size and indent size as configured with preference edit.indent-size (one tab is placed instead of each group of edit.tab-size spaces. Tab size is forced to 8 for Python files, since the Python interpreter expects this in mixed indentation.  
force-indent-style-to-spaces-only Force future indentation in the text file to use spaces only in indentation, regardless of the current contents of the file. This is not available for Python files that don't already have inconsistent indentation.  
force-indent-style-to-tabs-only Force future indentation in the text file to use tabs only in indentation, regardless of the current contents of the file. This is not available for Python files that don't already have inconsistent indentation.  
force-indent-style-to-mixed Force future indentation in the text file to use mixed tab and space indentation, regardless of the current contents of the file. This is not available for Python files that don't already have inconsistent indentation.  
check-indent-consistency Check current file for indentation consistency with respect to the use of tabs and spaces. If some areas are indented with tabs and others with spaces, then the user is prompted to convert to all spaces, convert to all tab/space indentation, or to leave the file as is.  
enable-folding Enable structural folding on the source code.  
disable-folding Disable structural folding on the source code.  
fold-toggle Toggle the fold state of the first fold point found in the current selection or on the current line.  
fold-collapse-all-current Collapse recursively the current fold point, folding up all children as well.  
fold-expand-all-current Expand recursively the current fold point, ensuring that all children are visible as well.  
fold-collapse-all Collapse the entire source file recursively.  
fold-expand-all Expand the entire source file recursively.  
use-lexer-by-doctype Determine syntax colorizing for the text file according to the probable mime type of the file, based on the file extension.  
use-lexer-none Turn of syntax colorizing for the text file.  
use-lexer-python Use the Python lexer to colorize the text file.  
use-lexer-cpp Use the C++ lexer to colorize the text file.  
use-lexer-java Use the Java lexer to colorize the text file.  
use-lexer-makefile Use the Makefile lexer to colorize the text file.  
use-lexer-dos-batch Use the DOS datch file lexer to colorize the text file.  
use-lexer-vb Use the Visual Basic lexer to colorize the text file.  
use-lexer-html Use the HTML lexer to colorize the text file.  
use-lexer-properties Use the properties file lexer to colorize the text file.  
use-lexer-errlist Use the error list lexer to colorize the text file.  
use-lexer-msidl Use the MS IDL lexer to colorize the text file.  
use-lexer-sql Use the SQL lexer to colorize the text file.  
use-lexer-xml Use the XML lexer to colorize the text file.  
use-lexer-xcode Use the xcode lexer to colorize the text file.  
use-lexer-latex Use the LaTeX lexer to colorize the text file.  
use-lexer-lua Use the Lua to colorize the text file.  
use-lexer-idl Use the CORBA IDL lexer to colorize the text file.  
use-lexer-javascript Use the Javascript lexer to colorize the text file.  
use-lexer-rc Use the RC lexer to colorize the text file.  
use-lexer-plsql Use the PLSQL lexer to colorize the text file.  
use-lexer-php Use the PHP lexer to colorize the text file.  
use-lexer-perl Use the Perl lexer to colorize the text file.  
use-lexer-diff Use the diff/patch file lexer to colorize the text file.  
use-lexer-pascal Use the Pascal lexer to colorize the text file.  
use-lexer-apache-conf Use the Apache web server configuration lexer to colorize the text file.  
use-lexer-ave Use the Ave lexer to colorize the text file.  
show-line-numbers Show the line number display column on all source files. The width of the column is set with the edit.lineno-column-width preference.  
hide-line-numbers Hide the line number display column on all source files.  

A.5 Debugger

The following commands are defined in debug.client subsystem in the class cmdmanager.CDebuggerCommands.

Command Name Description Parameters
show-debug-window Bring the debugger window to front.  
show-expression-evaluator Display the expression evaluator window, bringing it to front if not already there.  
show-debug-probe Display the debug probe window, bringing it to front if not already there.  
show-interactive-shell Display the interactive shell window, bringing it to front if not already there.  
show-error-list Bring the runtime error window to front.  
enable-passive-listen Enable passive listening on the debugger network port.  
disable-passive-listen Disable passive listening on the debugger network port.  
exception-always-stop Always stop on exceptions, even if they are handled by the debug program's code.  
exception-never-stop Never stop on execptions.  
exception-unhandled-stop Only stop on exceptions that are not handled by the debug program's code.  
clear-exception-ignores-list Clear all exception points previously designated as ignored during execution.  
debug-start or run Start debug program execution, stopping on first line of code. This executes the main debug file as specified by the project manager, if it has been defined, or otherwise the current frontmost editor window.  
debug-file Start debugging the current file (regardless of whether a main debug file has been defined in the project manager).  
execute-file Execute the current file outside of the debugger. Makefiles, python code, and any executable file may be executed in this way.  
debug-continue Continue the current debug session, or start a new one using the main debug file if one has been specified in the project manager, or otherwise the frontmost editor window. This will stop on the next breakpoint or exception (and not on the first line of code when debug is initiated).  
debug-attach Display the attach dialog box, which allows attaching Wing IDE to debug processes that are already running.  
debug-detach Detach from the current debug process. The process starts free-running right away and will not stop at breakpoints or exceptions as long as it is detached from Wing IDE.  
run-to-cursor Start or continue running the debug program (either the main debug file, if specified, or otherwise the frontmost editor window) until the current cursor position is reached (or until an intervening breakpoint or exception is found).  
debug-kill End the current debug session, exiting the debug program and terminating the debug server connecton.  
debug-stop Stop (aka pause) the current debug session at current run location.  
choose-args Display the debug argument dialog for the frontmost editor window.  
step-over Step over the current execution point.  
step-into Step into function or method at current execution point.  
step-out Step out of the current function.  
frame-up Move up the current debug stack one frame.  
frame-down Move down the current debug stack one frame.  
break-set Set a new regular breakpoint at the cursor position.  
break-toggle Set or clear a breakpoint at the cursor position.  
break-set-temp Set a new temporary breakpoint at the cursor position.  
break-set-cond Set a new conditional breakpoint at the cursor position, prompting the user to enter the conditional to use.  
break-ignore Ignore the breakpoint at current cursor position for a given number of iterations, prompting user to enter the ignore value.  
break-edit-cond Prompt user to edit the conditional for the conditional breakpoint at the current cursor position.  
break-enable Enable the breakpoint at current cursor position.  
break-disable Disable the breakpoint at current cursor position.  
break-clear Clear the breakpoint at current cursor position.  
break-clear-all Clear all set breakpoints of all types.  
show-var-defaults Zoom the selected variable value into a seperate window, using the default configured view and value tracking styles.  
show-var-parent-ref-defaults Zoom the selected variable value into a seperate window, tracking the value by object reference to the parent value and symbolic reference to the data slot. The display style is the default configured style.  
show-var-parent-ref-combo Zoom the selected variable value into a seperate window, tracking the value by object reference to the parent value and symbolic reference to the data slot. The display style is a combo view containing both tree and textual areas.  
show-var-parent-ref-tree Zoom the selected variable value into a seperate window, tracking the value by object reference to the parent value and symbolic reference to the data slot. The tree display style is used.  
show-var-parent-ref-text Zoom the selected variable value into a seperate window, tracking the value by object reference to the parent value and symbolic reference to the data slot. The textual display style is used.  
show-var-value-ref-defaults Zoom the selected variable value into a seperate window, tracking the value by direct object reference. The display style is the default configured style.  
show-var-value-ref-combo Zoom the selected variable value into a seperate window, tracking the value by direct object reference. The display style is a combo view containing both tree and textual areas.  
show-var-value-ref-tree Zoom the selected variable value into a seperate window, tracking the value by direct object reference. The tree display style is used.  
show-var-value-ref-text Zoom the selected variable value into a seperate window, tracking the value by direct object reference. The textual display style is used.  
show-var-symbolic-defaults Zoom the selected variable value into a seperate window, tracking the value by direct object reference. The display style is the default configured style.  
show-var-symbolic-combo Zoom the selected variable value into a seperate window, tracking the value by its symbolic path. The display style is a combo view containing both tree and textual areas.  
show-var-symbolic-tree Zoom the selected variable value into a seperate window, tracking the value by its symbolic path. The tree display style is used.  
show-var-symbolic-text Zoom the selected variable value into a seperate window, tracking the value by its symbolic path. The textual display style is used.  
set-default-var-view-combo Set the default zoom view style to combination view, containing both a tree and textual display area. This overrides the value set by the debug.default-var-view-style preference.  
set-default-var-view-tree Set the default zoom view style to dynamic tree. This overrides the value set by the debug.default-var-view-style preference.  
set-default-var-view-text Set the default zoom view style to textual. This overrides the value set by the debug.default-var-view-style preference.  
set-default-var-track-symbolic Set the default zoom value tracking style to use the symbolic path to the data value. This overrides the value set by the debug.default-var-track-style preference.  
set-default-var-track-parent-ref Set the default zoom value tracking style to use the object reference of the parent value and the symbolic name for the data slot. This overrides the value set by the debug.default-var-track-style preference.  
set-default-var-track-value-ref Set the default zoom value tracking style to use a direct object reference to the value. This overrides the value set by the debug.default-var-track-style preference.  
expand-tree-more Expand the currently selected variable in the tree formatted variable display by one additional level of depth.  
collapse-tree-more Collapse the currently selected variable in the tree formatted variable display by one additional level of depth.  
force-var-reload Force reload of the variable currently selected on the active tree variable view. This overrides previously stored errors causing the debugger to attempt to reevaluate the value.  
clear-var-errors Clear the list of stored variables for which fatal errors were encountered during previous debug sessions. Values for these variables are not normally reloaded during subsequent debugging.  


next up previous contents
Next: B. Wing Tips Up: Reference Manual Wing IDE Previous: 6. Debugger   Contents



2003-08-28