Source: pathComponent.mjs

  1. import { Component } from "./component.mjs";
  2. import { Pin } from "./pin.mjs";
  3. import { Coordinate } from "./coordinate.mjs";
  4. import { Net } from "./net.mjs";
  6. /**
  7.  * Class representing a path-style TikZ component.
  8.  *
  9.  * @extends Component
  10.  */
  11. class PathComponent extends Component {
  12. 	/**
  13. 	 * @property {string} tikzComponentName - the tikz component name, e.g. "R"
  14. 	 * @private
  15. 	 */
  16. 	#tikzComponentName;
  17. 	/** @property {string} instanceName - the instance name, e.g. "R1" */
  18. 	instanceName;
  19. 	/** @property {Pin[]} pins - a list of the two corresponding pins */
  20. 	pins;
  22. 	/**
  23. 	 * Generate a PathComponent or -stencil.
  24. 	 *
  25. 	 * @param {string} tikzComponentName - the tikz component name, e.g. "R"
  26. 	 * @param {string} [instanceName=""] - the instance name, e.g. "R1"
  27. 	 * @param {Pin[]} pins - a list of the two corresponding pins
  28. 	 * @param {number} [angle=0] - the angle to rotate the component
  29. 	 * @param {boolean} [mirrorX=false] - true to mirror on x axis
  30. 	 * @param {boolean} [mirrorY=false] - true to mirror on y axis
  31. 	 */
  32. 	constructor(tikzComponentName, instanceName, pins, angle = 0, mirrorX = false, mirrorY = false) {
  33. 		super(angle || 0, mirrorX, mirrorY);
  34. 		this.#tikzComponentName = tikzComponentName;
  35. 		this.instanceName = instanceName || "";
  36. 		this.pins = pins;
  37. 	}
  39. 	/**
  40. 	 * Getts the private tikzComponentName.
  41. 	 *
  42. 	 * @returns {string}
  43. 	 */
  44. 	get tikzComponentName() {
  45. 		return this.#tikzComponentName;
  46. 	}
  48. 	/**
  49. 	 * Serializes a component. The TikZ "source code" is returned.
  50. 	 *
  51. 	 * @param {number} [indent=0] - the indention (= amount of tabs) to use
  52. 	 * @returns {string} the serialized component
  53. 	 */
  54. 	serialize(indent = 0) {
  55. 		// C1 --> ${C}_{1}$
  56. 		let label = "";
  57. 		if (this.instanceName) {
  58. 			let [_fullMatch, name, index] = this.instanceName.match(/^([a-zA-Z]+)[_-]?([0-9]+)$/) || [null, null, null];
  60. 			if (name && !Number.isNaN((index = Number.parseInt(index)))) label = `\${${name}}_{${index}}\$`;
  61. 			else label = this.instanceName.replace("_", "\\_");
  63. 			label = ", l=" + label;
  64. 		}
  66. 		/** DEBUG: marks the first pin of the component. (1)-/--[R]---(2) */
  67. 		/** @type {string} */
  68. 		let pinmark;
  69. 		if (global.DEBUG) {
  70. 			pinmark = "\t".repeat(indent) + "\\draw[color=blue] " + this.pins[0].coord.serializeName() + " ";
  71. 			if (this.angle === 0 || this.angle === 180) {
  72. 				if (this.pins[0].coord.x < this.pins[1].coord.x)
  73. 					// -->
  74. 					pinmark += "++ (3pt,0) ++ (-1.25pt, -2.5pt) -- ++(2.5pt, 5pt);\n";
  75. 				// <--
  76. 				else pinmark += "++ (-3pt,0) ++ (-1.25pt, -2.5pt) -- ++(2.5pt, 5pt);\n";
  77. 			} else if (this.angle === 90 || this.angle === -90) {
  78. 				if (this.pins[0].coord.y < this.pins[1].coord.y)
  79. 					// up
  80. 					pinmark += "++ (0,3pt) ++ (-2.5pt, -1.25pt) -- ++(5pt, 2.5pt);\n";
  81. 				// down
  82. 				else pinmark += "++ (0,-3pt) ++ (-2.5pt, -1.25pt) -- ++(5pt, 2.5pt);\n";
  83. 			} else pinmark = ""; // unknown / diagonal
  84. 		} else pinmark = "";
  86. 		return (
  87. 			pinmark +
  88. 			"\t".repeat(indent) +
  89. 			(global.DEBUG ? "\\draw[color=blue] " : "\\draw ") +
  90. 			this.pins[0].coord.serializeName() +
  91. 			" to[" +
  92. 			this.#tikzComponentName +
  93. 			label +
  94. 			"] " +
  95. 			this.pins[1].coord.serializeName() +
  96. 			";"
  97. 		);
  98. 	}
  100. 	/**
  101. 	 * Deep clone of this object.
  102. 	 *
  103. 	 * @returns {PathComponent} the cloned object
  104. 	 */
  105. 	deepClone() {
  106. 		return new PathComponent(this.#tikzComponentName, this.instanceName, this.pins.deepClone(), this.angle);
  107. 	}
  109. 	/**
  110. 	 * Generate a TikZ component using `this` as an stencil. The parameters are informations extracted from ABL.
  111. 	 *
  112. 	 * @param {string} libraryName - the ABL library name, e.g. "ads_rflib"
  113. 	 * @param {string} cellName - the librarys component name, e.g. "R"
  114. 	 * @param {string} instanceName - the instance/component name, e.g. "R1"
  115. 	 * @param {Map<string,string>} attributes - map of all (XML) attributes
  116. 	 * @param {Pin[]} pins - the pins with their name and number (position not yet set)
  117. 	 * @param {{x: number, y: number, angle: number, xScale: number, yScale: number, mirrorX: boolean, mirrorY: boolean, scaling: number}} placement - general component placement information
  118. 	 * @param {Wire[]} wires - list of all wires
  119. 	 * @param {Map<string,Net>} nets - list of all nets
  120. 	 * @param {Coordinate[]} coords - list of all coordinates
  121. 	 *
  122. 	 * @returns {PathComponent} the new PathComponent
  123. 	 */
  124. 	useAsStencil(libraryName, cellName, instanceName, attributes, pins, placement, wires, nets, coords) {
  125. 		// normalize angle --> -180 < angle <= 180
  126. 		while (placement.angle <= -180) placement.angle += 360;
  127. 		while (placement.angle > 180) placement.angle -= 360;
  129. 		// get coordinate
  130. 		let instanceCoord = new Coordinate(placement.x * placement.scaling, placement.y * placement.scaling);
  131. 		const oldCoord = coords.find((existingCoord) => instanceCoord.equals(existingCoord));
  132. 		if (oldCoord) instanceCoord = oldCoord;
  133. 		else coords.push(instanceCoord);
  135. 		// reorder
  136. 		pins = this.pins.map((ablPin) =>
  137. 			pins.find((pin) =>
  138. 				pin.name && ablPin.name ? pin.name == ablPin.name : pin.instTermNumber === ablPin.instTermNumber
  139. 			)
  140. 		);
  142. 		// set pins (+positions)
  143. 		pins.forEach((pin) => pin.findPosition(this.pins, placement, instanceCoord, wires, nets, coords));
  145. 		return new PathComponent(this.#tikzComponentName, instanceName, pins, placement.angle);
  146. 	}
  147. }
  149. export { PathComponent };