kicadts 0.0.1

package/lib/sexpr/classes/FootprintPath.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 FootprintPath extends SxClass {
+  static override token = "path"
+  static override parentToken = "footprint"
+  token = "path"
+
+  private _value: string
+
+  constructor(value: string) {
+    super()
+    this._value = value
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintPath {
+    const value = toStringValue(primitiveSexprs[0])
+    if (value === undefined) {
+      throw new Error("path expects a string value")
+    }
+    return new FootprintPath(value)
+  }
+
+  get value(): string {
+    return this._value
+  }
+
+  set value(value: string) {
+    this._value = value
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    return `(path ${quoteSExprString(this._value)})`
+  }
+}
+SxClass.register(FootprintPath)

package/lib/sexpr/classes/FootprintPlaced.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 FootprintPlaced extends SxPrimitiveBoolean {
+  static override token = "placed"
+  static override parentToken = "footprint"
+  token = "placed"
+
+  constructor(value = true) {
+    super(value)
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintPlaced {
+    if (primitiveSexprs.length === 0) {
+      return new FootprintPlaced(true)
+    }
+
+    const parsed = parseYesNo(primitiveSexprs[0])
+    if (parsed === undefined) {
+      throw new Error(
+        `placed expects yes/no, received ${JSON.stringify(primitiveSexprs[0])}`,
+      )
+    }
+
+    return new FootprintPlaced(parsed)
+  }
+}
+SxClass.register(FootprintPlaced)

package/lib/sexpr/classes/FootprintPrivateLayers.ts

@@ -0,0 +1,56 @@
+import { SxClass } from "../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+import { quoteSExprString } from "../utils/quoteSExprString"
+import { toStringValue } from "../utils/toStringValue"
+
+export class FootprintPrivateLayers extends SxClass {
+  static override token = "private_layers"
+  static override parentToken = "footprint"
+  token = "private_layers"
+
+  private _layers: string[] = []
+
+  constructor(layers: string[]) {
+    super()
+    this.layers = layers
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintPrivateLayers {
+    const layers = primitiveSexprs.map((primitive) => {
+      const value = toStringValue(primitive)
+      if (value === undefined) {
+        throw new Error(
+          `private_layers expects string layer names, received ${JSON.stringify(primitive)}`,
+        )
+      }
+      return value
+    })
+    return new FootprintPrivateLayers(layers)
+  }
+
+  get layers(): string[] {
+    return [...this._layers]
+  }
+
+  set layers(values: string[]) {
+    this._layers = values.map((value) => String(value))
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    const rendered = this._layers
+      .map((layer) =>
+        /^[^\s()"]+$/u.test(layer) && !["nil", "#t", "#f"].includes(layer)
+          ? layer
+          : quoteSExprString(layer),
+      )
+      .join(" ")
+    return `(private_layers ${rendered})`
+  }
+}
+SxClass.register(FootprintPrivateLayers)

package/lib/sexpr/classes/FootprintSheetfile.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 FootprintSheetfile extends SxClass {
+  static override token = "sheetfile"
+  static override parentToken = "footprint"
+  override token = "sheetfile"
+
+  private _value: string
+
+  constructor(value: string) {
+    super()
+    this._value = value
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintSheetfile {
+    const value = toStringValue(primitiveSexprs[0])
+    if (value === undefined) {
+      throw new Error("sheetfile expects a string value")
+    }
+    return new FootprintSheetfile(value)
+  }
+
+  get value(): string {
+    return this._value
+  }
+
+  set value(value: string) {
+    this._value = value
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    return `(sheetfile ${quoteSExprString(this._value)})`
+  }
+}
+SxClass.register(FootprintSheetfile)

package/lib/sexpr/classes/FootprintSheetname.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 FootprintSheetname extends SxClass {
+  static override token = "sheetname"
+  static override parentToken = "footprint"
+  override token = "sheetname"
+
+  private _value: string
+
+  constructor(value: string) {
+    super()
+    this._value = value
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintSheetname {
+    const value = toStringValue(primitiveSexprs[0])
+    if (value === undefined) {
+      throw new Error("sheetname expects a string value")
+    }
+    return new FootprintSheetname(value)
+  }
+
+  get value(): string {
+    return this._value
+  }
+
+  set value(value: string) {
+    this._value = value
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    return `(sheetname ${quoteSExprString(this._value)})`
+  }
+}
+SxClass.register(FootprintSheetname)

package/lib/sexpr/classes/FootprintSolderMaskMargin.ts

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

package/lib/sexpr/classes/FootprintSolderPasteMargin.ts

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

package/lib/sexpr/classes/FootprintSolderPasteRatio.ts

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

package/lib/sexpr/classes/FootprintTags.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 FootprintTags extends SxClass {
+  static override token = "tags"
+  static override parentToken = "footprint"
+  token = "tags"
+
+  private _value: string
+
+  constructor(value: string) {
+    super()
+    this._value = value
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintTags {
+    const value = toStringValue(primitiveSexprs[0])
+    if (value === undefined) {
+      throw new Error("tags expects a string value")
+    }
+    return new FootprintTags(value)
+  }
+
+  get value(): string {
+    return this._value
+  }
+
+  set value(value: string) {
+    this._value = value
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    return `(tags ${quoteSExprString(this._value)})`
+  }
+}
+SxClass.register(FootprintTags)

package/lib/sexpr/classes/FootprintTedit.ts

@@ -0,0 +1,21 @@
+import { SxPrimitiveString } from "../base-classes/SxPrimitiveString"
+import { SxClass } from "../base-classes/SxClass"
+import { toStringValue } from "../utils/toStringValue"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+
+export class FootprintTedit extends SxPrimitiveString {
+  static override token = "tedit"
+  static override parentToken = "footprint"
+  token = "tedit"
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FootprintTedit {
+    const value = toStringValue(primitiveSexprs[0])
+    if (value === undefined) {
+      throw new Error("tedit expects a string value")
+    }
+    return new FootprintTedit(value)
+  }
+}
+SxClass.register(FootprintTedit)

package/lib/sexpr/classes/FootprintThermalGap.ts

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

package/lib/sexpr/classes/FootprintThermalWidth.ts

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

package/lib/sexpr/classes/FootprintZoneConnect.ts

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

package/lib/sexpr/classes/FpArc.ts

@@ -0,0 +1,289 @@
+import { SxClass } from "../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+import { Layer } from "./Layer"
+import { Stroke } from "./Stroke"
+import { Uuid } from "./Uuid"
+import { Width } from "./Width"
+import { toNumberValue } from "../utils/toNumberValue"
+
+export class FpArc extends SxClass {
+  static override token = "fp_arc"
+  token = "fp_arc"
+
+  private _sxStart?: FpArcStart
+  private _sxMid?: FpArcMid
+  private _sxEnd?: FpArcEnd
+  private _sxLayer?: Layer
+  private _sxWidth?: Width
+  private _sxStroke?: Stroke
+  private _sxUuid?: Uuid
+  private _locked = false
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FpArc {
+    const arc = new FpArc()
+
+    const { propertyMap } = SxClass.parsePrimitivesToClassProperties(
+      primitiveSexprs,
+      this.token,
+    )
+
+    arc._sxStart = propertyMap.start as FpArcStart | undefined
+    arc._sxMid = propertyMap.mid as FpArcMid | undefined
+    arc._sxEnd = propertyMap.end as FpArcEnd | undefined
+    arc._sxLayer = propertyMap.layer as Layer | undefined
+    arc._sxWidth = propertyMap.width as Width | undefined
+    arc._sxStroke = propertyMap.stroke as Stroke | undefined
+    arc._sxUuid = propertyMap.uuid as Uuid | undefined
+
+    for (const primitive of primitiveSexprs) {
+      if (primitive === "locked") {
+        arc._locked = true
+      }
+    }
+
+    return arc
+  }
+
+  get start(): FpArcStart | undefined {
+    return this._sxStart
+  }
+
+  set start(value: FpArcStart | { x: number; y: number } | undefined) {
+    if (value === undefined) {
+      this._sxStart = undefined
+      return
+    }
+    if (value instanceof FpArcStart) {
+      this._sxStart = value
+      return
+    }
+    this._sxStart = new FpArcStart(value.x, value.y)
+  }
+
+  get mid(): FpArcMid | undefined {
+    return this._sxMid
+  }
+
+  set mid(value: FpArcMid | { x: number; y: number } | undefined) {
+    if (value === undefined) {
+      this._sxMid = undefined
+      return
+    }
+    if (value instanceof FpArcMid) {
+      this._sxMid = value
+      return
+    }
+    this._sxMid = new FpArcMid(value.x, value.y)
+  }
+
+  get end(): FpArcEnd | undefined {
+    return this._sxEnd
+  }
+
+  set end(value: FpArcEnd | { x: number; y: number } | undefined) {
+    if (value === undefined) {
+      this._sxEnd = undefined
+      return
+    }
+    if (value instanceof FpArcEnd) {
+      this._sxEnd = value
+      return
+    }
+    this._sxEnd = new FpArcEnd(value.x, value.y)
+  }
+
+  get layer(): Layer | undefined {
+    return this._sxLayer
+  }
+
+  set layer(value: Layer | string | string[] | undefined) {
+    if (value === undefined) {
+      this._sxLayer = undefined
+      return
+    }
+    if (value instanceof Layer) {
+      this._sxLayer = value
+      return
+    }
+    const names = Array.isArray(value) ? value : [value]
+    this._sxLayer = new Layer(names)
+  }
+
+  get width(): number | undefined {
+    return this._sxWidth?.value
+  }
+
+  set width(value: number | Width | undefined) {
+    if (value === undefined) {
+      this._sxWidth = undefined
+      return
+    }
+    if (value instanceof Width) {
+      this._sxWidth = value
+      return
+    }
+    this._sxWidth = new Width(value)
+  }
+
+  get widthClass(): Width | undefined {
+    return this._sxWidth
+  }
+
+  get stroke(): Stroke | undefined {
+    return this._sxStroke
+  }
+
+  set stroke(value: Stroke | undefined) {
+    this._sxStroke = value
+  }
+
+  get uuid(): string | undefined {
+    return this._sxUuid?.value
+  }
+
+  set uuid(value: string | Uuid | undefined) {
+    if (value === undefined) {
+      this._sxUuid = undefined
+      return
+    }
+    if (value instanceof Uuid) {
+      this._sxUuid = value
+      return
+    }
+    this._sxUuid = new Uuid(value)
+  }
+
+  get uuidClass(): Uuid | undefined {
+    return this._sxUuid
+  }
+
+  get locked(): boolean {
+    return this._locked
+  }
+
+  set locked(value: boolean) {
+    this._locked = value
+  }
+
+  override getChildren(): SxClass[] {
+    const children: SxClass[] = []
+    if (this._sxStart) children.push(this._sxStart)
+    if (this._sxMid) children.push(this._sxMid)
+    if (this._sxEnd) children.push(this._sxEnd)
+    if (this._sxLayer) children.push(this._sxLayer)
+    if (this._sxWidth) children.push(this._sxWidth)
+    if (this._sxStroke) children.push(this._sxStroke)
+    if (this._sxUuid) children.push(this._sxUuid)
+    return children
+  }
+
+  override getString(): string {
+    const lines = ["(fp_arc"]
+    const push = (value?: SxClass) => {
+      if (!value) return
+      lines.push(value.getStringIndented())
+    }
+
+    push(this._sxStart)
+    push(this._sxMid)
+    push(this._sxEnd)
+    push(this._sxLayer)
+    push(this._sxWidth)
+    push(this._sxStroke)
+    push(this._sxUuid)
+
+    if (this._locked) {
+      lines.push("  locked")
+    }
+
+    lines.push(")")
+    return lines.join("\n")
+  }
+}
+SxClass.register(FpArc)
+
+export class FpArcStart extends SxClass {
+  static override token = "start"
+  static override parentToken = "fp_arc"
+  token = "start"
+
+  x: number
+  y: number
+
+  constructor(x: number, y: number) {
+    super()
+    this.x = x
+    this.y = y
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FpArcStart {
+    const x = toNumberValue(primitiveSexprs[0]) ?? 0
+    const y = toNumberValue(primitiveSexprs[1]) ?? 0
+    return new FpArcStart(x, y)
+  }
+
+  override getString(): string {
+    return `(start ${this.x} ${this.y})`
+  }
+}
+SxClass.register(FpArcStart)
+
+export class FpArcMid extends SxClass {
+  static override token = "mid"
+  static override parentToken = "fp_arc"
+  token = "mid"
+
+  x: number
+  y: number
+
+  constructor(x: number, y: number) {
+    super()
+    this.x = x
+    this.y = y
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FpArcMid {
+    const x = toNumberValue(primitiveSexprs[0]) ?? 0
+    const y = toNumberValue(primitiveSexprs[1]) ?? 0
+    return new FpArcMid(x, y)
+  }
+
+  override getString(): string {
+    return `(mid ${this.x} ${this.y})`
+  }
+}
+SxClass.register(FpArcMid)
+
+export class FpArcEnd extends SxClass {
+  static override token = "end"
+  static override parentToken = "fp_arc"
+  token = "end"
+
+  x: number
+  y: number
+
+  constructor(x: number, y: number) {
+    super()
+    this.x = x
+    this.y = y
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): FpArcEnd {
+    const x = toNumberValue(primitiveSexprs[0]) ?? 0
+    const y = toNumberValue(primitiveSexprs[1]) ?? 0
+    return new FpArcEnd(x, y)
+  }
+
+  override getString(): string {
+    return `(end ${this.x} ${this.y})`
+  }
+}
+SxClass.register(FpArcEnd)