DevTools: Create TextEditor Interface around CodeMirrorTextEditor

third_party/WebKit/Source/devtools/front_end/ui/TextEditor.js

+/**
+ * @interface
+ */
+WebInspector.TextEditorFactory = function() { }
+
+WebInspector.TextEditorFactory.prototype = {
+    /**
+     * @param {!WebInspector.TextEditor.Options} options
+     * @return {!WebInspector.TextEditor}
+     */
+    createEditor: function(options) { }
+}
+
+/**
+ * @interface
+ */
+WebInspector.TextEditor = function()
+{
+}
+WebInspector.TextEditor.prototype = {
+
+    /**
+     * @return {!WebInspector.Widget}
+     */
+    widget: function() { },
+
+    /**
+     * @return {!WebInspector.TextRange}
+     */
+    range: function(){ },

[dgozman, 2016/08/26 19:03:24]

fullRange?

[einbinder, 2016/08/26 23:05:33]

Done.

+
+    /**
+     * @return {!WebInspector.TextRange}
+     */
+    selection: function() { },
+
+    /**
+     * @param {!WebInspector.TextRange} selection
+     */
+    setSelection: function(selection) { },
+
+    /**
+     * @param {!WebInspector.TextRange=} textRange
+     * @return {string}
+     */
+    text: function(textRange) { },
+
+    /**
+     * @param {string} text
+     */
+    setText: function(text) { },

[lushnikov, 2016/08/26 23:11:52]

nit: we can make this accept a range as a second optional parameter

[einbinder, 2016/08/27 02:20:04]

The editRange and setText functions seem similar to the user, but they have very
different side effects. For example, setText refreshes all the whitespace
settings and editRange fires an onTextChanged event to delegates.

+
+    /**
+     * @param {number} lineNumber
+     * @return {string}
+     */
+    line: function(lineNumber) { },
+
+    /**
+     * @param {function(!KeyboardEvent)} handler
+     */
+    onKeyDown: function(handler) { },

[dgozman, 2016/08/26 19:03:24]

addKeyDownHandler

[einbinder, 2016/08/26 23:05:33]

Done.

+
+    /**
+     * @param {?WebInspector.AutocompleteConfig} config
+     */
+    configureAutocomplete: function(config) { },
+
+    clearAutocomplete: function() { }

[dgozman, 2016/08/26 19:03:25]

What is this one?

[einbinder, 2016/08/26 23:05:33]

It clears the autocomplete, renamed from finishAutocomplete. Things that modify
a text editor often want to hide the suggestbox beforehand.

+}
+
+/**
+ * @typedef {{
+ *  bracketMatchingFlag: (string|undefined),

[dgozman, 2016/08/26 19:03:24]

What does this string mean? Is it actually an enum?

[einbinder, 2016/08/26 23:05:33]

Replaced above with WI.Setting.

+ *  lineNumbers: boolean,
+ *  lineWrapping: boolean,
+ *  mimeType: (string|undefined),
+ * }}
+ **/
+WebInspector.TextEditor.Options;
+
+/**
+ * @typedef {{
+ *     substituteRangeCallback: ((function(number, number):?WebInspector.TextRange)|undefined),
+ *     suggestionsCallback: ((function(!WebInspector.TextRange, !WebInspector.TextRange):?Promise.<!Array.<{title: string, className: (string|undefined)}>>)|undefined),

[dgozman, 2016/08/26 19:03:24]

Why not use SuggestBox.Suggestions (or how it's called now)?

[einbinder, 2016/08/26 23:05:33]

Closure yelled at me a lot and I gave up trying to use the typedef.

+ *     isWordChar: ((function(string):boolean)|undefined),
+ * }}
+ **/
+WebInspector.AutocompleteConfig;