kicadts 0.0.1

package/lib/sexpr/classes/FootprintAttr.ts

@@ -0,0 +1,102 @@
+import { SxClass } from "../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+
+const FLAG_TOKENS = new Set([
+  "board_only",
+  "exclude_from_pos_files",
+  "exclude_from_bom",
+])
+
+export class FootprintAttr extends SxClass {
+  static override token = "attr"
+  static override parentToken = "footprint"
+  token = "attr"
+
+  private _type?: string
+  private _boardOnly = false
+  private _excludeFromPosFiles = false
+  private _excludeFromBom = false
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintAttr {
+    const attr = new FootprintAttr()
+    for (const primitive of primitiveSexprs) {
+      if (typeof primitive !== "string") {
+        throw new Error(
+          `attr encountered unsupported child: ${JSON.stringify(primitive)}`,
+        )
+      }
+      if (FLAG_TOKENS.has(primitive)) {
+        attr.applyFlag(primitive)
+        continue
+      }
+      if (attr._type === undefined) {
+        attr._type = primitive
+        continue
+      }
+      throw new Error(`attr encountered duplicate or unknown token "${primitive}"`)
+    }
+    return attr
+  }
+
+  private applyFlag(flag: string) {
+    switch (flag) {
+      case "board_only":
+        this._boardOnly = true
+        break
+      case "exclude_from_pos_files":
+        this._excludeFromPosFiles = true
+        break
+      case "exclude_from_bom":
+        this._excludeFromBom = true
+        break
+    }
+  }
+
+  get type(): string | undefined {
+    return this._type
+  }
+
+  set type(value: string | undefined) {
+    this._type = value
+  }
+
+  get boardOnly(): boolean {
+    return this._boardOnly
+  }
+
+  set boardOnly(value: boolean) {
+    this._boardOnly = value
+  }
+
+  get excludeFromPosFiles(): boolean {
+    return this._excludeFromPosFiles
+  }
+
+  set excludeFromPosFiles(value: boolean) {
+    this._excludeFromPosFiles = value
+  }
+
+  get excludeFromBom(): boolean {
+    return this._excludeFromBom
+  }
+
+  set excludeFromBom(value: boolean) {
+    this._excludeFromBom = value
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    const tokens = ["attr"]
+    if (this._type) tokens.push(this._type)
+    if (this._boardOnly) tokens.push("board_only")
+    if (this._excludeFromPosFiles) tokens.push("exclude_from_pos_files")
+    if (this._excludeFromBom) tokens.push("exclude_from_bom")
+    return `(${tokens.join(" ")})`
+  }
+}
+SxClass.register(FootprintAttr)

package/lib/sexpr/classes/FootprintAutoplaceCost180.ts

@@ -0,0 +1,9 @@
+import { SxPrimitiveNumber } from "../base-classes/SxPrimitiveNumber"
+import { SxClass } from "../base-classes/SxClass"
+
+export class FootprintAutoplaceCost180 extends SxPrimitiveNumber {
+  static override token = "autoplace_cost180"
+  static override parentToken = "footprint"
+  token = "autoplace_cost180"
+}
+SxClass.register(FootprintAutoplaceCost180)

package/lib/sexpr/classes/FootprintAutoplaceCost90.ts

@@ -0,0 +1,9 @@
+import { SxPrimitiveNumber } from "../base-classes/SxPrimitiveNumber"
+import { SxClass } from "../base-classes/SxClass"
+
+export class FootprintAutoplaceCost90 extends SxPrimitiveNumber {
+  static override token = "autoplace_cost90"
+  static override parentToken = "footprint"
+  token = "autoplace_cost90"
+}
+SxClass.register(FootprintAutoplaceCost90)

package/lib/sexpr/classes/FootprintClearance.ts

