kicadts 0.0.1

package/lib/sexpr/classes/Setup/setupMultiValueProperties.ts

@@ -0,0 +1,54 @@
+import { SxClass } from "../../base-classes/SxClass"
+
+import { CoordinateProperty, NumericListProperty } from "./base"
+
+abstract class SetupNumericListProperty extends NumericListProperty {
+  static override parentToken = "setup"
+}
+
+abstract class SetupCoordinateProperty extends CoordinateProperty {
+  static override parentToken = "setup"
+}
+
+export class SetupPcbTextSize extends SetupNumericListProperty {
+  static override token = "pcb_text_size"
+  token = "pcb_text_size"
+}
+SxClass.register(SetupPcbTextSize)
+
+export class SetupModTextSize extends SetupNumericListProperty {
+  static override token = "mod_text_size"
+  token = "mod_text_size"
+}
+SxClass.register(SetupModTextSize)
+
+export class SetupPadSize extends SetupNumericListProperty {
+  static override token = "pad_size"
+  token = "pad_size"
+}
+SxClass.register(SetupPadSize)
+
+export class SetupPadToPasteClearanceValues extends SetupNumericListProperty {
+  static override token = "pad_to_paste_clearance_values"
+  token = "pad_to_paste_clearance_values"
+}
+SxClass.register(SetupPadToPasteClearanceValues)
+
+export class SetupTraceWidth extends SetupNumericListProperty {
+  static override token = "trace_width"
+  token = "trace_width"
+}
+SxClass.register(SetupTraceWidth)
+
+export class SetupAuxAxisOrigin extends SetupCoordinateProperty {
+  static override token = "aux_axis_origin"
+  token = "aux_axis_origin"
+}
+SxClass.register(SetupAuxAxisOrigin)
+
+export class SetupGridOrigin extends SetupCoordinateProperty {
+  static override token = "grid_origin"
+  token = "grid_origin"
+}
+SxClass.register(SetupGridOrigin)
+

package/lib/sexpr/classes/Setup/setupNumericProperties.ts

