feat(tcl): initial support for tcleval() in texts

src/SVGRenderer.ts

@@ -4,6 +4,7 @@
 
 import { Layers } from './Layers';
 import { type LibraryLoader } from './LibraryLoader';
+import { tclEval } from './tcl';
 import { EventEmitter } from './util/EventEmitter';
 import { isPointInsideWire } from './util/geometry';
 import type { VersionObject, Wire, Object_1 as XschemObject } from './xschem-parser';
@@ -62,24 +63,41 @@ export class SVGRenderer extends EventTarget {
       }
 
       case 'Text': {
+        const hide = item.properties.hide === 'true';
+        if (hide) {
+          // hidden for now
+          break;
+        }
+
         // attribute substitution
-        const text = item.text.replace(/@([\w#:]+)/g, (match, attrName: string) => {
+        let text = item.text.replace(/@([\w#:]+)/g, (match, attrName: string) => {
           if (attrName.startsWith('#') && attrName.endsWith(':net_name')) {
             // see https://github.com/TinyTapeout/xschem-viewer/issues/1#issuecomment-1989506966
             return '';
           }
           return properties[attrName] ?? match;
         });
+        if (text.startsWith('tcleval(') && text.endsWith(')')) {
+          const tclExpr = text.substring(8, text.length - 1);
+          text = await tclEval(`string cat "${tclExpr}"`).catch((error) => {
+            console.warn('tcleval failed:', tclExpr, error);
+          });
+        }
+
+        // Special case: labels inside pins use the Wire layer.
+        // see https://github.com/TinyTapeout/xschem-viewer/issues/2#issuecomment-1997048537
+        const insidePin = ['ipin', 'opin', 'iopin', 'label'].includes(properties.type ?? '');
+
         // deal with multi-line text
         const lines = text.split('\n');
-        const layer = item.properties.layer != null ? Number(item.properties.layer) : Layers.Text;
+        const layer =
+          item.properties.layer != null
+            ? Number(item.properties.layer)
+            : insidePin
+              ? Layers.Wire
+              : Layers.Text;
         const hCenter = item.properties.hcenter === 'true';
         const vCenter = item.properties.vcenter === 'true';
-        const hide = item.properties.hide === 'true';
-        if (hide) {
-          // hidden for now
-          break;
-        }
 
         for (let i = 0; i < lines.length; i++) {
           const text = document.createElementNS('http://www.w3.org/2000/svg', 'text');

src/tcl.ts

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2024 Tiny Tapeout LTD
+// Author: Uri Shaked
+
+import tclInitCode from './tcl/init.tcl?raw';
+let tclInterpPromise: any = null;
+
+export async function tclInit() {
+  const { wacl } = await import('./wacl/wacl');
+  const interp = await new Promise<any>((resolve) => wacl.onReady(resolve));
+  interp.Eval(tclInitCode);
+  return interp;
+}
+
+export async function tclEval(expr: string) {
+  if (tclInterpPromise == null) {
+    tclInterpPromise = tclInit();
+  }
+  const interp = await tclInterpPromise;
+  return interp.Eval(expr);
+}

src/tcl/init.tcl

@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 Tiny Tapeout LTD
+# Author: Uri Shaked
+
+proc ev {args} {
+  return [expr [join $args]]
+}

src/wacl/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2017, ecky-l
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/wacl/license.terms

@@ -0,0 +1,40 @@
+This software is copyrighted by the Regents of the University of
+California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState
+Corporation and other parties.  The following terms apply to all files
+associated with the software unless explicitly disclaimed in
+individual files.
+
+The authors hereby grant permission to use, copy, modify, distribute,
+and license this software and its documentation for any purpose, provided
+that existing copyright notices are retained in all copies and that this
+notice is included verbatim in any distributions. No written agreement,
+license, or royalty fee is required for any of the authorized uses.
+Modifications to this software may be copyrighted by their authors
+and need not follow the licensing terms described here, provided that
+the new terms are clearly indicated on the first page of each file where
+they apply.
+
+IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
+FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
+DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE
+IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
+NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
+MODIFICATIONS.
+
+GOVERNMENT USE: If you are acquiring this software on behalf of the
+U.S. government, the Government shall have only "Restricted Rights"
+in the software and related documentation as defined in the Federal
+Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2).  If you
+are acquiring the software on behalf of the Department of Defense, the
+software shall be classified as "Commercial Computer Software" and the
+Government shall have only "Restricted Rights" as defined in Clause
+252.227-7014 (b) (3) of DFARs.  Notwithstanding the foregoing, the
+authors grant the U.S. Government and others acting in its behalf
+permission to use and distribute the software in accordance with the
+terms specified in this license.