authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2019-10-07 13:57:01-04:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2019-10-07 13:57:01-04:00
log9237461b24664ecf12546b87530952f49f0e1166
tree8f6c146b20600edf887c531b8f5e901620c9b912
parent2ccb48ddc3f3b543bca0538da948013447afe429
signaturelock-open Commit is signed but in an unrecognized format.

generated docs: logo and basic search proof of concept

2 files changed, 139 insertions(+), 21 deletions(-)

lib/std/special/docs/index.html+15
......@@ -20,6 +20,7 @@
2020 font-size:1em;
2121 background-color:#F5F5F5;
2222 padding:1em;
23 overflow-x: auto;
2324 }
2425 #listNav {
2526 list-style-type: none;
......@@ -45,6 +46,16 @@
4546 background-color: #4CAF50;
4647 }
4748
49 #logo {
50 width: 5em;
51 float: left;
52 padding: 0 1em 0 0;
53 }
54
55 #search {
56 width: 90%;
57 }
58
4859 @media (prefers-color-scheme: dark) {
4960 body{
5061 background-color: #111;
......@@ -60,12 +71,16 @@
6071 </style>
6172 </head>
6273 <body>
74 <img alt="ZIG" id="logo" src="data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCAxNTAgMTAwIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjxnIGZpbGw9IiNmN2E0MWQiPjxwYXRoIGQ9Im0wIDEwdjgwaDE5bDYtMTAgMTItMTBoLTE3di00MGgxNXYtMjB6bTQwIDB2MjBoNjJ2LTIwem05MSAwLTYgMTAtMTIgMTBoMTd2NDBoLTE1djIwaDM1di04MHptLTgzIDYwdjIwaDYydi0yMHoiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwYXRoIGQ9Im0zNyA3MC0xOCAyMHYtMTV6Ii8+PHBhdGggZD0ibTExMyAzMCAxOC0yMHYxNXoiLz48cGF0aCBkPSJtOTYuOTggMTAuNjMgMzYuMjgtMTAuNC04MC4yOSA4OS4xNy0zNi4yOCAxMC40eiIvPjwvZz48L3N2Zz4K"></img>
75 <input type="search" id="search" autocomplete="off" spellcheck="false" placeholder="`s` to search, `?` to see more options">
6376 <p id="status">Loading...</p>
6477 <div id="sectNav" class="hidden"><ul id="listNav"></ul></div>
6578 <div id="fnProto" class="hidden">
6679 <pre id="fnProtoCode"></pre>
6780 </div>
6881 <div id="fnDocs" class="hidden"></div>
82 <div id="sectSearchResults" class="hidden"><ul id="listSearchResults"></ul></div>
83 <div id="sectSearchNoResults" class="hidden"><p>No search results.</p></div>
6984 <div id="sectPkgs" class="hidden">
7085 <h2>Packages</h2>
7186 <ul id="listPkgs">
lib/std/special/docs/main.js+124-21
......@@ -11,6 +11,13 @@
1111 var domFnProto = document.getElementById("fnProto");
1212 var domFnProtoCode = document.getElementById("fnProtoCode");
1313 var domFnDocs = document.getElementById("fnDocs");
14 var domSearch = document.getElementById("search");
15 var domSectSearchResults = document.getElementById("sectSearchResults");
16 var domListSearchResults = document.getElementById("listSearchResults");
17 var domSectSearchNoResults = document.getElementById("sectSearchNoResults");
18
19 var searchTimer = null;
20 var escapeHtmlReplacements = { "&": "&amp;", '"': "&quot;", "<": "&lt;", ">": "&gt;" };
1421
1522 var typeKindTypeId;
1623 var typeKindFnId;
......@@ -31,10 +38,13 @@
3138 // these will be all types, except the last one may be a type or a decl
3239 declObjs: [],
3340 };
41 var curNavSearch = "";
3442
3543 var rootIsStd = detectRootIsStd();
3644 var typeTypeId = findTypeTypeId();
45 domSearch.addEventListener('keydown', onSearchKeyDown, false);
3746 window.addEventListener('hashchange', onHashChange, false);
47 window.addEventListener('keydown', onWindowKeyDown, false);
3848 onHashChange();
3949
4050 function renderTitle() {
......@@ -58,10 +68,14 @@
5868 domSectPkgs.classList.add("hidden");
5969 domSectTypes.classList.add("hidden");
6070 domSectFns.classList.add("hidden");
61
71 domSectSearchResults.classList.add("hidden");
6272
6373 renderTitle();
6474
75 if (curNavSearch !== "") {
76 return renderSearch();
77 }
78
6579 var pkg = zigAnalysis.packages[zigAnalysis.rootPkg];
6680 curNav.pkgObjs = [pkg];
6781 for (var i = 0; i < curNav.pkgNames.length; i += 1) {
......@@ -99,16 +113,16 @@
99113 renderPkgList(lastPkg);
100114
101115 var lastDecl = curNav.declObjs[curNav.declObjs.length - 1];
102 if (lastDecl.pubDecls != null) {
103 return renderContainer(lastDecl);
104 } else if (lastDecl.type != null) {
116 if (lastDecl.type != null) {
105117 var typeObj = zigAnalysis.types[lastDecl.type];
106118 if (typeObj.kind === typeKindFnId) {
107119 return renderFn(lastDecl);
108120 }
109121 throw new Error("docs for this decl which is not a container");
110 } else {
111 throw new Error("docs for this decl which is a type");
122 }
123 renderType(lastDecl);
124 if (lastDecl.pubDecls != null) {
125 renderContainer(lastDecl);
112126 }
113127 }
114128
......@@ -164,10 +178,6 @@
164178 function render404() {
165179 domStatus.textContent = "404 Not Found";
166180 domStatus.classList.remove("hidden");
167 domSectPkgs.classList.add("hidden");
168 domSectTypes.classList.add("hidden");
169 domSectFns.classList.add("hidden");
170 domFnProto.classList.add("hidden");
171181 }
172182
173183 function renderPkgList(pkg) {
......@@ -183,9 +193,7 @@
183193 return operatorCompare(a.name.toLowerCase(), b.name.toLowerCase());
184194 });
185195
186 if (list.length === 0) {
187 domSectPkgs.classList.add("hidden");
188 } else {
196 if (list.length !== 0) {
189197 resizeDomList(domListPkgs, list.length, '<li><a href="#"></a></li>');
190198 for (var i = 0; i < list.length; i += 1) {
191199 var liDom = domListPkgs.children[i];
......@@ -228,6 +236,11 @@
228236 }
229237 }
230238
239 function renderType(typeObj) {
240 domFnDocs.innerText = zigAnalysis.typeKinds[typeObj.kind] + ": " + typeObj.name;
241 domFnDocs.classList.remove("hidden");
242 }
243
231244 function renderContainer(container) {
232245 var typesList = [];
233246 var fnsList = [];
......@@ -251,9 +264,7 @@
251264 return operatorCompare(a.name.toLowerCase(), b.name.toLowerCase());
252265 });
253266
254 if (typesList.length === 0) {
255 domSectTypes.classList.add("hidden");
256 } else {
267 if (typesList.length !== 0) {
257268 resizeDomList(domListTypes, typesList.length, '<li><a href="#"></a></li>');
258269 for (var i = 0; i < typesList.length; i += 1) {
259270 var liDom = domListTypes.children[i];
......@@ -265,9 +276,7 @@
265276 domSectTypes.classList.remove("hidden");
266277 }
267278
268 if (fnsList.length === 0) {
269 domSectFns.classList.add("hidden");
270 } else {
279 if (fnsList.length !== 0) {
271280 resizeDomList(domListFns, fnsList.length, '<li><a href="#"></a></li>');
272281 for (var i = 0; i < fnsList.length; i += 1) {
273282 var liDom = domListFns.children[i];
......@@ -332,8 +341,19 @@
332341 declNames: [],
333342 declObjs: [],
334343 };
344 curNavSearch = "";
345
335346 if (location.hash[0] === '#' && location.hash.length > 1) {
336 var parts = location.hash.substring(1).split(";");
347 var nonSearchAndSearchParts = location.hash.substring(1).split("?");
348 var nonSearchPart;
349 if (nonSearchAndSearchParts.length === 1) {
350 nonSearchPart = nonSearchAndSearchParts[0];
351 } else {
352 nonSearchPart = nonSearchAndSearchParts[0];
353 curNavSearch = nonSearchAndSearchParts[1];
354 }
355
356 var parts = nonSearchPart.split(";");
337357 curNav.pkgNames = parts[0].split(".");
338358 if (parts[1] != null) {
339359 curNav.declNames = parts[1].split(".");
......@@ -388,10 +408,93 @@
388408 return list;
389409 }
390410
391 var escapeHtmlReplacements = { "&": "&amp;", '"': "&quot;", "<": "&lt;", ">": "&gt;" };
392411 function markdown(mdText) {
393412 return mdText.replace(/[&"<>]/g, function (m) {
394413 return escapeHtmlReplacements[m];
395414 });
396415 }
416
417 function onSearchKeyDown(ev) {
418 switch (ev.which) {
419 case 27:
420 domSearch.value = "";
421 domSearch.blur();
422 ev.preventDefault();
423 break;
424 }
425 ev.stopPropagation();
426 startAsyncSearch();
427 }
428
429 function onWindowKeyDown(ev) {
430 switch (ev.which) {
431 case 83:
432 domSearch.focus();
433 ev.preventDefault();
434 ev.stopPropagation();
435 startAsyncSearch();
436 break;
437 }
438 }
439
440 function clearAsyncSearch() {
441 if (searchTimer != null) clearTimeout(searchTimer);
442 }
443
444 function startAsyncSearch() {
445 clearAsyncSearch();
446 searchTimer = setTimeout(startSearch, 50);
447 }
448 function startSearch() {
449 var parts = location.hash.split("?");
450 var newPart2 = (domSearch.value === "") ? "" : ("?" + domSearch.value);
451 if (parts.length === 1) {
452 location.hash = location.hash + newPart2;
453 } else {
454 location.hash = parts[0] + newPart2;
455 }
456 }
457 function renderSearch() {
458 if (domSearch.value !== curNavSearch) {
459 domSearch.value = curNavSearch;
460 }
461
462 var matchedDecls = [];
463 var terms = curNavSearch.split(/[ \r\n\t]+/);
464 decl_loop: for (var declIndex = 0; declIndex < zigAnalysis.decls.length; declIndex += 1) {
465 var decl = zigAnalysis.decls[declIndex];
466 for (var termIndex = 0; termIndex < terms.length; termIndex += 1) {
467 var term = terms[termIndex];
468 if (decl.name.indexOf(term) >= 0) {
469 continue;
470 }
471 var astNode = zigAnalysis.astNodes[decl.src]
472 if (astNode.docs != null && astNode.docs.indexOf(term) >= 0) {
473 continue;
474 }
475 var file = zigAnalysis.files[astNode.file];
476 if (file.indexOf(term) >= 0) {
477 continue;
478 }
479
480 continue decl_loop;
481 }
482
483 matchedDecls.push(decl);
484 }
485
486 if (matchedDecls.length !== 0) {
487 resizeDomList(domListSearchResults, matchedDecls.length, '<li></li>');
488
489 for (var i = 0; i < matchedDecls.length; i += 1) {
490 var liDom = domListSearchResults.children[i];
491 var decl = matchedDecls[i];
492 liDom.textContent = decl.name;
493 }
494
495 domSectSearchResults.classList.remove("hidden");
496 } else {
497 domSectSearchNoResults.classList.remove("hidden");
498 }
499 }
397500})();