@@ -0,0 +1,151 @@
+import { SxClass } from "../../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../../parseToPrimitiveSExpr"
+import { toNumberValue } from "../../utils/toNumberValue"
+
+import { SingleValueProperty } from "./base"
+
+abstract class SetupNumberProperty extends SingleValueProperty<number> {
+  static override parentToken = "setup"
+
+  protected static override parsePrimitiveValue(
+    value: PrimitiveSExpr | undefined,
+  ): number {
+    const parsed = toNumberValue(value)
+    if (parsed === undefined) {
+      throw new Error(`${this.name} expects a numeric value`)
+    }
+    return parsed
+  }
+}
+
+export class SetupPadToMaskClearance extends SetupNumberProperty {
+  static override token = "pad_to_mask_clearance"
+  token = "pad_to_mask_clearance"
+}
+SxClass.register(SetupPadToMaskClearance)
+
+export class SetupSolderMaskMinWidth extends SetupNumberProperty {
+  static override token = "solder_mask_min_width"
+  token = "solder_mask_min_width"
+}
+SxClass.register(SetupSolderMaskMinWidth)
+
+export class SetupPadToPasteClearance extends SetupNumberProperty {
+  static override token = "pad_to_paste_clearance"
+  token = "pad_to_paste_clearance"
+}
+SxClass.register(SetupPadToPasteClearance)
+
+export class SetupPadToPasteClearanceRatio extends SetupNumberProperty {
+  static override token = "pad_to_paste_clearance_ratio"
+  token = "pad_to_paste_clearance_ratio"
+}
+SxClass.register(SetupPadToPasteClearanceRatio)
+
+export class SetupLastTraceWidth extends SetupNumberProperty {
+  static override token = "last_trace_width"
+  token = "last_trace_width"
+}
+SxClass.register(SetupLastTraceWidth)
+
+export class SetupTraceClearance extends SetupNumberProperty {
+  static override token = "trace_clearance"
+  token = "trace_clearance"
+}
+SxClass.register(SetupTraceClearance)
+
+export class SetupZoneClearance extends SetupNumberProperty {
+  static override token = "zone_clearance"
+  token = "zone_clearance"
+}
+SxClass.register(SetupZoneClearance)
+
+export class SetupTraceMin extends SetupNumberProperty {
+  static override token = "trace_min"
+  token = "trace_min"
+}
+SxClass.register(SetupTraceMin)
+
+export class SetupSegmentWidth extends SetupNumberProperty {
+  static override token = "segment_width"
+  token = "segment_width"
+}
+SxClass.register(SetupSegmentWidth)
+
+export class SetupEdgeWidth extends SetupNumberProperty {
+  static override token = "edge_width"
+  token = "edge_width"
+}
+SxClass.register(SetupEdgeWidth)
+
+export class SetupViaSize extends SetupNumberProperty {
+  static override token = "via_size"
+  token = "via_size"
+}
+SxClass.register(SetupViaSize)
+
+export class SetupViaDrill extends SetupNumberProperty {
+  static override token = "via_drill"
+  token = "via_drill"
+}
+SxClass.register(SetupViaDrill)
+
+export class SetupViaMinSize extends SetupNumberProperty {
+  static override token = "via_min_size"
+  token = "via_min_size"
+}
+SxClass.register(SetupViaMinSize)
+
+export class SetupViaMinDrill extends SetupNumberProperty {
+  static override token = "via_min_drill"
+  token = "via_min_drill"
+}
+SxClass.register(SetupViaMinDrill)
+
+export class SetupUviaSize extends SetupNumberProperty {
+  static override token = "uvia_size"
+  token = "uvia_size"
+}
+SxClass.register(SetupUviaSize)
+
+export class SetupUviaDrill extends SetupNumberProperty {
+  static override token = "uvia_drill"
+  token = "uvia_drill"
+}
+SxClass.register(SetupUviaDrill)
+
+export class SetupUviaMinSize extends SetupNumberProperty {
+  static override token = "uvia_min_size"
+  token = "uvia_min_size"
+}
+SxClass.register(SetupUviaMinSize)
+
+export class SetupUviaMinDrill extends SetupNumberProperty {
+  static override token = "uvia_min_drill"
+  token = "uvia_min_drill"
+}
+SxClass.register(SetupUviaMinDrill)
+
+export class SetupPcbTextWidth extends SetupNumberProperty {
+  static override token = "pcb_text_width"
+  token = "pcb_text_width"
+}
+SxClass.register(SetupPcbTextWidth)
+
+export class SetupModEdgeWidth extends SetupNumberProperty {
+  static override token = "mod_edge_width"
+  token = "mod_edge_width"
+}
+SxClass.register(SetupModEdgeWidth)
+
+export class SetupModTextWidth extends SetupNumberProperty {
+  static override token = "mod_text_width"
+  token = "mod_text_width"
+}
+SxClass.register(SetupModTextWidth)
+
+export class SetupPadDrill extends SetupNumberProperty {
+  static override token = "pad_drill"
+  token = "pad_drill"
+}
+SxClass.register(SetupPadDrill)

package/lib/sexpr/classes/Setup/setupPropertyHandlers.ts

