Commit 3ce83e879b48273ada1e4e3d795967004f7d21b3 | zig

author	Andrew Kelley <andrew@ziglang.org> 2019-10-09 15:22:26-04:00
committer	Andrew Kelley <andrew@ziglang.org> 2019-10-09 15:23:13-04:00
log	3ce83e879b48273ada1e4e3d795967004f7d21b3
tree	d05a4e83189472dc02f059490f2796f65241649b
parent	a5714ddb973305b38703a69093af066514bdd8f8
signature	Commit is signed but in an unrecognized format.

generated docs: show error sets pages

also favicon, improve error sets css, syntax awareness of
noreturn

2 files changed, 71 insertions(+), 40 deletions(-)

lib
- std
  - special
    docs
    index.html
    main.js

lib/std/special/docs/index.html+4-6

...	@@ -3,7 +3,7 @@	...	@@ -3,7 +3,7 @@
3	<head>	3	<head>
4	<meta charset="utf-8">	4	<meta charset="utf-8">
5	<title>Documentation - Zig</title>	5	<title>Documentation - Zig</title>
6	<link rel="icon" href="favicon.png">	6	<link rel="icon" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAgklEQVR4AWMYWuD7EllJIM4G4g4g5oIJ/odhOJ8wToOxSTXgNxDHoeiBMfA4+wGShjyYOCkG/IGqWQziEzYAoUAeiF9D5U+DxEg14DRU7jWIT5IBIOdCxf+A+CQZAAoopEB7QJwBCBwHiip8UYmRdrAlDpIMgApwQZNnNii5Dq0MBgCxxycBnwEd+wAAAABJRU5ErkJggg==">
7	<style type="text/css">	7	<style type="text/css">
8	body {	8	body {
9	font-family: system-ui, -apple-system, Roboto, "Segoe UI", sans-serif;	9	font-family: system-ui, -apple-system, Roboto, "Segoe UI", sans-serif;
...	@@ -127,7 +127,7 @@	...	@@ -127,7 +127,7 @@
127	text-align: center;	127	text-align: center;
128	font-size: 1.5em;	128	font-size: 1.5em;
129	}	129	}
130	dt, dd {	130	#helpDialog dt, #helpDialog dd {
131	display: inline;	131	display: inline;
132	margin: 0 0.2em;	132	margin: 0 0.2em;
133	}	133	}
...	@@ -152,10 +152,8 @@	...	@@ -152,10 +152,8 @@
152	background-color: #93e196;	152	background-color: #93e196;
153	}	153	}
154		154
155	#tableFnErrors tr td:first-child{	155	#tableFnErrors dt {
156	text-align: right;
157	font-weight: bold;	156	font-weight: bold;
158	vertical-align: top;
159	}	157	}
160		158
161	#sectGlobalVars td, #sectFns td, #sectFields td {	159	#sectGlobalVars td, #sectFns td, #sectFields td {
...	@@ -297,7 +295,7 @@	...	@@ -297,7 +295,7 @@
297	<div id="fnErrorsAnyError">	295	<div id="fnErrorsAnyError">
298	<p><span class="tok-type">anyerror</span> means the error set is known only at runtime.</p>	296	<p><span class="tok-type">anyerror</span> means the error set is known only at runtime.</p>
299	</div>	297	</div>
300	<table id="tableFnErrors"><tbody id="listFnErrors"></tbody></table>	298	<div id="tableFnErrors"><dl id="listFnErrors"></dl></div>
301	</div>	299	</div>
302	<div id="fnExamples" class="hidden"></div>	300	<div id="fnExamples" class="hidden"></div>
303	<div id="fnNoExamples" class="hidden">	301	<div id="fnNoExamples" class="hidden">

lib/std/special/docs/main.js+67-34

 @@ -44,6 +44,7 @@
     var typeKindIntId;
     var typeKindBoolId;
     var typeKindVoidId;
+    var typeKindNoReturnId;
     var typeKindErrSetId;
     var typeKindErrUnionId;
     findTypeKinds();
 @@ -171,7 +172,9 @@
             }
             throw new Error("docs for this decl which is not a container");
         }
