From f07e1154ef81a08927f4bfa26e622e3a019670f4 Mon Sep 17 00:00:00 2001 From: Geequlim Date: Tue, 8 Oct 2019 19:34:47 +0800 Subject: [PATCH] Improve native documentation webview renderer Make prism as a custom lib instead of node module to reduce the binary size --- package.json | 1 - src/deps/prism/prism.js | 573 +++++++++++++++++++++++++++++++ src/lsp/NativeDocumentManager.ts | 27 +- tsconfig.json | 6 +- 4 files changed, 593 insertions(+), 14 deletions(-) create mode 100644 src/deps/prism/prism.js diff --git a/package.json b/package.json index 376b537..be1f763 100644 --- a/package.json +++ b/package.json @@ -108,7 +108,6 @@ "dependencies": { "global": "^4.4.0", "marked": "^0.7.0", - "prismjs": "^1.17.1", "vscode-languageclient": "^5.2.1", "ws": "^7.0.0" } diff --git a/src/deps/prism/prism.js b/src/deps/prism/prism.js new file mode 100644 index 0000000..190cce5 --- /dev/null +++ b/src/deps/prism/prism.js @@ -0,0 +1,573 @@ +/* PrismJS 1.17.1 +https://prismjs.com/download.html#themes=prism */ +var _self = (typeof window !== 'undefined') + ? window // if in browser + : ( + (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) + ? self // if in worker + : {} // if in node js + ); + +/** + * Prism: Lightweight, robust, elegant syntax highlighting + * MIT license http://www.opensource.org/licenses/mit-license.php/ + * @author Lea Verou http://lea.verou.me + */ + +var Prism = (function (_self){ + +// Private helper vars +var lang = /\blang(?:uage)?-([\w-]+)\b/i; +var uniqueId = 0; + +/** + * Returns the Prism language of the given element set by a `language-xxxx` or `lang-xxxx` class. + * + * If no language is set for the element or the element is `null` or `undefined`, `none` will be returned. + * + * @param {Element} element + * @returns {string} + */ +function getLanguage(element) { + while (element && !lang.test(element.className)) { + element = element.parentNode; + } + if (element) { + return (element.className.match(lang) || [, 'none'])[1].toLowerCase(); + } + return 'none'; +} + + +var _ = { + manual: _self.Prism && _self.Prism.manual, + disableWorkerMessageHandler: _self.Prism && _self.Prism.disableWorkerMessageHandler, + util: { + encode: function (tokens) { + if (tokens instanceof Token) { + return new Token(tokens.type, _.util.encode(tokens.content), tokens.alias); + } else if (Array.isArray(tokens)) { + return tokens.map(_.util.encode); + } else { + return tokens.replace(/&/g, '&').replace(/ text.length) { + // Something went terribly wrong, ABORT, ABORT! + return; + } + + if (str instanceof Token) { + continue; + } + + if (greedy && i != strarr.length - 1) { + pattern.lastIndex = pos; + var match = pattern.exec(text); + if (!match) { + break; + } + + var from = match.index + (lookbehind && match[1] ? match[1].length : 0), + to = match.index + match[0].length, + k = i, + p = pos; + + for (var len = strarr.length; k < len && (p < to || (!strarr[k].type && !strarr[k - 1].greedy)); ++k) { + p += strarr[k].length; + // Move the index i to the element in strarr that is closest to from + if (from >= p) { + ++i; + pos = p; + } + } + + // If strarr[i] is a Token, then the match starts inside another Token, which is invalid + if (strarr[i] instanceof Token) { + continue; + } + + // Number of tokens to delete and replace with the new match + delNum = k - i; + str = text.slice(pos, p); + match.index -= pos; + } else { + pattern.lastIndex = 0; + + var match = pattern.exec(str), + delNum = 1; + } + + if (!match) { + if (oneshot) { + break; + } + + continue; + } + + if(lookbehind) { + lookbehindLength = match[1] ? match[1].length : 0; + } + + var from = match.index + lookbehindLength, + match = match[0].slice(lookbehindLength), + to = from + match.length, + before = str.slice(0, from), + after = str.slice(to); + + var args = [i, delNum]; + + if (before) { + ++i; + pos += before.length; + args.push(before); + } + + var wrapped = new Token(token, inside? _.tokenize(match, inside) : match, alias, match, greedy); + + args.push(wrapped); + + if (after) { + args.push(after); + } + + Array.prototype.splice.apply(strarr, args); + + if (delNum != 1) + _.matchGrammar(text, strarr, grammar, i, pos, true, token + ',' + j); + + if (oneshot) + break; + } + } + } + }, + + tokenize: function(text, grammar) { + var strarr = [text]; + + var rest = grammar.rest; + + if (rest) { + for (var token in rest) { + grammar[token] = rest[token]; + } + + delete grammar.rest; + } + + _.matchGrammar(text, strarr, grammar, 0, 0, false); + + return strarr; + }, + + hooks: { + all: {}, + + add: function (name, callback) { + var hooks = _.hooks.all; + + hooks[name] = hooks[name] || []; + + hooks[name].push(callback); + }, + + run: function (name, env) { + var callbacks = _.hooks.all[name]; + + if (!callbacks || !callbacks.length) { + return; + } + + for (var i=0, callback; callback = callbacks[i++];) { + callback(env); + } + } + }, + + Token: Token +}; + +_self.Prism = _; + +function Token(type, content, alias, matchedStr, greedy) { + this.type = type; + this.content = content; + this.alias = alias; + // Copy of the full string this token was created from + this.length = (matchedStr || '').length|0; + this.greedy = !!greedy; +} + +Token.stringify = function(o, language) { + if (typeof o == 'string') { + return o; + } + + if (Array.isArray(o)) { + return o.map(function(element) { + return Token.stringify(element, language); + }).join(''); + } + + var env = { + type: o.type, + content: Token.stringify(o.content, language), + tag: 'span', + classes: ['token', o.type], + attributes: {}, + language: language + }; + + if (o.alias) { + var aliases = Array.isArray(o.alias) ? o.alias : [o.alias]; + Array.prototype.push.apply(env.classes, aliases); + } + + _.hooks.run('wrap', env); + + var attributes = Object.keys(env.attributes).map(function(name) { + return name + '="' + (env.attributes[name] || '').replace(/"/g, '"') + '"'; + }).join(' '); + + return '<' + env.tag + ' class="' + env.classes.join(' ') + '"' + (attributes ? ' ' + attributes : '') + '>' + env.content + ''; +}; + +if (!_self.document) { + if (!_self.addEventListener) { + // in Node.js + return _; + } + + if (!_.disableWorkerMessageHandler) { + // In worker + _self.addEventListener('message', function (evt) { + var message = JSON.parse(evt.data), + lang = message.language, + code = message.code, + immediateClose = message.immediateClose; + + _self.postMessage(_.highlight(code, _.languages[lang], lang)); + if (immediateClose) { + _self.close(); + } + }, false); + } + + return _; +} + +//Get current script and highlight +var script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop(); + +if (script) { + _.filename = script.src; + + if (script.hasAttribute('data-manual')) { + _.manual = true; + } +} + +if (!_.manual) { + function highlightAutomaticallyCallback() { + if (!_.manual) { + _.highlightAll(); + } + } + + if(document.readyState !== 'loading') { + if (window.requestAnimationFrame) { + window.requestAnimationFrame(highlightAutomaticallyCallback); + } else { + window.setTimeout(highlightAutomaticallyCallback, 16); + } + } + else { + document.addEventListener('DOMContentLoaded', highlightAutomaticallyCallback); + } +} + +return _; + +})(_self); + +if (typeof module !== 'undefined' && module.exports) { + module.exports = Prism; +} + +// hack for components to work correctly in node.js +if (typeof global !== 'undefined') { + global.Prism = Prism; +} +; diff --git a/src/lsp/NativeDocumentManager.ts b/src/lsp/NativeDocumentManager.ts index 66cc47a..4e25ec1 100644 --- a/src/lsp/NativeDocumentManager.ts +++ b/src/lsp/NativeDocumentManager.ts @@ -3,14 +3,14 @@ import { EventEmitter } from "events"; import { MessageIO } from "./MessageIO"; import { NotificationMessage } from "vscode-jsonrpc"; import { DocumentSymbol } from "vscode"; -import * as Prism from "prismjs"; +import * as Prism from "../deps/prism/prism"; import * as marked from "marked"; marked.setOptions({ highlight: function (code, lang) { return Prism.highlight(code, GDScriptGrammar, lang); } }); - + const enum Methods { SHOW_NATIVE_SYMBOL = 'gdscript/show_native_symbol', INSPECT_NATIVE_SYMBOL = 'textDocument/nativeSymbol' @@ -120,17 +120,18 @@ export default class NativeDocumentManager extends EventEmitter { private make_symbol_document(symbol: GodotNativeSymbol): string { + const classlink = make_link(symbol.native_class, undefined); - function make_function_signature(s: GodotNativeSymbol) { + function make_function_signature(s: GodotNativeSymbol, with_class = false) { let parts = /\((.*)?\)\s*\-\>\s*(([A-z0-9]+)?)$/.exec(s.detail); if (!parts) return ""; const ret_type = make_link(parts[2] || "void", undefined); let args = (parts[1] || "").replace(/\:\s([A-z0-9_]+)(\,\s*)?/g, `: $1$2`); args = args.replace(/\s=\s(.*?)[\,\)]/g, "") - return `${ret_type} ${element("a", s.name, {href: `#${s.name}`})}( ${args} )`; + return `${ret_type} ${with_class?`${classlink}.`:''}${element("a", s.name, {href: `#${s.name}`})}( ${args} )`; }; - function make_symbol_elements(s: GodotNativeSymbol): {index?: string, body: string} { + function make_symbol_elements(s: GodotNativeSymbol, with_class = false): {index?: string, body: string} { switch (s.kind) { case vscode.SymbolKind.Property: case vscode.SymbolKind.Variable: { @@ -139,7 +140,7 @@ export default class NativeDocumentManager extends EventEmitter { if (!parts) return; let type = make_link(parts[2], undefined); let name = element("a", s.name, {href: `#${s.name}`}); - const title = element('h4', type + " " + s.name); + const title = element('h4', `${type} ${with_class?`${classlink}.`:''}${s.name}`); const doc = element("p", format_documentation(s.documentation, symbol.native_class)); const div = element("div", title + doc); return { @@ -156,7 +157,7 @@ export default class NativeDocumentManager extends EventEmitter { let name = parts[1]; let value = element('code', parts[4]); - const title = element('p', type + " " + name + " = " + value); + const title = element('p', `${type} ${with_class?`${classlink}.`:''}${name} = ${value}`); const doc = element("p", format_documentation(s.documentation, symbol.native_class)); const div = element("div", title + doc); return { @@ -167,7 +168,7 @@ export default class NativeDocumentManager extends EventEmitter { const parts = /\.([A-z0-9]+)\((.*)?\)/.exec(s.detail); if (!parts) return; const args = (parts[2] || "").replace(/\:\s([A-z0-9_]+)(\,\s*)?/g, `: $1$2`); - const title = element('p', `${s.name}( ${args} )`); + const title = element('p', `${with_class?`signal ${with_class?`${classlink}.`:''}`:''}${s.name}( ${args} )`); const doc = element("p", format_documentation(s.documentation, symbol.native_class)); const div = element("div", title + doc); return { @@ -176,7 +177,7 @@ export default class NativeDocumentManager extends EventEmitter { } break; case vscode.SymbolKind.Method: case vscode.SymbolKind.Function: { - const signature = make_function_signature(s); + const signature = make_function_signature(s, with_class); const title = element("h4", signature); const doc = element("p", format_documentation(s.documentation, symbol.native_class)); const div = element("div", title + doc); @@ -239,6 +240,8 @@ export default class NativeDocumentManager extends EventEmitter { doc += element('ul', block); } }; + + doc += element("p", format_documentation(symbol.documentation, symbol.native_class)); add_group("Properties", properties_index); add_group("Constants", constants); add_group("Signals", signals); @@ -251,9 +254,11 @@ export default class NativeDocumentManager extends EventEmitter { return doc; } else { let doc = ""; - const elements = make_symbol_elements(symbol); + const elements = make_symbol_elements(symbol, true); if (elements.index) { - doc += element("h2", elements.index); + if ([vscode.SymbolKind.Function, vscode.SymbolKind.Method].indexOf(symbol.kind) == -1) { + doc += element("h2", elements.index); + } } doc += element("div", elements.body); return doc; diff --git a/tsconfig.json b/tsconfig.json index 8ac63df..8ae7a3c 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -9,9 +9,11 @@ ], "sourceMap": true, "rootDir": "src", - "strict": false + "strict": false, + "allowJs": true }, "exclude": [ - "node_modules" + "node_modules", + "out" ] }