@@ -0,0 +1,90 @@
+import type { SetupPropertyValues } from "./SetupPropertyTypes"
+import { PcbPlotParams } from "./PcbPlotParams"
+import { Stackup } from "./Stackup"
+import {
+  SetupAuxAxisOrigin,
+  SetupGridOrigin,
+  SetupModTextSize,
+  SetupPadSize,
+  SetupPadToPasteClearanceValues,
+  SetupPcbTextSize,
+  SetupTraceWidth,
+} from "./setupMultiValueProperties"
+import {
+  SetupAllowSoldermaskBridgesInFootprints,
+  SetupTenting,
+  SetupUviasAllowed,
+  SetupVisibleElements,
+  SetupZone45Only,
+} from "./setupStringProperties"
+import {
+  SetupEdgeWidth,
+  SetupLastTraceWidth,
+  SetupModEdgeWidth,
+  SetupModTextWidth,
+  SetupPadDrill,
+  SetupPadToMaskClearance,
+  SetupPadToPasteClearance,
+  SetupPadToPasteClearanceRatio,
+  SetupPcbTextWidth,
+  SetupSegmentWidth,
+  SetupSolderMaskMinWidth,
+  SetupTraceClearance,
+  SetupTraceMin,
+  SetupUviaDrill,
+  SetupUviaMinDrill,
+  SetupUviaMinSize,
+  SetupUviaSize,
+  SetupViaDrill,
+  SetupViaMinDrill,
+  SetupViaMinSize,
+  SetupViaSize,
+  SetupZoneClearance,
+} from "./setupNumericProperties"
+
+type Constructor<T> = new (...args: any[]) => T
+
+export const setupPropertyDescriptors = [
+  { Class: Stackup, key: "stackup" },
+  { Class: PcbPlotParams, key: "pcbPlotParams" },
+  { Class: SetupPadToMaskClearance, key: "padToMaskClearance" },
+  { Class: SetupSolderMaskMinWidth, key: "solderMaskMinWidth" },
+  { Class: SetupPadToPasteClearance, key: "padToPasteClearance" },
+  { Class: SetupPadToPasteClearanceRatio, key: "padToPasteClearanceRatio" },
+  { Class: SetupLastTraceWidth, key: "lastTraceWidth" },
+  { Class: SetupTraceClearance, key: "traceClearance" },
+  { Class: SetupZoneClearance, key: "zoneClearance" },
+  { Class: SetupZone45Only, key: "zone45Only" },
+  { Class: SetupTraceMin, key: "traceMin" },
+  { Class: SetupSegmentWidth, key: "segmentWidth" },
+  { Class: SetupEdgeWidth, key: "edgeWidth" },
+  { Class: SetupViaSize, key: "viaSize" },
+  { Class: SetupViaDrill, key: "viaDrill" },
+  { Class: SetupViaMinSize, key: "viaMinSize" },
+  { Class: SetupViaMinDrill, key: "viaMinDrill" },
+  { Class: SetupUviasAllowed, key: "uviasAllowed" },
+  { Class: SetupUviaSize, key: "uviaSize" },
+  { Class: SetupUviaDrill, key: "uviaDrill" },
+  { Class: SetupUviaMinSize, key: "uviaMinSize" },
+  { Class: SetupUviaMinDrill, key: "uviaMinDrill" },
+  { Class: SetupPcbTextWidth, key: "pcbTextWidth" },
+  { Class: SetupPcbTextSize, key: "pcbTextSize" },
+  { Class: SetupModEdgeWidth, key: "modEdgeWidth" },
+  { Class: SetupModTextSize, key: "modTextSize" },
+  { Class: SetupModTextWidth, key: "modTextWidth" },
+  { Class: SetupPadSize, key: "padSize" },
+  { Class: SetupPadDrill, key: "padDrill" },
+  {
+    Class: SetupAllowSoldermaskBridgesInFootprints,
+    key: "allowSoldermaskBridgesInFootprints",
+  },
+  { Class: SetupTenting, key: "tenting" },
+  { Class: SetupAuxAxisOrigin, key: "auxAxisOrigin" },
+  { Class: SetupGridOrigin, key: "gridOrigin" },
+  { Class: SetupVisibleElements, key: "visibleElements" },
+  { Class: SetupPadToPasteClearanceValues, key: "padToPasteClearanceValues" },
+  { Class: SetupTraceWidth, key: "traceWidth" },
+] as const satisfies ReadonlyArray<{
+  Class: Constructor<SetupPropertyValues[keyof SetupPropertyValues]>
+  key: keyof SetupPropertyValues
+}>

package/lib/sexpr/classes/Setup/setupStringProperties.ts

@@ -0,0 +1,75 @@
+import { SxClass } from "../../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../../parseToPrimitiveSExpr"
+import { toStringValue } from "../../utils/toStringValue"
+
+import { SingleValueProperty } from "./base"
+
+abstract class SetupStringProperty extends SingleValueProperty<string> {
+  static override parentToken = "setup"
+}
+
+export class SetupZone45Only extends SetupStringProperty {
+  static override token = "zone_45_only"
+  token = "zone_45_only"
+}
+SxClass.register(SetupZone45Only)
+
+export class SetupAllowSoldermaskBridgesInFootprints extends SetupStringProperty {
+  static override token = "allow_soldermask_bridges_in_footprints"
+  token = "allow_soldermask_bridges_in_footprints"
+}
+SxClass.register(SetupAllowSoldermaskBridgesInFootprints)
+
+export class SetupVisibleElements extends SetupStringProperty {
+  static override token = "visible_elements"
+  token = "visible_elements"
+}
+SxClass.register(SetupVisibleElements)
+
+export class SetupUviasAllowed extends SetupStringProperty {
+  static override token = "uvias_allowed"
+  token = "uvias_allowed"
+}
+SxClass.register(SetupUviasAllowed)
+
+export class SetupTenting extends SxClass {
+  static override token = "tenting"
+  static override parentToken = "setup"
+  token = "tenting"
+
+  private _sides: string[] = []
+
+  constructor(sides: string[] = []) {
+    super()
+    this.sides = sides
+  }
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): SetupTenting {
+    const sides = primitiveSexprs
+      .map((primitive) => toStringValue(primitive))
+      .filter((value): value is string => value !== undefined)
+    return new SetupTenting(sides)
+  }
+
+  get sides(): string[] {
+    return [...this._sides]
+  }
+
+  set sides(sides: string[]) {
+    this._sides = sides.map((side) => String(side))
+  }
+
+  override getChildren(): SxClass[] {
+    return []
+  }
+
+  override getString(): string {
+    if (this._sides.length === 0) {
+      return "(tenting)"
+    }
+    return `(tenting ${this._sides.join(" ")})`
+  }
+}
+SxClass.register(SetupTenting)

