750 lines
34 KiB
JavaScript
750 lines
34 KiB
JavaScript
/**
|
|
* This module is used as a base class for language handlers.
|
|
* It provides properties, helper functions, and functions that
|
|
* can be overridden by language handlers to implement
|
|
* language services such as code completion.
|
|
*
|
|
* See {@link language} for an example plugin.
|
|
*
|
|
* @class language.base_handler
|
|
*/
|
|
define("xace/base_handler", function(require, exports, module) {
|
|
|
|
module.exports = {
|
|
|
|
/**
|
|
* Indicates the handler handles editors, the immediate window,
|
|
* and anything else.
|
|
*/
|
|
HANDLES_ANY: 0,
|
|
|
|
/**
|
|
* Indicates the handler only handles editors, not the immediate window.
|
|
*/
|
|
HANDLES_EDITOR: 1,
|
|
|
|
/**
|
|
* Indicates the handler only handles the immediate window, not editors.
|
|
*/
|
|
HANDLES_IMMEDIATE: 2,
|
|
|
|
/**
|
|
* Indicates the handler only handles the immediate window, not editors.
|
|
*/
|
|
HANDLES_EDITOR_AND_IMMEDIATE: 3,
|
|
|
|
/**
|
|
* The language this worker is currently operating on.
|
|
* @type {String}
|
|
*/
|
|
language: null,
|
|
|
|
/**
|
|
* The path of the file this worker is currently operating on.
|
|
* @type {String}
|
|
*/
|
|
path: null,
|
|
|
|
/**
|
|
* The current workspace directory.
|
|
* @type {String}
|
|
*/
|
|
workspaceDir: null,
|
|
|
|
/**
|
|
* The current document this worker is operating on.
|
|
*
|
|
* @type {Document}
|
|
*/
|
|
doc: null,
|
|
|
|
// UTILITIES
|
|
|
|
/**
|
|
* Utility function, used to determine whether a certain feature is enabled
|
|
* in the user's preferences.
|
|
*
|
|
* Should not be overridden by inheritors.
|
|
*
|
|
* @deprecated Use worker_util#isFeatureEnabled instead
|
|
*
|
|
* @param {String} name The name of the feature, e.g. "unusedFunctionArgs"
|
|
* @return {Boolean}
|
|
*/
|
|
isFeatureEnabled: function(name) {
|
|
/*global disabledFeatures*/
|
|
return !disabledFeatures[name];
|
|
},
|
|
|
|
/**
|
|
* Utility function, used to determine the identifier regex for the
|
|
* current language, by invoking {@link #getIdentifierRegex} on its handlers.
|
|
*
|
|
* Should not be overridden by inheritors.
|
|
*
|
|
* @deprecated Use worker_util#getIdentifierRegex instead
|
|
*
|
|
* @return {RegExp}
|
|
*/
|
|
$getIdentifierRegex: function() {
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Utility function, used to retrigger completion,
|
|
* in case new information was collected and should
|
|
* be displayed, and assuming the popup is still open.
|
|
*
|
|
* Should not be overridden by inheritors.
|
|
*
|
|
* @deprecated Use worker_util#completeUpdate instead
|
|
*
|
|
* @param {Object} pos The position to retrigger this update
|
|
* @param {String} line The line that this update was triggered for
|
|
*/
|
|
completeUpdate: function(pos) {
|
|
throw new Error("Use worker_util.completeUpdate instead()"); // implemented by worker.completeUpdate
|
|
},
|
|
|
|
// OVERRIDABLE ACCESORS
|
|
|
|
/**
|
|
* Returns whether this language handler should be enabled for the given
|
|
* file.
|
|
*
|
|
* Must be overridden by inheritors.
|
|
*
|
|
* @param {String} language to check the handler against
|
|
* @return {Boolean}
|
|
*/
|
|
handlesLanguage: function(language) {
|
|
throw new Error("base_handler.handlesLanguage() is not overridden");
|
|
},
|
|
|
|
/**
|
|
* Returns whether this language handler should be used in a
|
|
* particular kind of editor.
|
|
*
|
|
* May be overridden by inheritors; returns {@link #HANDLES_EDITOR}
|
|
* by default.
|
|
*
|
|
* @return {Number} One of {@link #HANDLES_EDITOR},
|
|
* {@link #HANDLES_IMMEDIATE}, or
|
|
* {@link #HANDLES_EDITOR_AND_IMMEDIATE}, or
|
|
* {@link #HANDLES_ANY}.
|
|
*/
|
|
handlesEditor: function() {
|
|
return this.HANDLES_EDITOR;
|
|
},
|
|
|
|
/**
|
|
* Returns the maximum file size this language handler supports.
|
|
* Should return Infinity if size does not matter.
|
|
* Default is 10.000 lines of 80 characters.
|
|
*
|
|
* May be overridden by inheritors.
|
|
*
|
|
* @return {Number}
|
|
*/
|
|
getMaxFileSizeSupported: function() {
|
|
// Moderately conservative default (well, still 800K)
|
|
return 10 * 1000 * 80;
|
|
},
|
|
|
|
/**
|
|
* Determine if the language component supports parsing.
|
|
* Assumed to be true if at least one hander for the language reports true.
|
|
*
|
|
* Should be overridden by inheritors.
|
|
*
|
|
* @return {Boolean}
|
|
*/
|
|
isParsingSupported: function() {
|
|
return false;
|
|
},
|
|
|
|
/**
|
|
* Returns a regular expression for identifiers in the handler's language.
|
|
* If not specified, /[A-Za-z0-9$_]/ is used.
|
|
*
|
|
* Note: to indicate dollars are allowed at the start of identifiers
|
|
* (like with php $variables), include '$$'' in the regex, e.g.
|
|
* /[A-Z0-9$$_]/.
|
|
*
|
|
* Should be overridden by inheritors that implement code completion.
|
|
*
|
|
* @return RegExp
|
|
*/
|
|
getIdentifierRegex: function() {
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Returns a regular expression used to trigger code completion.
|
|
* If a non-null value is returned, it is assumed continous completion
|
|
* is supported for this language.
|
|
*
|
|
* As an example, Java-like languages might want to use: /^\.$/
|
|
*
|
|
* Should be overridden by inheritors that implement code completion.
|
|
* Default implementation returns null.
|
|
*
|
|
* @return RegExp
|
|
*/
|
|
getCompletionRegex: function() {
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Returns a regular expression used to trigger a tooltip.
|
|
* Normally, tooltips after a scheduled analysis has been completed.
|
|
* To avoid delays, this function can be used to trigger
|
|
* analysis & tooltip fetching early.
|
|
*
|
|
* Should be overridden by inheritors that implement tooltips.
|
|
* Default implementation returns null.
|
|
*
|
|
* @return RegExp
|
|
*/
|
|
getTooltipRegex: function() {
|
|
return null;
|
|
},
|
|
|
|
// PARSING AND ABSTRACT SYNTAX CALLBACKS
|
|
|
|
/**
|
|
* Parses the given document.
|
|
*
|
|
* Should be overridden by inheritors that implement parsing
|
|
* (which is, like all features here, optional).
|
|
*
|
|
* @param value {String} the source the document to analyze
|
|
* @return {Object} an abstract syntax tree (of any type), or null if not implemented
|
|
*/
|
|
parse: function(value, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Finds a tree node at a certain row and column,
|
|
* e.g. using the findNode(pos) function of treehugger.
|
|
*
|
|
* Should be overridden by inheritors that implement parsing.
|
|
*
|
|
* @param {Object} ast An abstract syntax tree object from {@link #parse}
|
|
* @param {Object} pos The position of the node to look up
|
|
* @param {Number} pos.row The position's row
|
|
* @param {Number} pos.column The position's column
|
|
* @param {Function} callback The callback for the result
|
|
* @param {Object} [callback.result] The found node
|
|
*/
|
|
findNode: function(ast, pos, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Returns the a tree node at a certain row and col,
|
|
* e.g. using the node.getPos() function of treehugger.
|
|
*
|
|
* Should be overridden by inheritors that implement parsing.
|
|
*
|
|
* @param {Object} node The node to look up
|
|
* @param {Function} callback The callback for the result
|
|
* @param {Object} [callback.result] The resulting position
|
|
* @param {Number} callback.result.sl The starting line
|
|
* @param {Number} callback.result.el The ending line
|
|
* @param {Number} callback.result.sc The starting column
|
|
* @param {Number} callback.result.ec The ending column
|
|
*/
|
|
getPos: function(node, callback) {
|
|
callback();
|
|
},
|
|
|
|
// OTHER CALLBACKS
|
|
|
|
/**
|
|
* Initialize this language handler.
|
|
*
|
|
* May be overridden by inheritors.
|
|
*
|
|
* @param callback The callback; must be called
|
|
*/
|
|
init: function(callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Invoked when the document has been updated (possibly after a certain delay)
|
|
*
|
|
* May be overridden by inheritors.
|
|
*
|
|
* @param {Document} doc The current document
|
|
* @param {Function} callback The callback; must be called
|
|
*/
|
|
onUpdate: function(doc, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Invoked when a new document has been opened.
|
|
*
|
|
* May be overridden by inheritors.
|
|
*
|
|
* @param {String} path The path of the newly opened document
|
|
* @param {String} doc The Document object representing the source
|
|
* @param {String} oldPath The path of the document that was active before
|
|
* @param {Function} callback The callback; must be called
|
|
*/
|
|
onDocumentOpen: function(path, doc, oldPath, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Invoked when a document is closed in the IDE.
|
|
*
|
|
* May be overridden by inheritors.
|
|
*
|
|
* @param {String} path the path of the file
|
|
* @param {Function} callback The callback; must be called
|
|
*/
|
|
onDocumentClose: function(path, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Invoked when the cursor has been moved.
|
|
*
|
|
* May be overridden by inheritors that immediately act upon cursor moves.
|
|
*
|
|
* See {@link #tooltip} and {@link #highlightOccurrences}
|
|
* for handler functions that are invoked after the cursor has been moved,
|
|
* the document has been analyzed, and feedback is requested.
|
|
*
|
|
* @param {Document} doc Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if parsed already, otherwise null)
|
|
* @param {Object} cursorPos The current cursor position
|
|
* @param {Number} cursorPos.row The current cursor's row
|
|
* @param {Number} cursorPos.column The current cursor's column
|
|
* @param {Object} currentNode The AST node the cursor is currently at (if parsed alreadty, and if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @paran {Object} callback.result An optional result. Supports the same result objects as
|
|
* {@link #tooltip} and {@link #highlightOccurrences}
|
|
*/
|
|
onCursorMove: function(doc, fullAst, cursorPos, currentNode, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Invoked when the cursor has been moved inside to a different AST node.
|
|
* Gets a tooltip to display when the cursor is moved to a particular location.
|
|
*
|
|
* Should be overridden by inheritors that implement tooltips.
|
|
*
|
|
* @param {Document} doc Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Object} cursorPos The current cursor position
|
|
* @param {Number} cursorPos.row The current cursor's row
|
|
* @param {Number} cursorPos.column The current cursor's column
|
|
* @param {Object} currentNode The AST node the cursor is currently at (if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result
|
|
* @param {Object|String} callback.result.hint An object or HTML string with the tooltip to display
|
|
* @param {Object[]} [callback.result.signatures] One or more function signatures to show
|
|
* @param {String} callback.result.signatures.name Function name
|
|
* @param {String} [callback.result.signatures.doc] Function documentation
|
|
* @param {Object[]} callback.result.signatures.parameters
|
|
* Function parameters
|
|
* @param {String} callback.result.signatures.parameters.name
|
|
* Parameter name
|
|
* @param {String} [callback.result.signatures.parameters.type]
|
|
* Parameter type
|
|
* @param {String} [callback.result.signatures.parameters.doc]
|
|
* Parameter documentation
|
|
* @param {String} [callback.result.signatures.returnType]
|
|
* The function return type
|
|
* @param {Object} callback.result.pos The position range for which this tooltip is valid
|
|
* @param {Number} callback.result.pos.sl The starting line
|
|
* @param {Number} callback.result.pos.el The ending line
|
|
* @param {Number} callback.result.pos.sc The starting column
|
|
* @param {Number} callback.result.pos.ec The ending column
|
|
* @param {Object} [callback.result.displayPos] The position to display this tooltip
|
|
* @param {Number} [callback.result.displayPos.row] The display position's row
|
|
* @param {Number} [callback.result.displayPos.column] The display position's column
|
|
*/
|
|
tooltip: function(doc, fullAst, cursorPos, currentNode, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Gets the instances to highlight when the cursor is moved to a particular location.
|
|
*
|
|
* Should be overridden by inheritors that implement occurrence highlighting.
|
|
*
|
|
* @param {Document} doc Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Object} cursorPos The current cursor position
|
|
* @param {Number} cursorPos.row The current cursor's row
|
|
* @param {Number} cursorPos.column The current cursor's column
|
|
* @param {Object} currentNode The AST node the cursor is currently at (if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result
|
|
* @param {Object[]} [callback.result.markers] The occurrences to highlight
|
|
* @param {Object} callback.result.markers.pos The marker's position
|
|
* @param {Number} callback.result.markers.pos.sl The starting line
|
|
* @param {Number} callback.result.markers.pos.el The ending line
|
|
* @param {Number} callback.result.markers.pos.sc The starting column
|
|
* @param {Number} callback.result.markers.pos.ec The ending column
|
|
* @param {Boolean} callback.result.isGeneric Indicates this is generic highlighting and should be deferred
|
|
* @param {"occurrence_other"|"occurrence_main"} callback.result.markers.type
|
|
* The type of occurrence: the main one, or any other one.
|
|
*/
|
|
highlightOccurrences: function(doc, fullAst, cursorPos, currentNode, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Determines what refactorings to enable when the cursor is moved to a particular location.
|
|
*
|
|
* Should be overridden by inheritors that implement refactorings.
|
|
*
|
|
* @param {Document} doc Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Object} cursorPos The current cursor position
|
|
* @param {Number} cursorPos.row The current cursor's row
|
|
* @param {Number} cursorPos.column The current cursor's column
|
|
* @param {Object} currentNode The AST node the cursor is currently at (if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result
|
|
* @param {String[]} callback.result.refactorings
|
|
* The refactorings to enable, such as "rename"
|
|
* @param {String[]} [callback.result.isGeneric]
|
|
* Whether is a generic answer and should be deferred
|
|
*/
|
|
getRefactorings: function(doc, fullAst, cursorPos, currentNode, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Constructs an outline.
|
|
*
|
|
* Example outline object:
|
|
*
|
|
* {
|
|
* icon: 'method',
|
|
* name: "fooMethod",
|
|
* pos: this.getPos(),
|
|
* displayPos: { sl: 15, sc: 20 },
|
|
* items: [ ...items nested under this method... ],
|
|
* isUnordered: true
|
|
* }
|
|
*
|
|
* Should be overridden by inheritors that implement an outline.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result, a JSON outline structure or null if not supported
|
|
* @param {"event"|"method"|"method2"|"package"|"property"|"property2"|"unknown"|"unknown2"} callback.result.icon
|
|
* The icon to display for the first outline item
|
|
* @param {String} callback.result.name The name to display for the first outline item
|
|
* @param {Object} callback.result.pos The item's range, e.g. the full visible range of a method
|
|
* @param {Number} callback.result.pos.sl The item's starting row
|
|
* @param {Number} [callback.result.pos.el] The item's ending row
|
|
* @param {Number} [callback.result.pos.sc] The item's starting column
|
|
* @param {Number} [callback.result.pos.ec] The item's ending column
|
|
* @param {Object} [callback.result.displayPos] The item's position of the text to select when it's picked from the outline
|
|
* @param {Number} callback.result.displayPos.sl The item's starting row
|
|
* @param {Number} [callback.result.displayPos.el] The item's ending row
|
|
* @param {Number} [callback.result.displayPos.sc] The item's starting column
|
|
* @param {Number} [callback.result.displayPos.ec] The item's ending column
|
|
* @param {Object[]} callback.result.items Any items nested under the curent item.
|
|
* @param {Boolean} [callback.result.isGeneric] Indicates that this is a generic, language-independent outline
|
|
* @param {Boolean} [callback.result.isUnordered] Indicates the outline is not ordered by appearance of the items,
|
|
* but that they're e.g. grouped as methods, properties, etc.
|
|
*/
|
|
outline: function(doc, fullAst, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Constructs a hierarchy.
|
|
*
|
|
* Should be overridden by inheritors that implement a type hierarchy.
|
|
*
|
|
* Not supported right now.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} cursorPos The current cursor position
|
|
* @param {Number} cursorPos.row The current cursor's row
|
|
* @param {Number} cursorPos.column The current cursor's column
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result A JSON hierarchy structure or null if not supported
|
|
*/
|
|
hierarchy: function(doc, cursorPos, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Performs code completion for the user based on the current cursor position.
|
|
*
|
|
* Should be overridden by inheritors that implement code completion.
|
|
*
|
|
* Example completion result:
|
|
* {
|
|
* name : "foo()",
|
|
* replaceText : "foo()",
|
|
* icon : "method",
|
|
* meta : "FooClass",
|
|
* doc : "The foo() method",
|
|
* docHead : "FooClass.foo",
|
|
* priority : 1
|
|
* };
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Object} pos The current cursor position
|
|
* @param {Number} pos.row The current cursor's row
|
|
* @param {Number} pos.column The current cursor's column
|
|
* @param {Object} currentNode The AST node the cursor is currently at (if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result, an array of completion matches
|
|
* @param {String} callback.result.name The full name to show in the completion popup
|
|
* @param {String} [callback.result.id] The short name that identifies this completion
|
|
* @param {String} callback.result.replaceText
|
|
* The text to replace the selection with
|
|
* @param {"event"|"method"|"method2"|"package"|"property"|"property2"|"unknown"|"unknown2"}
|
|
* [callback.result.icon]
|
|
* The icon to use
|
|
* @param {String} callback.result.meta Additional information to show
|
|
* @param {String} callback.result.doc Documentation to display
|
|
* @param {String} callback.result.docHead
|
|
* Documentation heading to display
|
|
* @param {Number} callback.result.priority
|
|
* Priority of this completion suggestion
|
|
* @param {Boolean} callback.result.isGeneric
|
|
* Indicates that this is a generic, language-independent
|
|
* suggestion
|
|
* @param {Boolean} callback.result.isContextual
|
|
* Indicates that this is a contextual completion,
|
|
* and that any generic completions should not be shown
|
|
*/
|
|
complete: function(doc, fullAst, pos, currentNode, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Analyzes an AST or file and annotates it as desired.
|
|
*
|
|
* Example of an annotation to return:
|
|
*
|
|
* {
|
|
* pos: { sl: 1, el: 1, sc: 4, ec: 5 },
|
|
* type: "warning",
|
|
* message: "Assigning to undeclared variable."
|
|
* }
|
|
*
|
|
* Should be overridden by inheritors that implement analysis.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result, an array of error and warning markers
|
|
* @param {Boolean} [minimalAnalysis] Fast, minimal analysis is requested, e.g.
|
|
* for code completion or tooltips.
|
|
*/
|
|
analyze: function(value, fullAst, callback, minimalAnalysis) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Gets all positions to select for a rename refactoring.
|
|
*
|
|
* Example result, renaming a 3-character identfier
|
|
* on line 10 that also occurs on line 11 and 12:
|
|
*
|
|
* {
|
|
* length: 3,
|
|
* pos: {
|
|
* row: 10,
|
|
* column: 5
|
|
* },
|
|
* others: [
|
|
* { row: 11, column: 5 },
|
|
* { row: 12, column: 5 }
|
|
* ]
|
|
* }
|
|
*
|
|
* Must be overridden by inheritors that implement rename refactoring.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} ast The entire AST of the current file (if any)
|
|
* @param {Object} pos The current cursor position
|
|
* @param {Number} pos.row The current cursor's row
|
|
* @param {Number} pos.column The current cursor's column
|
|
* @param {Object} currentNode The AST node the cursor is currently at (if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result (see function description).
|
|
* @param {Boolean} callback.result.isGeneric Indicates this is a generic refactoring and should be deferred.
|
|
* @param {Boolean} callback.result.length The lenght of the rename identifier
|
|
* @param {Object} callback.result.pos The position of the current identifier
|
|
* @param {Number} callback.result.pos.row The row of the current identifier
|
|
* @param {Number} callback.result.pos.column The column of the current identifier
|
|
* @param {Object[]} callback.result.others The positions of other identifiers to be renamed
|
|
* @param {Number} callback.result.others.row The row of another identifier to be renamed
|
|
* @param {Number} callback.result.others.column The column of another identifier to be renamed
|
|
*/
|
|
getRenamePositions: function(doc, ast, pos, currentNode, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Invoked when refactoring is started.
|
|
*
|
|
* May be overridden by inheritors that implement rename refactoring.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Function} callback The callback; must be called
|
|
*/
|
|
onRenameBegin: function(doc, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Confirms that a rename refactoring is valid, before committing it.
|
|
*
|
|
* May be overridden by inheritors that implement rename refactoring.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} oldId The old identifier was being renamed
|
|
* @param {Number} oldId.row The row of the identifier that was being renamed
|
|
* @param {Number} oldId.column The column of the identifier that was being renamed
|
|
* @param {String} oldId.value The value of the identifier that was being renamed
|
|
* @param {String} newName The new name of the element after refactoring
|
|
* @param {Boolean} isGeneric True if this was a refactoring marked with 'isGeneric' (see {@link #getRenamePositions})
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {String} callback.err Null if the refactoring can be committed, or an error message if refactoring failed
|
|
*/
|
|
commitRename: function(doc, oldName, newName, isGeneric, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Invoked when a refactor request is cancelled
|
|
*
|
|
* May be overridden by inheritors that implement rename refactoring.
|
|
*
|
|
* @param {Function} callback The callback; must be called
|
|
*/
|
|
onRenameCancel: function(callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Performs code formatting.
|
|
*
|
|
* Should be overridden by inheritors that implement code formatting.
|
|
*
|
|
* @param {Document} doc the Document object representing the source
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result
|
|
* @return a string value representing the new source code after formatting or null if not supported
|
|
*/
|
|
codeFormat: function(doc, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Performs jumping to a definition.
|
|
*
|
|
* Should be overridden by inheritors that implement jump to definition.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Object} pos The current cursor position
|
|
* @param {Number} pos.row The current cursor's row
|
|
* @param {Number} pos.column The current cursor's column
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object[]} callback.results The results
|
|
* @param {String} [callback.results.path]
|
|
* The result path
|
|
* @param {Number} [callback.results.row]
|
|
* The result row
|
|
* @param {Number} [callback.results.column]
|
|
* The result column
|
|
* @param {"event"|"method"|"method2"|"package"|"property"|"property2"|"unknown"|"unknown2"} [callback.results.icon]
|
|
* The icon to display (in case of multiple results)
|
|
* @param {Boolean} [callback.results.isGeneric]
|
|
* Indicates that this is a generic, language-independent
|
|
* suggestion (that should be deferred)
|
|
*/
|
|
jumpToDefinition: function(doc, fullAst, pos, currentNode, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Gets marker resolutions for quick fixes.
|
|
*
|
|
* Must be overridden by inheritors that implement quick fixes.
|
|
*
|
|
* See {@link #hasResolution}.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Object} markers The markers to get resolutions for
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The function's result
|
|
* @return {language.MarkerResolution[]} Resulting resolutions.
|
|
*/
|
|
getResolutions: function(doc, fullAst, markers, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Determines if there are marker resolutions for quick fixes.
|
|
*
|
|
* Must be overridden by inheritors that implement quick fixes.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Boolean} callback.result There is at least one resolution
|
|
*/
|
|
hasResolution: function(doc, fullAst, marker, callback) {
|
|
callback();
|
|
},
|
|
|
|
/**
|
|
* Given the cursor position and the parsed node at that position,
|
|
* gets the string to send to the debugger for live inspect hovering.
|
|
*
|
|
* Should be overridden by inheritors that implement a debugger
|
|
* with live inspect. If not implemented, the string value based on
|
|
* currentNode's position is used.
|
|
*
|
|
* @param {Document} doc The Document object representing the source
|
|
* @param {Object} fullAst The entire AST of the current file (if any)
|
|
* @param {Object} pos The current cursor position
|
|
* @param {Number} pos.row The current cursor's row
|
|
* @param {Number} pos.column The current cursor's column
|
|
* @param {Function} callback The callback; must be called
|
|
* @param {Object} callback.result The resulting expression
|
|
* @param {String} callback.result.value The string representation of the expression to inspect
|
|
* @param {Object} callback.result.pos The expression's position
|
|
* @param {Number} callback.result.pos.sl The expression's starting row
|
|
* @param {Number} callback.result.pos.el The expression's ending row
|
|
* @param {Number} callback.result.pos.sc The expression's starting column
|
|
* @param {Number} callback.result.pos.ec The expression's ending column
|
|
*/
|
|
getInspectExpression: function(doc, fullAst, pos, currentNode, callback) {
|
|
callback();
|
|
}
|
|
};
|
|
|
|
// Mark all abstract/builtin methods for later optimization
|
|
for (f in module.exports) {
|
|
if (typeof module.exports[f] === "function")
|
|
module.exports[f].base_handler = true;
|
|
}
|
|
|
|
});
|