Handle multiple sheet_instances entries in KicadSch (#8)

* Allow multiple sheet_instances in KicadSch

* Support direct sheet_instances paths

* Restore sheet instances parsing under sheets

Author: seveibar

lib/sexpr/classes/KicadSch.ts

@@ -26,7 +26,6 @@ const SINGLE_CHILD_TOKENS = new Set([
   "paper",
   "title_block",
   "lib_symbols",
-  "sheet_instances",
   "embedded_fonts",
 ])
 
@@ -39,6 +38,7 @@ const MULTI_CHILD_TOKENS = new Set([
   "label",
   "junction",
   "wire",
+  "sheet_instances",
 ])
 
 const SUPPORTED_CHILD_TOKENS = new Set([
@@ -54,7 +54,7 @@ export interface KicadSchConstructorParams {
   paper?: Paper
   titleBlock?: TitleBlock
   libSymbols?: LibSymbols
-  sheetInstances?: SheetInstances
+  sheetInstances?: SheetInstances | SheetInstances[]
   embeddedFonts?: EmbeddedFonts
   properties?: Property[]
   images?: Image[]
@@ -77,7 +77,7 @@ export class KicadSch extends SxClass {
   private _sxPaper?: Paper
   private _sxTitleBlock?: TitleBlock
   private _sxLibSymbols?: LibSymbols
-  private _sxSheetInstances?: SheetInstances
+  private _sheetInstances: SheetInstances[] = []
   private _sxEmbeddedFonts?: EmbeddedFonts
   private _properties: Property[] = []
   private _images: Image[] = []
@@ -216,7 +216,9 @@ export class KicadSch extends SxClass {
       paper: propertyMap.paper as Paper | undefined,
       titleBlock: propertyMap.title_block as TitleBlock | undefined,
       libSymbols: propertyMap.lib_symbols as LibSymbols | undefined,
-      sheetInstances: propertyMap.sheet_instances as SheetInstances | undefined,
+      sheetInstances: arrayPropertyMap.sheet_instances as
+        | SheetInstances[]
+        | undefined,
       embeddedFonts: propertyMap.embedded_fonts as EmbeddedFonts | undefined,
       properties: (arrayPropertyMap.property as Property[]) ?? [],
       images: (arrayPropertyMap.image as Image[]) ?? [],
@@ -292,12 +294,16 @@ export class KicadSch extends SxClass {
     this._sxLibSymbols = value
   }
 
-  get sheetInstances(): SheetInstances | undefined {
-    return this._sxSheetInstances
+  get sheetInstances(): SheetInstances[] {
+    return [...this._sheetInstances]
   }
 
-  set sheetInstances(value: SheetInstances | undefined) {
-    this._sxSheetInstances = value
+  set sheetInstances(value: SheetInstances | SheetInstances[] | undefined) {
+    if (value === undefined) {
+      this._sheetInstances = []
+      return
+    }
+    this._sheetInstances = Array.isArray(value) ? [...value] : [value]
   }
 
   get embeddedFonts(): EmbeddedFonts | undefined {
@@ -381,7 +387,7 @@ export class KicadSch extends SxClass {
     if (this._sxPaper) children.push(this._sxPaper)
     if (this._sxTitleBlock) children.push(this._sxTitleBlock)
     if (this._sxLibSymbols) children.push(this._sxLibSymbols)
-    if (this._sxSheetInstances) children.push(this._sxSheetInstances)
+    children.push(...this._sheetInstances)
     if (this._sxEmbeddedFonts) children.push(this._sxEmbeddedFonts)
     children.push(...this._properties)
     children.push(...this._images)

lib/sexpr/classes/SheetInstances.ts

@@ -2,44 +2,125 @@ import { SxClass } from "../base-classes/SxClass"
 import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
 import { quoteSExprString } from "../utils/quoteSExprString"
 import { toStringValue } from "../utils/toStringValue"
+import { SheetInstancesRootPath } from "./SheetInstancesRoot"
+
+const SUPPORTED_CHILD_TOKENS = new Set(["project", "path"])
+
+const parseSheetInstancesChildren = (
+  primitiveSexprs: PrimitiveSExpr[],
+): {
+  projects: SheetInstancesProject[]
+  paths: SheetInstancesRootPath[]
+} => {
+  const { propertyMap, arrayPropertyMap } =
+    SxClass.parsePrimitivesToClassProperties(primitiveSexprs, "sheet_instances")
+
+  const unsupportedSingularTokens = Object.keys(propertyMap).filter(
+    (token) => !SUPPORTED_CHILD_TOKENS.has(token),
+  )
+  if (unsupportedSingularTokens.length > 0) {
+    throw new Error(
+      `sheet_instances encountered unsupported child token${unsupportedSingularTokens.length > 1 ? "s" : ""} ${unsupportedSingularTokens
+        .map((token) => `"${token}"`)
+        .join(", ")}`,
+    )
+  }
+
+  const unsupportedArrayTokens = Object.keys(arrayPropertyMap).filter(
+    (token) => !SUPPORTED_CHILD_TOKENS.has(token),
+  )
+  if (unsupportedArrayTokens.length > 0) {
+    throw new Error(
+      `sheet_instances encountered unsupported repeated child token${unsupportedArrayTokens.length > 1 ? "s" : ""} ${unsupportedArrayTokens
+        .map((token) => `"${token}"`)
+        .join(", ")}`,
+    )
+  }
+
+  const projects = (arrayPropertyMap.project as SheetInstancesProject[]) ?? []
+  if (!projects.length && propertyMap.project) {
+    projects.push(propertyMap.project as SheetInstancesProject)
+  }
+
+  const paths = (arrayPropertyMap.path as SheetInstancesRootPath[]) ?? []
+  if (!paths.length && propertyMap.path) {
+    paths.push(propertyMap.path as SheetInstancesRootPath)
+  }
+
+  return { projects, paths }
+}
 
 export class SheetInstances extends SxClass {
   static override token = "sheet_instances"
   static override parentToken = "kicad_sch"
   token = "sheet_instances"
 
-  projects: SheetInstancesProject[] = []
+  private _projects: SheetInstancesProject[] = []
+  private _paths: SheetInstancesRootPath[] = []
 
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): SheetInstances {
     const instances = new SheetInstances()
-    const { arrayPropertyMap } = SxClass.parsePrimitivesToClassProperties(
-      primitiveSexprs,
-      "sheet_instances",
-    )
+    const { projects, paths } = parseSheetInstancesChildren(primitiveSexprs)
+    instances.projects = projects
+    instances.paths = paths
+    return instances
+  }
 
-    instances.projects =
-      (arrayPropertyMap.project as SheetInstancesProject[]) ?? []
+  get projects(): SheetInstancesProject[] {
+    return [...this._projects]
+  }
 
-    return instances
+  set projects(value: SheetInstancesProject[]) {
+    this._projects = [...value]
+  }
+
+  get paths(): SheetInstancesRootPath[] {
+    return [...this._paths]
+  }
+
+  set paths(value: SheetInstancesRootPath[]) {
+    this._paths = [...value]
   }
 
   override getChildren(): SxClass[] {
-    return [...this.projects]
+    return [...this._projects, ...this._paths]
   }
 
   override getString(): string {
-    const lines = ["(sheet_instances"]
-    for (const project of this.projects) {
-      lines.push(project.getStringIndented())
+    const children = this.getChildren()
+    if (children.length === 0) {
+      return `(${this.token})`
+    }
+
+    const lines = [`(${this.token}`]
+    for (const child of children) {
+      lines.push(child.getStringIndented())
     }
     lines.push(")")
     return lines.join("\n")
   }
 }
 SxClass.register(SheetInstances)
 
+export class SheetInstancesForSheet extends SheetInstances {
+  static override token = "instances"
+  static override parentToken = "sheet"
+  override token = "instances"
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): SheetInstancesForSheet {
+    const instances = new SheetInstancesForSheet()
+    const { projects, paths } = parseSheetInstancesChildren(primitiveSexprs)
+    instances.projects = projects
+    instances.paths = paths
+    return instances
+  }
+}
+SxClass.register(SheetInstancesForSheet)
+
 export class SheetInstancesProject extends SxClass {
   static override token = "project"
   static override parentToken = "sheet_instances"