@gtkx/codegen 1.1.0 → 1.2.0

package/src/store/gi/record-field-accessor.ts

@@ -366,6 +366,21 @@ const visitInlineStructFields = (
     }
 };
 
+const inlineLeafCount = (context: ModuleContext, fields: GirField[]): number => {
+    let count = 0;
+
+    visitInlineStructFields(context, fields, 0, {
+        leaf: () => {
+            count += 1;
+        },
+        nested: (_jsName, nested) => {
+            count += inlineLeafCount(context, nested);
+        },
+    });
+
+    return count;
+};
+
 const elementAccessExpr = (descriptor: string, offset: number): string =>
     `read(__array, ${descriptor}, __base + ${String(offset)})`;
 
@@ -452,7 +467,7 @@ const structArrayGetterBlock = (options: StructArrayAccessorOptions): string =>
 };
 
 const structArraySetterStatements = (context: ModuleContext, options: StructArrayAccessorOptions): string => {
-    const { elementDescriptor, offset, elementSize, elementFields } = options;
+    const { elementDescriptor, offset, elementSize, elementFields, lengthExpr } = options;
     const writes: string[] = [];
 
     appendElementWriteStatements(context, {
@@ -468,7 +483,7 @@ const structArraySetterStatements = (context: ModuleContext, options: StructArra
         `const __descriptor = ${elementDescriptor};`,
         `const __array = read(getHandle(this), __descriptor, ${String(offset)}) as ReturnType<typeof getHandle>;`,
         "for (const [__index, __element] of __value.entries()) {",
-        indent(loop, 1),
+        indent(`if (__index >= ${lengthExpr}) {\n    break;\n}\n\n${loop}`, 1),
         "}",
         `write(getHandle(this), __descriptor, ${String(offset)}, __array);`,
     ].join("\n");
@@ -543,7 +558,7 @@ const resolveStructArray = (context: ModuleContext, target: StructArrayTarget):
 
     const shape = resolveStructArrayShape(context, elements, siblingFields);
 
-    if (shape === undefined) {
+    if (shape === undefined || inlineLeafCount(context, elements.elementFields) === 0) {
         return undefined;
     }
 

package/src/store/gi/return-wrap.ts

@@ -10,7 +10,7 @@ type WrapReturnOptions = {
     valueExpression: string;
 };
 
-const BIGINT_CATEGORIES: Set<PrimitiveCategory> = new Set(["gtype", "bigint64", "biguint64"]);
+const BIGINT_CATEGORIES: Set<PrimitiveCategory> = new Set(["gtype", "bigint64", "biguint64", "pointer"]);
 
 const wrapReturnValue = (context: ModuleContext, options: WrapReturnOptions): string => {
     const { ref, isNullable, valueExpression } = options;

package/src/store/gi/signal.ts

@@ -48,6 +48,21 @@ const SIGNAL_HANDLER_TYPE = "(...args: any[]) => any";
 const SIGNALS_SUFFIX = "Signals";
 const SIGNAL_EMIT_SUFFIX = "SignalEmit";
 
+const DEPRECATED_SIGNAL_ALIASES: Map<string, string> = new Map([
+    ["addEventListener", "on"],
+    ["removeEventListener", "off"],
+]);
+
+const deprecatedAliasDoc = (method: string): string => {
+    const replacement = DEPRECATED_SIGNAL_ALIASES.get(method);
+
+    if (replacement === undefined) {
+        return "";
+    }
+
+    return `/** @deprecated Since 1.2. Use \`${replacement}\` instead. Removed in v2. */\n`;
+};
+
 const renderSignalMembers = (context: ModuleContext, klass: GirClass): string[] => {
     if (klass.glibGetType === undefined) {
         return [];
@@ -68,7 +83,7 @@ const renderSignalMembers = (context: ModuleContext, klass: GirClass): string[]
 
     const connectDefault = isRootObject
         ? "default:\n    throw new globalThis.Error(\"Unknown signal '\" + signal + \"'\");"
-        : "default:\n    return super.connect(signal, handler, isAfter);";
+        : "default:\n    return super.connect(signal as never, handler as never, isAfter);";
 
     const emitDefault = isRootObject
         ? "default:\n    throw new globalThis.Error(\"Unknown signal '\" + sigName + \"'\");"
@@ -129,7 +144,11 @@ const renderSignalMap = (spec: SignalMapSpec): string => {
         (signal) => `${signalDoc(signal)}${sourceStringLiteral(signal.name)}: ${renderEntry(context, signal)};`,
     );
 
-    const entries = [...signalEntries, ...renderNotifyDetailEntries(context, klass, suffix)];
+    const entries = [
+        ...signalEntries,
+        ...renderNotifyDetailEntries(context, klass, suffix),
+        ...renderCustomNotifyEntry(context, klass, suffix),
+    ];
 
     return renderBracedOrEmpty(`export interface ${className}${suffix}${extendsClause}`, entries.join("\n"));
 };
@@ -137,6 +156,14 @@ const renderSignalMap = (spec: SignalMapSpec): string => {
 const signalDoc = (signal: GirCallable): string =>
     renderJsDoc(signal.doc, undefined, handlerSpec(signal, signal.parameters));
 
+const renderCustomNotifyEntry = (context: ModuleContext, klass: GirClass, suffix: string): string[] => {
+    if (context.namespace.name !== "GObject" || klass.name !== "Object") {
+        return [];
+    }
+
+    return [`[detail: \`notify::\${string}\`]: ${gobjectObjectMapRef(context, suffix)}["notify"];`];
+};
+
 const renderNotifyDetailEntries = (context: ModuleContext, klass: GirClass, suffix: string): string[] => {
     const notifyValue = `${gobjectObjectMapRef(context, suffix)}["notify"]`;
 
@@ -191,7 +218,6 @@ const renderSignalConnectInterface = (className: string, isRootObject: boolean):
     const lines = [
         `__signals__?: ${map};`,
         `connect<K extends keyof ${map}>(signal: K, handler: ${map}[K], isAfter?: boolean): number;`,
-        `connect(signal: string, handler: ${SIGNAL_HANDLER_TYPE}, isAfter?: boolean): number;`,
         `emit<K extends keyof ${emitMap}>(sigName: K, ...args: ${emitMap}[K]["args"]): ${emitMap}[K]["result"];`,
         "emit(sigName: string, ...args: unknown[]): unknown;",
     ];
@@ -200,8 +226,8 @@ const renderSignalConnectInterface = (className: string, isRootObject: boolean):
         const chainable = (methods: string[], trailing: string): void => {
             for (const method of methods) {
                 lines.push(
+                    deprecatedAliasDoc(method) +
                     `${method}<K extends keyof ${map}>(signal: K, handler: ${map}[K]${trailing}): this;`,
-                    `${method}(signal: string, handler: ${SIGNAL_HANDLER_TYPE}${trailing}): this;`,
                 );
             }
         };

package/src/store/jsx-store.ts

@@ -30,7 +30,6 @@ const writeJsxStore = (
             peerDependencies: { "@gtkx/gi": "*", "@gtkx/react": "*", react: "*" },
         }),
         rawFiles,
-        requiresEnvReference: true,
     });
 };
 

package/src/store/store-fs.ts

@@ -50,7 +50,6 @@ type WriteStoreParams = {
     files: SourceModule[];
     manifest: Manifest;
     rawFiles?: RawFile[];
-    requiresEnvReference?: boolean;
 };
 
 const STORE_DIR_MODE = 0o755;
@@ -98,18 +97,13 @@ const writeStore = (params: WriteStoreParams): void => {
 };
 
 const buildTempStore = (tmp: string, params: WriteStoreParams): void => {
+    writePackageJson(tmp, params.manifest);
+
     for (const file of params.files) {
         writeSourceFile(tmp, file.fileName, file.source);
     }
 
-    compileStore({
-        storeDir: tmp,
-        files: params.files,
-        packageName: params.manifest.name,
-        ...(params.requiresEnvReference !== undefined && { requiresEnvReference: params.requiresEnvReference }),
-    });
-
-    writePackageJson(tmp, params.manifest);
+    compileStore({ storeDir: tmp, files: params.files, packageName: params.manifest.name });
     const rawFiles = params.rawFiles ?? [];
 
     for (const raw of rawFiles) {

package/src/xml.ts

@@ -7,8 +7,12 @@ type XmlFileInput = {
     parser: XMLParser;
     label: string;
     path: string;
+    malformedRemedy?: string;
 };
 
+const HIGHEST_CONTROL_CODE = 0x1F;
+const LEGAL_CONTROL_CODES: Set<number> = new Set([0x09, 0x0A, 0x0D]);
+
 const createXmlParser = (options: Partial<X2jOptions>): XMLParser =>
     new XMLParser({
         ignoreAttributes: false,
@@ -46,13 +50,51 @@ const positionSuffix = (error: unknown): string => {
     return ` (line ${String(line)}, column ${String(col)})`;
 };
 
+const isIllegalControlCode = (code: number): boolean =>
+    code <= HIGHEST_CONTROL_CODE && !LEGAL_CONTROL_CODES.has(code);
+
+const escapedCode = (code: number): string => `[U+${code.toString(16).toUpperCase().padStart(4, "0")}]`;
+
+const escapeControlCodes = (text: string): string => {
+    let escaped = "";
+
+    for (const character of text) {
+        const code = character.codePointAt(0) ?? 0;
+        escaped += isIllegalControlCode(code) ? escapedCode(code) : character;
+    }
+
+    return escaped;
+};
+
+const offendingLine = (xml: string, error: unknown): string => {
+    const line = isRecord(error) ? error.line : undefined;
+
+    if (typeof line !== "number") {
+        return "";
+    }
+
+    const text = xml.split("\n")[line - 1];
+
+    if (text === undefined) {
+        return "";
+    }
+
+    return `\n    ${escapeControlCodes(text.replace(/^[ \t]+/, "").replace(/\r$/, ""))}`;
+};
+
+const remedySuffix = (input: XmlFileInput, xml: string, error: unknown): string => {
+    const remedy = input.malformedRemedy;
+
+    return remedy === undefined ? "" : `${offendingLine(xml, error)}\n${remedy}`;
+};
+
 const assertWellFormed = (input: XmlFileInput, xml: string): void => {
     try {
         SyntaxValidator.validate(xml);
     } catch (error) {
         throw new Error(
             `The ${input.label} at ${input.path} is not well-formed XML: ` +
-            `${errorMessage(error)}${positionSuffix(error)}`,
+            `${errorMessage(error)}${positionSuffix(error)}${remedySuffix(input, xml, error)}`,
             { cause: error },
         );
     }