Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

Commit e7e1c20

Browse files
redmundsredmunds
committed
Merge pull request #5155 from lkcampbell/fix-issue-1483
Fix for issue #1483. Document file and handler function for each command.
2 parents c035593 + 5413247 commit e7e1c20

1 file changed

Lines changed: 92 additions & 85 deletions

File tree

‎src/command/Commands.js‎

Lines changed: 92 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -33,97 +33,104 @@ define(function (require, exports, module) {
3333
*/
3434

3535
// FILE
36-
exports.FILE_NEW_UNTITLED = "file.newDoc";
37-
exports.FILE_NEW = "file.newFile";
38-
exports.FILE_NEW_FOLDER = "file.newFolder";
39-
exports.FILE_OPEN = "file.open";
40-
exports.FILE_OPEN_FOLDER = "file.openFolder";
41-
exports.FILE_SAVE = "file.save";
42-
exports.FILE_SAVE_ALL = "file.saveAll";
43-
exports.FILE_SAVE_AS = "file.saveAs";
44-
exports.FILE_CLOSE = "file.close";
45-
exports.FILE_CLOSE_ALL = "file.close_all";
46-
exports.FILE_CLOSE_WINDOW = "file.close_window"; // string must MATCH string in native code (brackets_extensions)
47-
exports.FILE_ADD_TO_WORKING_SET = "file.addToWorkingSet";
48-
exports.FILE_LIVE_FILE_PREVIEW = "file.liveFilePreview";
49-
exports.FILE_LIVE_HIGHLIGHT = "file.previewHighlight";
50-
exports.FILE_PROJECT_SETTINGS = "file.projectSettings";
51-
exports.FILE_RENAME = "file.rename";
52-
exports.FILE_DELETE = "file.delete";
53-
exports.FILE_EXTENSION_MANAGER = "file.extensionManager";
54-
exports.FILE_REFRESH = "file.refresh";
55-
exports.FILE_QUIT = "file.quit"; // string must MATCH string in native code (brackets_extensions)
56-
36+
exports.FILE_NEW_UNTITLED = "file.newDoc"; // DocumentCommandHandlers.js handleFileNew()
37+
exports.FILE_NEW = "file.newFile"; // DocumentCommandHandlers.js handleFileNewInProject()
38+
exports.FILE_NEW_FOLDER = "file.newFolder"; // DocumentCommandHandlers.js handleNewFolderInProject()
39+
exports.FILE_OPEN = "file.open"; // DocumentCommandHandlers.js handleFileOpen()
40+
exports.FILE_OPEN_FOLDER = "file.openFolder"; // ProjectManager.js openProject()
41+
exports.FILE_SAVE = "file.save"; // DocumentCommandHandlers.js handleFileSave()
42+
exports.FILE_SAVE_ALL = "file.saveAll"; // DocumentCommandHandlers.js handleFileSaveAll()
43+
exports.FILE_SAVE_AS = "file.saveAs"; // DocumentCommandHandlers.js handleFileSaveAs()
44+
exports.FILE_CLOSE = "file.close"; // DocumentCommandHandlers.js handleFileClose()
45+
exports.FILE_CLOSE_ALL = "file.close_all"; // DocumentCommandHandlers.js handleFileCloseAll()
46+
exports.FILE_ADD_TO_WORKING_SET = "file.addToWorkingSet"; // DocumentCommandHandlers.js handleFileAddToWorkingSet()
47+
exports.FILE_LIVE_FILE_PREVIEW = "file.liveFilePreview"; // LiveDevelopment/main.js _handleGoLiveCommand()
48+
exports.FILE_LIVE_HIGHLIGHT = "file.previewHighlight"; // LiveDevelopment/main.js _handlePreviewHighlightCommand()
49+
exports.FILE_PROJECT_SETTINGS = "file.projectSettings"; // ProjectManager.js _projectSettings()
50+
exports.FILE_RENAME = "file.rename"; // DocumentCommandHandlers.js handleFileRename()
51+
exports.FILE_DELETE = "file.delete"; // DocumentCommandHandlers.js handleFileDelete()
52+
exports.FILE_EXTENSION_MANAGER = "file.extensionManager"; // ExtensionManagerDialog.js _showDialog()
53+
exports.FILE_REFRESH = "file.refresh"; // ProjectManager.js refreshFileTree()
54+
55+
// File shell callbacks - string must MATCH string in native code (appshell/command_callbacks.h)
56+
exports.FILE_CLOSE_WINDOW = "file.close_window"; // DocumentCommandHandlers.js handleFileCloseWindow()
57+
exports.FILE_QUIT = "file.quit"; // DocumentCommandHandlers.js handleFileQuit()
58+
5759
// EDIT
58-
exports.EDIT_UNDO = "edit.undo";
59-
exports.EDIT_REDO = "edit.redo";
60-
exports.EDIT_CUT = "edit.cut";
61-
exports.EDIT_COPY = "edit.copy";
62-
exports.EDIT_PASTE = "edit.paste";
63-
exports.EDIT_SELECT_ALL = "edit.selectAll";
64-
exports.EDIT_SELECT_LINE = "edit.selectLine";
65-
exports.EDIT_FIND = "edit.find";
66-
exports.EDIT_FIND_IN_FILES = "edit.findInFiles";
67-
exports.EDIT_FIND_IN_SUBTREE = "edit.findInSubtree";
68-
exports.EDIT_FIND_NEXT = "edit.findNext";
69-
exports.EDIT_FIND_PREVIOUS = "edit.findPrevious";
70-
exports.EDIT_REPLACE = "edit.replace";
71-
exports.EDIT_INDENT = "edit.indent";
72-
exports.EDIT_UNINDENT = "edit.unindent";
73-
exports.EDIT_DUPLICATE = "edit.duplicate";
74-
exports.EDIT_DELETE_LINES = "edit.deletelines";
75-
exports.EDIT_LINE_COMMENT = "edit.lineComment";
76-
exports.EDIT_BLOCK_COMMENT = "edit.blockComment";
77-
exports.EDIT_LINE_UP = "edit.lineUp";
78-
exports.EDIT_LINE_DOWN = "edit.lineDown";
79-
exports.EDIT_OPEN_LINE_ABOVE = "edit.openLineAbove";
80-
exports.EDIT_OPEN_LINE_BELOW = "edit.openLineBelow";
81-
exports.TOGGLE_CLOSE_BRACKETS = "edit.autoCloseBrackets";
82-
exports.SHOW_CODE_HINTS = "edit.showCodeHints";
60+
// File shell callbacks - string must MATCH string in native code (appshell/command_callbacks.h)
61+
exports.EDIT_UNDO = "edit.undo"; // EditorCommandHandlers.js handleUndo()
62+
exports.EDIT_REDO = "edit.redo"; // EditorCommandHandlers.js handleRedo()
63+
exports.EDIT_CUT = "edit.cut"; // EditorCommandHandlers.js ignoreCommand()
64+
exports.EDIT_COPY = "edit.copy"; // EditorCommandHandlers.js ignoreCommand()
65+
exports.EDIT_PASTE = "edit.paste"; // EditorCommandHandlers.js ignoreCommand()
66+
exports.EDIT_SELECT_ALL = "edit.selectAll"; // EditorCommandHandlers.js _handleSelectAll()
67+
68+
exports.EDIT_SELECT_LINE = "edit.selectLine"; // EditorCommandHandlers.js selectLine()
69+
exports.EDIT_FIND = "edit.find"; // FindReplace.js _launchFind()
70+
exports.EDIT_FIND_IN_FILES = "edit.findInFiles"; // FindInFiles.js _doFindInFiles()
71+
exports.EDIT_FIND_IN_SUBTREE = "edit.findInSubtree"; // FindInFiles.js _doFindInSubtree()
72+
exports.EDIT_FIND_NEXT = "edit.findNext"; // FindReplace.js _findNext()
73+
exports.EDIT_FIND_PREVIOUS = "edit.findPrevious"; // FindReplace.js _findPrevious()
74+
exports.EDIT_REPLACE = "edit.replace"; // FindReplace.js _replace()
75+
exports.EDIT_INDENT = "edit.indent"; // EditorCommandHandlers.js indentText()
76+
exports.EDIT_UNINDENT = "edit.unindent"; // EditorCommandHandlers.js unidentText()
77+
exports.EDIT_DUPLICATE = "edit.duplicate"; // EditorCommandHandlers.js duplicateText()
78+
exports.EDIT_DELETE_LINES = "edit.deletelines"; // EditorCommandHandlers.js deleteCurrentLines()
79+
exports.EDIT_LINE_COMMENT = "edit.lineComment"; // EditorCommandHandlers.js lineComment()
80+
exports.EDIT_BLOCK_COMMENT = "edit.blockComment"; // EditorCommandHandlers.js blockComment()
81+
exports.EDIT_LINE_UP = "edit.lineUp"; // EditorCommandHandlers.js moveLineUp()
82+
exports.EDIT_LINE_DOWN = "edit.lineDown"; // EditorCommandHandlers.js moveLineDown()
83+
exports.EDIT_OPEN_LINE_ABOVE = "edit.openLineAbove"; // EditorCommandHandlers.js openLineAbove()
84+
exports.EDIT_OPEN_LINE_BELOW = "edit.openLineBelow"; // EditorCommandHandlers.js openLineBelow()
85+
exports.TOGGLE_CLOSE_BRACKETS = "edit.autoCloseBrackets"; // EditorOptionHandlers.js _toggleCloseBrackets()
86+
exports.SHOW_CODE_HINTS = "edit.showCodeHints"; // CodeHintManager.js _startNewSession()
8387

8488
// VIEW
85-
exports.VIEW_HIDE_SIDEBAR = "view.hideSidebar";
86-
exports.VIEW_INCREASE_FONT_SIZE = "view.increaseFontSize";
87-
exports.VIEW_DECREASE_FONT_SIZE = "view.decreaseFontSize";
88-
exports.VIEW_RESTORE_FONT_SIZE = "view.restoreFontSize";
89-
exports.VIEW_SCROLL_LINE_UP = "view.scrollLineUp";
90-
exports.VIEW_SCROLL_LINE_DOWN = "view.scrollLineDown";
91-
exports.VIEW_TOGGLE_INSPECTION = "view.toggleCodeInspection";
92-
exports.TOGGLE_LINE_NUMBERS = "view.toggleLineNumbers";
93-
exports.TOGGLE_ACTIVE_LINE = "view.toggleActiveLine";
94-
exports.TOGGLE_WORD_WRAP = "view.toggleWordWrap";
95-
exports.SORT_WORKINGSET_BY_ADDED = "view.sortWorkingSetByAdded";
96-
exports.SORT_WORKINGSET_BY_NAME = "view.sortWorkingSetByName";
97-
exports.SORT_WORKINGSET_BY_TYPE = "view.sortWorkingSetByType";
98-
exports.SORT_WORKINGSET_AUTO = "view.sortWorkingSetAuto";
89+
exports.VIEW_HIDE_SIDEBAR = "view.hideSidebar"; // SidebarView.js toggle()
90+
exports.VIEW_INCREASE_FONT_SIZE = "view.increaseFontSize"; // ViewCommandHandlers.js _handleIncreaseFontSize()
91+
exports.VIEW_DECREASE_FONT_SIZE = "view.decreaseFontSize"; // ViewCommandHandlers.js _handleDecreaseFontSize()
92+
exports.VIEW_RESTORE_FONT_SIZE = "view.restoreFontSize"; // ViewCommandHandlers.js _handleRestoreFontSize()
93+
exports.VIEW_SCROLL_LINE_UP = "view.scrollLineUp"; // ViewCommandHandlers.js _handleScrollLineUp()
94+
exports.VIEW_SCROLL_LINE_DOWN = "view.scrollLineDown"; // ViewCommandHandlers.js _handleScrollLineDown()
95+
exports.VIEW_TOGGLE_INSPECTION = "view.toggleCodeInspection"; // CodeInspection.js toggleEnabled()
96+
exports.TOGGLE_LINE_NUMBERS = "view.toggleLineNumbers"; // EditorOptionHandlers.js _toggleLineNumbers()
97+
exports.TOGGLE_ACTIVE_LINE = "view.toggleActiveLine"; // EditorOptionHandlers.js _toggleActiveLine()
98+
exports.TOGGLE_WORD_WRAP = "view.toggleWordWrap"; // EditorOptionHandlers.js _toggleWordWrap()
99+
exports.SORT_WORKINGSET_BY_ADDED = "view.sortWorkingSetByAdded"; // WorkingSetSort.js _handleSortWorkingSetByAdded()
100+
exports.SORT_WORKINGSET_BY_NAME = "view.sortWorkingSetByName"; // WorkingSetSort.js _handleSortWorkingSetByName()
101+
exports.SORT_WORKINGSET_BY_TYPE = "view.sortWorkingSetByType"; // WorkingSetSort.js _handleSortWorkingSetByType()
102+
exports.SORT_WORKINGSET_AUTO = "view.sortWorkingSetAuto"; // WorkingSetSort.js _handleAutomaticSort()
99103

100-
// Navigate
101-
exports.NAVIGATE_NEXT_DOC = "navigate.nextDoc";
102-
exports.NAVIGATE_PREV_DOC = "navigate.prevDoc";
103-
exports.NAVIGATE_SHOW_IN_FILE_TREE = "navigate.showInFileTree";
104-
exports.NAVIGATE_SHOW_IN_OS = "navigate.showInOS";
105-
exports.NAVIGATE_QUICK_OPEN = "navigate.quickOpen";
106-
exports.NAVIGATE_JUMPTO_DEFINITION = "navigate.jumptoDefinition";
107-
exports.NAVIGATE_GOTO_DEFINITION = "navigate.gotoDefinition";
108-
exports.NAVIGATE_GOTO_LINE = "navigate.gotoLine";
109-
exports.NAVIGATE_GOTO_FIRST_PROBLEM = "navigate.gotoFirstProblem";
110-
exports.TOGGLE_QUICK_EDIT = "navigate.toggleQuickEdit";
111-
exports.TOGGLE_QUICK_DOCS = "navigate.toggleQuickDocs";
112-
exports.QUICK_EDIT_NEXT_MATCH = "navigate.nextMatch";
113-
exports.QUICK_EDIT_PREV_MATCH = "navigate.previousMatch";
104+
// NAVIGATE
105+
exports.NAVIGATE_NEXT_DOC = "navigate.nextDoc"; // DocumentCommandHandlers.js handleGoNextDoc()
106+
exports.NAVIGATE_PREV_DOC = "navigate.prevDoc"; // DocumentCommandHandlers.js handleGoPrevDoc()
107+
exports.NAVIGATE_SHOW_IN_FILE_TREE = "navigate.showInFileTree"; // DocumentCommandHandlers.js handleShowInTree()
108+
exports.NAVIGATE_SHOW_IN_OS = "navigate.showInOS"; // DocumentCommandHandlers.js handleShowInOS()
109+
exports.NAVIGATE_QUICK_OPEN = "navigate.quickOpen"; // QuickOpen.js doFileSearch()
110+
exports.NAVIGATE_JUMPTO_DEFINITION = "navigate.jumptoDefinition"; // EditorManager.js _doJumpToDef()
111+
exports.NAVIGATE_GOTO_DEFINITION = "navigate.gotoDefinition"; // QuickOpen.js doDefinitionSearch()
112+
exports.NAVIGATE_GOTO_LINE = "navigate.gotoLine"; // QuickOpen.js doGotoLine()
113+
exports.NAVIGATE_GOTO_FIRST_PROBLEM = "navigate.gotoFirstProblem"; // CodeInspection.js handleGotoFirstProblem()
114+
exports.TOGGLE_QUICK_EDIT = "navigate.toggleQuickEdit"; // EditorManager.js _toggleInlineWidget()
115+
exports.TOGGLE_QUICK_DOCS = "navigate.toggleQuickDocs"; // EditorManager.js _toggleInlineWidget()
116+
exports.QUICK_EDIT_NEXT_MATCH = "navigate.nextMatch"; // MultiRangeInlineEditor.js _nextRange()
117+
exports.QUICK_EDIT_PREV_MATCH = "navigate.previousMatch"; // MultiRangeInlineEditor.js _previousRange()
114118

115-
// Help
116-
exports.HELP_CHECK_FOR_UPDATE = "help.checkForUpdate";
117-
exports.HELP_HOW_TO_USE_BRACKETS = "help.howToUseBrackets";
118-
exports.HELP_FORUM = "help.forum";
119-
exports.HELP_RELEASE_NOTES = "help.releaseNotes";
120-
exports.HELP_REPORT_AN_ISSUE = "help.reportAnIssue";
121-
exports.HELP_SHOW_EXT_FOLDER = "help.showExtensionsFolder";
122-
exports.HELP_TWITTER = "help.twitter";
123-
exports.HELP_ABOUT = "help.about";
119+
// HELP
120+
exports.HELP_CHECK_FOR_UPDATE = "help.checkForUpdate"; // HelpCommandHandlers.js _handleCheckForUpdates()
121+
exports.HELP_HOW_TO_USE_BRACKETS = "help.howToUseBrackets"; // HelpCommandHandlers.js _handleLinkMenuItem()
122+
exports.HELP_FORUM = "help.forum"; // HelpCommandHandlers.js _handleLinkMenuItem()
123+
exports.HELP_RELEASE_NOTES = "help.releaseNotes"; // HelpCommandHandlers.js _handleLinkMenuItem()
124+
exports.HELP_REPORT_AN_ISSUE = "help.reportAnIssue"; // HelpCommandHandlers.js _handleLinkMenuItem()
125+
exports.HELP_SHOW_EXT_FOLDER = "help.showExtensionsFolder"; // HelpCommandHandlers.js _handleShowExtensionsFolder()
126+
exports.HELP_TWITTER = "help.twitter"; // HelpCommandHandlers.js _handleLinkMenuItem()
127+
128+
// File shell callbacks - string must MATCH string in native code (appshell/command_callbacks.h)
129+
exports.HELP_ABOUT = "help.about"; // HelpCommandHandlers.js _handleAboutDialog()
124130

131+
// APP
125132
// File shell callbacks - string must MATCH string in native code (appshell/command_callbacks.h)
126-
exports.APP_ABORT_QUIT = "app.abort_quit";
127-
exports.APP_BEFORE_MENUPOPUP = "app.before_menupopup";
133+
exports.APP_ABORT_QUIT = "app.abort_quit"; // DocumentCommandHandlers.js _handleAbortQuit()
134+
exports.APP_BEFORE_MENUPOPUP = "app.before_menupopup"; // DocumentCommandHandlers.js _handleBeforeMenuPopup()
128135
});
129136

0 commit comments

Comments
 (0)
⚡