package/lib/sexpr/classes/Sheet.ts

@@ -0,0 +1,205 @@
+import { SxClass } from "../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+import { indentLines } from "../utils/indentLines"
+import { quoteSExprString } from "../utils/quoteSExprString"
+import { toNumberValue } from "../utils/toNumberValue"
+import { toStringValue } from "../utils/toStringValue"
+import { At } from "./At"
+import { Color } from "./Color"
+import { Dnp } from "./Dnp"
+import { ExcludeFromSim } from "./ExcludeFromSim"
+import { FieldsAutoplaced } from "./FieldsAutoplaced"
+import { InBom } from "./InBom"
+import { OnBoard } from "./OnBoard"
+import { SheetInstances } from "./SheetInstances"
+import { SheetPin } from "./SheetPin"
+import { Stroke } from "./Stroke"
+import { TextEffects } from "./TextEffects"
+import { Uuid } from "./Uuid"
+import { SymbolPropertyId as PropertyId } from "./Symbol"
+import { SheetFill } from "./SheetFill"
+import { SheetSize } from "./SheetSize"
+import { SheetProperty } from "./SheetProperty"
+
+export class Sheet extends SxClass {
+  static override token = "sheet"
+  token = "sheet"
+
+  private _sxAt?: At
+  private _sxSize?: SheetSize
+  private _sxExcludeFromSim?: ExcludeFromSim
+  private _sxInBom?: InBom
+  private _sxOnBoard?: OnBoard
+  private _sxDnp?: Dnp
+  private _sxFieldsAutoplaced?: FieldsAutoplaced
+  private _sxStroke?: Stroke
+  private _sxFill?: SheetFill
+  private _sxUuid?: Uuid
+  private _properties: SheetProperty[] = []
+  private _pins: SheetPin[] = []
+  private _sxInstances?: SheetInstances
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): Sheet {
+    const sheet = new Sheet()
+
+    const { propertyMap, arrayPropertyMap } =
+      SxClass.parsePrimitivesToClassProperties(primitiveSexprs, this.token)
+
+    sheet._sxAt = propertyMap.at as At | undefined
+    sheet._sxSize = propertyMap.size as SheetSize | undefined
+    sheet._sxExcludeFromSim = propertyMap.exclude_from_sim as
+      | ExcludeFromSim
+      | undefined
+    sheet._sxInBom = propertyMap.in_bom as InBom | undefined
+    sheet._sxOnBoard = propertyMap.on_board as OnBoard | undefined
+    sheet._sxDnp = propertyMap.dnp as Dnp | undefined
+    sheet._sxFieldsAutoplaced = propertyMap.fields_autoplaced as
+      | FieldsAutoplaced
+      | undefined
+    sheet._sxStroke = propertyMap.stroke as Stroke | undefined
+    sheet._sxFill = propertyMap.fill as SheetFill | undefined
+    sheet._sxUuid = propertyMap.uuid as Uuid | undefined
+    sheet._properties = (arrayPropertyMap.property as SheetProperty[]) ?? []
+    sheet._pins = (arrayPropertyMap.pin as SheetPin[]) ?? []
+    sheet._sxInstances = propertyMap.instances as SheetInstances | undefined
+
+    return sheet
+  }
+
+  get position(): At | undefined {
+    return this._sxAt
+  }
+
+  set position(value: At | undefined) {
+    this._sxAt = value
+  }
+
+  get size(): { width: number; height: number } | undefined {
+    return this._sxSize?.toObject()
+  }
+
+  set size(value: SheetSize | { width: number; height: number } | undefined) {
+    if (value === undefined) {
+      this._sxSize = undefined
+      return
+    }
+    if (value instanceof SheetSize) {
+      this._sxSize = value
+      return
+    }
+    this._sxSize = new SheetSize(value.width, value.height)
+  }
+
+  get excludeFromSim(): boolean {
+    return this._sxExcludeFromSim?.value ?? false
+  }
+
+  set excludeFromSim(value: boolean) {
+    this._sxExcludeFromSim = new ExcludeFromSim(value)
+  }
+
+  get inBom(): boolean {
+    return this._sxInBom?.value ?? false
+  }
+
+  set inBom(value: boolean) {
+    this._sxInBom = new InBom(value)
+  }
+
+  get onBoard(): boolean {
+    return this._sxOnBoard?.value ?? false
+  }
+
+  set onBoard(value: boolean) {
+    this._sxOnBoard = new OnBoard(value)
+  }
+
+  get dnp(): boolean {
+    return this._sxDnp?.value ?? false
+  }
+
+  set dnp(value: boolean) {
+    this._sxDnp = new Dnp(value)
+  }
+
+  get fieldsAutoplaced(): boolean {
+    return this._sxFieldsAutoplaced?.value ?? false
+  }
+
+  set fieldsAutoplaced(value: boolean) {
+    this._sxFieldsAutoplaced = new FieldsAutoplaced(value)
+  }
+
+  get stroke(): Stroke | undefined {
+    return this._sxStroke
+  }
+
+  set stroke(value: Stroke | undefined) {
+    this._sxStroke = value
+  }
+
+  get fill(): SheetFill | undefined {
+    return this._sxFill
+  }
+
+  set fill(value: SheetFill | undefined) {
+    this._sxFill = value
+  }
+
+  get uuid(): Uuid | undefined {
+    return this._sxUuid
+  }
+
+  set uuid(value: Uuid | string | undefined) {
+    if (value === undefined) {
+      this._sxUuid = undefined
+      return
+    }
+    this._sxUuid = value instanceof Uuid ? value : new Uuid(value)
+  }
+
+  get properties(): SheetProperty[] {
+    return this._properties
+  }
+
+  set properties(value: SheetProperty[]) {
+    this._properties = value
+  }
+
+  get pins(): SheetPin[] {
+    return this._pins
+  }
+
+  set pins(value: SheetPin[]) {
+    this._pins = value
+  }
+
+  get instances(): SheetInstances | undefined {
+    return this._sxInstances
+  }
+
+  set instances(value: SheetInstances | undefined) {
+    this._sxInstances = value
+  }
+
+  override getChildren(): SxClass[] {
+    const children: SxClass[] = []
+    if (this._sxAt) children.push(this._sxAt)
+    if (this._sxSize) children.push(this._sxSize)
+    if (this._sxExcludeFromSim) children.push(this._sxExcludeFromSim)
+    if (this._sxInBom) children.push(this._sxInBom)
+    if (this._sxOnBoard) children.push(this._sxOnBoard)
+    if (this._sxDnp) children.push(this._sxDnp)
+    if (this._sxFieldsAutoplaced) children.push(this._sxFieldsAutoplaced)
+    if (this._sxStroke) children.push(this._sxStroke)
+    if (this._sxFill) children.push(this._sxFill)
+    if (this._sxUuid) children.push(this._sxUuid)
+    children.push(...this._properties)
+    children.push(...this._pins)
+    if (this._sxInstances) children.push(this._sxInstances)
+    return children
+  }
+}
+SxClass.register(Sheet)