-        renderType(lastDecl);
+        if (lastDecl.kind != null) {
+            renderType(lastDecl);
+        }
         if (lastDecl.pubDecls != null) {
             renderContainer(lastDecl);
         }
 @@ -211,38 +214,7 @@
         }
         if (errSetTypeIndex != null) {
             var errSetType = zigAnalysis.types[errSetTypeIndex];
-            if (errSetType.errors == null) {
+            renderErrorSet(errSetType);
-                domFnErrorsAnyError.classList.remove("hidden");
-            } else {
-                var errorList = [];
-                for (var i = 0; i < errSetType.errors.length; i += 1) {
-                    var errObj = zigAnalysis.errors[errSetType.errors[i]];
-                    var srcObj = zigAnalysis.astNodes[errObj.src];
-                    errorList.push({
-                        err: errObj,
-                        docs: srcObj.docs,
-                    });
-                }
-                errorList.sort(function(a, b) {
-                    return operatorCompare(a.err.name.toLowerCase(), b.err.name.toLowerCase());
-                });
-                resizeDomList(domListFnErrors, errorList.length, '<tr><td></td><td></td></tr>');
-                for (var i = 0; i < errorList.length; i += 1) {
-                    var trDom = domListFnErrors.children[i];
-                    var nameTdDom = trDom.children[0];
-                    var descTdDom = trDom.children[1];
-                    nameTdDom.textContent = errorList[i].err.name;
-                    var docs = errorList[i].docs;
-                    if (docs != null) {
-                        descTdDom.innerHTML = markdown(docs);
-                    } else {
-                        descTdDom.textContent = "";
-                    }
-                }
-                domTableFnErrors.classList.remove("hidden");
-            }
-            domSectFnErrors.classList.remove("hidden");
         }
         var protoSrcIndex;
 @@ -375,6 +347,19 @@
         return navLink(curNav.pkgNames, curNav.declNames.concat([childName]));
     }
+    function resizeDomListDl(dlDom, desiredLen) {
+        // add the missing dom entries
+        var i, ev;
+        for (i = dlDom.childElementCount / 2; i < desiredLen; i += 1) {
+            dlDom.insertAdjacentHTML('beforeend', '<dt></dt><dd></dd>');
+        }
+        // remove extra dom entries
+        while (desiredLen < dlDom.childElementCount / 2) {
+            dlDom.removeChild(dlDom.lastChild);
+            dlDom.removeChild(dlDom.lastChild);
+        }
+    }
     function resizeDomList(listDom, desiredLen, templateHtml) {
         // add the missing dom entries
         var i, ev;
 @@ -498,6 +483,12 @@
                 } else {
                     return "void";
                 }
+            case typeKindNoReturnId:
+                if (wantHtml) {
+                    return '<span class="tok-type">noreturn</span>';
+                } else {
+                    return "noreturn";
+                }
             case typeKindErrSetId:
                 if (typeObj.errors == null) {
                     if (wantHtml) {
 @@ -569,9 +560,46 @@
     function renderType(typeObj) {
         var name = typeName(typeObj, false, false);
         if (name != null && name != "") {
-            domHdrName.innerText = zigAnalysis.typeKinds[typeObj.kind] + " " + name;
+            domHdrName.innerText = name + " (" + zigAnalysis.typeKinds[typeObj.kind] + ")";
             domHdrName.classList.remove("hidden");
         }
+        if (typeObj.kind == typeKindErrSetId) {
+            renderErrorSet(typeObj);
+        }
+    }
+    function renderErrorSet(errSetType) {
+        if (errSetType.errors == null) {
+            domFnErrorsAnyError.classList.remove("hidden");
+        } else {
+            var errorList = [];
+            for (var i = 0; i < errSetType.errors.length; i += 1) {
+                var errObj = zigAnalysis.errors[errSetType.errors[i]];
+                var srcObj = zigAnalysis.astNodes[errObj.src];
+                errorList.push({
+                    err: errObj,
+                    docs: srcObj.docs,
+                });
+            }
+            errorList.sort(function(a, b) {
+                return operatorCompare(a.err.name.toLowerCase(), b.err.name.toLowerCase());
+            });
+            resizeDomListDl(domListFnErrors, errorList.length);
+            for (var i = 0; i < errorList.length; i += 1) {
+                var nameTdDom = domListFnErrors.children[i * 2 + 0];
+                var descTdDom = domListFnErrors.children[i * 2 + 1];
+                nameTdDom.textContent = errorList[i].err.name;
+                var docs = errorList[i].docs;
+                if (docs != null) {
+                    descTdDom.innerHTML = markdown(docs);
+                } else {
+                    descTdDom.textContent = "";
+                }
+            }
+            domTableFnErrors.classList.remove("hidden");
+        }
+        domSectFnErrors.classList.remove("hidden");
     }
     function allCompTimeFnCallsHaveTypeResult(typeIndex, value) {
 @@ -782,6 +810,8 @@
                 typeKindBoolId = i;
             } else if (zigAnalysis.typeKinds[i] === "Void") {
                 typeKindVoidId = i;
+            } else if (zigAnalysis.typeKinds[i] === "NoReturn") {
+                typeKindNoReturnId = i;
             } else if (zigAnalysis.typeKinds[i] === "ErrorSet") {
                 typeKindErrSetId = i;
             } else if (zigAnalysis.typeKinds[i] === "ErrorUnion") {
 @@ -809,6 +839,9 @@
         if (typeKindVoidId == null) {
             throw new Error("No type kind 'Void' found");
         }
+        if (typeKindNoReturnId == null) {
+            throw new Error("No type kind 'Void' found");
+        }
         if (typeKindErrSetId == null) {
             throw new Error("No type kind 'ErrorSet' found");
         }