-
-
-
-
-
-
-
-
-
- Search
-
-
-
- Use spaces instead of dots. See $resource for more info.
-
-
-
- -
-
- - Index - -
- - - -
-
+
-
-
-
- How to search effectively
-
-
- How To Search Effectively
-Matching
--
-
- Search is case-insensitive by default. -
- Using uppercase letters in your query will make the search - case-sensitive. -
- Given
ArrayListUnmanaged: --
-
- the following search terms (and their prefixes) will match:
-
-
-
array
- list
- unmanaged
-
- - the following search terms will NOT match:
-
-
-
stun
- ray
- managed
-
-
- - the following search terms (and their prefixes) will match:
-
- More precisely, the search system is based on a Radix Tree. The Radix Tree contains full decl names plus some suffixes, split by following the official style guide (e.g.
HashMapUnmanagedalso producesMapUnmanagedandUnmanaged, same with snake_case and camelCase names).
-
Multiple terms
- --
-
- When a search query contains multiple terms, order doesn't matter when
- all terms match within a single decl name (e.g. "map auto" will match
AutoHashMap).
- - Query term order does matter when matching different decls alognside
- a path (e.g. "js parse" matching
std.json.parse), in which - case the order of the terms will determine whether the match goes above or - below the "other results" line.
- - As an example, "fs create" will put above the line all things related to the creation of files and directories inside of `std.fs`, while still showing (but below the line) matches from `std.Bulild`. -
- As another example, "fs windows" will prioritize windows-related results in `std.fs`, while "windows fs" will prioritize "fs"-related results in `std.windows`. -
- This means that if you're searching inside a target namespace, you never have to read below the "other results" line. -
- Since matching doesn't have to be perfect, you can also target a group of namespaces to search into. For example "array orderedremove" will show you all "Array-" namespaces that support
orderedRemove.
- - Periods are replaced by spaces because the Radix Tree doesn't index full paths, and in practice you should expect the match scoring system to consistently give you what you're looking for even when your query path is split into multiple terms. -
Search Results
-
-
- No Results Found
-Here are some things you can try:
--
-
- Check out the Language Reference for the language itself. -
- Check out the Learn page for other helpful resources for learning Zig. -
- Use your search engine. -
Press ? to see keyboard shortcuts and Esc to return.
-
-
-
-
-
- Table of Contents
-No content to display.
-
-
-
-
-
-
+ Loading...
-
-
-
-
-
-
-
- This function is not tested or referenced.
-
-
-
- - This declaration is not tested or referenced, and it has therefore not been included in - semantic analysis, which means the only documentation available is whatever is in the - doc comments. -
-
-
- Parameters
- -
-
-
- Errors
-
-
- anyerror means the error set is known only at runtime.
-
-
- Fields
- -
-
-
-
- Namespaces
-
-
- Other Namespaces ⓘ
- -
-
-
-
- Types
-
-
-
-
- Global Variables
-
-
-
-
-
-
-
- Functions
-
-
-
-
- Values
-
-
-
-
-
-
-
- Error Sets
-
-
- Examples
-
-
- Usage Examples ⓘ
- -
-
- Tests
-
-
-
-
-
- Loading...
+[src]
+
+
+
+
+
- Parameters
+
-
-
-
+ Keyboard Shortcuts
-- ?
- Toggle this help modal
- Focus the search field
-
- - ↑
- Move up in search results
- ↓
- Move down in search results
- ⏎
- Go to active search result
- p
- Open preferences
- Esc
- Clear focus; close this modal
+
+
+ Errors
+
+
+ anyerror means the error set is known only at runtime.
+
+
+ Search Results
+
+
+ No Results Found
+Press escape to exit search and then '?' to see more options.
+
+
- Fields
+
- " + section.name + " ";
- }
- domGuideTocList.innerHTML = "" + renderTokens((function*() {
- yield Tok.identifier(fieldNode.name);
- yield Tok.colon;
- yield Tok.space;
- if (isVarArgs && i === typeObj.params.length - 1) {
- yield Tok.period;
- yield Tok.period;
- yield Tok.period;
- } else {
- yield* ex(value, {});
- }
- yield Tok.comma;
- }()));
-
- html += "";
-
- if (docsNonEmpty) {
- html += '" + text + " ";
- }
-
- // Replace the search results using our newly constructed HTML string
- domListSearchResults.innerHTML = matchedItemsHTML;
- if (searchTrimmed) {
- domSectSearchAllResultsLink.classList.remove("hidden");
- }
- renderSearchCursor();
-
- domSectSearchResults.classList.remove("hidden");
- } else {
- domSectSearchNoResults.classList.remove("hidden");
- }
- }
-
- function renderSearchAPI() {
- domSectSearchResults.prepend(
- domSearchHelp.parentElement.removeChild(domSearchHelp)
- );
- if (canonDeclPaths == null) {
- canonDeclPaths = computeCanonDeclPaths();
- }
- let declSet = new Set();
- let otherDeclSet = new Set(); // for low quality results
- let declScores = {};
-
- let ignoreCase = curNavSearch.toLowerCase() === curNavSearch;
- let term_list = getSearchTerms();
- for (let i = 0; i < term_list.length; i += 1) {
- let term = term_list[i];
- let result = declSearchIndex.search(term.toLowerCase());
- if (result == null) {
- domSectSearchNoResults.prepend(
- domSearchHelp.parentElement.removeChild(domSearchHelp)
- );
- domSectSearchNoResults.classList.remove("hidden");
-
- domSectSearchResults.classList.add("hidden");
- return;
- }
-
- let termSet = new Set();
- let termOtherSet = new Set();
-
- for (let list of [result.full, result.partial]) {
- for (let r of list) {
- const d = r.declIndex;
- const decl = getDecl(d);
- const canonPath = getCanonDeclPath(d);
-
- // collect unconditionally for the first term
- if (i == 0) {
- declSet.add(d);
- } else {
- // path intersection for subsequent terms
- let found = false;
- for (let p of canonPath.declIndexes) {
- if (declSet.has(p)) {
- found = true;
- break;
- }
- }
- if (!found) {
- otherDeclSet.add(d);
- } else {
- termSet.add(d);
- }
- }
-
- if (declScores[d] == undefined) declScores[d] = 0;
-
- // scores (lower is better)
- let decl_name = decl.name;
- if (ignoreCase) decl_name = decl_name.toLowerCase();
-
- // shallow path are preferable
- const path_depth = canonPath.declNames.length * 50;
- // matching the start of a decl name is good
- const match_from_start = decl_name.startsWith(term) ? -term.length * (2 - ignoreCase) : (decl_name.length - term.length) + 1;
- // being a perfect match is good
- const is_full_match = (decl_name === term) ? -decl_name.length * (1 - ignoreCase) : Math.abs(decl_name.length - term.length);
- // matching the end of a decl name is good
- const matches_the_end = decl_name.endsWith(term) ? -term.length * (1 - ignoreCase) : (decl_name.length - term.length) + 1;
- // explicitly penalizing scream case decls
- const decl_is_scream_case = decl.name.toUpperCase() != decl.name ? 0 : decl.name.length;
-
- const score = path_depth
- + match_from_start
- + is_full_match
- + matches_the_end
- + decl_is_scream_case;
-
- declScores[d] += score;
- }
- }
- if (i != 0) {
- for (let d of declSet) {
- if (termSet.has(d)) continue;
- let found = false;
- for (let p of getCanonDeclPath(d).declIndexes) {
- if (termSet.has(p) || otherDeclSet.has(p)) {
- found = true;
- break;
- }
- }
- if (found) {
- declScores[d] = declScores[d] / term_list.length;
- }
-
- termOtherSet.add(d);
- }
- declSet = termSet;
- for (let d of termOtherSet) {
- otherDeclSet.add(d);
- }
-
- }
- }
-
- let matchedItems = {
- high_quality: [],
- low_quality: [],
- };
- for (let idx of declSet) {
- matchedItems.high_quality.push({ points: declScores[idx], declIndex: idx })
- }
- for (let idx of otherDeclSet) {
- matchedItems.low_quality.push({ points: declScores[idx], declIndex: idx })
- }
-
- matchedItems.high_quality.sort(function(a, b) {
- let cmp = operatorCompare(a.points, b.points);
- return cmp;
- });
- matchedItems.low_quality.sort(function(a, b) {
- let cmp = operatorCompare(a.points, b.points);
- return cmp;
- });
-
- // Build up the list of search results
- let matchedItemsHTML = "";
-
- for (let list of [matchedItems.high_quality, matchedItems.low_quality]) {
- if (list == matchedItems.low_quality && list.length > 0) {
- matchedItemsHTML += "
" - } - for (let result of list) { - const points = result.points; - const match = result.declIndex; - - let canonPath = getCanonDeclPath(match); - if (canonPath == null) continue; - - let lastModName = canonPath.modNames[canonPath.modNames.length - 1]; - let text = lastModName + "." + canonPath.declNames.join("."); - - - const href = navLink(canonPath.modNames, canonPath.declNames); - - matchedItemsHTML += "" + text + " ";
- }
- }
-
- // Replace the search results using our newly constructed HTML string
- domListSearchResults.innerHTML = matchedItemsHTML;
- renderSearchCursor();
-
- domSectSearchResults.classList.remove("hidden");
- }
-
-
-
- function renderSearchCursor() {
- const searchResults = domListSearchResults.getElementsByTagName("li");
- for (let i = 0; i < searchResults.length; i += 1) {
- let liDom = searchResults[i];
- if (curSearchIndex === i) {
- liDom.classList.add("selected");
- } else {
- liDom.classList.remove("selected");
- }
- }
- }
-
- function scrollGuidesTop(ev) {
- document.getElementById("activeGuide").children[0].scrollIntoView({
- behavior: "smooth",
- });
- ev.preventDefault();
- ev.stopPropagation();
- }
- document.scrollGuidesTop = scrollGuidesTop;
-
- function scrollToHeading(id, alreadyThere) {
- // Don't scroll if the current location has a scrolling history.
- if (scrollHistory[location.hash]) return;
-
- const c = document.getElementById(id);
- if (c && alreadyThere) {
- requestAnimationFrame(() => c.scrollIntoView({behavior: "smooth"}));
- } else {
- requestAnimationFrame(() => c.scrollIntoView());
- }
return;
- }
- // function indexNodesToCalls() {
- // let map = {};
- // for (let i = 0; i < zigAnalysis.calls.length; i += 1) {
- // let call = zigAnalysis.calls[i];
- // let fn = zigAnalysis.fns[call.fn];
- // if (map[fn.src] == null) {
- // map[fn.src] = [i];
- // } else {
- // map[fn.src].push(i);
- // }
- // }
- // return map;
- // }
+ case "Escape":
+ if (ev.shiftKey || ev.ctrlKey || ev.altKey) return;
- function byNameProperty(a, b) {
- return operatorCompare(a.name, b.name);
- }
+ domSearch.value = "";
+ domSearch.blur();
+ curSearchIndex = -1;
+ ev.preventDefault();
+ ev.stopPropagation();
+ startSearch();
+ return;
+ case "ArrowUp":
+ if (ev.shiftKey || ev.ctrlKey || ev.altKey) return;
+ moveSearchCursor(-1);
+ ev.preventDefault();
+ ev.stopPropagation();
+ return;
+ case "ArrowDown":
+ if (ev.shiftKey || ev.ctrlKey || ev.altKey) return;
- function getDecl(idx) {
- const decl = zigAnalysis.decls[idx];
- return {
- name: decl[0],
- kind: decl[1],
- src: decl[2],
- value: decl[3],
- decltest: decl[4],
- is_uns: decl[5],
- parent_container: decl[6],
- };
- }
-
- function getAstNode(idx) {
- const ast = zigAnalysis.astNodes[idx];
- return {
- file: ast[0],
- line: ast[1],
- col: ast[2],
- name: ast[3],
- code: ast[4],
- docs: ast[5],
- fields: ast[6],
- comptime: ast[7],
- };
- }
-
- function getFile(idx) {
- const file = zigAnalysis.files[idx];
- return {
- name: file[0],
- modIndex: file[1],
- };
- }
-
- function getType(idx) {
- const ty = zigAnalysis.types[idx];
- switch (ty[0]) {
- default:
- throw "unhandled type kind!";
- case typeKinds.Unanalyzed:
- throw "unanalyzed type!";
- case typeKinds.Type:
- case typeKinds.Void:
- case typeKinds.Bool:
- case typeKinds.NoReturn:
- case typeKinds.Int:
- case typeKinds.Float:
- return { kind: ty[0], name: ty[1] };
- case typeKinds.Pointer:
- return {
- kind: ty[0],
- size: ty[1],
- child: ty[2],
- sentinel: ty[3],
- align: ty[4],
- address_space: ty[5],
- bit_start: ty[6],
- host_size: ty[7],
- is_ref: ty[8],
- is_allowzero: ty[9],
- is_mutable: ty[10],
- is_volatile: ty[11],
- has_sentinel: ty[12],
- has_align: ty[13],
- has_addrspace: ty[14],
- has_bit_range: ty[15],
- };
- case typeKinds.Array:
- return {
- kind: ty[0],
- len: ty[1],
- child: ty[2],
- sentinel: ty[3],
- };
- case typeKinds.Struct:
- return {
- kind: ty[0],
- name: ty[1],
- src: ty[2],
- privDecls: ty[3],
- pubDecls: ty[4],
- field_types: ty[5],
- field_defaults: ty[6],
- backing_int: ty[7],
- is_tuple: ty[8],
- line_number: ty[9],
- parent_container: ty[10],
- layout: ty[11],
- };
- case typeKinds.ComptimeExpr:
- case typeKinds.ComptimeFloat:
- case typeKinds.ComptimeInt:
- case typeKinds.Undefined:
- case typeKinds.Null:
- return { kind: ty[0], name: ty[1] };
- case typeKinds.Optional:
- return {
- kind: ty[0],
- name: ty[1],
- child: ty[2],
- };
- case typeKinds.ErrorUnion:
- return {
- kind: ty[0],
- lhs: ty[1],
- rhs: ty[2],
- };
- case typeKinds.InferredErrorUnion:
- return {
- kind: ty[0],
- payload: ty[1],
- };
- case typeKinds.ErrorSet:
- return {
- kind: ty[0],
- name: ty[1],
- fields: ty[2],
- };
- case typeKinds.Enum:
- return {
- kind: ty[0],
- name: ty[1],
- src: ty[2],
- privDecls: ty[3],
- pubDecls: ty[4],
- tag: ty[5],
- values: ty[6],
- nonexhaustive: ty[7],
- parent_container: ty[8],
- };
- case typeKinds.Union:
- return {
- kind: ty[0],
- name: ty[1],
- src: ty[2],
- privDecls: ty[3],
- pubDecls: ty[4],
- field_types: ty[5],
- tag: ty[6],
- auto_tag: ty[7],
- parent_container: ty[8],
- layout: ty[9],
- };
- case typeKinds.Fn:
- return {
- kind: ty[0],
- name: ty[1],
- src: ty[2],
- ret: ty[3],
- generic_ret: ty[4],
- params: ty[5],
- lib_name: ty[6],
- is_var_args: ty[7],
- is_inferred_error: ty[8],
- has_lib_name: ty[9],
- has_cc: ty[10],
- cc: ty[11],
- align: ty[12],
- has_align: ty[13],
- is_test: ty[14],
- is_extern: ty[15],
- };
- case typeKinds.Opaque:
- return {
- kind: ty[0],
- name: ty[1],
- src: ty[2],
- privDecls: ty[3],
- pubDecls: ty[4],
- parent_container: ty[5],
- };
- case typeKinds.Frame:
- case typeKinds.AnyFrame:
- case typeKinds.Vector:
- case typeKinds.EnumLiteral:
- return { kind: ty[0], name: ty[1] };
- }
- }
-
- function getLocalStorage() {
- if ("localStorage" in window) {
- try {
- return window.localStorage;
- } catch (ignored) {
- // localStorage may be disabled (SecurityError)
+ moveSearchCursor(1);
+ ev.preventDefault();
+ ev.stopPropagation();
+ return;
+ default:
+ ev.stopPropagation(); // prevent keyboard shortcuts
+ return;
}
}
- // If localStorage isn't available, persist preferences only for the current session
- const sessionPrefs = {};
- return {
- getItem(key) {
- return key in sessionPrefs ? sessionPrefs[key] : null;
- },
- setItem(key, value) {
- sessionPrefs[key] = String(value);
- },
- };
- }
- function loadPrefs() {
- const storedPrefSlashSearch = prefs.getItem("slashSearch");
- if (storedPrefSlashSearch === null) {
- // Slash search defaults to enabled for all browsers except Firefox
- setPrefSlashSearch(navigator.userAgent.indexOf("Firefox") === -1);
- } else {
- setPrefSlashSearch(storedPrefSlashSearch === "true");
+ function onSearchChange(ev) {
+ curSearchIndex = -1;
+ startAsyncSearch();
}
- }
- function getPrefSlashSearch() {
- return prefs.getItem("slashSearch") === "true";
- }
+ function moveSearchCursor(dir) {
+ if (curSearchIndex < 0 || curSearchIndex >= domListSearchResults.children.length) {
+ if (dir > 0) {
+ curSearchIndex = -1 + dir;
+ } else if (dir < 0) {
+ curSearchIndex = domListSearchResults.children.length + dir;
+ }
+ } else {
+ curSearchIndex += dir;
+ }
+ if (curSearchIndex < 0) {
+ curSearchIndex = 0;
+ }
+ if (curSearchIndex >= domListSearchResults.children.length) {
+ curSearchIndex = domListSearchResults.children.length - 1;
+ }
+ renderSearchCursor();
+ }
- function setPrefSlashSearch(enabled) {
- prefs.setItem("slashSearch", String(enabled));
- domPrefSlashSearch.checked = enabled;
- const searchKeys = enabled ? "/ or s" : "s";
- domSearchKeys.innerHTML = searchKeys;
- domSearchPlaceholderText.innerHTML = searchKeys + " to search, ? for more options";
- }
+ function onWindowKeyDown(ev) {
+ switch (ev.code) {
+ case "Escape":
+ if (ev.shiftKey || ev.ctrlKey || ev.altKey) return;
+ if (!domHelpModal.classList.contains("hidden")) {
+ domHelpModal.classList.add("hidden");
+ ev.preventDefault();
+ ev.stopPropagation();
+ }
+ break;
+ case "KeyS":
+ if (ev.shiftKey || ev.ctrlKey || ev.altKey) return;
+ domSearch.focus();
+ domSearch.select();
+ ev.preventDefault();
+ ev.stopPropagation();
+ startAsyncSearch();
+ break;
+ case "KeyU":
+ if (ev.shiftKey || ev.ctrlKey || ev.altKey) return;
+ ev.preventDefault();
+ ev.stopPropagation();
+ navigateToSource();
+ break;
+ case "Slash":
+ if (!ev.shiftKey || ev.ctrlKey || ev.altKey) return;
+ ev.preventDefault();
+ ev.stopPropagation();
+ showHelpModal();
+ break;
+ }
+ }
+
+ function showHelpModal() {
+ domHelpModal.classList.remove("hidden");
+ domHelpModal.style.left = (window.innerWidth / 2 - domHelpModal.clientWidth / 2) + "px";
+ domHelpModal.style.top = (window.innerHeight / 2 - domHelpModal.clientHeight / 2) + "px";
+ domHelpModal.focus();
+ }
+
+ function navigateToSource() {
+ if (curNav.viewSourceHash != null) {
+ location.hash = curNav.viewSourceHash;
+ }
+ }
+
+ function clearAsyncSearch() {
+ if (searchTimer != null) {
+ clearTimeout(searchTimer);
+ searchTimer = null;
+ }
+ }
+
+ function startAsyncSearch() {
+ clearAsyncSearch();
+ searchTimer = setTimeout(startSearch, 10);
+ }
+ function computeSearchHash() {
+ // How location.hash works:
+ // 1. http://example.com/ => ""
+ // 2. http://example.com/# => ""
+ // 3. http://example.com/#foo => "#foo"
+ // wat
+ const oldWatHash = location.hash;
+ const oldHash = oldWatHash.startsWith("#") ? oldWatHash : "#" + oldWatHash;
+ const parts = oldHash.split("?");
+ const newPart2 = (domSearch.value === "") ? "" : ("?" + domSearch.value);
+ return parts[0] + newPart2;
+ }
+ function startSearch() {
+ clearAsyncSearch();
+ navigate(computeSearchHash());
+ }
+ function renderSearch() {
+ renderNav(curNav.decl);
+
+ const ignoreCase = (curNavSearch.toLowerCase() === curNavSearch);
+ const results = executeQuery(curNavSearch, ignoreCase);
+
+ if (results.length !== 0) {
+ resizeDomList(domListSearchResults, results.length, '
-
+
-
- Preferences
--
-
-
+
+ Types
+-
+
+
+ Namespaces
+-
+
+
+
+
+
+
+ Global Variables
+
+
+
+
+
+
+ Values
+
+
+ Functions
+-
+
+
+ Error Sets
+-
+
+
+ Example Usage
+
+
+
+ Source Code
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
diff --git a/docs/main.js b/docs/main.js
index 4991c31..d9888ea 100644
--- a/docs/main.js
+++ b/docs/main.js
@@ -1,5242 +1,987 @@
-"use strict";
-
-var zigAnalysis = {
- typeKinds,
- rootMod,
- modules,
- astNodes,
- calls,
- files,
- decls,
- exprs,
- types,
- comptimeExprs,
- guideSections
-};
-
-let skipNextHashChange = null;
-
-const NAV_MODES = {
- API: "#A;",
- GUIDES: "#G;",
-};
-
-
-var scrollHistory = {};
-
(function() {
- const domBanner = document.getElementById("banner");
- const domMain = document.getElementById("main");
- const domStatus = document.getElementById("status");
- const domSectNavAPI = document.getElementById("sectNavAPI");
- const domListNavAPI = document.getElementById("listNavAPI");
- const domSectNavGuides = document.getElementById("sectNavGuides");
- const domListNavGuides = document.getElementById("listNavGuides");
- const domApiSwitch = document.getElementById("ApiSwitch");
- const domGuideSwitch = document.getElementById("guideSwitch");
- const domGuidesMenu = document.getElementById("guidesMenu");
- const domGuidesMenuTitle = document.getElementById("guidesMenuTitle");
- const domGuideTocList = document.getElementById("guideTocList");
- const domGuideTocListEmtpy = document.getElementById("guideTocListEmpty");
- const domListMods = document.getElementById("listMods");
- const domSectTypes = document.getElementById("sectTypes");
- const domListTypesLeft = document.getElementById("listTypesLeft");
- const domListTypesRight = document.getElementById("listTypesRight");
- const domSectTests = document.getElementById("sectTests");
- const domListTests = document.getElementById("listTests");
- const domSectDocTests = document.getElementById("sectDocTests");
- const domDocTestsCode = document.getElementById("docTestsCode");
- const domSectNamespaces = document.getElementById("sectNamespaces");
- const domListNamespacesLeft = document.getElementById("listNamespacesLeft");
- const domListNamespacesRight = document.getElementById("listNamespacesRight");
- const domNoDocsNamespaces = document.getElementById("noDocsNamespaces");
- const domSectErrSets = document.getElementById("sectErrSets");
- const domListErrSets = document.getElementById("listErrSets");
- const domSectFns = document.getElementById("sectFns");
- const domListFns = document.getElementById("listFns");
- const domSectFields = document.getElementById("sectFields");
- const domListFields = document.getElementById("listFields");
- const domSectGlobalVars = document.getElementById("sectGlobalVars");
- const domListGlobalVars = document.getElementById("listGlobalVars");
- const domSectValues = document.getElementById("sectValues");
- const domListValues = document.getElementById("listValues");
- const domFnProto = document.getElementById("fnProto");
- const domFnProtoCode = document.getElementById("fnProtoCode");
- const domFnSourceLink = document.getElementById("fnSourceLink");
- const domSectParams = document.getElementById("sectParams");
- const domListParams = document.getElementById("listParams");
- const domTldDocs = document.getElementById("tldDocs");
- const domSectFnErrors = document.getElementById("sectFnErrors");
- const domListFnErrors = document.getElementById("listFnErrors");
- const domTableFnErrors = document.getElementById("tableFnErrors");
- const domFnErrorsAnyError = document.getElementById("fnErrorsAnyError");
- const domFnExamples = document.getElementById("fnExamples");
- // const domListFnExamples = (document.getElementById("listFnExamples"));
- const domFnNoExamples = document.getElementById("fnNoExamples");
- const domDeclNoRef = document.getElementById("declNoRef");
- const domSearch = document.getElementById("search");
- const domSearchHelp = document.getElementById("searchHelp");
- const domSearchHelpSummary = document.getElementById("searchHelpSummary");
- const domSectSearchResults = document.getElementById("sectSearchResults");
- const domSectSearchAllResultsLink = document.getElementById("sectSearchAllResultsLink");
- const domDocs = document.getElementById("docs");
- const domDocsScroll = document.getElementById("docs-scroll");
- const domGuidesSection = document.getElementById("guides");
- const domActiveGuide = document.getElementById("activeGuide");
+ const CAT_namespace = 0;
+ const CAT_global_variable = 1;
+ const CAT_function = 2;
+ const CAT_primitive = 3;
+ const CAT_error_set = 4;
+ const CAT_global_const = 5;
+ const CAT_alias = 6;
+ const CAT_type = 7;
+ const CAT_type_type = 8;
+ const CAT_type_function = 9;
- const domListSearchResults = document.getElementById("listSearchResults");
- const domSectSearchNoResults = document.getElementById("sectSearchNoResults");
- // const domTdTarget = (document.getElementById("tdTarget"));
- const domTdZigVer = document.getElementById("tdZigVer");
- const domHdrName = document.getElementById("hdrName");
- const domHelpModal = document.getElementById("helpModal");
- const domSearchKeys = document.getElementById("searchKeys");
- const domPrefsModal = document.getElementById("prefsModal");
- const domSearchPlaceholder = document.getElementById("searchPlaceholder");
- const domSearchPlaceholderText = document.getElementById("searchPlaceholderText");
- const sourceFileUrlTemplate = "src/{{mod}}/{{file}}.html#L{{line}}"
- const domLangRefLink = document.getElementById("langRefLink");
+ const domDocTestsCode = document.getElementById("docTestsCode");
+ const domFnErrorsAnyError = document.getElementById("fnErrorsAnyError");
+ const domFnProto = document.getElementById("fnProto");
+ const domFnProtoCode = document.getElementById("fnProtoCode");
+ const domHdrName = document.getElementById("hdrName");
+ const domHelpModal = document.getElementById("helpDialog");
+ const domListErrSets = document.getElementById("listErrSets");
+ const domListFields = document.getElementById("listFields");
+ const domListParams = document.getElementById("listParams");
+ const domListFnErrors = document.getElementById("listFnErrors");
+ const domListFns = document.getElementById("listFns");
+ const domListGlobalVars = document.getElementById("listGlobalVars");
+ const domListInfo = document.getElementById("listInfo");
+ const domListNamespaces = document.getElementById("listNamespaces");
+ const domListNav = document.getElementById("listNav");
+ const domListSearchResults = document.getElementById("listSearchResults");
+ const domListTypes = document.getElementById("listTypes");
+ const domListValues = document.getElementById("listValues");
+ const domSearch = document.getElementById("search");
+ const domSectDocTests = document.getElementById("sectDocTests");
+ const domSectErrSets = document.getElementById("sectErrSets");
+ const domSectFields = document.getElementById("sectFields");
+ const domSectParams = document.getElementById("sectParams");
+ const domSectFnErrors = document.getElementById("sectFnErrors");
+ const domSectFns = document.getElementById("sectFns");
+ const domSectGlobalVars = document.getElementById("sectGlobalVars");
+ const domSectNamespaces = document.getElementById("sectNamespaces");
+ const domSectNav = document.getElementById("sectNav");
+ const domSectSearchNoResults = document.getElementById("sectSearchNoResults");
+ const domSectSearchResults = document.getElementById("sectSearchResults");
+ const domSectSource = document.getElementById("sectSource");
+ const domSectTypes = document.getElementById("sectTypes");
+ const domSectValues = document.getElementById("sectValues");
+ const domSourceText = document.getElementById("sourceText");
+ const domStatus = document.getElementById("status");
+ const domTableFnErrors = document.getElementById("tableFnErrors");
+ const domTldDocs = document.getElementById("tldDocs");
- const domPrefSlashSearch = document.getElementById("prefSlashSearch");
- const prefs = getLocalStorage();
- loadPrefs();
+ var searchTimer = null;
- domPrefSlashSearch.addEventListener("change", () => setPrefSlashSearch(domPrefSlashSearch.checked));
+ const curNav = {
+ // 0 = home
+ // 1 = decl (decl)
+ // 2 = source (path)
+ tag: 0,
+ // unsigned int: decl index
+ decl: null,
+ // string file name matching tarball path
+ path: null,
- const scrollMonitor = [
- domActiveGuide,
- domGuideTocList,
- domDocsScroll,
- domSectSearchResults,
- ];
+ // when this is populated, pressing the "view source" command will
+ // navigate to this hash.
+ viewSourceHash: null,
+ };
+ var curNavSearch = "";
+ var curSearchIndex = -1;
+ var imFeelingLucky = false;
- computeGuideHashes();
+ // names of modules in the same order as wasm
+ const moduleList = [];
- let searchTimer = null;
- let searchTrimResults = true;
+ let wasm_promise = fetch("main.wasm");
+ let sources_promise = fetch("sources.tar").then(function(response) {
+ if (!response.ok) throw new Error("unable to download sources");
+ return response.arrayBuffer();
+ });
+ var wasm_exports = null;
- let escapeHtmlReplacements = {
- "&": "&",
- '"': """,
- "<": "<",
- ">": ">",
- };
+ const text_decoder = new TextDecoder();
+ const text_encoder = new TextEncoder();
- let typeKinds = indexTypeKinds();
- let typeTypeId = findTypeTypeId();
- let pointerSizeEnum = { One: 0, Many: 1, Slice: 2, C: 3 };
+ WebAssembly.instantiateStreaming(wasm_promise, {
+ js: {
+ log: function(ptr, len) {
+ const msg = decodeString(ptr, len);
+ console.log(msg);
+ },
+ panic: function (ptr, len) {
+ const msg = decodeString(ptr, len);
+ throw new Error("panic: " + msg);
+ },
+ },
+ }).then(function(obj) {
+ wasm_exports = obj.instance.exports;
+ window.wasm = obj; // for debugging
- let declSearchIndex = new RadixTree();
- window.search = declSearchIndex;
+ sources_promise.then(function(buffer) {
+ const js_array = new Uint8Array(buffer);
+ const ptr = wasm_exports.alloc(js_array.length);
+ const wasm_array = new Uint8Array(wasm_exports.memory.buffer, ptr, js_array.length);
+ wasm_array.set(js_array);
+ wasm_exports.unpack(ptr, js_array.length);
- // for each module, is an array with modules to get to this one
- let canonModPaths = computeCanonicalModulePaths();
+ updateModuleList();
- // for each decl, is an array with {declNames, modNames} to get to this one
- let canonDeclPaths = null; // lazy; use getCanonDeclPath
+ window.addEventListener('popstate', onPopState, false);
+ domSearch.addEventListener('keydown', onSearchKeyDown, false);
+ domSearch.addEventListener('input', onSearchChange, false);
+ window.addEventListener('keydown', onWindowKeyDown, false);
+ onHashChange(null);
+ });
+ });
- // for each type, is an array with {declNames, modNames} to get to this one
- let canonTypeDecls = null; // lazy; use getCanonTypeDecl
-
- let curNav = {
- hash: "",
- mode: NAV_MODES.API,
- activeGuide: "",
- activeGuideScrollTo: null,
- // each element is a module name, e.g. @import("a") then within there @import("b")
- // starting implicitly from root module
- modNames: [],
- // same as above except actual modules, not names
- modObjs: [],
- // Each element is a decl name, `a.b.c`, a is 0, b is 1, c is 2, etc.
- // empty array means refers to the module itself
- declNames: [],
- // these will be all types, except the last one may be a type or a decl
- declObjs: [],
- // (a, b, c, d) comptime call; result is the value the docs refer to
- callName: null,
- };
-
- let curNavSearch = "";
- let curSearchIndex = -1;
- let imFeelingLucky = false;
-
- let rootIsStd = detectRootIsStd();
-
- // map of decl index to list of non-generic fn indexes
- // let nodesToFnsMap = indexNodesToFns();
- // map of decl index to list of comptime fn calls
- // let nodesToCallsMap = indexNodesToCalls();
-
- let guidesSearchIndex = {};
- window.guideSearch = guidesSearchIndex;
- parseGuides();
-
- // identifiers can contain modal trigger characters so we want to allow typing
- // such characters when the search is focused instead of toggling the modal
- let canToggleModal = true;
-
- domSearch.disabled = false;
- domSearch.addEventListener("keydown", onSearchKeyDown, false);
- domSearch.addEventListener("input", onSearchInput, false);
- domSearch.addEventListener("focus", ev => {
- domSearchPlaceholder.classList.add("hidden");
- canToggleModal = false;
- });
- domSearch.addEventListener("blur", ev => {
- if (domSearch.value.length == 0)
- domSearchPlaceholder.classList.remove("hidden");
- canToggleModal = true;
- });
- domSectSearchAllResultsLink.addEventListener('click', onClickSearchShowAllResults, false);
- function onClickSearchShowAllResults(ev) {
- ev.preventDefault();
- ev.stopPropagation();
- searchTrimResults = false;
- onHashChange();
- }
-
- if (location.hash == "") {
- location.hash = "#A;";
- }
-
- // make the modal disappear if you click outside it
- function handleModalClick(ev) {
- if (ev.target.classList.contains("modal-container")) {
- hideModal(this);
+ function renderTitle() {
+ const suffix = " - Zig Documentation";
+ if (curNavSearch.length > 0) {
+ document.title = curNavSearch + " - Search" + suffix;
+ } else if (curNav.decl != null) {
+ document.title = fullyQualifiedName(curNav.decl) + suffix;
+ } else if (curNav.path != null) {
+ document.title = curNav.path + suffix;
+ } else {
+ document.title = moduleList[0] + suffix; // Home
+ }
}
- }
- domHelpModal.addEventListener("click", handleModalClick);
- domPrefsModal.addEventListener("click", handleModalClick);
- window.addEventListener("hashchange", onHashChange, false);
- window.addEventListener("keydown", onWindowKeyDown, false);
- onHashChange();
+ function render() {
+ domFnErrorsAnyError.classList.add("hidden");
+ domFnProto.classList.add("hidden");
+ domHdrName.classList.add("hidden");
+ domHelpModal.classList.add("hidden");
+ domSectErrSets.classList.add("hidden");
+ domSectDocTests.classList.add("hidden");
+ domSectFields.classList.add("hidden");
+ domSectParams.classList.add("hidden");
+ domSectFnErrors.classList.add("hidden");
+ domSectFns.classList.add("hidden");
+ domSectGlobalVars.classList.add("hidden");
+ domSectNamespaces.classList.add("hidden");
+ domSectNav.classList.add("hidden");
+ domSectSearchNoResults.classList.add("hidden");
+ domSectSearchResults.classList.add("hidden");
+ domSectSource.classList.add("hidden");
+ domSectTypes.classList.add("hidden");
+ domSectValues.classList.add("hidden");
+ domStatus.classList.add("hidden");
+ domTableFnErrors.classList.add("hidden");
+ domTldDocs.classList.add("hidden");
- // TODO: fix this once langref becomes part of autodoc
- let langRefVersion = "master";
- domLangRefLink.href = `https://ziglang.org/documentation/${langRefVersion}/`;
+ renderTitle();
- function renderTitle() {
- let suffix = " - Zig";
- switch (curNav.mode) {
- case NAV_MODES.API:
- let list = curNav.modNames.concat(curNav.declNames);
- if (list.length === 0) {
- document.title = zigAnalysis.modules[zigAnalysis.rootMod].name + suffix;
- } else {
- document.title = list.join(".") + suffix;
+ if (curNavSearch !== "") return renderSearch();
+
+ switch (curNav.tag) {
+ case 0: return renderHome();
+ case 1:
+ if (curNav.decl == null) {
+ return renderNotFound();
+ } else {
+ return renderDecl(curNav.decl);
+ }
+ case 2: return renderSource(curNav.path);
+ default: throw new Error("invalid navigation state");
}
- return;
- case NAV_MODES.GUIDES:
- document.title = "[G] " + curNav.activeGuide + suffix;
- return;
}
- }
- function isDecl(x) {
- return "value" in x;
- }
-
- function isType(x) {
- return "kind" in x && !("value" in x);
- }
-
- function isContainerType(x) {
- return isType(x) && typeKindIsContainer(x.kind);
- }
-
- function typeShorthandName(expr) {
- let resolvedExpr = resolveValue({ expr: expr });
- if (!("type" in resolvedExpr)) {
- return null;
+ function renderHome() {
+ if (moduleList.length == 0) {
+ domStatus.textContent = "sources.tar contains no modules";
+ domStatus.classList.remove("hidden");
+ return;
+ }
+ return renderModule(0);
}
- let type = getType(resolvedExpr.type);
- outer: for (let i = 0; i < 10000; i += 1) {
- switch (type.kind) {
- case typeKinds.Optional:
- case typeKinds.Pointer:
- let child = type.child;
- let resolvedChild = resolveValue(child);
- if ("type" in resolvedChild) {
- type = getType(resolvedChild.type);
- continue;
- } else {
- return null;
- }
+ function renderModule(pkg_index) {
+ const root_decl = wasm_exports.find_module_root(pkg_index);
+ return renderDecl(root_decl);
+ }
+
+ function renderDecl(decl_index) {
+ const category = wasm_exports.categorize_decl(decl_index, 0);
+ switch (category) {
+ case CAT_namespace:
+ return renderNamespacePage(decl_index);
+ case CAT_global_variable:
+ case CAT_primitive:
+ case CAT_global_const:
+ case CAT_type:
+ case CAT_type_type:
+ return renderGlobal(decl_index);
+ case CAT_function:
+ return renderFunction(decl_index);
+ case CAT_type_function:
+ return renderTypeFunction(decl_index);
+ case CAT_error_set:
+ return renderErrorSetPage(decl_index);
+ case CAT_alias:
+ return renderDecl(wasm_exports.get_aliasee());
default:
- break outer;
- }
-
- if (i == 9999) throw "Exhausted typeShorthandName quota";
- }
-
- let name = undefined;
- if (type.kind === typeKinds.Struct) {
- name = "struct";
- } else if (type.kind === typeKinds.Enum) {
- name = "enum";
- } else if (type.kind === typeKinds.Union) {
- name = "union";
- } else {
- console.log("TODO: unhandled case in typeShortName");
- return null;
- }
-
- return escapeHtml(name);
- }
-
- function typeKindIsContainer(typeKind) {
- return (
- typeKind === typeKinds.Struct ||
- typeKind === typeKinds.Union ||
- typeKind === typeKinds.Enum ||
- typeKind === typeKinds.Opaque
- );
- }
-
- function declCanRepresentTypeKind(typeKind) {
- return typeKind === typeKinds.ErrorSet || typeKindIsContainer(typeKind);
- }
-
- //
- // function findCteInRefPath(path) {
- // for (let i = path.length - 1; i >= 0; i -= 1) {
- // const ref = path[i];
- // if ("string" in ref) continue;
- // if ("comptimeExpr" in ref) return ref;
- // if ("refPath" in ref) return findCteInRefPath(ref.refPath);
- // return null;
- // }
-
- // return null;
- // }
-
- function resolveValue(value, trackDecls) {
- let seenDecls = [];
- let i = 0;
- while (true) {
- i += 1;
- if (i >= 10000) {
- throw "resolveValue quota exceeded"
- }
-
- if ("refPath" in value.expr) {
- value = { expr: value.expr.refPath[value.expr.refPath.length - 1] };
- continue;
- }
-
- if ("declRef" in value.expr) {
- seenDecls.push(value.expr.declRef);
- value = getDecl(value.expr.declRef).value;
- continue;
- }
-
- if ("as" in value.expr) {
- value = {
- typeRef: zigAnalysis.exprs[value.expr.as.typeRefArg],
- expr: zigAnalysis.exprs[value.expr.as.exprArg],
- };
- continue;
- }
-
- if (trackDecls) return { value, seenDecls };
- return value;
- }
- }
-
- function resolveGenericRet(genericFunc) {
- if (genericFunc.generic_ret == null) return null;
- let result = resolveValue({ expr: genericFunc.generic_ret });
-
- let i = 0;
- while (true) {
- i += 1;
- if (i >= 10000) {
- throw "resolveGenericRet quota exceeded"
- }
-
- if ("call" in result.expr) {
- let call = zigAnalysis.calls[result.expr.call];
- let resolvedFunc = resolveValue({ expr: call.func });
- if (!("type" in resolvedFunc.expr)) return null;
- let callee = getType(resolvedFunc.expr.type);
- if (!callee.generic_ret) return null;
- result = resolveValue({ expr: callee.generic_ret });
- continue;
- }
-
- return result;
- }
- }
-
- // function typeOfDecl(decl){
- // return decl.value.typeRef;
- //
- // let i = 0;
- // while(i < 1000) {
- // i += 1;
- // console.assert(isDecl(decl));
- // if ("type" in decl.value) {
- // return ({ type: typeTypeId });
- // }
- //
- //// if ("string" in decl.value) {
- //// return ({ type: {
- //// kind: typeKinds.Pointer,
- //// size: pointerSizeEnum.One,
- //// child: });
- //// }
- //
- // if ("refPath" in decl.value) {
- // decl = ({
- // value: decl.value.refPath[decl.value.refPath.length -1]
- // });
- // continue;
- // }
- //
- // if ("declRef" in decl.value) {
- // decl = zigAnalysis.decls[decl.value.declRef];
- // continue;
- // }
- //
- // if ("int" in decl.value) {
- // return decl.value.int.typeRef;
- // }
- //
- // if ("float" in decl.value) {
- // return decl.value.float.typeRef;
- // }
- //
- // if ("array" in decl.value) {
- // return decl.value.array.typeRef;
- // }
- //
- // if ("struct" in decl.value) {
- // return decl.value.struct.typeRef;
- // }
- //
- // if ("comptimeExpr" in decl.value) {
- // const cte = zigAnalysis.comptimeExprs[decl.value.comptimeExpr];
- // return cte.typeRef;
- // }
- //
- // if ("call" in decl.value) {
- // const fn_call = zigAnalysis.calls[decl.value.call];
- // let fn_decl = undefined;
- // if ("declRef" in fn_call.func) {
- // fn_decl = zigAnalysis.decls[fn_call.func.declRef];
- // } else if ("refPath" in fn_call.func) {
- // console.assert("declRef" in fn_call.func.refPath[fn_call.func.refPath.length -1]);
- // fn_decl = zigAnalysis.decls[fn_call.func.refPath[fn_call.func.refPath.length -1].declRef];
- // } else throw {};
- //
- // const fn_decl_value = resolveValue(fn_decl.value);
- // console.assert("type" in fn_decl_value); //TODO handle comptimeExpr
- // const fn_type = (zigAnalysis.types[fn_decl_value.type]);
- // console.assert(fn_type.kind === typeKinds.Fn);
- // return fn_type.ret;
- // }
- //
- // if ("void" in decl.value) {
- // return ({ type: typeTypeId });
- // }
- //
- // if ("bool" in decl.value) {
- // return ({ type: typeKinds.Bool });
- // }
- //
- // console.log("TODO: handle in `typeOfDecl` more cases: ", decl);
- // console.assert(false);
- // throw {};
- // }
- // console.assert(false);
- // return ({});
- // }
- function detectDeclPath(text, context) {
- let result = "";
- let separator = ":";
- const components = text.split(".");
- let curDeclOrType = undefined;
-
- let curContext = context;
- let limit = 10000;
- while (curContext) {
- limit -= 1;
-
- if (limit == 0) {
- throw "too many iterations";
- }
-
- curDeclOrType = findSubDecl(curContext, components[0]);
-
- if (!curDeclOrType) {
- if (curContext.parent_container == null) break;
- curContext = getType(curContext.parent_container);
- continue;
- }
-
- if (curContext == context) {
- separator = '.';
- result = location.hash + separator + components[0];
- } else {
- // We had to go up, which means we need a new path!
- const canonPath = getCanonDeclPath(curDeclOrType.find_subdecl_idx);
- if (!canonPath) return;
-
- let lastModName = canonPath.modNames[canonPath.modNames.length - 1];
- let fullPath = lastModName + ":" + canonPath.declNames.join(".");
-
- separator = '.';
- result = "#A;" + fullPath;
- }
-
- break;
- }
-
- if (!curDeclOrType) {
- for (let i = 0; i < zigAnalysis.modules.length; i += 1){
- const p = zigAnalysis.modules[i];
- if (p.name == components[0]) {
- curDeclOrType = getType(p.main);
- result += "#A;" + components[0];
- break;
- }
- }
- }
-
- if (!curDeclOrType) return null;
-
- for (let i = 1; i < components.length; i += 1) {
- curDeclOrType = findSubDecl(curDeclOrType, components[i]);
- if (!curDeclOrType) return null;
- result += separator + components[i];
- separator = '.';
- }
-
- return result;
-
- }
-
- function renderGuides() {
- renderTitle();
-
- // set guide mode
- domGuideSwitch.classList.add("active");
- domApiSwitch.classList.remove("active");
- domDocs.classList.add("hidden");
- domSectNavAPI.classList.add("hidden");
- domSectNavGuides.classList.remove("hidden");
- domGuidesSection.classList.remove("hidden");
- domActiveGuide.classList.add("hidden");
- domSectSearchResults.classList.add("hidden");
- domSectSearchAllResultsLink.classList.add("hidden");
- domSectSearchNoResults.classList.add("hidden");
- if (curNavSearch !== "") {
- return renderSearchGuides();
- }
-
- let activeGuide = undefined;
- outer: for (let i = 0; i < zigAnalysis.guideSections.length; i += 1) {
- const section = zigAnalysis.guideSections[i];
- for (let j = 0; j < section.guides.length; j += 1) {
- const guide = section.guides[j];
- if (guide.name == curNav.activeGuide) {
- activeGuide = guide;
- break outer;
- }
+ throw new Error("unrecognized category " + category);
}
}
+ function renderSource(path) {
+ const decl_index = findFileRoot(path);
+ if (decl_index == null) return renderNotFound();
- // navigation bar
-
- const guideIndexDom = domListNavGuides.children[0].children[0];
- const guideDom = domListNavGuides.children[1].children[0];
- if (activeGuide){
- guideDom.textContent = activeGuide.title;
- guideDom.setAttribute("href", location.hash);
- guideDom.classList.remove("hidden");
- guideIndexDom.classList.remove("active");
- } else {
- guideDom.classList.add("hidden");
- guideIndexDom.classList.add("active");
- }
+ renderNavFancy(decl_index, [{
+ name: "[src]",
+ href: location.hash,
+ }]);
- // main content
- domGuidesMenuTitle.textContent = "Table of Contents";
- if (activeGuide) {
- if (activeGuide.toc != "") {
- domGuideTocList.innerHTML = activeGuide.toc;
- // add js callbacks to all links
- function onLinkClick(ev) {
- const link = ev.target.getAttribute("href");
- skipNextHashChange = link;
- location.replace(link);
- scrollToHeading(":" + link.split(":")[1], true);
- ev.preventDefault();
- ev.stopPropagation();
- }
- for (let a of domGuideTocList.querySelectorAll("a")) {
- a.addEventListener('click', onLinkClick, false);
- }
- domGuideTocList.classList.remove("hidden");
- domGuideTocListEmtpy.classList.add("hidden");
- } else {
- domGuideTocListEmtpy.classList.remove("hidden");
- domGuideTocList.classList.add("hidden");
- }
-
- let reader = new commonmark.Parser({
- smart: true,
- autoDoc: {
- detectDeclPath: detectDeclPath,
- }
- });
- let ast = reader.parse(activeGuide.body);
- let writer = new commonmark.HtmlRenderer();
- let result = writer.render(ast);
- domActiveGuide.innerHTML = result;
- if (curNav.activeGuideScrollTo !== null) {
- scrollToHeading(curNav.activeGuideScrollTo, false);
- }
- } else {
- domGuideTocList.classList.add("hidden");
- domGuideTocListEmtpy.classList.remove("hidden");
-
- if (zigAnalysis.guideSections.length > 1 || (zigAnalysis.guideSections[0].guides.length > 0)) {
- renderGuidesIndex();
- } else {
- noGuidesAtAll();
- }
+ domSourceText.innerHTML = declSourceHtml(decl_index);
+
+ domSectSource.classList.remove("hidden");
}
- domGuidesMenu.classList.remove("hidden");
- domActiveGuide.classList.remove("hidden");
- }
+ function renderDeclHeading(decl_index) {
+ curNav.viewSourceHash = "#src/" + unwrapString(wasm_exports.decl_file_path(decl_index));
- // TODO: ensure unique hashes
- // TODO: hash also guides and their headings
- function computeGuideHashes() {
- for (let i = 1; i < zigAnalysis.guideSections.length; i += 1) {
- const section = zigAnalysis.guideSections[i];
- section.hash = "section-" + slugify(section.name || i);
- }
- }
-
- function renderGuidesIndex() {
- // main content
- {
- let html = "";
- for (let i = 0; i < zigAnalysis.guideSections.length; i += 1) {
- const section = zigAnalysis.guideSections[i];
- if (i != 0) { // first section is the default section
- html += "Keyboard Shortcuts
+- ?
- Show this help dialog
- Esc
- Clear focus; close this dialog
- s
- Focus the search field
- u
- Go to source code
- ↑
- Move up in search results
- ↓
- Move down in search results
- ⏎
- Go to active search result
" + section.name + "
"; - } - for (let guide of section.guides) { - html += "- " + (guide.title || guide.name) + " "; - html += guide.toc + "
- "+html+"
There are no doc comments for this declaration.
"; - } - domTldDocs.classList.remove("hidden"); - } - - function typeIsErrSet(typeIndex) { - let typeObj = getType(typeIndex); - return typeObj.kind === typeKinds.ErrorSet; - } - - function typeIsStructWithNoFields(typeIndex) { - let typeObj = getType(typeIndex); - if (typeObj.kind !== typeKinds.Struct) return false; - return typeObj.field_types.length == 0; - } - - function typeIsGenericFn(typeIndex) { - let typeObj = getType(typeIndex); - if (typeObj.kind !== typeKinds.Fn) { - return false; - } - return typeObj.generic_ret != null; - } - - function renderFn(fnDecl) { - if ("refPath" in fnDecl.value.expr) { - let last = fnDecl.value.expr.refPath.length - 1; - let lastExpr = fnDecl.value.expr.refPath[last]; - console.assert("declRef" in lastExpr); - fnDecl = getDecl(lastExpr.declRef); - } - - let value = resolveValue(fnDecl.value); - console.assert("type" in value.expr); - let typeObj = getType(value.expr.type); - - domFnProtoCode.innerHTML = renderTokens(ex(value.expr, { fnDecl: fnDecl })); - domFnSourceLink.classList.remove("hidden"); - domFnSourceLink.innerHTML = "[src]"; - - let docsSource = null; - let srcNode = getAstNode(fnDecl.src); - if (srcNode.docs != null) { - docsSource = srcNode.docs; - } - - renderFnParamDocs(fnDecl, typeObj); - - let retExpr = resolveValue({ expr: typeObj.ret }).expr; - if ("type" in retExpr) { - let retIndex = retExpr.type; - let errSetTypeIndex = null; - let retType = getType(retIndex); - if (retType.kind === typeKinds.ErrorSet) { - errSetTypeIndex = retIndex; - } else if (retType.kind === typeKinds.ErrorUnion) { - errSetTypeIndex = retType.err.type; - } - if (errSetTypeIndex != null) { - let errSetType = getType(errSetTypeIndex); - renderErrorSet(errSetType); - } - } - - let protoSrcIndex = fnDecl.src; - if (typeIsGenericFn(value.expr.type)) { - // does the generic_ret contain a container? - var resolvedGenericRet = resolveValue({ expr: typeObj.generic_ret }); - - if ("call" in resolvedGenericRet.expr) { - let call = zigAnalysis.calls[resolvedGenericRet.expr.call]; - let resolvedFunc = resolveValue({ expr: call.func }); - if (!("type" in resolvedFunc.expr)) return; - let callee = getType(resolvedFunc.expr.type); - if (!callee.generic_ret) return; - resolvedGenericRet = resolveValue({ expr: callee.generic_ret }); - } - - // TODO: see if unwrapping the `as` here is a good idea or not. - if ("as" in resolvedGenericRet.expr) { - resolvedGenericRet = { - expr: zigAnalysis.exprs[resolvedGenericRet.expr.as.exprArg], - }; - } - - if (!("type" in resolvedGenericRet.expr)) return; - const genericType = getType(resolvedGenericRet.expr.type); - if (isContainerType(genericType)) { - renderContainer(genericType); - } - - // old code - // let instantiations = nodesToFnsMap[protoSrcIndex]; - // let calls = nodesToCallsMap[protoSrcIndex]; - // if (instantiations == null && calls == null) { - // domFnNoExamples.classList.remove("hidden"); - // } else if (calls != null) { - // // if (fnObj.combined === undefined) fnObj.combined = allCompTimeFnCallsResult(calls); - // if (fnObj.combined != null) renderContainer(fnObj.combined); - - // resizeDomList(domListFnExamples, calls.length, ''); - - // for (let callI = 0; callI < calls.length; callI += 1) { - // let liDom = domListFnExamples.children[callI]; - // liDom.innerHTML = getCallHtml(fnDecl, calls[callI]); - // } - - // domFnExamples.classList.remove("hidden"); - // } else if (instantiations != null) { - // // TODO - // } - } else { - domFnExamples.classList.add("hidden"); - domFnNoExamples.classList.add("hidden"); - } - - let protoSrcNode = getAstNode(protoSrcIndex); - if ( - docsSource == null && - protoSrcNode != null && - protoSrcNode.docs != null - ) { - docsSource = protoSrcNode.docs; - } - if (docsSource != null) { - domTldDocs.innerHTML = markdown(docsSource, fnDecl); - domTldDocs.classList.remove("hidden"); - } - domFnProto.classList.remove("hidden"); - } - - function renderFnParamDocs(fnDecl, typeObj) { - let docCount = 0; - - let fnNode = getAstNode(fnDecl.src); - let fields = fnNode.fields; - if (fields === null) { - fields = getAstNode(typeObj.src).fields; - } - let isVarArgs = typeObj.is_var_args; - - for (let i = 0; i < fields.length; i += 1) { - let field = fields[i]; - let fieldNode = getAstNode(field); - if (fieldNode.docs != null) { - docCount += 1; - } - } - if (docCount == 0) { - return; - } - - resizeDomList(domListParams, docCount, ""); - let domIndex = 0; - - for (let i = 0; i < fields.length; i += 1) { - let field = fields[i]; - let fieldNode = getAstNode(field); - let docs = fieldNode.docs; - if (fieldNode.docs == null) { - continue; - } - let docsNonEmpty = docs !== ""; - let divDom = domListParams.children[domIndex]; - domIndex += 1; - - let value = typeObj.params[i]; - let preClass = docsNonEmpty ? ' class="fieldHasDocs"' : ""; - let html = "' + markdown(docs) + "
";
- }
- divDom.innerHTML = html;
- }
- domSectParams.classList.remove("hidden");
- }
-
- function renderNav() {
- let len = curNav.modNames.length + curNav.declNames.length;
- resizeDomList(domListNavAPI, len, '" + name + "(" - + zigAnalysis.typeKinds[typeObj.kind] + ")"; + const hdrNameSpan = domHdrName.children[0]; + const srcLink = domHdrName.children[1]; + hdrNameSpan.innerText = unwrapString(wasm_exports.decl_category_name(decl_index)); + srcLink.setAttribute('href', curNav.viewSourceHash); domHdrName.classList.remove("hidden"); - } - if (typeObj.kind == typeKinds.ErrorSet) { - renderErrorSet(typeObj); - } - } - function renderErrorSet(errSetType) { - if (errSetType.fields == null) { - domFnErrorsAnyError.classList.remove("hidden"); - } else { - let errorList = []; - for (let i = 0; i < errSetType.fields.length; i += 1) { - let errObj = errSetType.fields[i]; - //let srcObj = zigAnalysis.astNodes[errObj.src]; - errorList.push(errObj); - } - errorList.sort(function(a, b) { - return operatorCompare(a.name.toLowerCase(), b.name.toLowerCase()); - }); - - resizeDomListDl(domListFnErrors, errorList.length); - for (let i = 0; i < errorList.length; i += 1) { - let nameTdDom = domListFnErrors.children[i * 2 + 0]; - let descTdDom = domListFnErrors.children[i * 2 + 1]; - nameTdDom.textContent = errorList[i].name; - let 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) { - // let srcIndex = zigAnalysis.fns[value].src; - // let calls = nodesToCallsMap[srcIndex]; - // if (calls == null) return false; - // for (let i = 0; i < calls.length; i += 1) { - // let call = zigAnalysis.calls[calls[i]]; - // if (call.result.type !== typeTypeId) return false; - // } - // return true; - // } - // - // function allCompTimeFnCallsResult(calls) { - // let firstTypeObj = null; - // let containerObj = { - // privDecls: [], - // }; - // for (let callI = 0; callI < calls.length; callI += 1) { - // let call = zigAnalysis.calls[calls[callI]]; - // if (call.result.type !== typeTypeId) return null; - // let typeObj = zigAnalysis.types[call.result.value]; - // if (!typeKindIsContainer(typeObj.kind)) return null; - // if (firstTypeObj == null) { - // firstTypeObj = typeObj; - // containerObj.src = typeObj.src; - // } else if (firstTypeObj.src !== typeObj.src) { - // return null; - // } - // - // if (containerObj.fields == null) { - // containerObj.fields = (typeObj.fields || []).concat([]); - // } else for (let fieldI = 0; fieldI < typeObj.fields.length; fieldI += 1) { - // let prev = containerObj.fields[fieldI]; - // let next = typeObj.fields[fieldI]; - // if (prev === next) continue; - // if (typeof(prev) === 'object') { - // if (prev[next] == null) prev[next] = typeObj; - // } else { - // containerObj.fields[fieldI] = {}; - // containerObj.fields[fieldI][prev] = firstTypeObj; - // containerObj.fields[fieldI][next] = typeObj; - // } - // } - // - // if (containerObj.pubDecls == null) { - // containerObj.pubDecls = (typeObj.pubDecls || []).concat([]); - // } else for (let declI = 0; declI < typeObj.pubDecls.length; declI += 1) { - // let prev = containerObj.pubDecls[declI]; - // let next = typeObj.pubDecls[declI]; - // if (prev === next) continue; - // // TODO instead of showing "examples" as the public declarations, - // // do logic like this: - // //if (typeof(prev) !== 'object') { - // // let newDeclId = zigAnalysis.decls.length; - // // prev = clone(zigAnalysis.decls[prev]); - // // prev.id = newDeclId; - // // zigAnalysis.decls.push(prev); - // // containerObj.pubDecls[declI] = prev; - // //} - // //mergeDecls(prev, next, firstTypeObj, typeObj); - // } - // } - // for (let declI = 0; declI < containerObj.pubDecls.length; declI += 1) { - // let decl = containerObj.pubDecls[declI]; - // if (typeof(decl) === 'object') { - // containerObj.pubDecls[declI] = containerObj.pubDecls[declI].id; - // } - // } - // return containerObj; - // } - - function renderValue(decl) { - let resolvedValue = resolveValue(decl.value); - if (resolvedValue.expr.fieldRef) { - const declRef = decl.value.expr.refPath[0].declRef; - const type = getDecl(declRef); - - domFnProtoCode.innerHTML = renderTokens( - (function*() { - yield Tok.const; - yield Tok.space; - yield Tok.identifier(decl.name); - yield Tok.colon; - yield Tok.space; - yield Tok.identifier(type.name); - yield Tok.space; - yield Tok.eql; - yield Tok.space; - yield* ex(decl.value.expr, {}); - yield Tok.semi; - })()); - } else if ( - resolvedValue.expr.string !== undefined || - resolvedValue.expr.call !== undefined || - resolvedValue.expr.comptimeExpr !== undefined - ) { - // TODO: we're using the resolved value but - // not keeping track of how we got there - // that's important context that should - // be shown to the user! - domFnProtoCode.innerHTML = renderTokens( - (function*() { - yield Tok.const; - yield Tok.space; - yield Tok.identifier(decl.name); - if (decl.value.typeRef) { - yield Tok.colon; - yield Tok.space; - yield* ex(decl.value.typeRef, {}); - } - yield Tok.space; - yield Tok.eql; - yield Tok.space; - yield* ex(resolvedValue.expr, {}); - yield Tok.semi; - })()); - } else if (resolvedValue.expr.compileError) { - domFnProtoCode.innerHTML = renderTokens( - (function*() { - yield Tok.const; - yield Tok.space; - yield Tok.identifier(decl.name); - yield Tok.space; - yield Tok.eql; - yield Tok.space; - yield* ex(decl.value.expr, {}); - yield Tok.semi; - })()); - } else { - const parent = getType(decl.parent_container); - domFnProtoCode.innerHTML = renderTokens( - (function*() { - yield Tok.const; - yield Tok.space; - yield Tok.identifier(decl.name); - if (decl.value.typeRef !== null) { - yield Tok.colon; - yield Tok.space; - yield* ex(decl.value.typeRef, {}); - } - yield Tok.space; - yield Tok.eql; - yield Tok.space; - yield* ex(decl.value.expr, {}); - yield Tok.semi; - })()); + renderTopLevelDocs(decl_index); } - let docs = getAstNode(decl.src).docs; - if (docs != null) { - // TODO: it shouldn't just be decl.parent_container, but rather - // the type that the decl holds (if the value is a type) - domTldDocs.innerHTML = markdown(docs, decl); - - domTldDocs.classList.remove("hidden"); - } - - domFnProto.classList.remove("hidden"); - } - - function renderVar(decl) { - let resolvedVar = resolveValue(decl.value); - - if (resolvedVar.expr.fieldRef) { - const declRef = decl.value.expr.refPath[0].declRef; - const type = getDecl(declRef); - domFnProtoCode.innerHTML = renderTokens( - (function*() { - yield Tok.var; - yield Tok.space; - yield Tok.identifier(decl.name); - yield Tok.colon; - yield Tok.space; - yield Tok.identifier(type.name); - yield Tok.space; - yield Tok.eql; - yield Tok.space; - yield* ex(decl.value.expr, {}); - yield Tok.semi; - })()); - } else if ( - resolvedVar.expr.string !== undefined || - resolvedVar.expr.call !== undefined || - resolvedVar.expr.comptimeExpr !== undefined - ) { - domFnProtoCode.innerHTML = renderTokens( - (function*() { - yield Tok.var; - yield Tok.space; - yield Tok.identifier(decl.name); - if (decl.value.typeRef) { - yield Tok.colon; - yield Tok.space; - yield* ex(decl.value.typeRef, {}); - } - yield Tok.space; - yield Tok.eql; - yield Tok.space; - yield* ex(decl.value.expr, {}); - yield Tok.semi; - })()); - } else if (resolvedVar.expr.compileError) { - domFnProtoCode.innerHTML = renderTokens( - (function*() { - yield Tok.var; - yield Tok.space; - yield Tok.identifier(decl.name); - yield Tok.space; - yield Tok.eql; - yield Tok.space; - yield* ex(decl.value.expr, {}); - yield Tok.semi; - })()); - } else { - domFnProtoCode.innerHTML = renderTokens( - (function*() { - yield Tok.var; - yield Tok.space; - yield Tok.identifier(decl.name); - yield Tok.colon; - yield Tok.space; - yield* ex(resolvedVar.typeRef, {}); - yield Tok.space; - yield Tok.eql; - yield Tok.space; - yield* ex(decl.value.expr, {}); - yield Tok.semi; - })()); - } - - let docs = getAstNode(decl.src).docs; - if (docs != null) { - domTldDocs.innerHTML = markdown(docs); - domTldDocs.classList.remove("hidden"); - } - - domFnProto.classList.remove("hidden"); - } - - function categorizeDecls( - decls, - typesList, - namespacesWithDocsList, - namespacesNoDocsList, - errSetsList, - fnsList, - varsList, - valsList, - testsList, - unsList - ) { - for (let i = 0; i < decls.length; i += 1) { - let decl = getDecl(decls[i]); - let declValue = resolveValue(decl.value); - - // if (decl.isTest) { - // testsList.push(decl); - // continue; - // } - - if (decl.kind === "var") { - varsList.push(decl); - continue; - } - - if (decl.kind === "const") { - if ("type" in declValue.expr) { - // We have the actual type expression at hand. - const typeExpr = getType(declValue.expr.type); - if (typeExpr.kind == typeKinds.Fn) { - const funcRetExpr = resolveValue({ - expr: typeExpr.ret, - }); - if ( - "type" in funcRetExpr.expr && - funcRetExpr.expr.type == typeTypeId - ) { - if (typeIsErrSet(declValue.expr.type)) { - errSetsList.push(decl); - } else if (typeIsStructWithNoFields(declValue.expr.type)) { - - let docs = getAstNode(decl.src).docs; - if (!docs) { - // If this is a re-export, try to fetch docs from the actual definition - const { value, seenDecls } = resolveValue(decl.value, true); - if (seenDecls.length > 0) { - const definitionDecl = getDecl(seenDecls[seenDecls.length - 1]); - docs = getAstNode(definitionDecl.src).docs; - } else { - docs = getAstNode(getType(value.expr.type).src).docs; - } - } - - if (docs) { - namespacesWithDocsList.push({decl, docs}); - } else { - namespacesNoDocsList.push(decl); - } - } else { - typesList.push(decl); - } - } else { - fnsList.push(decl); - } - } else { - if (typeIsErrSet(declValue.expr.type)) { - errSetsList.push(decl); - } else if (typeIsStructWithNoFields(declValue.expr.type)) { - let docs = getAstNode(decl.src).docs; - if (!docs) { - // If this is a re-export, try to fetch docs from the actual definition - const { value, seenDecls } = resolveValue(decl.value, true); - if (seenDecls.length > 0) { - const definitionDecl = getDecl(seenDecls[seenDecls.length - 1]); - docs = getAstNode(definitionDecl.src).docs; - } else { - docs = getAstNode(getType(value.expr.type).src).docs; - } - } - if (docs) { - namespacesWithDocsList.push({decl, docs}); - } else { - namespacesNoDocsList.push(decl); - } - } else { - typesList.push(decl); - } - } - } else if (declValue.typeRef) { - if ("type" in declValue.typeRef && declValue.typeRef == typeTypeId) { - // We don't know what the type expression is, but we know it's a type. - typesList.push(decl); - } else { - valsList.push(decl); - } - } else { - valsList.push(decl); - } - } - - if (decl.is_uns) { - unsList.push(decl); - } - } - } - - function sourceFileLink(decl) { - const srcNode = getAstNode(decl.src); - const srcFile = getFile(srcNode.file); - return sourceFileUrlTemplate. - replace("{{mod}}", zigAnalysis.modules[srcFile.modIndex].name). - replace("{{file}}", srcFile.name). - replace("{{line}}", srcNode.line + 1); - } - - function renderContainer(container) { - let typesList = []; - - let namespacesWithDocsList = []; - let namespacesNoDocsList = []; - - let errSetsList = []; - - let fnsList = []; - - let varsList = []; - - let valsList = []; - - let testsList = []; - - let unsList = []; - - categorizeDecls( - container.pubDecls, - typesList, - namespacesWithDocsList, - namespacesNoDocsList, - errSetsList, - fnsList, - varsList, - valsList, - testsList, - unsList - ); - if (curNav.showPrivDecls) - categorizeDecls( - container.privDecls, - typesList, - namespacesWithDocsList, - namespacesNoDocsList, - errSetsList, - fnsList, - varsList, - valsList, - testsList, - unsList - ); - - while (unsList.length > 0) { - let uns = unsList.shift(); - let declValue = resolveValue(uns.value); - if (!("type" in declValue.expr)) continue; - let uns_container = getType(declValue.expr.type); - if (!isContainerType(uns_container)) continue; - categorizeDecls( - uns_container.pubDecls, - typesList, - namespacesWithDocsList, - namespacesNoDocsList, - errSetsList, - fnsList, - varsList, - valsList, - testsList, - unsList - ); - if (curNav.showPrivDecls) - categorizeDecls( - uns_container.privDecls, - typesList, - namespacesWithDocsList, - namespacesNoDocsList, - errSetsList, - fnsList, - varsList, - valsList, - testsList, - unsList - ); - } - - typesList.sort(byNameProperty); - namespacesWithDocsList.sort(byNameProperty); - namespacesNoDocsList.sort(byNameProperty); - errSetsList.sort(byNameProperty); - fnsList.sort(byNameProperty); - varsList.sort(byNameProperty); - valsList.sort(byNameProperty); - testsList.sort(byNameProperty); - - if (container.src != null) { - let docs = getAstNode(container.src).docs; - if (docs != null) { - domTldDocs.innerHTML = markdown(docs, container); + function renderTopLevelDocs(decl_index) { + const tld_docs_html = unwrapString(wasm_exports.decl_docs_html(decl_index, false)); + if (tld_docs_html.length > 0) { + domTldDocs.innerHTML = tld_docs_html; domTldDocs.classList.remove("hidden"); } } - if (typesList.length !== 0) { - const splitPoint = Math.ceil(typesList.length / 2); - const template = '
No documentation provided.
"; - } - if (i == splitPoint - 1) { - activeList = domListTypesRight; - offset = splitPoint; - } - } - domSectTypes.classList.remove("hidden"); - } - - if (namespacesWithDocsList.length !== 0) { - const splitPoint = Math.ceil(namespacesWithDocsList.length / 2); - const template = '" + short + "
" + "" + long + "
";
- }
- else {
- tdDesc.innerHTML = markdown(short, container);
- }
- } else {
- tdDesc.innerHTML = "No documentation provided.
"; - } - } - domSectFns.classList.remove("hidden"); - } - - let containerNode = getAstNode(container.src); - if (containerNode.fields && containerNode.fields.length > 0) { - resizeDomList(domListFields, containerNode.fields.length, "
"); - - for (let i = 0; i < containerNode.fields.length; i += 1) { - let fieldNode = getAstNode(containerNode.fields[i]); - let divDom = domListFields.children[i]; - let fieldName = fieldNode.name; - let docs = fieldNode.docs; - let docsNonEmpty = docs != null && docs !== ""; - let extraPreClass = docsNonEmpty ? " fieldHasDocs" : ""; - - let html = - '' +
- escapeHtml(fieldName);
-
- if (container.kind === typeKinds.Enum) {
- let value = container.values[i];
- if (value !== null) {
- html += renderTokens((function*() {
- yield Tok.space;
- yield Tok.eql;
- yield Tok.space;
- yield* ex(value, {});
- })());
- }
- } else {
- let fieldTypeExpr = container.field_types[i];
- if (container.kind !== typeKinds.Struct || !container.is_tuple) {
- html += renderTokens((function*() {
- yield Tok.colon;
- yield Tok.space;
- })());
- }
- html += renderTokens(ex(fieldTypeExpr, {}));
- let tsn = typeShorthandName(fieldTypeExpr);
- if (tsn) {
- html += " (" + tsn + ")";
- }
- if (container.kind === typeKinds.Struct && !container.is_tuple) {
- let defaultInitExpr = container.field_defaults[i];
- if (defaultInitExpr !== null) {
- html += renderTokens((function*() {
- yield Tok.space;
- yield Tok.eql;
- yield Tok.space;
- yield* ex(defaultInitExpr, {});
- })());
- }
- }
- }
-
- html += ",' + markdown(docs) + "
";
- }
- divDom.innerHTML = html;
- }
- domSectFields.classList.remove("hidden");
- }
-
- if (varsList.length !== 0) {
- resizeDomList(
- domListGlobalVars,
- varsList.length,
- '" + - zigAnalysis.typeKinds[container.kind] + - ""; - domHdrName.classList.remove("hidden"); - } - } - - function operatorCompare(a, b) { - if (a === b) { - return 0; - } else if (a < b) { - return -1; - } else { - return 1; - } - } - - function detectRootIsStd() { - let rootMod = zigAnalysis.modules[zigAnalysis.rootMod]; - if (rootMod.table["std"] == null) { - // no std mapped into the root module - return false; - } - let stdMod = zigAnalysis.modules[rootMod.table["std"]]; - if (stdMod == null) return false; - return rootMod.file === stdMod.file; - } - - function indexTypeKinds() { - let map = {}; - for (let i = 0; i < zigAnalysis.typeKinds.length; i += 1) { - map[zigAnalysis.typeKinds[i]] = i; - } - // This is just for debugging purposes, not needed to function - let assertList = [ - "Type", - "Void", - "Bool", - "NoReturn", - "Int", - "Float", - "Pointer", - "Array", - "Struct", - "ComptimeFloat", - "ComptimeInt", - "Undefined", - "Null", - "Optional", - "ErrorUnion", - "ErrorSet", - "Enum", - "Union", - "Fn", - "Opaque", - "Frame", - "AnyFrame", - "Vector", - "EnumLiteral", - ]; - for (let i = 0; i < assertList.length; i += 1) { - if (map[assertList[i]] == null) - throw new Error("No type kind '" + assertList[i] + "' found"); - } - return map; - } - - function findTypeTypeId() { - for (let i = 0; i < zigAnalysis.types.length; i += 1) { - if (getType(i).kind == typeKinds.Type) { - return i; - } - } - throw new Error("No type 'type' found"); - } - - - function updateCurNav() { - curNav = { - hash: location.hash, - mode: NAV_MODES.API, - modNames: [], - modObjs: [], - declNames: [], - declObjs: [], - callName: null, - activeGuide: null, - activeGuideScrollTo: null, - }; - curNavSearch = ""; - - const mode = location.hash.substring(0, 3); - let query = location.hash.substring(3); - - let qpos = query.indexOf("?"); - let nonSearchPart; - if (qpos === -1) { - nonSearchPart = query; - } else { - nonSearchPart = query.substring(0, qpos); - curNavSearch = decodeURIComponent(query.substring(qpos + 1)); - } - - const DEFAULT_HASH = NAV_MODES.API + zigAnalysis.modules[zigAnalysis.rootMod].name; - switch (mode) { - case NAV_MODES.API: - // #A;MODULE:decl.decl.decl?search-term - curNav.mode = mode; - { - let parts = nonSearchPart.split(":"); - if (parts[0] == "") { - location.hash = DEFAULT_HASH; - } else { - curNav.modNames = decodeURIComponent(parts[0]).split("."); - } - - if (parts[1] != null) { - curNav.declNames = decodeURIComponent(parts[1]).split("."); - } - } - return; - case NAV_MODES.GUIDES: - curNav.mode = mode; - - { - let parts = nonSearchPart.split(":"); - curNav.activeGuide = parts[0]; - if (parts[1] != null) { - curNav.activeGuideScrollTo = decodeURIComponent(":" + parts[1]); - } - } - return; - default: - location.hash = DEFAULT_HASH; - return; - } - } - - function onHashChange(ev) { - scrollHistory[curNav.hash] = scrollMonitor.map(function (x) { - return [x, x.scrollTop] - }); - - if (skipNextHashChange == decodeURIComponent(location.hash)) { - skipNextHashChange = null; - return; - } - skipNextHashChange = null; - updateCurNav(); - - if (domSearch.value !== curNavSearch) { - domSearch.value = curNavSearch; - if (domSearch.value.length == 0) - domSearchPlaceholder.classList.remove("hidden"); - else - domSearchPlaceholder.classList.add("hidden"); - } - render(); - if (imFeelingLucky) { - imFeelingLucky = false; - activateSelectedResult(); - } - - scroll(); - } - - function scroll() { - const cur = scrollHistory[location.hash]; - if (cur) { - for (let [elem, offset] of cur) { - elem.scrollTo(0, offset); - } - } else { - if (curNav.activeGuideScrollTo) return; - for (let elem of scrollMonitor) { - elem.scrollTo(0, 0); - } - } - } - - function findSubDecl(parentTypeOrDecl, childName) { - let parentType = parentTypeOrDecl; - { - // Generic functions / resolving decls - if ("value" in parentType) { - const rv = resolveValue(parentType.value); - if ("type" in rv.expr) { - const t = getType(rv.expr.type); - parentType = t; - if (t.kind == typeKinds.Fn && t.generic_ret != null) { - let resolvedGenericRet = resolveValue({ expr: t.generic_ret }); - - if ("call" in resolvedGenericRet.expr) { - let call = zigAnalysis.calls[resolvedGenericRet.expr.call]; - let resolvedFunc = resolveValue({ expr: call.func }); - if (!("type" in resolvedFunc.expr)) return null; - let callee = getType(resolvedFunc.expr.type); - if (!callee.generic_ret) return null; - resolvedGenericRet = resolveValue({ expr: callee.generic_ret }); - } - - if ("type" in resolvedGenericRet.expr) { - parentType = getType(resolvedGenericRet.expr.type); - } - } - } - } - } - - if (parentType.pubDecls) { - for (let i = 0; i < parentType.pubDecls.length; i += 1) { - let declIndex = parentType.pubDecls[i]; - let childDecl = getDecl(declIndex); - if (childDecl.name === childName) { - childDecl.find_subdecl_idx = declIndex; - return childDecl; - } else if (childDecl.is_uns) { - let declValue = resolveValue(childDecl.value); - if (!("type" in declValue.expr)) continue; - let uns_container = getType(declValue.expr.type); - let uns_res = findSubDecl(uns_container, childName); - if (uns_res !== null) return uns_res; - } - } - } - - if (parentType.privDecls) { - for (let i = 0; i < parentType.privDecls.length; i += 1) { - let declIndex = parentType.privDecls[i]; - let childDecl = getDecl(declIndex); - if (childDecl.name === childName) { - childDecl.find_subdecl_idx = declIndex; - childDecl.is_private = true; - return childDecl; - } else if (childDecl.is_uns) { - let declValue = resolveValue(childDecl.value); - if (!("type" in declValue.expr)) continue; - let uns_container = getType(declValue.expr.type); - let uns_res = findSubDecl(uns_container, childName); - uns_res.is_private = true; - if (uns_res !== null) return uns_res; - } - } - } - - return null; - } - - function computeCanonicalModulePaths() { - let list = new Array(zigAnalysis.modules.length); - // Now we try to find all the modules from root. - let rootMod = zigAnalysis.modules[zigAnalysis.rootMod]; - // Breadth-first to keep the path shortest possible. - let stack = [ + function renderNavFancy(cur_nav_decl, list) { { - path: [], - mod: rootMod, - }, - ]; - while (stack.length !== 0) { - let item = stack.shift(); - for (let key in item.mod.table) { - let childModIndex = item.mod.table[key]; - if (list[childModIndex] != null) continue; - let childMod = zigAnalysis.modules[childModIndex]; - if (childMod == null) continue; - - let newPath = item.path.concat([key]); - list[childModIndex] = newPath; - stack.push({ - path: newPath, - mod: childMod, - }); - } - } - - for (let i = 0; i < zigAnalysis.modules.length; i += 1) { - const p = zigAnalysis.modules[i]; - // TODO - // declSearchIndex.add(p.name, {moduleId: i}); - } - return list; - } - - function computeCanonDeclPaths() { - let list = new Array(zigAnalysis.decls.length); - canonTypeDecls = new Array(zigAnalysis.types.length); - - for (let modI = 0; modI < zigAnalysis.modules.length; modI += 1) { - let mod = zigAnalysis.modules[modI]; - let modNames = canonModPaths[modI]; - if (modNames === undefined) continue; - - let stack = [ - { - declNames: [], - declIndexes: [], - type: getType(mod.main), - }, - ]; - while (stack.length !== 0) { - let item = stack.shift(); - - if (isContainerType(item.type)) { - let t = item.type; - - let len = t.pubDecls ? t.pubDecls.length : 0; - for (let declI = 0; declI < len; declI += 1) { - let declIndex = t.pubDecls[declI]; - if (list[declIndex] != null) continue; - - let decl = getDecl(declIndex); - - if (decl.is_uns) { - let unsDeclList = [decl]; - while (unsDeclList.length != 0) { - let unsDecl = unsDeclList.pop(); - let unsDeclVal = resolveValue(unsDecl.value); - if (!("type" in unsDeclVal.expr)) continue; - let unsType = getType(unsDeclVal.expr.type); - if (!isContainerType(unsType)) continue; - let unsPubDeclLen = unsType.pubDecls ? unsType.pubDecls.length : 0; - for (let unsDeclI = 0; unsDeclI < unsPubDeclLen; unsDeclI += 1) { - let childDeclIndex = unsType.pubDecls[unsDeclI]; - let childDecl = getDecl(childDeclIndex); - - if (childDecl.is_uns) { - unsDeclList.push(childDecl); - } else { - addDeclToSearchResults(childDecl, childDeclIndex, modNames, item, list, stack); - } - } - } - } else { - addDeclToSearchResults(decl, declIndex, modNames, item, list, stack); - } - } + // First, walk backwards the decl parents within a file. + let decl_it = cur_nav_decl; + let prev_decl_it = null; + while (decl_it != null) { + list.push({ + name: declIndexName(decl_it), + href: navLinkDeclIndex(decl_it), + }); + prev_decl_it = decl_it; + decl_it = declParent(decl_it); } - } - } - window.cdp = list; - return list; - } - function addDeclToSearchResults(decl, declIndex, modNames, item, list, stack) { - let {value: declVal, seenDecls} = resolveValue(decl.value, true); - let declNames = item.declNames.concat([decl.name]); - let declIndexes = item.declIndexes.concat([declIndex]); - - if (list[declIndex] != null) return; - list[declIndex] = { - modNames: modNames, - declNames: declNames, - declIndexes: declIndexes, - }; - - for (let sd of seenDecls) { - if (list[sd] != null) continue; - list[sd] = { - modNames: modNames, - declNames: declNames, - declIndexes: declIndexes, - }; - } - - // add to search index - { - declSearchIndex.add(decl.name, { declIndex }); - } - - - if ("type" in declVal.expr) { - let value = getType(declVal.expr.type); - if (declCanRepresentTypeKind(value.kind)) { - canonTypeDecls[declVal.type] = declIndex; - } - - if (isContainerType(value)) { - stack.push({ - declNames: declNames, - declIndexes: declIndexes, - type: value, - }); - } - - // Generic function - if (typeIsGenericFn(declVal.expr.type)) { - let ret = resolveGenericRet(value); - if (ret != null && "type" in ret.expr) { - let generic_type = getType(ret.expr.type); - if (isContainerType(generic_type)) { - stack.push({ - declNames: declNames, - declIndexes: declIndexes, - type: generic_type, + // Next, walk backwards the file path segments. + if (prev_decl_it != null) { + const file_path = fullyQualifiedName(prev_decl_it); + const parts = file_path.split("."); + parts.pop(); // skip last + for (;;) { + const href = navLinkFqn(parts.join(".")); + const part = parts.pop(); + if (!part) break; + list.push({ + name: part, + href: href, }); } } + + list.reverse(); } + resizeDomList(domListNav, list.length, '
" - } - for (let result of list) { - const points = result.points; - const match = result.declIndex; - - let canonPath = getCanonDeclPath(match); - if (canonPath == null) continue; - - let lastModName = canonPath.modNames[canonPath.modNames.length - 1]; - let text = lastModName + "." + canonPath.declNames.join("."); - - - const href = navLink(canonPath.modNames, canonPath.declNames); - - matchedItemsHTML += "