@@ -0,0 +1,9 @@
+import { SxPrimitiveNumber } from "../base-classes/SxPrimitiveNumber"
+import { SxClass } from "../base-classes/SxClass"
+
+export class FootprintClearance extends SxPrimitiveNumber {
+  static override token = "clearance"
+  static override parentToken = "footprint"
+  token = "clearance"
+}
+SxClass.register(FootprintClearance)

package/lib/sexpr/classes/FootprintDescr.ts

@@ -0,0 +1,44 @@
+import { SxClass } from "../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+import { quoteSExprString } from "../utils/quoteSExprString"
+import { toStringValue } from "../utils/toStringValue"
+
+export class FootprintDescr extends SxClass {
+  static override token = "descr"
+  static override parentToken = "footprint"
+  token = "descr"
+
+  private _value: string
+
+  constructor(value: string) {
+    super()
+    this._value = value
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintDescr {
+    const value = toStringValue(primitiveSexprs[0])
+    if (value === undefined) {
+      throw new Error("descr expects a string value")
+    }
+    return new FootprintDescr(value)
+  }
+
+  get value(): string {
+    return this._value
+  }
+
+  set value(value: string) {
+    this._value = value
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    return `(descr ${quoteSExprString(this._value)})`
+  }
+}
+SxClass.register(FootprintDescr)

package/lib/sexpr/classes/FootprintLocked.ts

@@ -0,0 +1,32 @@
+import { SxClass } from "../base-classes/SxClass"
+import { SxPrimitiveBoolean } from "../base-classes/SxPrimitiveBoolean"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+import { parseYesNo } from "../utils/parseYesNo"
+
+export class FootprintLocked extends SxPrimitiveBoolean {
+  static override token = "locked"
+  static override parentToken = "footprint"
+  token = "locked"
+
+  constructor(value = true) {
+    super(value)
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintLocked {
+    if (primitiveSexprs.length === 0) {
+      return new FootprintLocked(true)
+    }
+
+    const parsed = parseYesNo(primitiveSexprs[0])
+    if (parsed === undefined) {
+      throw new Error(
+        `locked expects yes/no, received ${JSON.stringify(primitiveSexprs[0])}`,
+      )
+    }
+
+    return new FootprintLocked(parsed)
+  }
+}
+SxClass.register(FootprintLocked)

package/lib/sexpr/classes/FootprintModel.ts

@@ -0,0 +1,145 @@
+import { SxClass } from "../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+import { quoteSExprString } from "../utils/quoteSExprString"
+import { toNumberValue } from "../utils/toNumberValue"
+import { toStringValue } from "../utils/toStringValue"
+
+export interface ModelVector {
+  x: number
+  y: number
+  z: number
+}
+
+const DEFAULT_VECTOR: ModelVector = { x: 0, y: 0, z: 0 }
+
+export class FootprintModel extends SxClass {
+  static override token = "model"
+  static override parentToken = "footprint"
+  override token = "model"
+
+  private _path: string
+  private _offset?: ModelVector
+  private _scale?: ModelVector
+  private _rotate?: ModelVector
+
+  constructor(path: string) {
+    super()
+    this._path = path
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintModel {
+    if (primitiveSexprs.length === 0) {
+      throw new Error("model requires a path argument")
+    }
+
+    const [rawPath, ...rest] = primitiveSexprs
+    const path = toStringValue(rawPath)
+    if (path === undefined) {
+      throw new Error("model path must be a string value")
+    }
+
+    const model = new FootprintModel(path)
+
+    for (const primitive of rest) {
+      if (!Array.isArray(primitive) || primitive.length === 0) {
+        throw new Error(
+          `model encountered invalid child expression: ${JSON.stringify(primitive)}`,
+        )
+      }
+      const [token, ...args] = primitive
+      if (token === "offset") {
+        model._offset = parseVectorArgs(args, "offset")
+        continue
+      }
+      if (token === "scale") {
+        model._scale = parseVectorArgs(args, "scale")
+        continue
+      }
+      if (token === "rotate") {
+        model._rotate = parseVectorArgs(args, "rotate")
+        continue
+      }
+      throw new Error(`model encountered unsupported child token "${token}"`)
+    }
+
+    return model
+  }
+
+  get path(): string {
+    return this._path
+  }
+
+  set path(value: string) {
+    this._path = value
+  }
+
+  get offset(): ModelVector | undefined {
+    return this._offset ? { ...this._offset } : undefined
+  }
+
+  set offset(value: ModelVector | undefined) {
+    this._offset = value ? { ...value } : undefined
+  }
+
+  get scale(): ModelVector | undefined {
+    return this._scale ? { ...this._scale } : undefined
+  }
+
+  set scale(value: ModelVector | undefined) {
+    this._scale = value ? { ...value } : undefined
+  }
+
+  get rotate(): ModelVector | undefined {
+    return this._rotate ? { ...this._rotate } : undefined
+  }
+
+  set rotate(value: ModelVector | undefined) {
+    this._rotate = value ? { ...value } : undefined
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    const lines = [`(model ${quoteSExprString(this._path)}`]
+    if (this._offset) {
+      lines.push(renderVectorBlock("offset", this._offset))
+    }
+    if (this._scale) {
+      lines.push(renderVectorBlock("scale", this._scale))
+    }
+    if (this._rotate) {
+      lines.push(renderVectorBlock("rotate", this._rotate))
+    }
+    lines.push(")")
+    return lines.join("\n")
+  }
+}
+SxClass.register(FootprintModel)
+
+function parseVectorArgs(
+  args: PrimitiveSExpr[],
+  token: string,
+): ModelVector {
+  if (args.length !== 1) {
+    throw new Error(`model ${token} expects a single xyz child`)
+  }
+  const [first] = args
+  if (!Array.isArray(first) || first.length !== 4 || first[0] !== "xyz") {
+    throw new Error(
+      `model ${token} expects (xyz x y z), received ${JSON.stringify(first)}`,
+    )
+  }
+  const [, rawX, rawY, rawZ] = first
+  const x = toNumberValue(rawX) ?? DEFAULT_VECTOR.x
+  const y = toNumberValue(rawY) ?? DEFAULT_VECTOR.y
+  const z = toNumberValue(rawZ) ?? DEFAULT_VECTOR.z
+  return { x, y, z }
+}
+
+function renderVectorBlock(label: string, vector: ModelVector): string {
+  return `  (${label}\n    (xyz ${vector.x} ${vector.y} ${vector.z})\n  )`
+}

package/lib/sexpr/classes/FootprintNetTiePadGroups.ts

@@ -0,0 +1,50 @@
+import { SxClass } from "../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+import { quoteSExprString } from "../utils/quoteSExprString"
+import { toStringValue } from "../utils/toStringValue"
+
+export class FootprintNetTiePadGroups extends SxClass {
+  static override token = "net_tie_pad_groups"
+  static override parentToken = "footprint"
+  token = "net_tie_pad_groups"
+
+  private _groups: string[] = []
+
+  constructor(groups: string[]) {
+    super()
+    this.groups = groups
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintNetTiePadGroups {
+    const groups = primitiveSexprs.map((primitive) => {
+      const value = toStringValue(primitive)
+      if (value === undefined) {
+        throw new Error(
+          `net_tie_pad_groups expects string group entries, received ${JSON.stringify(primitive)}`,
+        )
+      }
+      return value
+    })
+    return new FootprintNetTiePadGroups(groups)
+  }
+
+  get groups(): string[] {
+    return [...this._groups]
+  }
+
+  set groups(values: string[]) {
+    this._groups = values.map((value) => String(value))
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    const rendered = this._groups.map((group) => quoteSExprString(group)).join(" ")
+    return `(net_tie_pad_groups ${rendered})`
+  }
+}
+SxClass.register(FootprintNetTiePadGroups)