@gtkx/codegen 1.0.0-rc.4 → 1.0.0

package/src/analysis/param-capability.ts

@@ -0,0 +1,172 @@
+import type { GirCallable, GirParameter } from "../gir/parameter.js";
+import type { CArrayType, TypeId } from "../gir/type-id.js";
+import type { GirType } from "../gir/type.js";
+import type { ModuleContext } from "../writer/context.js";
+import { isCallerAllocatedOut, isInoutParameter } from "../gir/parameter.js";
+import { constructibleName } from "../store/gi/method.js";
+import { isCollectibleCallerOut, isHandlePassedInPlace, underlyingType } from "../store/gi/param-marshal.js";
+import { isScalarRef, recordInlineSize } from "./descriptor-render.js";
+
+const POINTER_DEPTH = 1;
+
+const isPointerType = (context: ModuleContext, type: GirType): boolean => {
+    switch (type.kind) {
+        case "primitive": {
+            return type.category === "string";
+        }
+        case "record": {
+            return recordInlineSize(context, type.value) === undefined;
+        }
+        case "class":
+        case "interface":
+        case "carray":
+        case "list":
+        case "hashtable": {
+            return true;
+        }
+        case "alias":
+        case "callback":
+        case "enum":
+        case "varargs": {
+            return false;
+        }
+    }
+};
+
+const isPointerElement = (context: ModuleContext, element: TypeId): boolean => {
+    if (isScalarRef(context.library, element)) {
+        return false;
+    }
+
+    const type = underlyingType(context, element);
+
+    return type !== undefined && isPointerType(context, type);
+};
+
+const carrayIndirection = (context: ModuleContext, type: CArrayType): number =>
+    POINTER_DEPTH + (isPointerElement(context, type.element) ? POINTER_DEPTH : 0);
+
+const typeIndirection = (context: ModuleContext, type: GirType): number | undefined => {
+    switch (type.kind) {
+        case "primitive": {
+            return type.category === "string" ? POINTER_DEPTH : undefined;
+        }
+        case "callback":
+        case "class":
+        case "hashtable":
+        case "interface":
+        case "list":
+        case "record": {
+            return POINTER_DEPTH;
+        }
+        case "carray": {
+            return carrayIndirection(context, type);
+        }
+        case "alias":
+        case "enum":
+        case "varargs": {
+            return undefined;
+        }
+    }
+};
+
+const baseIndirection = (context: ModuleContext, ref: TypeId | undefined): number | undefined => {
+    if (isScalarRef(context.library, ref)) {
+        return 0;
+    }
+
+    const type = ref === undefined ? undefined : underlyingType(context, ref);
+
+    return type === undefined ? undefined : typeIndirection(context, type);
+};
+
+const declaredIndirection = (parameter: GirParameter): number | undefined => {
+    const cType = parameter.cType;
+
+    if (cType === undefined) {
+        return undefined;
+    }
+
+    return cType.split("*").length - 1;
+};
+
+const marshalledIndirection = (context: ModuleContext, parameter: GirParameter): number | undefined => {
+    const base = baseIndirection(context, parameter.type);
+
+    if (base === undefined) {
+        return undefined;
+    }
+
+    if (isCallerAllocatedOut(parameter) || isHandlePassedInPlace(context, parameter)) {
+        return base;
+    }
+
+    if (isInoutParameter(parameter) && !isScalarRef(context.library, parameter.type)) {
+        return base;
+    }
+
+    return base + POINTER_DEPTH;
+};
+
+const hasCallerSuppliedLength = (context: ModuleContext, parameter: GirParameter): boolean => {
+    const type = parameter.type === undefined ? undefined : underlyingType(context, parameter.type);
+
+    return type?.kind === "carray" && type.lengthParameterIndex !== undefined;
+};
+
+const isUnbuildableCallerOut = (context: ModuleContext, parameter: GirParameter): boolean =>
+    constructibleName(context, parameter.type) === undefined || !isCollectibleCallerOut(context, parameter);
+
+const isUnmarshalableCallerOut = (context: ModuleContext, parameter: GirParameter): boolean => {
+    if (hasCallerSuppliedLength(context, parameter)) {
+        return true;
+    }
+
+    return isUnbuildableCallerOut(context, parameter) && !parameter.optional;
+};
+
+const hasIndirectionMismatch = (context: ModuleContext, parameter: GirParameter): boolean => {
+    const declared = declaredIndirection(parameter);
+    const marshalled = marshalledIndirection(context, parameter);
+
+    if (declared === undefined || marshalled === undefined) {
+        return false;
+    }
+
+    return declared !== marshalled;
+};
+
+const isTypeErasedCallback = (context: ModuleContext, parameter: GirParameter): boolean => {
+    if (parameter.closureIndex === undefined) {
+        return false;
+    }
+
+    const type = parameter.type === undefined ? undefined : underlyingType(context, parameter.type);
+
+    return type?.kind === "callback" && type.value.parameters.length === 0;
+};
+
+const isUnmarshalableCallParam = (context: ModuleContext, parameter: GirParameter): boolean => {
+    if (parameter.isVarargs) {
+        return false;
+    }
+
+    if (isTypeErasedCallback(context, parameter)) {
+        return true;
+    }
+
+    if (parameter.direction === "in") {
+        return false;
+    }
+
+    if (isCallerAllocatedOut(parameter)) {
+        return isUnmarshalableCallerOut(context, parameter);
+    }
+
+    return hasIndirectionMismatch(context, parameter);
+};
+
+const hasUnmarshalableParam = (context: ModuleContext, callable: GirCallable): boolean =>
+    callable.parameters.some((parameter) => isUnmarshalableCallParam(context, parameter));
+
+export { hasUnmarshalableParam };

