Commit b3ccc483 authored by semeny@google.com's avatar semeny@google.com

DevTools: [Documentation] Add property token autodetection

Now documentation context menu item appears without token selection.

BUG=391593

Review URL: https://codereview.chromium.org/471583003

git-svn-id: svn://svn.chromium.org/blink/trunk@180362 bbb929c8-8fbe-4397-9dbb-9b2b20218538
parent b96c01fd
...@@ -38,10 +38,15 @@ WebInspector.DocumentationURLProvider._sources = [ ...@@ -38,10 +38,15 @@ WebInspector.DocumentationURLProvider._sources = [
*/ */
WebInspector.DocumentationURLProvider._urlFormat = "http://docs.webplatform.org/w/api.php?action=query&titles=%s%s&prop=revisions&rvprop=timestamp|content&format=json" WebInspector.DocumentationURLProvider._urlFormat = "http://docs.webplatform.org/w/api.php?action=query&titles=%s%s&prop=revisions&rvprop=timestamp|content&format=json"
/**
* @typedef {{url: string, name: string, searchItem: string}}
*/
WebInspector.DocumentationURLProvider.ItemDescriptor;
WebInspector.DocumentationURLProvider.prototype = { WebInspector.DocumentationURLProvider.prototype = {
/** /**
* @param {string} searchTerm * @param {string} searchTerm
* @return {!Array.<{url: string, name: string}>} * @return {!Array.<!WebInspector.DocumentationURLProvider.ItemDescriptor>}
*/ */
itemDescriptors: function(searchTerm) itemDescriptors: function(searchTerm)
{ {
...@@ -56,13 +61,14 @@ WebInspector.DocumentationURLProvider.prototype = { ...@@ -56,13 +61,14 @@ WebInspector.DocumentationURLProvider.prototype = {
/** /**
* @param {string} searchTerm * @param {string} searchTerm
* @return {{url: string, name: string}} * @return {!WebInspector.DocumentationURLProvider.ItemDescriptor}
*/ */
function createDescriptor(searchTerm) function createDescriptor(searchTerm)
{ {
return { return {
url: String.sprintf(WebInspector.DocumentationURLProvider._urlFormat, sourceRef.url, searchTerm), url: String.sprintf(WebInspector.DocumentationURLProvider._urlFormat, sourceRef.url, searchTerm),
name: sourceRef.name name: sourceRef.name,
searchItem: searchTerm
}; };
} }
} }
......
...@@ -45,21 +45,52 @@ WebInspector.DocumentationView.ContextMenuProvider.prototype = { ...@@ -45,21 +45,52 @@ WebInspector.DocumentationView.ContextMenuProvider.prototype = {
if (!(target instanceof WebInspector.CodeMirrorTextEditor)) if (!(target instanceof WebInspector.CodeMirrorTextEditor))
return; return;
var textEditor = /** @type {!WebInspector.CodeMirrorTextEditor} */ (target); var textEditor = /** @type {!WebInspector.CodeMirrorTextEditor} */ (target);
var selection = textEditor.selection(); var descriptors = this._determineDescriptors(textEditor);
if (!selection || selection.isEmpty() || selection.startLine !== selection.endLine)
return;
var selectedText = textEditor.copyRange(selection);
var urlProvider = new WebInspector.DocumentationURLProvider();
var descriptors = urlProvider.itemDescriptors(selectedText);
if (!descriptors.length) if (!descriptors.length)
return; return;
if (descriptors.length === 1) { if (descriptors.length === 1) {
var formatString = WebInspector.useLowerCaseMenuTitles() ? "Show documentation for %s.%s" : "Show Documentation for %s.%s"; var formatString = WebInspector.useLowerCaseMenuTitles() ? "Show documentation for %s.%s" : "Show Documentation for %s.%s";
contextMenu.appendItem(WebInspector.UIString(formatString, descriptors[0].name, selectedText), WebInspector.DocumentationView.showDocumentationURL.bind(null, descriptors[0].url)); contextMenu.appendItem(WebInspector.UIString(formatString, descriptors[0].name, descriptors[0].searchItem), WebInspector.DocumentationView.showDocumentationURL.bind(null, descriptors[0].url));
return; return;
} }
var subMenuItem = contextMenu.appendSubMenuItem(WebInspector.UIString(WebInspector.useLowerCaseMenuTitles() ? "Show documentation for..." : "Show Documentation for...")); var subMenuItem = contextMenu.appendSubMenuItem(WebInspector.UIString(WebInspector.useLowerCaseMenuTitles() ? "Show documentation for..." : "Show Documentation for..."));
for (var i = 0; i < descriptors.length; ++i) for (var i = 0; i < descriptors.length; ++i)
subMenuItem.appendItem(String.sprintf("%s.%s", descriptors[i].name, selectedText), WebInspector.DocumentationView.showDocumentationURL.bind(null, descriptors[i].url)); subMenuItem.appendItem(String.sprintf("%s.%s", descriptors[i].name, descriptors[i].searchItem), WebInspector.DocumentationView.showDocumentationURL.bind(null, descriptors[i].url));
},
/**
* @param {!WebInspector.CodeMirrorTextEditor} textEditor
* @return {!Array.<!WebInspector.DocumentationURLProvider.ItemDescriptor>}
*/
_determineDescriptors: function(textEditor)
{
var urlProvider = new WebInspector.DocumentationURLProvider();
var textSelection = textEditor.selection().normalize();
if (!textSelection.isEmpty()) {
if (textSelection.startLine !== textSelection.endLine)
return [];
return urlProvider.itemDescriptors(textEditor.copyRange(textSelection));
}
var descriptors = computeDescriptors(textSelection.startColumn);
if (descriptors.length)
return descriptors;
return computeDescriptors(textSelection.startColumn - 1);
/**
* @param {number} column
* @return {!Array.<!WebInspector.DocumentationURLProvider.ItemDescriptor>}
*/
function computeDescriptors(column)
{
var token = textEditor.tokenAtTextPosition(textSelection.startLine, column);
if (!token)
return [];
var tokenText = textEditor.line(textSelection.startLine).substring(token.startColumn, token.endColumn);
return urlProvider.itemDescriptors(tokenText);
}
} }
} }
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment