@jhlagado/azm 0.2.9 → 0.2.10

package/README.md

@@ -120,9 +120,7 @@ Use `@Name:` for callable routine entries. The `@` marks a register contracts
 routine boundary; call sites still write the symbol name without `@`:
 
 ```asm
-;!      in        A
-;!      out       A
-;!      clobbers  BC
+;! in A; out A; clobbers BC
 @MxMask:
         LD      C,A
         OR      A
@@ -406,9 +404,7 @@ register and stack assumptions visible before they become debugger sessions.
 Routine entry labels start with `@`:
 
 ```asm
-;! in A,HL
-;! out carry
-;! clobbers B
+;! in A,HL; out carry; clobbers B
 @CheckTile:
         ld      b,(hl)
         cp      b
@@ -423,9 +419,11 @@ name:
 ```
 
 AZMDoc register contract comments use `;!` and may record inputs, outputs,
-clobbered registers and preserved registers. `clobbers B` means the routine may
-change `B`. `preserves B` means the value that enters in `B` is still present
-when the routine returns.
+clobbered registers and preserved registers. Separate clauses on the same line
+with semicolons. Older one-clause-per-line comments are still accepted, but AZM
+generated annotations use the compact single-line form. `clobbers B` means the
+routine may change `B`. `preserves B` means the value that enters in `B` is
+still present when the routine returns.
 
 Run the analysis with:
 

package/dist/src/register-contracts/report.js

@@ -2,6 +2,7 @@ function list(units) {
     return units.length === 0 ? '-' : units.join(',');
 }
 const FLAG_UNITS = new Set(['carry', 'zero', 'sign', 'parity', 'halfCarry']);
+const FLAG_UNIT_LIST = ['carry', 'zero', 'sign', 'parity', 'halfCarry'];
 const CONTRACT_CARRIER_PAIRS = [
     { label: 'BC', hi: 'B', lo: 'C' },
     { label: 'DE', hi: 'D', lo: 'E' },
@@ -32,6 +33,14 @@ export function contractCarrierList(units) {
     }
     return parts.length === 0 ? '-' : parts.join(',');
 }
+function sourceContractCarrierList(units) {
+    const unique = [...new Set(units)];
+    const hasAllFlags = FLAG_UNIT_LIST.every((unit) => unique.includes(unit));
+    const compacted = hasAllFlags
+        ? unique.filter((unit) => !FLAG_UNITS.has(unit)).concat('F')
+        : unique;
+    return contractCarrierList(compacted);
+}
 function relationOutputUnits(relations) {
     return relations.flatMap((rel) => rel.out);
 }
@@ -59,9 +68,9 @@ function sourceContractEntries(summary) {
     const outputUnits = relationOutputUnits(summary.valueRelations);
     if (outputUnits.length > 0)
         out.push({ keyword: 'out', carriers: contractCarrierList(outputUnits) });
-    const clobbers = summary.mayWrite.filter((unit) => !relationOut.has(unit) && !FLAG_UNITS.has(unit));
+    const clobbers = summary.mayWrite.filter((unit) => !relationOut.has(unit));
     if (clobbers.length > 0)
-        out.push({ keyword: 'clobbers', carriers: contractCarrierList(clobbers) });
+        out.push({ keyword: 'clobbers', carriers: sourceContractCarrierList(clobbers) });
     return out;
 }
 function stackStatus(summary) {
@@ -152,5 +161,8 @@ export function renderRegisterContractsInterface(summaries) {
     return `${lines.join('\n')}\n`;
 }
 export function renderRegisterContractsSourceBlock(summary) {
-    return sourceContractEntries(summary).map((entry) => `;!      ${entry.keyword.padEnd(10)}${entry.carriers}`);
+    const entries = sourceContractEntries(summary);
+    if (entries.length === 0)
+        return [];
+    return [`;! ${entries.map((entry) => `${entry.keyword} ${entry.carriers}`).join('; ')}`];
 }

package/dist/src/register-contracts/smartCommentParsing.d.ts

@@ -1,3 +1,4 @@
 import type { SmartComment } from './types.js';
 export declare function parseSmartCommentLine(line: string): SmartComment | undefined;
+export declare function parseSmartCommentLines(line: string): SmartComment[];
 export declare function isCompactSourceCommentLine(line: string): boolean;

package/dist/src/register-contracts/smartCommentParsing.js

@@ -1,5 +1,6 @@
 import { expandCarrierList } from './carriers.js';
 const COMPACT_SOURCE_TAG_RE = /^;?\s*!\s*(in|out|clobbers|preserves)(?:\s+(.+))?$/i;
+const COMPACT_SOURCE_CLAUSE_RE = /^(in|out|clobbers|preserves)(?:\s+(.+))?$/i;
 const COMPACT_SOURCE_LINE_RE = /^\s*;\s*!\s*(?:in|out|maybe-out|clobbers|preserves)(?:\s|$)/i;
 const CARRIER_RE = /^\{([^}]+)\}(?:\s+(.+))?$/;
 const CONTRACT_COMMENT_KINDS = new Set(['in', 'out', 'clobbers', 'preserves']);
@@ -35,17 +36,51 @@ function parseCarrierPayload(rest) {
     return { carriers, ...(name ? { name } : {}) };
 }
 export function parseSmartCommentLine(line) {
+    return parseSmartCommentLines(line)[0];
+}
+export function parseSmartCommentLines(line) {
     const trimmed = line.trim();
     const expectOut = parseExpectOutComment(trimmed);
     if (expectOut !== undefined)
-        return expectOut;
+        return [expectOut];
+    const semicolonSeparated = parseSemicolonSeparatedSourceComments(trimmed);
+    if (semicolonSeparated.length > 0)
+        return semicolonSeparated;
     const match = COMPACT_SOURCE_TAG_RE.exec(trimmed);
-    if (!match)
-        return undefined;
-    const tag = match[1].toLowerCase();
-    if (!CONTRACT_COMMENT_KINDS.has(tag))
-        return undefined;
-    return parseCarrierComment(tag, match[2]?.trim());
+    if (match) {
+        const tag = match[1].toLowerCase();
+        if (!CONTRACT_COMMENT_KINDS.has(tag))
+            return [];
+        const comment = parseCarrierComment(tag, match[2]?.trim());
+        return comment === undefined ? [] : [comment];
+    }
+    return [];
+}
+function parseSemicolonSeparatedSourceComments(trimmed) {
+    const sourcePrefix = /^;?\s*!\s*/.exec(trimmed);
+    if (sourcePrefix === null)
+        return [];
+    const content = trimmed.slice(sourcePrefix[0].length);
+    const parts = content
+        .split(';')
+        .map((part) => part.trim())
+        .filter(Boolean);
+    if (parts.length <= 1)
+        return [];
+    const comments = [];
+    for (const part of parts) {
+        const match = COMPACT_SOURCE_CLAUSE_RE.exec(part);
+        if (!match)
+            return [];
+        const tag = match[1].toLowerCase();
+        if (!CONTRACT_COMMENT_KINDS.has(tag))
+            return [];
+        const comment = parseCarrierComment(tag, match[2]?.trim());
+        if (comment === undefined)
+            return [];
+        comments.push(comment);
+    }
+    return comments;
 }
 function parseExpectOutComment(trimmed) {
     const expectOut = /^;?\s*expects\s+out\s+(.+)$/i.exec(trimmed);

package/dist/src/register-contracts/smartComments.d.ts

@@ -1,5 +1,5 @@
 import type { LocatedSmartComment, RegisterContractsRoutine, RoutineContract } from './types.js';
-import { parseSmartCommentLine } from './smartCommentParsing.js';
-export { parseSmartCommentLine };
+import { parseSmartCommentLine, parseSmartCommentLines } from './smartCommentParsing.js';
+export { parseSmartCommentLine, parseSmartCommentLines };
 export declare function parseSmartComments(sourceLineComments: ReadonlyMap<string, ReadonlyMap<number, string>>): LocatedSmartComment[];
 export declare function buildRoutineContracts(comments: LocatedSmartComment[], routines?: RegisterContractsRoutine[], sourceTexts?: ReadonlyMap<string, string>): Map<string, RoutineContract>;

package/dist/src/register-contracts/smartComments.js

@@ -1,12 +1,11 @@
 import { collectPrecedingCommentBlock } from './smartCommentBlocks.js';
-import { parseSmartCommentLine } from './smartCommentParsing.js';
-export { parseSmartCommentLine };
+import { parseSmartCommentLine, parseSmartCommentLines } from './smartCommentParsing.js';
+export { parseSmartCommentLine, parseSmartCommentLines };
 export function parseSmartComments(sourceLineComments) {
     const out = [];
     for (const [file, comments] of sourceLineComments) {
         for (const [line, text] of comments) {
-            const parsed = parseSmartCommentLine(`;${text}`);
-            if (parsed) {
+            for (const parsed of parseSmartCommentLines(`;${text}`)) {
                 out.push({ file, line, comment: parsed });
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jhlagado/azm",
-  "version": "0.2.9",
+  "version": "0.2.10",
   "description": "AZM assembler for the Z80 family (Node.js CLI)",
   "license": "GPL-3.0-only",
   "engines": {