package/src/analysis/param-structure.ts

@@ -2,6 +2,7 @@ import { toCamelIdentifier } from "@gtkx/utils";
 import type { GirFunction } from "../gir/function.js";
 import type { Library } from "../gir/library.js";
 import type { TypeId } from "../gir/type-id.js";
+import type { JsDocParam } from "../writer/doc-tags.js";
 import { type GirCallable, type GirParameter, isCallerAllocatedOut, isOutParameter } from "../gir/parameter.js";
 import { isCellInout, shouldOmitPrimaryReturn } from "./descriptor-render.js";
 
@@ -16,6 +17,7 @@ type HandlerResultOptions = {
     renderType: (ref: TypeId | undefined, isNullable: boolean) => string;
     shouldIncludeCallerAllocated: boolean;
     isOptOut: boolean;
+    shouldExcludeOut?: (parameter: GirParameter) => boolean;
 };
 
 const isInputParameter = (options: {
@@ -108,7 +110,7 @@ const carrayLengthIndex = (library: Library, ref: TypeId | undefined): number |
     return type.lengthParameterIndex;
 };
 
-const arrayLengthSources = (library: Library, fn: GirFunction): Map<number, number> => {
+const arrayLengthSources = (library: Library, fn: GirCallable): Map<number, number> => {
     const map: Map<number, number> = new Map();
 
     for (const [index, parameter] of fn.parameters.entries()) {
@@ -122,19 +124,7 @@ const arrayLengthSources = (library: Library, fn: GirFunction): Map<number, numb
     return map;
 };
 
-const hasCallerAllocatedArrayLength = (library: Library, fn: GirFunction): boolean => {
-    for (const arrayIndex of arrayLengthSources(library, fn).values()) {
-        const array = fn.parameters[arrayIndex];
-
-        if (array !== undefined && isCallerAllocatedOut(array)) {
-            return true;
-        }
-    }
-
-    return false;
-};
-
-const returnArrayLengthIndices = (library: Library, fn: GirFunction): Set<number> => {
+const returnArrayLengthIndices = (library: Library, fn: GirCallable): Set<number> => {
     const returnType = fn.returnValue.type === undefined ? undefined : library.typeFor(fn.returnValue.type);
 
     if (returnType?.kind !== "carray") {
@@ -150,7 +140,7 @@ const returnArrayLengthIndices = (library: Library, fn: GirFunction): Set<number
     return new Set([lengthIndex]);
 };
 
-const foldedLengthIndices = (library: Library, fn: GirFunction): Set<number> => {
+const foldedLengthIndices = (library: Library, fn: GirCallable): Set<number> => {
     const indices: Set<number> = new Set(arrayLengthSources(library, fn).keys());
 
     for (const index of returnArrayLengthIndices(library, fn)) {
@@ -160,6 +150,20 @@ const foldedLengthIndices = (library: Library, fn: GirFunction): Set<number> =>
     return indices;
 };
 
+const foldedLengthParameters = (library: Library, fn: GirCallable): Set<GirParameter> => {
+    const folded: Set<GirParameter> = new Set();
+
+    for (const index of foldedLengthIndices(library, fn)) {
+        const parameter = fn.parameters[index];
+
+        if (parameter !== undefined) {
+            folded.add(parameter);
+        }
+    }
+
+    return folded;
+};
+
 const parameterIdentifier = (parameter: GirParameter, index: number): string => {
     if (parameter.name.length === 0) {
         return `arg${String(index)}`;
@@ -168,17 +172,62 @@ const parameterIdentifier = (parameter: GirParameter, index: number): string =>
     return toCamelIdentifier(parameter.name);
 };
 
+const handlerParameters = (
+    parameters: GirParameter[],
+    shouldExclude: (parameter: GirParameter) => boolean = () => false,
+): GirParameter[] =>
+    parameters.filter(
+        (parameter) => !parameter.isVarargs && !isOutParameter(parameter) && !shouldExclude(parameter),
+    );
+
+const documentedParameters = (
+    library: Library,
+    fn: GirFunction,
+    shouldSkip: (parameter: GirParameter) => boolean = () => false,
+    renames?: Map<string, string>,
+): JsDocParam[] =>
+    inputParameters(library, fn)
+        .filter(({ parameter }) => !shouldSkip(parameter))
+        .map(({ parameter, index }) => ({
+            name: renames?.get(parameter.name) ?? parameterIdentifier(parameter, index),
+            doc: parameter.doc ?? "",
+        }))
+        .filter((entry) => entry.doc.length > 0);
+
+const documentedHandlerParameters = (parameters: GirParameter[]): JsDocParam[] =>
+    handlerParameters(parameters)
+        .map((parameter, index) => ({ name: parameterIdentifier(parameter, index), doc: parameter.doc ?? "" }))
+        .filter((entry) => entry.doc.length > 0);
+
+const handlerRenames = (parameters: GirParameter[]): Map<string, string> => {
+    const renames: Map<string, string> = new Map();
+
+    for (const [index, parameter] of parameters.entries()) {
+        renames.set(parameter.name, parameterIdentifier(parameter, index));
+    }
+
+    return renames;
+};
+
+const renamesWithInstance = (parameters: GirParameter[], instance: GirParameter | undefined): Map<string, string> => {
+    const renames = handlerRenames(parameters);
+
+    if (instance !== undefined && instance.name.length > 0) {
+        renames.set(instance.name, "this");
+    }
+
+    return renames;
+};
+
 const renderHandlerParameters = (
     parameters: GirParameter[],
     renderType: (ref: TypeId | undefined, isNullable: boolean) => string,
     shouldExclude: (parameter: GirParameter) => boolean = () => false,
 ): string[] =>
-    parameters
-        .filter((parameter) => !parameter.isVarargs && !isOutParameter(parameter) && !shouldExclude(parameter))
-        .map(
-            (parameter, index) =>
-                `${parameterIdentifier(parameter, index)}: ${renderType(parameter.type, parameter.nullable)}`,
-        );
+    handlerParameters(parameters, shouldExclude).map(
+        (parameter, index) =>
+            `${parameterIdentifier(parameter, index)}: ${renderType(parameter.type, parameter.nullable)}`,
+    );
 
 const foldOutParamShape = (primary: string | undefined, outTypes: string[]): string => {
     if (primary !== undefined) {
@@ -226,13 +275,18 @@ const scalarResultType = (primary: string | undefined, isOptOut: boolean): strin
 
 const renderHandlerResultType = (options: HandlerResultOptions): string => {
     const { library, signal, renderType, shouldIncludeCallerAllocated, isOptOut } = options;
+    const shouldExcludeOut = options.shouldExcludeOut ?? (() => false);
 
     const primary = shouldOmitPrimaryReturn(library, signal.returnValue)
         ? undefined
         : renderType(signal.returnValue.type, signal.returnValue.nullable);
 
     const outTypes = signal.parameters
-        .filter((parameter) => isHandlerOutParameter({ library, parameter, shouldIncludeCallerAllocated }))
+        .filter(
+            (parameter) =>
+                isHandlerOutParameter({ library, parameter, shouldIncludeCallerAllocated }) &&
+                !shouldExcludeOut(parameter),
+        )
         .map((parameter) => renderType(parameter.type, parameter.nullable));
 
     if (outTypes.length === 0) {
@@ -247,10 +301,16 @@ export {
     inputParameters,
     closureAndDestroyIndices,
     arrayLengthSources,
-    hasCallerAllocatedArrayLength,
     foldedLengthIndices,
+    foldedLengthParameters,
     parameterIdentifier,
+    documentedParameters,
+    documentedHandlerParameters,
+    handlerRenames,
+    renamesWithInstance,
+    handlerParameters,
     renderHandlerParameters,
     foldOutParamShape,
     renderHandlerResultType,
+    type InputParameter,
 };

package/src/analysis/type-shape.ts

@@ -0,0 +1,24 @@
+import type { Library } from "../gir/library.js";
+import type { PrimitiveCategory } from "../gir/primitives.js";
+import type { CArrayType, TypeId } from "../gir/type-id.js";
+import type { GirType } from "../gir/type.js";
+
+const resolvedTypeFor = (library: Library, ref: TypeId | undefined): GirType | undefined =>
+    ref === undefined ? undefined : library.typeFor(ref);
+
+const carrayFor = (library: Library, ref: TypeId | undefined): CArrayType | undefined => {
+    const type = resolvedTypeFor(library, ref);
+
+    return type?.kind === "carray" ? type : undefined;
+};
+
+const primitiveCategoryFor = (library: Library, ref: TypeId | undefined): PrimitiveCategory | undefined => {
+    const type = resolvedTypeFor(library, ref);
+
+    return type?.kind === "primitive" ? type.category : undefined;
+};
+
+const isUnboundedArray = (type: CArrayType): boolean =>
+    type.isZeroTerminated && type.lengthParameterIndex === undefined && type.fixedSize === undefined;
+
+export { carrayFor, isUnboundedArray, primitiveCategoryFor };

package/src/compile.ts

@@ -177,4 +177,4 @@ const checkModules = (params: { modules: SourceModule[]; resolveFrom: string; la
     }
 };
 
-export { compileProject, checkModules, type SourceModule, type CompileProjectParams };
+export { compileProject, checkModules, type SourceModule };

package/src/docs/api-reference.ts

@@ -9,7 +9,7 @@ import { namespaceFunctionExportName } from "../store/gi/function.js";
 import { type ElementProps, setElementProps } from "../store/jsx/element-prop-imports.js";
 import { collectIntrinsicElementClasses, type GlibNamedClass } from "../store/jsx/intrinsic-elements.js";
 import { type OmittedProps, setOmittedProps } from "../store/jsx/omitted-props.js";
-import { createElementPageContext, type ElementPageContext, renderElementPage } from "./element-page.js";
+import { type ElementPageContext, renderElementPage } from "./element-page.js";
 import { docsSignatureContext, firstSentence, namespaceOrder } from "./render.js";
 import { type GiSymbolEntry, renderSymbolPage, type SymbolPageOptions } from "./symbol-page.js";
 
@@ -34,7 +34,16 @@ type ApiSymbolQuery = {
 };
 
 /** What an indexed symbol is: one of the GIR symbol kinds, or a JSX element. */
-type ApiSymbolKind = GiSymbolEntry["kind"] | "element";
+type ApiSymbolKind =
+    "alias" |
+    "callback" |
+    "class" |
+    "constant" |
+    "element" |
+    "enum" |
+    "function" |
+    "interface" |
+    "record";
 
 /** An indexed symbol, without its reference page. */
 type ApiSymbol = {
@@ -93,16 +102,30 @@ type ApiSearchOptions = {
     limit?: number;
 };
 
+/** An indexed JSX element, carrying the widget class its page renders from. */
 type ElementEntry = {
+    /** Discriminant marking the entry as a JSX element rather than a GIR symbol. */
     kind: "element";
+    /** GIR namespace declaring the widget class. */
     namespace: GirNamespace;
+    /** Element name, which is the class's GLib type name such as `GtkButton`. */
     name: string;
+    /** Documentation text carried by the widget class's GIR node. */
     doc: string | undefined;
+    /** The widget class the element is generated from. */
     element: GlibNamedClass;
 };
 
+/** Anything the index holds: a GIR symbol or a JSX element. */
 type SymbolEntry = GiSymbolEntry | ElementEntry;
-type ScoredEntry = { score: number; entry: SymbolEntry };
+
+/** A search hit: an indexed entry and how well its name answered the query. */
+type ScoredEntry = {
+    /** Match strength, ranked best first: an exact name, then a prefix, then a substring. */
+    score: number;
+    /** The entry that matched. */
+    entry: SymbolEntry;
+};
 
 /** Every kind the reference indexes, in the order a namespace overview groups its symbols. */
 const API_SYMBOL_KINDS: ApiSymbolKind[] = [
@@ -139,6 +162,9 @@ const compareNames = (a: string, b: string): number => {
     return a > b ? 1 : 0;
 };
 
+const symbolKindSet = (kinds: ApiSymbolKind[] | undefined): Set<ApiSymbolKind> | undefined =>
+    kinds === undefined ? undefined : new Set(kinds);
+
 const isQueriedEntry = (
     entry: SymbolEntry,
     namespaceFilter: string | undefined,
@@ -280,29 +306,13 @@ const narrowToExactMatches = (candidates: SymbolEntry[], trimmed: string, isQual
     return exact.length > 0 ? exact : candidates;
 };
 
-const isSearchFilterMatch = (
-    entry: SymbolEntry,
-    namespaceFilter: string | undefined,
-    kinds: ApiSymbolKind[] | undefined,
-): boolean => {
-    if (namespaceFilter !== undefined && entry.namespace.name.toLowerCase() !== namespaceFilter) {
-        return false;
-    }
-
-    if (kinds !== undefined && !kinds.includes(entry.kind)) {
-        return false;
-    }
-
-    return true;
-};
-
 const getScoredEntry = (
     entry: SymbolEntry,
     query: string,
     namespaceFilter: string | undefined,
-    kinds: ApiSymbolKind[] | undefined,
+    kinds: Set<ApiSymbolKind> | undefined,
 ): ScoredEntry | undefined => {
-    if (!isSearchFilterMatch(entry, namespaceFilter, kinds)) {
+    if (!isQueriedEntry(entry, namespaceFilter, kinds)) {
         return undefined;
     }
 
@@ -355,12 +365,13 @@ class ApiReference {
     private props: ElementProps;
     private omittedProps: OmittedProps;
 
+    /** Indexes every symbol and JSX element in the GIR data the options point at. */
     constructor(options: ApiReferenceOptions) {
         this.libraries = options.libraries;
         this.props = options.props ?? {};
         this.omittedProps = options.omittedProps ?? {};
         this.library = Library.load(options.libraries, options.girPath);
-        this.elementContext = createElementPageContext(this.library, (): string | undefined => undefined);
+        this.elementContext = { library: this.library, linkFor: (): string | undefined => undefined };
         this.buildIndex();
     }
 
@@ -484,7 +495,7 @@ class ApiReference {
     private scoreEntries(
         query: string,
         namespaceFilter: string | undefined,
-        kinds: ApiSymbolKind[] | undefined,
+        kinds: Set<ApiSymbolKind> | undefined,
     ): ScoredEntry[] {
         const scored: ScoredEntry[] = [];
 
@@ -535,7 +546,7 @@ class ApiReference {
     /** Every indexed symbol the query keeps, ordered by namespace (Gtk, then Adw, then alphabetically) and name. */
     symbols(query: ApiSymbolQuery = {}): ApiSymbol[] {
         const namespaceFilter = query.namespace?.toLowerCase();
-        const kinds = query.kinds === undefined ? undefined : new Set(query.kinds);
+        const kinds = symbolKindSet(query.kinds);
 
         return this.entries
             .filter((entry) => isQueriedEntry(entry, namespaceFilter, kinds))
@@ -556,7 +567,7 @@ class ApiReference {
 
         const limit = Math.max(1, Math.floor(options.limit ?? DEFAULT_SEARCH_LIMIT));
         const namespaceFilter = options.namespace?.toLowerCase();
-        const scored = this.scoreEntries(query, namespaceFilter, options.kinds);
+        const scored = this.scoreEntries(query, namespaceFilter, symbolKindSet(options.kinds));
         scored.sort(compareScoredEntries);
 
         return scored.slice(0, limit).map((item) => this.toApiSymbol(item.entry));