package/lib/sexpr/classes/SheetFill.ts

@@ -0,0 +1,44 @@
+import { SxClass } from "../base-classes/SxClass"
+import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
+import { indentLines } from "../utils/indentLines"
+import { quoteSExprString } from "../utils/quoteSExprString"
+import { toStringValue } from "../utils/toStringValue"
+import { At } from "./At"
+import { TextEffects } from "./TextEffects"
+import { SymbolPropertyId as PropertyId } from "./Symbol"
+import type { Color } from "./Color"
+
+export class SheetFill extends SxClass {
+  static override token = "fill"
+  static override parentToken = "sheet"
+  token = "fill"
+
+  private _sxColor?: Color
+
+  static override fromSexprPrimitives(
+    primitiveSexprs: PrimitiveSExpr[],
+  ): SheetFill {
+    const fill = new SheetFill()
+    const { propertyMap } = SxClass.parsePrimitivesToClassProperties(
+      primitiveSexprs,
+      this.token,
+    )
+
+    fill._sxColor = propertyMap.color as Color | undefined
+
+    return fill
+  }
+
+  get color(): Color | undefined {
+    return this._sxColor
+  }
+
+  set color(value: Color | undefined) {
+    this._sxColor = value
+  }
+
+  override getChildren(): SxClass[] {
+    return this._sxColor ? [this._sxColor] : []
+  }
+}
+SxClass.register(SheetFill)