mirrors/zig
1
0
Fork 0
mirror of https://codeberg.org/ziglang/zig.git synced 2025-12-06 13:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
zig/lib/docs/main.js
Loris Cro 80f9490e06 autodoc: more js type fixes
2022-07-19 19:10:11 -07:00

2742 lines
94 KiB
JavaScript
Raw Blame History

'use strict';
/**
* @typedef {
| "Type"
| "Void"
| "Bool"
| "NoReturn"
| "Int"
| "Float"
| "Pointer"
| "Array"
| "Struct"
| "ComptimeFloat"
| "ComptimeInt"
| "Undefined"
| "Null"
| "Optional"
| "ErrorUnion"
| "ErrorSet"
| "Enum"
| "Union"
| "Fn"
| "BoundFn"
| "Opaque"
| "Frame"
| "AnyFrame"
| "Vector"
| "EnumLiteral"
| "ComptimeExpr"
| "Unanalyzed"
} TypeKind
*/
/**
* @typedef {{
void: {},
unreachable: {},
anytype: {},
type: number,
comptimeExpr: number,
call: number,
int: { typeRef: WalkResult; value: number },
float: { typeRef: WalkResult; value: number },
bool: boolean,
undefined: WalkResult,
null: WalkResult,
typeOf: WalkResult,
compileError: string,
string: string,
struct: Struct,
refPath: WalkResult[],
declRef: number,
array: ZigArray,
enumLiteral: string,
}} WalkResult
*/
/**
* @typedef {{
kind: number,
name: string,
src: number,
privDecls: number[],
pubDecls: number[],
fields: WalkResult[]
}} ContainerType
*/
/**
* @typedef {{
kind: number,
name: string,
src: number,
ret: WalkResult,
params: WalkResult[]
}} Fn
*/
/**
* @typedef {{
kind: number,
name: string,
fields: { name: string, docs: string }[]
fn: number | undefined,
}} ErrSetType
*/
/**
* @typedef {{
kind: number,
err: WalkResult,
payload: WalkResult,
}} ErrUnionType
*/
// Type, Void, Bool, NoReturn, Int, Float, ComptimeExpr, ComptimeFloat, ComptimeInt, Undefined, Null, ErrorUnion, BoundFn, Opaque, Frame, AnyFrame, Vector, EnumLiteral
/**
* @typedef {{
kind: number,
name: string
}} NumberType
*/
/**
* @typedef {{
kind: number,
size: number,
child: WalkResult
align: number,
bitOffsetInHost: number,
hostIntBytes: number,
volatile: boolean,
const: boolean,
}} PointerType
*/
/**
* @typedef {{
kind: number,
len: WalkResult
child: WalkResult
}} ArrayType
*/
/**
* @typedef {{
kind: number,
name: string,
child: WalkResult
}} OptionalType
*/
/**
* @typedef {
| OptionalType
| ArrayType
| PointerType
| ContainerType
| Fn
| ErrSetType
| ErrUnionType
| NumberType
} Type
*/
/**
* @typedef {{
func: WalkResult,
args: WalkResult[],
ret: WalkResult,
}} Call
*/
/**
* @typedef {{
file: number,
line: number,
col: number,
name?: string,
docs?: string,
fields?: number[],
comptime: boolean,
noalias: boolean,
varArgs: boolean,
}} AstNode
*/
/**
* @typedef {{
name: string,
kind: string,
src: number,
value: WalkResult,
decltest?: number,
isTest: boolean,
}} Decl
*/
/**
* @typedef {{
name: string,
file: number,
main: number,
table: Record<string, number>,
}} Package
*/
/**
* @typedef {{
name: string,
src?: number,
privDecls: number[],
pubDecls: number[],
fields?: WalkResult[],
}} Struct
*/
/**
* @typedef {{
len: WalkResult,
child: WalkResult,
}} ZigArray
*/
/**
* @typedef {{
code: string,
typeRef: WalkResult,
}} ComptimeExpr
*/
/**
* @typedef {{
typeKinds: TypeKind[];
rootPkg: number;
params: {
zigId: string;
zigVersion: string;
target: string;
rootName: string;
builds: { target: string };
};
packages: Package[];
errors: {};
astNodes: AstNode[];
calls: Call[];
files: Record<string, string>;
types: Type[];
decls: Decl[];
comptimeExprs: ComptimeExpr[];
fns: Fn[];
}} DocData
*/
/** @type {DocData} */
var zigAnalysis;
(function() {
var domStatus = /** @type HTMLElement */(document.getElementById("status"));
var domSectNav = /** @type HTMLElement */(document.getElementById("sectNav"));
var domListNav = /** @type HTMLElement */(document.getElementById("listNav"));
var domSectMainPkg = /** @type HTMLElement */(document.getElementById("sectMainPkg"));
var domSectPkgs = /** @type HTMLElement */(document.getElementById("sectPkgs"));
var domListPkgs = /** @type HTMLElement */(document.getElementById("listPkgs"));
var domSectTypes = /** @type HTMLElement */(document.getElementById("sectTypes"));
var domListTypes = /** @type HTMLElement */(document.getElementById("listTypes"));
var domSectTests = /** @type HTMLElement */(document.getElementById("sectTests"));
var domListTests = /** @type HTMLElement */(document.getElementById("listTests"));
var domSectNamespaces = /** @type HTMLElement */(document.getElementById("sectNamespaces"));
var domListNamespaces = /** @type HTMLElement */(document.getElementById("listNamespaces"));
var domSectErrSets = /** @type HTMLElement */(document.getElementById("sectErrSets"));
var domListErrSets = /** @type HTMLElement */(document.getElementById("listErrSets"));
var domSectFns = /** @type HTMLElement */(document.getElementById("sectFns"));
var domListFns = /** @type HTMLElement */(document.getElementById("listFns"));
var domSectFields = /** @type HTMLElement */(document.getElementById("sectFields"));
var domListFields = /** @type HTMLElement */(document.getElementById("listFields"));
var domSectGlobalVars = /** @type HTMLElement */(document.getElementById("sectGlobalVars"));
var domListGlobalVars = /** @type HTMLElement */(document.getElementById("listGlobalVars"));
var domSectValues = /** @type HTMLElement */(document.getElementById("sectValues"));
var domListValues = /** @type HTMLElement */(document.getElementById("listValues"));
var domFnProto = /** @type HTMLElement */(document.getElementById("fnProto"));
var domFnProtoCode = /** @type HTMLElement */(document.getElementById("fnProtoCode"));
var domSectParams = /** @type HTMLElement */(document.getElementById("sectParams"));
var domListParams = /** @type HTMLElement */(document.getElementById("listParams"));
var domTldDocs = /** @type HTMLElement */(document.getElementById("tldDocs"));
var domSectFnErrors = /** @type HTMLElement */(document.getElementById("sectFnErrors"));
var domListFnErrors = /** @type HTMLElement */(document.getElementById("listFnErrors"));
var domTableFnErrors =/** @type HTMLElement */(document.getElementById("tableFnErrors"));
var domFnErrorsAnyError = /** @type HTMLElement */(document.getElementById("fnErrorsAnyError"));
var domFnExamples = /** @type HTMLElement */(document.getElementById("fnExamples"));
var domListFnExamples = /** @type HTMLElement */(document.getElementById("listFnExamples"));
var domFnNoExamples = /** @type HTMLElement */(document.getElementById("fnNoExamples"));
var domDeclNoRef = /** @type HTMLElement */(document.getElementById("declNoRef"));
var domSearch = /** @type HTMLInputElement */(document.getElementById("search"));
var domSectSearchResults = /** @type HTMLElement */(document.getElementById("sectSearchResults"));
var domListSearchResults = /** @type HTMLElement */(document.getElementById("listSearchResults"));
var domSectSearchNoResults = /** @type HTMLElement */(document.getElementById("sectSearchNoResults"));
var domSectInfo = /** @type HTMLElement */(document.getElementById("sectInfo"));
var domTdTarget = /** @type HTMLElement */(document.getElementById("tdTarget"));
var domPrivDeclsBox = /** @type HTMLCheckboxElement */(document.getElementById("privDeclsBox"));
var domTdZigVer = /** @type HTMLElement */(document.getElementById("tdZigVer"));
var domHdrName = /** @type HTMLElement */(document.getElementById("hdrName"));
var domHelpModal = /** @type HTMLElement */(document.getElementById("helpDialog"));
/** @type number | null */
var searchTimer = null;
/** @type Object<string, string> */
var escapeHtmlReplacements = { "&": "&amp;", '"': "&quot;", "<": "&lt;", ">": "&gt;" };
var typeKinds = /** @type {Record<string, number>} */(indexTypeKinds());
var typeTypeId = /** @type {number} */ (findTypeTypeId());
var pointerSizeEnum = { One: 0, Many: 1, Slice: 2, C: 3 };
// for each package, is an array with packages to get to this one
var canonPkgPaths = computeCanonicalPackagePaths();
/** @typedef {{declNames: string[], pkgNames: string[]}} CanonDecl */
// for each decl, is an array with {declNames, pkgNames} to get to this one
/** @type CanonDecl[] | null */
var canonDeclPaths = null; // lazy; use getCanonDeclPath
// for each type, is an array with {declNames, pkgNames} to get to this one
/** @type number[] | null */
var canonTypeDecls = null; // lazy; use getCanonTypeDecl
/** @typedef {{
* showPrivDecls: boolean,
* pkgNames: string[],
* pkgObjs: Package[],
* declNames: string[],
* declObjs: Decl[],
* callName: any,
* }} CurNav
*/
/** @type {CurNav} */
var curNav = {
showPrivDecls: false,
// each element is a package name, e.g. @import("a") then within there @import("b")
// starting implicitly from root package
pkgNames: [],
// same as above except actual packages, not names
pkgObjs: [],
// 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 package 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,
};
var curNavSearch = "";
var curSearchIndex = -1;
var imFeelingLucky = false;
var rootIsStd = detectRootIsStd();
// map of decl index to list of non-generic fn indexes
// var nodesToFnsMap = indexNodesToFns();
// map of decl index to list of comptime fn calls
// var nodesToCallsMap = indexNodesToCalls();
domSearch.addEventListener('keydown', onSearchKeyDown, false);
domPrivDeclsBox.addEventListener('change', function() {
if (this.checked != curNav.showPrivDecls) {
if (this.checked && location.hash.length > 1 && location.hash[1] != '*'){
location.hash = "#*" + location.hash.substring(1);
return;
}
if (!this.checked && location.hash.length > 1 && location.hash[1] == '*') {
location.hash = "#" + location.hash.substring(2);
return;
}
}
}, false);
window.addEventListener('hashchange', onHashChange, false);
window.addEventListener('keydown', onWindowKeyDown, false);
onHashChange();
function renderTitle() {
var list = curNav.pkgNames.concat(curNav.declNames);
var suffix = " - Zig";
if (list.length === 0) {
if (rootIsStd) {
document.title = "std" + suffix;
} else {
document.title = zigAnalysis.params.rootName + suffix;
}
} else {
document.title = list.join('.') + suffix;
}
}
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(type) {
var name = type.name;
if (type.kind === typeKinds.Struct) {
name = "struct";
} else if (type.kind === typeKinds.Enum) {
name = "enum";
} else if (type.kind === typeKinds.Union) {
name= "union";
}
return escapeHtml(name);
}
function typeKindIsContainer(typeKind) {
return typeKind === typeKinds.Struct ||
typeKind === typeKinds.Union ||
typeKind === typeKinds.Enum;
}
function declCanRepresentTypeKind(typeKind) {
return typeKind === typeKinds.ErrorSet || typeKindIsContainer(typeKind);
}
function findCteInRefPath(path) {
for (var 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) {
var i = 0;
while(i < 1000) {
i += 1;
if ("refPath" in value) {
value = value.refPath[value.refPath.length -1];
continue;
}
if ("declRef" in value) {
value = zigAnalysis.decls[value.declRef].value;
continue;
}
return value;
}
console.assert(false);
}
function typeOfDecl(decl){
var i = 0;
while(i < 1000) {
i += 1;
console.assert(isDecl(decl));
if ("type" in decl.value) {
return { type: typeTypeId };
}
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];
var 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.value];
} 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);
}
function render() {
domStatus.classList.add("hidden");
domFnProto.classList.add("hidden");
domSectParams.classList.add("hidden");
domTldDocs.classList.add("hidden");
domSectMainPkg.classList.add("hidden");
domSectPkgs.classList.add("hidden");
domSectTypes.classList.add("hidden");
domSectTests.classList.add("hidden");
domSectNamespaces.classList.add("hidden");
domSectErrSets.classList.add("hidden");
domSectFns.classList.add("hidden");
domSectFields.classList.add("hidden");
domSectSearchResults.classList.add("hidden");
domSectSearchNoResults.classList.add("hidden");
domSectInfo.classList.add("hidden");
domHdrName.classList.add("hidden");
domSectNav.classList.add("hidden");
domSectFnErrors.classList.add("hidden");
domFnExamples.classList.add("hidden");
domFnNoExamples.classList.add("hidden");
domDeclNoRef.classList.add("hidden");
domFnErrorsAnyError.classList.add("hidden");
domTableFnErrors.classList.add("hidden");
domSectGlobalVars.classList.add("hidden");
domSectValues.classList.add("hidden");
renderTitle();
renderInfo();
renderPkgList();
domPrivDeclsBox.checked = curNav.showPrivDecls;
if (curNavSearch !== "") {
return renderSearch();
}
var rootPkg = zigAnalysis.packages[zigAnalysis.rootPkg];
var pkg = rootPkg;
curNav.pkgObjs = [pkg];
for (var i = 0; i < curNav.pkgNames.length; i += 1) {
var childPkg = zigAnalysis.packages[pkg.table[curNav.pkgNames[i]]];
if (childPkg == null) {
return render404();
}
pkg = childPkg;
curNav.pkgObjs.push(pkg);
}
var currentType = zigAnalysis.types[pkg.main];
curNav.declObjs = [currentType];
for (var i = 0; i < curNav.declNames.length; i += 1) {
var childDecl = findSubDecl(currentType, curNav.declNames[i]);
if (childDecl == null) {
return render404();
}
var childDeclValue = resolveValue(childDecl.value);
if ("type" in childDeclValue) {
const t = zigAnalysis.types[childDeclValue.type];
if (t.kind != typeKinds.Fn) {
childDecl = t;
}
}
currentType = childDecl;
curNav.declObjs.push(currentType);
}
renderNav();
var last = curNav.declObjs[curNav.declObjs.length - 1];
var lastIsDecl = isDecl(last);
var lastIsType = isType(last);
var lastIsContainerType = isContainerType(last);
if (lastIsContainerType) {
return renderContainer(last);
}
if (!lastIsDecl && !lastIsType) {
return renderUnknownDecl(last);
}
if (lastIsType) {
return renderType(last);
}
if (lastIsDecl && last.kind === 'var') {
return renderVar(last);
}
if (lastIsDecl && last.kind === 'const') {
var typeObj = zigAnalysis.types[resolveValue(last.value).type];
if (typeObj && typeObj.kind === typeKinds.Fn) {
return renderFn(last);
}
return renderValue(last);
}
}
function renderUnknownDecl(decl) {
domDeclNoRef.classList.remove("hidden");
var docs = zigAnalysis.astNodes[decl.src].docs;
if (docs != null) {
domTldDocs.innerHTML = markdown(docs);
} else {
domTldDocs.innerHTML = '<p>There are no doc comments for this declaration.</p>';
}
domTldDocs.classList.remove("hidden");
}
function typeIsErrSet(typeIndex) {
var typeObj = zigAnalysis.types[typeIndex];
return typeObj.kind === typeKinds.ErrorSet;
}
function typeIsStructWithNoFields(typeIndex) {
var typeObj = zigAnalysis.types[typeIndex];
if (typeObj.kind !== typeKinds.Struct)
return false;
return typeObj.fields.length == 0;
}
function typeIsGenericFn(typeIndex) {
var typeObj = zigAnalysis.types[typeIndex];
if (typeObj.kind !== typeKinds.Fn) {
return false;
}
return typeObj.generic;
}
/** @param {Decl} fnDecl */
function renderFn(fnDecl) {
var value = resolveValue(fnDecl.value);
console.assert("type" in value);
var typeObj = zigAnalysis.types[value.type];
domFnProtoCode.innerHTML = typeValueName(value, true, true, fnDecl);
var docsSource = null;
var srcNode = zigAnalysis.astNodes[fnDecl.src];
if (srcNode.docs != null) {
docsSource = srcNode.docs;
}
var retIndex = resolveValue(typeObj.ret).type;
renderFnParamDocs(fnDecl, typeObj);
var errSetTypeIndex = null;
var retType = zigAnalysis.types[retIndex];
if (retType.kind === typeKinds.ErrorSet) {
errSetTypeIndex = retIndex;
} else if (retType.kind === typeKinds.ErrorUnion) {
errSetTypeIndex = retType.err;
}
if (errSetTypeIndex != null) {
var errSetType = /** @type {ErrSetType} */(zigAnalysis.types[errSetTypeIndex]);
renderErrorSet(errSetType);
}
var protoSrcIndex = fnDecl.src;
if (typeIsGenericFn(value.type)) {
throw "TODO";
// var instantiations = nodesToFnsMap[protoSrcIndex];
// var 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, '<li></li>');
// for (var callI = 0; callI < calls.length; callI += 1) {
// var 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");
}
var protoSrcNode = zigAnalysis.astNodes[protoSrcIndex];
if (docsSource == null && protoSrcNode != null && protoSrcNode.docs != null) {
docsSource = protoSrcNode.docs;
}
if (docsSource != null) {
domTldDocs.innerHTML = markdown(docsSource);
domTldDocs.classList.remove("hidden");
}
domFnProto.classList.remove("hidden");
}
/**
* @param {Decl} fnDecl
* @param {Fn} typeObj
*/
function renderFnParamDocs(fnDecl, typeObj) {
var docCount = 0;
var fnNode = zigAnalysis.astNodes[fnDecl.src];
var fields = /** @type {number[]} */(fnNode.fields);
var isVarArgs = fnNode.varArgs;
for (var i = 0; i < fields.length; i += 1) {
var field = fields[i];
var fieldNode = zigAnalysis.astNodes[field];
if (fieldNode.docs != null) {
docCount += 1;
}
}
if (docCount == 0) {
return;
}
resizeDomList(domListParams, docCount, '<div></div>');
var domIndex = 0;
for (var i = 0; i < fields.length; i += 1) {
var field = fields[i];
var fieldNode = zigAnalysis.astNodes[field];
if (fieldNode.docs == null) {
continue;
}
var divDom = domListParams.children[domIndex];
domIndex += 1;
var value = typeObj.params[i];
var html = '<pre>' + escapeHtml(/** @type {string} */(fieldNode.name)) + ": ";
if (isVarArgs && i === typeObj.params.length - 1) {
html += '...';
} else {
var name = typeValueName(value, false, false);
html += '<span class="tok-kw">' + name + '</span>';
}
html += ',</pre>';
var docs = fieldNode.docs;
if (docs != null) {
html += markdown(docs);
}
divDom.innerHTML = html;
}
domSectParams.classList.remove("hidden");
}
function renderNav() {
var len = curNav.pkgNames.length + curNav.declNames.length;
resizeDomList(domListNav, len, '<li><a href="#"></a></li>');
var list = [];
var hrefPkgNames = [];
var hrefDeclNames = /** @type {string[]} */([]);
for (var i = 0; i < curNav.pkgNames.length; i += 1) {
hrefPkgNames.push(curNav.pkgNames[i]);
list.push({
name: curNav.pkgNames[i],
link: navLink(hrefPkgNames, hrefDeclNames),
});
}
for (var i = 0; i < curNav.declNames.length; i += 1) {
hrefDeclNames.push(curNav.declNames[i]);
list.push({
name: curNav.declNames[i],
link: navLink(hrefPkgNames, hrefDeclNames),
});
}
for (var i = 0; i < list.length; i += 1) {
var liDom = domListNav.children[i];
var aDom = liDom.children[0];
aDom.textContent = list[i].name;
aDom.setAttribute('href', list[i].link);
if (i + 1 == list.length) {
aDom.classList.add("active");
} else {
aDom.classList.remove("active");
}
}
domSectNav.classList.remove("hidden");
}
function renderInfo() {
domTdZigVer.textContent = zigAnalysis.params.zigVersion;
//domTdTarget.textContent = zigAnalysis.params.builds[0].target;
domSectInfo.classList.remove("hidden");
}
function render404() {
domStatus.textContent = "404 Not Found";
domStatus.classList.remove("hidden");
}
function renderPkgList() {
var rootPkg = zigAnalysis.packages[zigAnalysis.rootPkg];
var list = [];
for (var key in rootPkg.table) {
var pkgIndex = rootPkg.table[key];
if (zigAnalysis.packages[pkgIndex] == null) continue;
list.push({
name: key,
pkg: pkgIndex,
});
}
{
var aDom = domSectMainPkg.children[1].children[0].children[0];
aDom.textContent = zigAnalysis.params.rootName;
aDom.setAttribute('href', navLinkPkg(zigAnalysis.rootPkg));
if (zigAnalysis.params.rootName === curNav.pkgNames[0]) {
aDom.classList.add("active");
} else {
aDom.classList.remove("active");
}
domSectMainPkg.classList.remove("hidden");
}
list.sort(function(a, b) {
return operatorCompare(a.name.toLowerCase(), b.name.toLowerCase());
});
if (list.length !== 0) {
resizeDomList(domListPkgs, list.length, '<li><a href="#"></a></li>');
for (var i = 0; i < list.length; i += 1) {
var liDom = domListPkgs.children[i];
var aDom = liDom.children[0];
aDom.textContent = list[i].name;
aDom.setAttribute('href', navLinkPkg(list[i].pkg));
if (list[i].name === curNav.pkgNames[0]) {
aDom.classList.add("active");
} else {
aDom.classList.remove("active");
}
}
domSectPkgs.classList.remove("hidden");
}
}
/**
* @param {string[]} pkgNames
* @param {string[]} declNames
* @param {string} [callName]
*/
function navLink(pkgNames, declNames, callName) {
let base = '#';
if (curNav.showPrivDecls) {
base += "*";
}
if (pkgNames.length === 0 && declNames.length === 0) {
return base;
} else if (declNames.length === 0 && callName == null) {
return base + pkgNames.join('.');
} else if (callName == null) {
return base + pkgNames.join('.') + ';' + declNames.join('.');
} else {
return base + pkgNames.join('.') + ';' + declNames.join('.') + ';' + callName;
}
}
/** @param {number} pkgIndex */
function navLinkPkg(pkgIndex) {
return navLink(canonPkgPaths[pkgIndex], []);
}
/** @param {string} childName */
function navLinkDecl(childName) {
return navLink(curNav.pkgNames, curNav.declNames.concat([childName]));
}
/** @param {Call} callObj */
function navLinkCall(callObj) {
var declNamesCopy = curNav.declNames.concat([]);
var callName = /** @type {string} */(declNamesCopy.pop());
callName += '(';
for (var arg_i = 0; arg_i < callObj.args.length; arg_i += 1) {
if (arg_i !== 0) callName += ',';
var argObj = callObj.args[arg_i];
callName += getValueText(argObj, argObj, false, false);
}
callName += ')';
declNamesCopy.push(callName);
return navLink(curNav.pkgNames, declNamesCopy);
}
/**
* @param {any} dlDom
* @param {number} desiredLen
*/
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);
}
}
/**
* @param {any} listDom
* @param {number} desiredLen
* @param {string} templateHtml
*/
function resizeDomList(listDom, desiredLen, templateHtml) {
// add the missing dom entries
var i, ev;
for (i = listDom.childElementCount; i < desiredLen; i += 1) {
listDom.insertAdjacentHTML('beforeend', templateHtml);
}
// remove extra dom entries
while (desiredLen < listDom.childElementCount) {
listDom.removeChild(listDom.lastChild);
}
}
/**
* @param {WalkResult} typeValue,
* @param {boolean} wantHtml,
* @param {boolean} wantLink,
* @param {Decl | null} [fnDecl],
* @param {string} [linkFnNameDecl],
* @return {string}
*/
function typeValueName(typeValue, wantHtml, wantLink, fnDecl, linkFnNameDecl) {
if ("int" in typeValue) {
return "" + typeValue.int.value;
}
if ("call" in typeValue) {
var result = "";
var call = zigAnalysis.calls[typeValue.call];
var functionName = typeValueName(call.func, wantHtml, wantLink, fnDecl, linkFnNameDecl);
result += functionName + "(";
for (var j = 0; j < call.args.length; j += 1) {
result += typeValueName(call.args[j], wantHtml, wantLink, fnDecl, linkFnNameDecl);
if (j != call.args.length -1) result += ",";
}
return result + ")";
}
if ("comptimeExpr" in typeValue) {
return "[ComptimeExpr]";
}
if ("refPath" in typeValue) {
var result = "";
for (var j = 0; j < typeValue.refPath.length; j++) {
var name = "[RefPath]";
if (wantHtml) {
//result += '<a href="'+navLinkDecl(decl.name)+'">';
result += '<a href="">';
result += '<span class="tok-kw" style="color:lightblue;">' +
name + '</span>';
result += '</a>';
} else {
result += name;
}
if (j != 0) result += ".";
}
return result;
}
if ("declRef" in typeValue) {
return zigAnalysis.decls[typeValue.declRef].name;
}
if ("string" in typeValue) {
return typeValue.string + " (string)";
}
if ("anytype" in typeValue) {
return "anytype";
}
if ("this" in typeValue) {
return "this";
}
console.assert("type" in typeValue)
var typeIndex = typeValue.type;
var typeObj = zigAnalysis.types[typeIndex];
var declNameOk = declCanRepresentTypeKind(typeObj.kind);
if (wantLink) {
var declIndex = getCanonTypeDecl(typeIndex);
var declPath = getCanonDeclPath(declIndex);
if (declPath == null) {
return typeName(typeObj, wantHtml, wantLink, fnDecl, linkFnNameDecl);
}
var name = (wantLink && declCanRepresentTypeKind(typeObj.kind)) ?
declPath.declNames[declPath.declNames.length - 1] :
typeName(typeObj, wantHtml, false, fnDecl, linkFnNameDecl);
if (wantLink && wantHtml) {
return '<a href="' + navLink(declPath.pkgNames, declPath.declNames) + '">' + name + '</a>';
} else {
return name;
}
} else {
return typeName(typeObj, wantHtml, false, fnDecl, linkFnNameDecl);
}
}
/**
* @param {WalkResult} typeRef
* @param {string} paramName
*/
function shouldSkipParamName(typeRef, paramName) {
var resolvedTypeRef = resolveValue(typeRef);
if ("type" in resolvedTypeRef) {
var typeObj = zigAnalysis.types[resolvedTypeRef.type];
if (typeObj.kind === typeKinds.Pointer){
let ptrObj = /** @type {PointerType} */(typeObj);
if (getPtrSize(ptrObj) === pointerSizeEnum.One) {
const value = resolveValue(ptrObj.child);
return typeValueName(value, false, true).toLowerCase() === paramName;
}
}
}
return false;
}
/** @param {PointerType} typeObj */
function getPtrSize(typeObj) {
return (typeObj.size == null) ? pointerSizeEnum.One : typeObj.size;
}
// function getCallHtml(fnDecl, callIndex) {
// var callObj = zigAnalysis.calls[callIndex];
// // TODO make these links work
// //var html = '<a href="' + navLinkCall(callObj) + '">' + escapeHtml(fnDecl.name) + '</a>(';
// var html = escapeHtml(fnDecl.name) + '(';
// for (var arg_i = 0; arg_i < callObj.args.length; arg_i += 1) {
// if (arg_i !== 0) html += ', ';
// var argObj = callObj.args[arg_i];
// html += getValueText(argObj, argObj.value, true, true);
// }
// html += ')';
// return html;
// }
/**
* @param {WalkResult} typeRef
* @param {any} value
* @param {boolean} wantHtml
* @param {boolean} wantLink
*/
function getValueText(typeRef, value, wantHtml, wantLink) {
var resolvedTypeRef = resolveValue(typeRef);
if ("comptimeExpr" in resolvedTypeRef) {
return "[ComptimeExpr]";
}
console.assert("type" in resolvedTypeRef);
var typeObj = zigAnalysis.types[typeRef.type];
switch (typeObj.kind) {
case typeKinds.Type:
return typeValueName(value, wantHtml, wantLink);
case typeKinds.Fn:
var fnObj = zigAnalysis.fns[value];
return typeName(fnObj, wantHtml, wantLink);
case typeKinds.Int:
if (wantHtml) {
return '<span class="tok-number">' + value + '</span>';
} else {
return value + "";
}
default:
console.trace("TODO implement getValueText for this type:", zigAnalysis.typeKinds[typeObj.kind]);
}
}
/**
* @param {Type} typeObj,
* @param {boolean} wantHtml,
* @param {boolean} wantSubLink,
* @param {Decl | null} [fnDecl],
* @param {string} [linkFnNameDecl],
* @return {string}
*/
function typeName(typeObj, wantHtml, wantSubLink, fnDecl, linkFnNameDecl) {
switch (typeObj.kind) {
case typeKinds.Array:
{
let arrayObj = /** @type {ArrayType} */(typeObj);
var name = "[";
var lenName = typeValueName(arrayObj.len, wantHtml, wantSubLink);
if (wantHtml) {
name += '<span class="tok-number">' + lenName + '</span>';
} else {
name += lenName;
}
name += "]";
name += typeValueName(arrayObj.child, wantHtml, wantSubLink, null);
return name;
}
case typeKinds.Optional:
return "?" + typeValueName(/**@type {OptionalType} */(typeObj).child, wantHtml, wantSubLink, fnDecl, linkFnNameDecl);
case typeKinds.Pointer:
{
let ptrObj = /** @type {PointerType} */(typeObj);
var name = "";
switch (ptrObj.size) {
default:
console.log("TODO: implement unhandled pointer size case");
case pointerSizeEnum.One:
name += "*";
break;
case pointerSizeEnum.Many:
name += "[*]";
break;
case pointerSizeEnum.Slice:
name += "[]";
break;
case pointerSizeEnum.C:
name += "[*c]";
break;
}
if (ptrObj['const']) {
if (wantHtml) {
name += '<span class="tok-kw">const</span> ';
} else {
name += "const ";
}
}
if (ptrObj['volatile']) {
if (wantHtml) {
name += '<span class="tok-kw">volatile</span> ';
} else {
name += "volatile ";
}
}
if (ptrObj.align != null) {
if (wantHtml) {
name += '<span class="tok-kw">align</span>(';
} else {
name += "align(";
}
if (wantHtml) {
name += '<span class="tok-number">' + ptrObj.align + '</span>';
} else {
name += ptrObj.align;
}
if (ptrObj.hostIntBytes != null) {
name += ":";
if (wantHtml) {
name += '<span class="tok-number">' + ptrObj.bitOffsetInHost + '</span>';
} else {
name += ptrObj.bitOffsetInHost;
}
name += ":";
if (wantHtml) {
name += '<span class="tok-number">' + ptrObj.hostIntBytes + '</span>';
} else {
name += ptrObj.hostIntBytes;
}
}
name += ") ";
}
name += typeValueName(ptrObj.child, wantHtml, wantSubLink, null);
return name;
}
case typeKinds.Float:
{
let floatObj = /** @type {NumberType} */ (typeObj);
if (wantHtml) {
return '<span class="tok-type">' + floatObj.name + '</span>';
} else {
return floatObj.name;
}
}
case typeKinds.Int:
{
let intObj = /** @type {NumberType} */(typeObj);
var name = intObj.name;
if (wantHtml) {
return '<span class="tok-type">' + name + '</span>';
} else {
return name;
}
}
case typeKinds.ComptimeInt:
if (wantHtml) {
return '<span class="tok-type">comptime_int</span>';
} else {
return "comptime_int";
}
case typeKinds.ComptimeFloat:
if (wantHtml) {
return '<span class="tok-type">comptime_float</span>';
} else {
return "comptime_float";
}
case typeKinds.Type:
if (wantHtml) {
return '<span class="tok-type">type</span>';
} else {
return "type";
}
case typeKinds.Bool:
if (wantHtml) {
return '<span class="tok-type">bool</span>';
} else {
return "bool";
}
case typeKinds.Void:
if (wantHtml) {
return '<span class="tok-type">void</span>';
} else {
return "void";
}
case typeKinds.EnumLiteral:
if (wantHtml) {
return '<span class="tok-type">(enum literal)</span>';
} else {
return "(enum literal)";
}
case typeKinds.NoReturn:
if (wantHtml) {
return '<span class="tok-type">noreturn</span>';
} else {
return "noreturn";
}
case typeKinds.ErrorSet:
{
let errSetObj = /** @type {ErrSetType} */(typeObj);
if (errSetObj.fields == null) {
if (wantHtml) {
return '<span class="tok-type">anyerror</span>';
} else {
return "anyerror";
}
} else {
throw "TODO";
// if (wantHtml) {
// return escapeHtml(typeObj.name);
// } else {
// return typeObj.name;
// }
}
}
case typeKinds.ErrorUnion:
{
throw "TODO";
// TODO: implement error union printing assuming that both
// payload and error union are walk results!
// let errUnionObj = /** @type {ErrUnionType} */(typeObj);
// var errSetTypeObj = /** @type {ErrSetType} */ (zigAnalysis.types[errUnionObj.err]);
// var payloadHtml = typeValueName(errUnionObj.payload, wantHtml, wantSubLink, null);
// if (fnDecl != null && errSetTypeObj.fn === fnDecl.value.type) {
// // function index parameter supplied and this is the inferred error set of it
// return "!" + payloadHtml;
// } else {
// return typeValueName(errUnionObj.err, wantHtml, wantSubLink, null) + "!" + payloadHtml;
// }
}
case typeKinds.Fn:
{
let fnObj = /** @type {Fn} */(typeObj);
var payloadHtml = "";
if (wantHtml) {
payloadHtml += '<span class="tok-kw">fn</span>';
if (fnDecl != null) {
payloadHtml += ' <span class="tok-fn">';
if (linkFnNameDecl != null) {
payloadHtml += '<a href="' + linkFnNameDecl + '">' +
escapeHtml(fnDecl.name) + '</a>';
} else {
payloadHtml += escapeHtml(fnDecl.name);
}
payloadHtml += '</span>';
}
} else {
payloadHtml += 'fn'
}
payloadHtml += '(';
if (fnObj.params) {
var fields = null;
var isVarArgs = false;
var fnNode = zigAnalysis.astNodes[fnObj.src];
fields = fnNode.fields;
isVarArgs = fnNode.varArgs;
for (var i = 0; i < fnObj.params.length; i += 1) {
if (i != 0) {
payloadHtml += ', ';
}
var value = fnObj.params[i];
var paramValue = resolveValue(value);
var isCte = "comptimeExpr" in paramValue;
if (fields != null) {
var paramNode = zigAnalysis.astNodes[fields[i]];
if (paramNode.varArgs) {
payloadHtml += '...';
continue;
}
if (paramNode.noalias) {
if (wantHtml) {
payloadHtml += '<span class="tok-kw">noalias</span> ';
} else {
payloadHtml += 'noalias ';
}
}
if (paramNode.comptime) {
if (wantHtml) {
payloadHtml += '<span class="tok-kw">comptime</span> ';
} else {
payloadHtml += 'comptime ';
}
}
var paramName = paramNode.name;
if (paramName != null) {
// skip if it matches the type name
if (!shouldSkipParamName(paramValue, paramName)) {
payloadHtml += paramName + ': ';
}
}
}
if (isVarArgs && i === fnObj.params.length - 1) {
payloadHtml += '...';
} else if ("refPath" in value) {
payloadHtml += '<a href="">';
payloadHtml += '<span class="tok-kw" style="color:lightblue;">[Ref Path]</span>';
payloadHtml += '</a>';
} else if ("type" in value) {
var name = typeValueName(value, wantHtml, wantSubLink, fnDecl, linkFnNameDecl);
payloadHtml += '<span class="tok-kw">' + escapeHtml(name) + '</span>';
} else if ("comptimeExpr" in value) {
payloadHtml += '<span class="tok-kw">[ComptimeExpr]</span>';
} else if (wantHtml) {
payloadHtml += '<span class="tok-kw">var</span>';
} else {
payloadHtml += 'var';
}
}
}
payloadHtml += ') ';
if (fnObj.ret != null) {
payloadHtml += typeValueName(fnObj.ret, wantHtml, wantSubLink, fnDecl);
} else if (wantHtml) {
payloadHtml += '<span class="tok-kw">anytype</span>';
} else {
payloadHtml += 'anytype';
}
return payloadHtml;
}
default:
throw "TODO";
// if (wantHtml) {
// return escapeHtml(typeObj.name);
// } else {
// return typeObj.name;
// }
}
}
/** @param {Type} typeObj */
function renderType(typeObj) {
var name;
if (rootIsStd && typeObj === zigAnalysis.types[zigAnalysis.packages[zigAnalysis.rootPkg].main]) {
name = "std";
} else {
name = typeName(typeObj, false, false);
}
if (name != null && name != "") {
domHdrName.innerText = name + " (" + zigAnalysis.typeKinds[typeObj.kind] + ")";
domHdrName.classList.remove("hidden");
}
if (typeObj.kind == typeKinds.ErrorSet) {
renderErrorSet(/** @type {ErrSetType} */(typeObj));
}
}
/** @param {ErrSetType} errSetType */
function renderErrorSet(errSetType) {
if (errSetType.fields == null) {
domFnErrorsAnyError.classList.remove("hidden");
} else {
var errorList = [];
for (var i = 0; i < errSetType.fields.length; i += 1) {
var errObj = errSetType.fields[i];
//var 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 (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].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) {
// var srcIndex = zigAnalysis.fns[value].src;
// var calls = nodesToCallsMap[srcIndex];
// if (calls == null) return false;
// for (var i = 0; i < calls.length; i += 1) {
// var call = zigAnalysis.calls[calls[i]];
// if (call.result.type !== typeTypeId) return false;
// }
// return true;
// }
//
// function allCompTimeFnCallsResult(calls) {
// var firstTypeObj = null;
// var containerObj = {
// privDecls: [],
// };
// for (var callI = 0; callI < calls.length; callI += 1) {
// var call = zigAnalysis.calls[calls[callI]];
// if (call.result.type !== typeTypeId) return null;
// var 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 (var fieldI = 0; fieldI < typeObj.fields.length; fieldI += 1) {
// var prev = containerObj.fields[fieldI];
// var 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 (var declI = 0; declI < typeObj.pubDecls.length; declI += 1) {
// var prev = containerObj.pubDecls[declI];
// var 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') {
// // var 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 (var declI = 0; declI < containerObj.pubDecls.length; declI += 1) {
// var decl = containerObj.pubDecls[declI];
// if (typeof(decl) === 'object') {
// containerObj.pubDecls[declI] = containerObj.pubDecls[declI].id;
// }
// }
// return containerObj;
// }
// function mergeDecls(declObj, nextDeclIndex, firstTypeObj, typeObj) {
// var nextDeclObj = zigAnalysis.decls[nextDeclIndex];
// if (declObj.type != null && nextDeclObj.type != null && declObj.type !== nextDeclObj.type) {
// if (typeof(declObj.type) !== 'object') {
// var prevType = declObj.type;
// declObj.type = {};
// declObj.type[prevType] = firstTypeObj;
// declObj.value = null;
// }
// declObj.type[nextDeclObj.type] = typeObj;
// } else if (declObj.type == null && nextDeclObj != null) {
// declObj.type = nextDeclObj.type;
// }
// if (declObj.value != null && nextDeclObj.value != null && declObj.value !== nextDeclObj.value) {
// if (typeof(declObj.value) !== 'object') {
// var prevValue = declObj.value;
// declObj.value = {};
// declObj.value[prevValue] = firstTypeObj;
// }
// declObj.value[nextDeclObj.value] = typeObj;
// } else if (declObj.value == null && nextDeclObj.value != null) {
// declObj.value = nextDeclObj.value;
// }
// }
/** @param {Decl} decl */
function renderValue(decl) {
var declTypeRef = typeOfDecl(decl);
var declValueText = "";
switch(Object.keys(decl.value)[0]) {
case "int":
declValueText += /** @type {{int: {value: number}}} */(decl.value).int.value;
break;
case "float":
declValueText += /** @type {{float: {value: number}}} */(decl.value).float.value;
break;
case "comptimeExpr":
declValueText += "[ComptimeExpr]";
break;
default:
console.log("TODO: renderValue for ", Object.keys(decl.value)[0]);
declValueText += "#TODO#";
}
domFnProtoCode.innerHTML = '<span class="tok-kw">const</span> ' +
escapeHtml(decl.name) + ': ' + typeValueName(declTypeRef, true, true) +
" = " + declValueText;
var docs = zigAnalysis.astNodes[decl.src].docs;
if (docs != null) {
domTldDocs.innerHTML = markdown(docs);
domTldDocs.classList.remove("hidden");
}
domFnProto.classList.remove("hidden");
}
/** @param {Decl} decl */
function renderVar(decl) {
var declTypeRef = typeOfDecl(decl);
domFnProtoCode.innerHTML = '<span class="tok-kw">var</span> ' +
escapeHtml(decl.name) + ': ' + typeValueName(declTypeRef, true, true);
var docs = zigAnalysis.astNodes[decl.src].docs;
if (docs != null) {
domTldDocs.innerHTML = markdown(docs);
domTldDocs.classList.remove("hidden");
}
domFnProto.classList.remove("hidden");
}
/**
* @param {number[]} decls
* @param {Decl[]} typesList
* @param {Decl[]} namespacesList,
* @param {Decl[]} errSetsList,
* @param {Decl[]} fnsList,
* @param {Decl[]} varsList,
* @param {Decl[]} valsList,
* @param {Decl[]} testsList
*/
function categorizeDecls(decls,
typesList, namespacesList, errSetsList,
fnsList, varsList, valsList, testsList) {
for (var i = 0; i < decls.length; i += 1) {
var decl = zigAnalysis.decls[decls[i]];
var declValue = resolveValue(decl.value);
if (decl.isTest) {
testsList.push(decl);
continue;
}
if (decl.kind === 'var') {
varsList.push(decl);
continue;
}
if (decl.kind === 'const') {
if ("call" in declValue) {
let c = zigAnalysis.calls[declValue.call];
console.assert("comptimeExpr" in c.ret);
let fDecl = resolveValue(c.func);
if ("type" in fDecl) {
console.assert("type" in fDecl);
let fType = /** @type {Fn} */(zigAnalysis.types[fDecl.type]);
console.assert("type" in fType.ret);
if (fType.ret.type === typeTypeId) {
typesList.push(decl);
} else {
valsList.push(decl);
}
} else {
valsList.push(decl);
}
} else if (!("type" in declValue)){
valsList.push(decl);
} else {
var value = zigAnalysis.types[declValue.type];
var kind = value.kind;
if (kind === typeKinds.Fn) {
// TODO: handle CTE return types when we know their type.
const resVal = resolveValue(/** @type {Fn} */(value).ret);
if ("type" in resVal && resVal.type == typeTypeId) {
typesList.push(decl);
} else {
fnsList.push(decl);
}
} else if (typeIsErrSet(declValue.type)) {
errSetsList.push(decl);
} else if (typeIsStructWithNoFields(declValue.type)) {
namespacesList.push(decl);
} else {
typesList.push(decl);
}
}
}
}
}
/**
* @param {ContainerType} container
*/
function renderContainer(container) {
/** @type {Decl[]} */
var typesList = [];
/** @type {Decl[]} */
var namespacesList = [];
/** @type {Decl[]} */
var errSetsList = [];
/** @type {Decl[]} */
var fnsList = [];
/** @type {Decl[]} */
var varsList = [];
/** @type {Decl[]} */
var valsList = [];
/** @type {Decl[]} */
var testsList = [];
categorizeDecls(container.pubDecls,
typesList, namespacesList, errSetsList,
fnsList, varsList, valsList, testsList);
if (curNav.showPrivDecls) categorizeDecls(container.privDecls,
typesList, namespacesList, errSetsList,
fnsList, varsList, valsList, testsList);
typesList.sort(byNameProperty);
namespacesList.sort(byNameProperty);
errSetsList.sort(byNameProperty);
fnsList.sort(byNameProperty);
varsList.sort(byNameProperty);
valsList.sort(byNameProperty);
testsList.sort(byNameProperty);
if (container.src != null) {
var docs = zigAnalysis.astNodes[container.src].docs;
if (docs != null) {
domTldDocs.innerHTML = markdown(docs);
domTldDocs.classList.remove("hidden");
}
}
if (typesList.length !== 0) {
resizeDomList(domListTypes, typesList.length, '<li><a href="#"></a></li>');
for (var i = 0; i < typesList.length; i += 1) {
var liDom = domListTypes.children[i];
var aDom = liDom.children[0];
var decl = typesList[i];
aDom.textContent = decl.name;
aDom.setAttribute('href', navLinkDecl(decl.name));
}
domSectTypes.classList.remove("hidden");
}
if (namespacesList.length !== 0) {
resizeDomList(domListNamespaces, namespacesList.length, '<li><a href="#"></a></li>');
for (var i = 0; i < namespacesList.length; i += 1) {
var liDom = domListNamespaces.children[i];
var aDom = liDom.children[0];
var decl = namespacesList[i];
aDom.textContent = decl.name;
aDom.setAttribute('href', navLinkDecl(decl.name));
}
domSectNamespaces.classList.remove("hidden");
}
if (errSetsList.length !== 0) {
resizeDomList(domListErrSets, errSetsList.length, '<li><a href="#"></a></li>');
for (var i = 0; i < errSetsList.length; i += 1) {
var liDom = domListErrSets.children[i];
var aDom = liDom.children[0];
var decl = errSetsList[i];
aDom.textContent = decl.name;
aDom.setAttribute('href', navLinkDecl(decl.name));
}
domSectErrSets.classList.remove("hidden");
}
if (fnsList.length !== 0) {
resizeDomList(domListFns, fnsList.length, '<tr><td></td><td></td></tr>');
for (var i = 0; i < fnsList.length; i += 1) {
var decl = fnsList[i];
var trDom = domListFns.children[i];
var tdFnCode = trDom.children[0];
var tdDesc = trDom.children[1];
var declType = resolveValue(decl.value);
console.assert("type" in declType);
tdFnCode.innerHTML = typeValueName(declType, true, true, decl, navLinkDecl(decl.name));
var docs = zigAnalysis.astNodes[decl.src].docs;
if (docs != null) {
tdDesc.innerHTML = shortDescMarkdown(docs);
} else {
tdDesc.textContent = "";
}
}
domSectFns.classList.remove("hidden");
}
var containerNode = zigAnalysis.astNodes[container.src];
if (containerNode.fields) {
resizeDomList(domListFields, containerNode.fields.length, '<div></div>');
for (var i = 0; i < containerNode.fields.length; i += 1) {
var fieldNode = zigAnalysis.astNodes[containerNode.fields[i]];
var divDom = domListFields.children[i];
let fieldName = /** @type {string} */(fieldNode.name);
var html = '<div class="mobile-scroll-container"><pre class="scroll-item">' + escapeHtml(fieldName);
if (container.kind === typeKinds.Enum) {
html += ' = <span class="tok-number">' + fieldName + '</span>';
} else {
var field = container.fields[i];
html += ": ";
var name = typeValueName(field, false, false);
html += '<span class="tok-kw">'+ name +'</span>';
}
html += ',</pre></div>';
var docs = fieldNode.docs;
if (docs != null) {
html += markdown(docs);
}
divDom.innerHTML = html;
}
domSectFields.classList.remove("hidden");
}
if (varsList.length !== 0) {
resizeDomList(domListGlobalVars, varsList.length,
'<tr><td><a href="#"></a></td><td></td><td></td></tr>');
for (var i = 0; i < varsList.length; i += 1) {
var decl = varsList[i];
var trDom = domListGlobalVars.children[i];
var tdName = trDom.children[0];
var tdNameA = tdName.children[0];
var tdType = trDom.children[1];
var tdDesc = trDom.children[2];
tdNameA.setAttribute('href', navLinkDecl(decl.name));
tdNameA.textContent = decl.name;
tdType.innerHTML = typeValueName(typeOfDecl(decl), true, true);
var docs = zigAnalysis.astNodes[decl.src].docs;
if (docs != null) {
tdDesc.innerHTML = shortDescMarkdown(docs);
} else {
tdDesc.textContent = "";
}
}
domSectGlobalVars.classList.remove("hidden");
}
if (valsList.length !== 0) {
resizeDomList(domListValues, valsList.length,
'<tr><td><a href="#"></a></td><td></td><td></td></tr>');
for (var i = 0; i < valsList.length; i += 1) {
var decl = valsList[i];
var trDom = domListValues.children[i];
var tdName = trDom.children[0];
var tdNameA = tdName.children[0];
var tdType = trDom.children[1];
var tdDesc = trDom.children[2];
tdNameA.setAttribute('href', navLinkDecl(decl.name));
tdNameA.textContent = decl.name;
tdType.innerHTML = typeValueName(typeOfDecl(decl), true, true);
var docs = zigAnalysis.astNodes[decl.src].docs;
if (docs != null) {
tdDesc.innerHTML = shortDescMarkdown(docs);
} else {
tdDesc.textContent = "";
}
}
domSectValues.classList.remove("hidden");
}
if (testsList.length !== 0) {
resizeDomList(domListTests, testsList.length,
'<tr><td><a href="#"></a></td><td></td><td></td></tr>');
for (var i = 0; i < testsList.length; i += 1) {
var decl = testsList[i];
var trDom = domListTests.children[i];
var tdName = trDom.children[0];
var tdNameA = tdName.children[0];
var tdType = trDom.children[1];
var tdDesc = trDom.children[2];
tdNameA.setAttribute('href', navLinkDecl(decl.name));
tdNameA.textContent = decl.name;
tdType.innerHTML = typeValueName(typeOfDecl(decl), true, true);
var docs = zigAnalysis.astNodes[decl.src].docs;
if (docs != null) {
tdDesc.innerHTML = shortDescMarkdown(docs);
} else {
tdDesc.textContent = "";
}
}
domSectTests.classList.remove("hidden");
}
}
/**
* @param {string | number} a
* @param {string | number} b
*/
function operatorCompare(a, b) {
if (a === b) {
return 0;
} else if (a < b) {
return -1;
} else {
return 1;
}
}
function detectRootIsStd() {
var rootPkg = zigAnalysis.packages[zigAnalysis.rootPkg];
if (rootPkg.table["std"] == null) {
// no std mapped into the root package
return false;
}
var stdPkg = zigAnalysis.packages[rootPkg.table["std"]];
if (stdPkg == null) return false;
return rootPkg.file === stdPkg.file;
}
function indexTypeKinds() {
var map = /** @type {Record<string, number>} */({});
for (var i = 0; i < zigAnalysis.typeKinds.length; i += 1) {
map[zigAnalysis.typeKinds[i]] = i;
}
// This is just for debugging purposes, not needed to function
var assertList = ["Type","Void","Bool","NoReturn","Int","Float","Pointer","Array","Struct",
"ComptimeFloat","ComptimeInt","Undefined","Null","Optional","ErrorUnion","ErrorSet","Enum",
"Union","Fn","BoundFn","Opaque","Frame","AnyFrame","Vector","EnumLiteral"];
for (var 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 (var i = 0; i < zigAnalysis.types.length; i += 1) {
if (zigAnalysis.types[i].kind == typeKinds.Type) {
return i;
}
}
throw new Error("No type 'type' found");
}
function updateCurNav() {
curNav = {
showPrivDecls: false,
pkgNames: [],
pkgObjs: [],
declNames: [],
declObjs: [],
callName: null,
};
curNavSearch = "";
if (location.hash[0] === '#' && location.hash.length > 1) {
var query = location.hash.substring(1);
if (query[0] === '*') {
curNav.showPrivDecls = true;
query = query.substring(1);
}
var qpos = query.indexOf("?");
var nonSearchPart;
if (qpos === -1) {
nonSearchPart = query;
} else {
nonSearchPart = query.substring(0, qpos);
curNavSearch = decodeURIComponent(query.substring(qpos + 1));
}
var parts = nonSearchPart.split(";");
curNav.pkgNames = decodeURIComponent(parts[0]).split(".");
if (parts[1] != null) {
curNav.declNames = decodeURIComponent(parts[1]).split(".");
}
}
if (curNav.pkgNames.length === 0 && rootIsStd) {
curNav.pkgNames = ["std"];
}
}
function onHashChange() {
updateCurNav();
if (domSearch.value !== curNavSearch) {
domSearch.value = curNavSearch;
}
render();
if (imFeelingLucky) {
imFeelingLucky = false;
activateSelectedResult();
}
}
/**
* @param {ContainerType} parentType
* @param {string} childName
*/
function findSubDecl(parentType, childName) {
if (!parentType.pubDecls) return null;
for (var i = 0; i < parentType.pubDecls.length; i += 1) {
var declIndex = parentType.pubDecls[i];
var childDecl = zigAnalysis.decls[declIndex];
if (childDecl.name === childName) {
return childDecl;
}
}
if (!parentType.privDecls) return null;
for (var i = 0; i < parentType.privDecls.length; i += 1) {
var declIndex = parentType.privDecls[i];
var childDecl = zigAnalysis.decls[declIndex];
if (childDecl.name === childName) {
return childDecl;
}
}
return null;
}
function computeCanonicalPackagePaths() {
var list = new Array(zigAnalysis.packages.length);
// Now we try to find all the packages from root.
var rootPkg = zigAnalysis.packages[zigAnalysis.rootPkg];
// Breadth-first to keep the path shortest possible.
var stack = [{
path: /** @type {string[]} */([]),
pkg: rootPkg,
}];
while (stack.length !== 0) {
var item = /** @type {{path: string[], pkg: Package}} */(stack.shift());
for (var key in item.pkg.table) {
var childPkgIndex = item.pkg.table[key];
if (list[childPkgIndex] != null) continue;
var childPkg = zigAnalysis.packages[childPkgIndex];
if (childPkg == null) continue;
var newPath = item.path.concat([key])
list[childPkgIndex] = newPath;
stack.push({
path: newPath,
pkg: childPkg,
});
}
}
return list;
}
/** @return {CanonDecl[]} */
function computeCanonDeclPaths() {
var list = new Array(zigAnalysis.decls.length);
canonTypeDecls = new Array(zigAnalysis.types.length);
for (var pkgI = 0; pkgI < zigAnalysis.packages.length; pkgI += 1) {
if (pkgI === zigAnalysis.rootPkg && rootIsStd) continue;
var pkg = zigAnalysis.packages[pkgI];
var pkgNames = canonPkgPaths[pkgI];
var stack = [{
declNames: /** @type {string[]} */([]),
type: zigAnalysis.types[pkg.main],
}];
while (stack.length !== 0) {
var item = /** @type {{declNames: string[], type: Type}} */(stack.shift());
if (isContainerType(item.type)) {
let t = /** @type {ContainerType} */(item.type);
var len = t.pubDecls ? t.pubDecls.length : 0;
for (var declI = 0; declI < len; declI += 1) {
var mainDeclIndex = t.pubDecls[declI];
if (list[mainDeclIndex] != null) continue;
var decl = zigAnalysis.decls[mainDeclIndex];
var declVal = resolveValue(decl.value);
var declNames = item.declNames.concat([decl.name]);
list[mainDeclIndex] = {
pkgNames: pkgNames,
declNames: declNames,
};
if ("type" in declVal) {
var value = zigAnalysis.types[declVal.type];
if (declCanRepresentTypeKind(value.kind))
{
canonTypeDecls[declVal.type] = mainDeclIndex;
}
if (isContainerType(value)) {
stack.push({
declNames: declNames,
type:value,
});
}
}
}
}
}
}
return list;
}
/** @param {number} index */
function getCanonDeclPath(index) {
if (canonDeclPaths == null) {
canonDeclPaths = computeCanonDeclPaths();
}
let cd = /** @type {CanonDecl[]}*/(canonDeclPaths);
return cd[index];
}
/** @param {number} index */
function getCanonTypeDecl(index) {
getCanonDeclPath(0);
let ct = /** @type {number[]}*/(canonTypeDecls);
return ct[index];
}
/** @param {string} text */
function escapeHtml(text) {
return text.replace(/[&"<>]/g, function (m) {
return escapeHtmlReplacements[m];
});
}
/** @param {string} docs */
function shortDescMarkdown(docs) {
var parts = docs.trim().split("\n");
var firstLine = parts[0];
return markdown(firstLine);
}
/** @param {string} input */
function markdown(input) {
const raw_lines = input.split('\n'); // zig allows no '\r', so we don't need to split on CR
/**
* @type Array<{
* indent: number,
* raw_text: string,
* text: string,
* type: string,
* ordered_number: number,
* }>
*/
const lines = [];
// PHASE 1:
// Dissect lines and determine the type for each line.
// Also computes indentation level and removes unnecessary whitespace
var is_reading_code = false;
var code_indent = 0;
for (var line_no = 0; line_no < raw_lines.length; line_no++) {
const raw_line = raw_lines[line_no];
const line = {
indent: 0,
raw_text: raw_line,
text: raw_line.trim(),
type: "p", // p, h1 … h6, code, ul, ol, blockquote, skip, empty
ordered_number: -1, // NOTE: hack to make the type checker happy
};
if (!is_reading_code) {
while ((line.indent < line.raw_text.length) && line.raw_text[line.indent] == ' ') {
line.indent += 1;
}
if (line.text.startsWith("######")) {
line.type = "h6";
line.text = line.text.substr(6);
}
else if (line.text.startsWith("#####")) {
line.type = "h5";
line.text = line.text.substr(5);
}
else if (line.text.startsWith("####")) {
line.type = "h4";
line.text = line.text.substr(4);
}
else if (line.text.startsWith("###")) {
line.type = "h3";
line.text = line.text.substr(3);
}
else if (line.text.startsWith("##")) {
line.type = "h2";
line.text = line.text.substr(2);
}
else if (line.text.startsWith("#")) {
line.type = "h1";
line.text = line.text.substr(1);
}
else if (line.text.startsWith("-")) {
line.type = "ul";
line.text = line.text.substr(1);
}
else if (line.text.match(/^\d+\..*$/)) { // if line starts with {number}{dot}
const match = /** @type {RegExpMatchArray} */(line.text.match(/(\d+)\./));
line.type = "ul";
line.text = line.text.substr(match[0].length);
line.ordered_number = Number(match[1].length);
}
else if (line.text == "```") {
line.type = "skip";
is_reading_code = true;
code_indent = line.indent;
}
else if (line.text == "") {
line.type = "empty";
}
}
else {
if (line.text == "```") {
is_reading_code = false;
line.type = "skip";
} else {
line.type = "code";
line.text = line.raw_text.substr(code_indent); // remove the indent of the ``` from all the code block
}
}
if (line.type != "skip") {
lines.push(line);
}
}
// PHASE 2:
// Render HTML from markdown lines.
// Look at each line and emit fitting HTML code
/**
* @param {string } innerText
*/
function markdownInlines(innerText) {
// inline types:
// **{INLINE}** : <strong>
// __{INLINE}__ : <u>
// ~~{INLINE}~~ : <s>
// *{INLINE}* : <emph>
// _{INLINE}_ : <emph>
// `{TEXT}` : <code>
// [{INLINE}]({URL}) : <a>
// ![{TEXT}]({URL}) : <img>
// [[std;format.fmt]] : <a> (inner link)
/** @typedef {{marker: string, tag: string}} Fmt*/
/** @type {Array<Fmt>} */
const formats = [
{
marker: "**",
tag: "strong",
},
{
marker: "~~",
tag: "s",
},
{
marker: "__",
tag: "u",
},
{
marker: "*",
tag: "em",
}
];
/** @type {Array<Fmt>} */
const stack = [];
var innerHTML = "";
var currentRun = "";
function flushRun() {
if (currentRun != "") {
innerHTML += escapeHtml(currentRun);
}
currentRun = "";
}
var parsing_code = false;
var codetag = "";
var in_code = false;
for (var i = 0; i < innerText.length; i++) {
if (parsing_code && in_code) {
if (innerText.substr(i, codetag.length) == codetag) {
// remove leading and trailing whitespace if string both starts and ends with one.
if (currentRun[0] == " " && currentRun[currentRun.length - 1] == " ") {
currentRun = currentRun.substr(1, currentRun.length - 2);
}
flushRun();
i += codetag.length - 1;
in_code = false;
parsing_code = false;
innerHTML += "</code>";
codetag = "";
} else {
currentRun += innerText[i];
}
continue;
}
if (innerText[i] == "`") {
flushRun();
if (!parsing_code) {
innerHTML += "<code>";
}
parsing_code = true;
codetag += "`";
continue;
}
if (parsing_code) {
currentRun += innerText[i];
in_code = true;
} else {
var any = false;
for (let idx = /** @type {number} */(stack.length > 0 ? -1 : 0); idx < formats.length; idx++) {
const fmt = idx >= 0 ? formats[idx] : stack[stack.length - 1];
if (innerText.substr(i, fmt.marker.length) == fmt.marker) {
flushRun();
if (stack[stack.length - 1] == fmt) {
stack.pop();
innerHTML += "</" + fmt.tag + ">";
} else {
stack.push(fmt);
innerHTML += "<" + fmt.tag + ">";
}
i += fmt.marker.length - 1;
any = true;
break;
}
}
if (!any) {
currentRun += innerText[i];
}
}
}
flushRun();
while (stack.length > 0) {
const fmt = /** @type {Fmt} */(stack.pop());
innerHTML += "</" + fmt.tag + ">";
}
return innerHTML;
}
/**
* @param {string} type
* @param {number} line_no
*/
function previousLineIs(type, line_no) {
if (line_no > 0) {
return (lines[line_no - 1].type == type);
} else {
return false;
}
}
/**
* @param {string} type
* @param {number} line_no
*/
function nextLineIs(type, line_no) {
if (line_no < (lines.length - 1)) {
return (lines[line_no + 1].type == type);
} else {
return false;
}
}
/** @param {number} line_no */
function getPreviousLineIndent(line_no) {
if (line_no > 0) {
return lines[line_no - 1].indent;
} else {
return 0;
}
}
/** @param {number} line_no */
function getNextLineIndent(line_no) {
if (line_no < (lines.length - 1)) {
return lines[line_no + 1].indent;
} else {
return 0;
}
}
var html = "";
for (var line_no = 0; line_no < lines.length; line_no++) {
const line = lines[line_no];
switch (line.type) {
case "h1":
case "h2":
case "h3":
case "h4":
case "h5":
case "h6":
html += "<" + line.type + ">" + markdownInlines(line.text) + "</" + line.type + ">\n";
break;
case "ul":
case "ol":
if (!previousLineIs("ul", line_no) || getPreviousLineIndent(line_no) < line.indent) {
html += "<" + line.type + ">\n";
}
html += "<li>" + markdownInlines(line.text) + "</li>\n";
if (!nextLineIs("ul", line_no) || getNextLineIndent(line_no) < line.indent) {
html += "</" + line.type + ">\n";
}
break;
case "p":
if (!previousLineIs("p", line_no)) {
html += "<p>\n";
}
html += markdownInlines(line.text) + "\n";
if (!nextLineIs("p", line_no)) {
html += "</p>\n";
}
break;
case "code":
if (!previousLineIs("code", line_no)) {
html += "<pre><code>";
}
html += escapeHtml(line.text) + "\n";
if (!nextLineIs("code", line_no)) {
html += "</code></pre>\n";
}
break;
}
}
return html;
}
function activateSelectedResult() {
if (domSectSearchResults.classList.contains("hidden")) {
return;
}
var liDom = domListSearchResults.children[curSearchIndex];
if (liDom == null && domListSearchResults.children.length !== 0) {
liDom = domListSearchResults.children[0];
}
if (liDom != null) {
var aDom = liDom.children[0];
location.href = /** @type {string} */(aDom.getAttribute("href"));
curSearchIndex = -1;
}
domSearch.blur();
}
/** @param {KeyboardEvent} ev */
function onSearchKeyDown(ev) {
switch (getKeyString(ev)) {
case "Enter":
// detect if this search changes anything
var terms1 = getSearchTerms();
startSearch();
updateCurNav();
var terms2 = getSearchTerms();
// we might have to wait for onHashChange to trigger
imFeelingLucky = (terms1.join(' ') !== terms2.join(' '));
if (!imFeelingLucky) activateSelectedResult();
ev.preventDefault();
ev.stopPropagation();
return;
case "Esc":
domSearch.value = "";
domSearch.blur();
curSearchIndex = -1;
ev.preventDefault();
ev.stopPropagation();
startSearch();
return;
case "Up":
moveSearchCursor(-1);
ev.preventDefault();
ev.stopPropagation();
return;
case "Down":
moveSearchCursor(1);
ev.preventDefault();
ev.stopPropagation();
return;
default:
if (ev.shiftKey || ev.ctrlKey || ev.altKey) return;
curSearchIndex = -1;
ev.stopPropagation();
startAsyncSearch();
return;
}
}
/** @param {number} dir */
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();
}
/** @param {KeyboardEvent} ev */
function getKeyString(ev) {
var name;
var ignoreShift = false;
switch (ev.which) {
case 13:
name = "Enter";
break;
case 27:
name = "Esc";
break;
case 38:
name = "Up";
break;
case 40:
name = "Down";
break;
default:
ignoreShift = true;
name = (ev.key != null) ? ev.key : String.fromCharCode(ev.charCode || ev.keyCode);
}
if (!ignoreShift && ev.shiftKey) name = "Shift+" + name;
if (ev.altKey) name = "Alt+" + name;
if (ev.ctrlKey) name = "Ctrl+" + name;
return name;
}
/** @param {KeyboardEvent} ev */
function onWindowKeyDown(ev) {
switch (getKeyString(ev)) {
case "Esc":
if (!domHelpModal.classList.contains("hidden")) {
domHelpModal.classList.add("hidden");
ev.preventDefault();
ev.stopPropagation();
}
break;
case "s":
domSearch.focus();
domSearch.select();
ev.preventDefault();
ev.stopPropagation();
startAsyncSearch();
break;
case "?":
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 clearAsyncSearch() {
if (searchTimer != null) {
clearTimeout(searchTimer);
searchTimer = null;
}
}
function startAsyncSearch() {
clearAsyncSearch();
searchTimer = setTimeout(startSearch, 100);
}
function startSearch() {
clearAsyncSearch();
var oldHash = location.hash;
var parts = oldHash.split("?");
var newPart2 = (domSearch.value === "") ? "" : ("?" + domSearch.value);
location.hash = (parts.length === 1) ? (oldHash + newPart2) : (parts[0] + newPart2);
}
function getSearchTerms() {
var list = curNavSearch.trim().split(/[ \r\n\t]+/);
list.sort();
return list;
}
function renderSearch() {
var matchedItems = [];
var ignoreCase = (curNavSearch.toLowerCase() === curNavSearch);
var terms = getSearchTerms();
decl_loop: for (var declIndex = 0; declIndex < zigAnalysis.decls.length; declIndex += 1) {
var canonPath = getCanonDeclPath(declIndex);
if (canonPath == null) continue;
var decl = zigAnalysis.decls[declIndex];
var lastPkgName = canonPath.pkgNames[canonPath.pkgNames.length - 1];
var fullPathSearchText = lastPkgName + "." + canonPath.declNames.join('.');
var astNode = zigAnalysis.astNodes[decl.src];
var fileAndDocs = zigAnalysis.files[astNode.file];
if (astNode.docs != null) {
fileAndDocs += "\n" + astNode.docs;
}
var fullPathSearchTextLower = fullPathSearchText;
if (ignoreCase) {
fullPathSearchTextLower = fullPathSearchTextLower.toLowerCase();
fileAndDocs = fileAndDocs.toLowerCase();
}
var points = 0;
for (var termIndex = 0; termIndex < terms.length; termIndex += 1) {
var term = terms[termIndex];
// exact, case sensitive match of full decl path
if (fullPathSearchText === term) {
points += 4;
continue;
}
// exact, case sensitive match of just decl name
if (decl.name == term) {
points += 3;
continue;
}
// substring, case insensitive match of full decl path
if (fullPathSearchTextLower.indexOf(term) >= 0) {
points += 2;
continue;
}
if (fileAndDocs.indexOf(term) >= 0) {
points += 1;
continue;
}
continue decl_loop;
}
matchedItems.push({
decl: decl,
path: canonPath,
points: points,
});
}
if (matchedItems.length !== 0) {
resizeDomList(domListSearchResults, matchedItems.length, '<li><a href="#"></a></li>');
matchedItems.sort(function(a, b) {
var cmp = operatorCompare(b.points, a.points);
if (cmp != 0) return cmp;
return operatorCompare(a.decl.name, b.decl.name);
});
for (var i = 0; i < matchedItems.length; i += 1) {
var liDom = domListSearchResults.children[i];
var aDom = liDom.children[0];
var match = matchedItems[i];
var lastPkgName = match.path.pkgNames[match.path.pkgNames.length - 1];
aDom.textContent = lastPkgName + "." + match.path.declNames.join('.');
aDom.setAttribute('href', navLink(match.path.pkgNames, match.path.declNames));
}
renderSearchCursor();
domSectSearchResults.classList.remove("hidden");
} else {
domSectSearchNoResults.classList.remove("hidden");
}
}
function renderSearchCursor() {
for (var i = 0; i < domListSearchResults.children.length; i += 1) {
var liDom = /** @type HTMLElement */(domListSearchResults.children[i]);
if (curSearchIndex === i) {
liDom.classList.add("selected");
} else {
liDom.classList.remove("selected");
}
}
}
// function indexNodesToCalls() {
// var map = {};
// for (var i = 0; i < zigAnalysis.calls.length; i += 1) {
// var call = zigAnalysis.calls[i];
// var fn = zigAnalysis.fns[call.fn];
// if (map[fn.src] == null) {
// map[fn.src] = [i];
// } else {
// map[fn.src].push(i);
// }
// }
// return map;
// }
/**
* @param {{ name: string }} a
* @param {{ name: string }} b
*/
function byNameProperty(a, b) {
return operatorCompare(a.name, b.name);
}
/**
* @template T
* @param {T} obj
* @returns {T}
*/
function clone(obj) {
var res = /** @type T */({});
for (var key in obj) {
res[key] = obj[key];
}
return res;
}
})();
Reference in a new issue View git blame Copy permalink