From 9d64d8e678b886ff18ffaa976aa8d827850a4a31 Mon Sep 17 00:00:00 2001
From: alaindargelas <alain.dargelas@gmail.com>
Date: Sun, 3 Mar 2024 22:16:58 -0800
Subject: [PATCH] Preserve escaped names

---
 .../fpga_verilog/verilog_testbench_utils.cpp  | 38 +++++++++++++------
 .../src/fpga_verilog/verilog_writer_utils.cpp |  4 +-
 .../src/fpga_verilog/verilog_writer_utils.h   |  2 +
 3 files changed, 30 insertions(+), 14 deletions(-)

diff --git a/openfpga/src/fpga_verilog/verilog_testbench_utils.cpp b/openfpga/src/fpga_verilog/verilog_testbench_utils.cpp
index 4dbb879c94..66a4773465 100644
--- a/openfpga/src/fpga_verilog/verilog_testbench_utils.cpp
+++ b/openfpga/src/fpga_verilog/verilog_testbench_utils.cpp
@@ -116,6 +116,14 @@ void print_verilog_testbench_fpga_instance(
   fp << std::endl;
 }
 
+std::string escapeNames(const std::string& original) {
+  std::string result = original;
+  if (result.find("$") != std::string::npos) {
+    result = "\\" + result + " ";
+  }
+  return result;
+}
+
 /********************************************************************
  * Instanciate the input benchmark module
  *******************************************************************/
@@ -224,17 +232,18 @@ void print_verilog_testbench_benchmark_instance(
             fp << "~";
           }
 
-          fp << bus_group.pin_name(pin);
+          std::string escapedName = bus_group.pin_name(pin);
 
           /* For clock ports, skip postfix */
           if (clock_port_names.end() == std::find(clock_port_names.begin(),
                                                   clock_port_names.end(),
                                                   port_names[iport])) {
-            fp << input_port_postfix;
+            escapedName += input_port_postfix;
           } else if (include_clock_port_postfix) {
-            fp << input_port_postfix;
+            escapedName += input_port_postfix;
           }
-
+          escapedName = escapeNames(escapedName);
+          fp << escapedName;
           pin_counter++;
         }
         fp << "}";
@@ -249,16 +258,17 @@ void print_verilog_testbench_benchmark_instance(
             pin_constraints.net_default_value(port_names[iport])) {
           fp << "~";
         }
-
-        fp << port_names[iport];
+        std::string escapedName = port_names[iport];
         /* For clock ports, skip postfix */
         if (clock_port_names.end() == std::find(clock_port_names.begin(),
                                                 clock_port_names.end(),
                                                 port_names[iport])) {
-          fp << input_port_postfix;
+          escapedName += input_port_postfix;
         } else if (include_clock_port_postfix) {
-          fp << input_port_postfix;
+          escapedName += input_port_postfix;
         }
+        escapedName = escapeNames(escapedName); 
+        fp << escapedName;
       }
 
       if (true == use_explicit_port_map) {
@@ -286,12 +296,16 @@ void print_verilog_testbench_benchmark_instance(
           if (0 < pin_counter) {
             fp << ", ";
           }
-          fp << bus_group.pin_name(pin) << output_port_postfix;
+          std::string escapedName = bus_group.pin_name(pin) + output_port_postfix;
+          escapedName = escapeNames(escapedName); 
+          fp << escapedName;
           pin_counter++;
         }
         fp << "}";
       } else {
-        fp << port_names[iport] << output_port_postfix;
+        std::string escapedName = port_names[iport] + output_port_postfix;
+        escapedName = escapeNames(escapedName);
+        fp << escapedName;
       }
       if (true == use_explicit_port_map) {
         fp << ")";
@@ -867,7 +881,7 @@ void print_verilog_testbench_random_stimuli(
 
     /* TODO: find the clock inputs will be initialized later */
     if (AtomBlockType::INPAD == atom_ctx.nlist.block_type(atom_blk)) {
-      fp << "\t\t" << block_name + input_port_postfix << " <= 1'b0;"
+      fp << "\t\t" << escapeNames(block_name + input_port_postfix) << " <= 1'b0;"
          << std::endl;
     }
   }
@@ -951,7 +965,7 @@ void print_verilog_testbench_random_stimuli(
 
     /* TODO: find the clock inputs will be initialized later */
     if (AtomBlockType::INPAD == atom_ctx.nlist.block_type(atom_blk)) {
-      fp << "\t\t" << block_name + input_port_postfix << " <= $random;"
+      fp << "\t\t" << escapeNames(block_name + input_port_postfix) << " <= $random;"
          << std::endl;
     }
   }
diff --git a/openfpga/src/fpga_verilog/verilog_writer_utils.cpp b/openfpga/src/fpga_verilog/verilog_writer_utils.cpp
index dd95205de4..20a29d2720 100644
--- a/openfpga/src/fpga_verilog/verilog_writer_utils.cpp
+++ b/openfpga/src/fpga_verilog/verilog_writer_utils.cpp
@@ -533,10 +533,10 @@ std::string generate_verilog_port(
     } else if ((1 == port_info.get_width())) {
       size_str = "[" + std::to_string(port_info.get_lsb()) + "]";
     }
-    verilog_line = port_info.get_name() + size_str;
+    verilog_line = escapeNames(port_info.get_name()) + size_str;
   } else {
     verilog_line = VERILOG_PORT_TYPE_STRING[verilog_port_type];
-    verilog_line += " " + size_str + " " + port_info.get_name();
+    verilog_line += " " + size_str + " " + escapeNames(port_info.get_name());
   }
 
   return verilog_line;
diff --git a/openfpga/src/fpga_verilog/verilog_writer_utils.h b/openfpga/src/fpga_verilog/verilog_writer_utils.h
index 665f191a2d..81e21b353b 100644
--- a/openfpga/src/fpga_verilog/verilog_writer_utils.h
+++ b/openfpga/src/fpga_verilog/verilog_writer_utils.h
@@ -199,6 +199,8 @@ void print_verilog_netlist_include_header_file(
   const char* subckt_dir, const char* header_file_name,
   const bool& include_time_stamp);
 
+std::string escapeNames(const std::string& name);
+
 } /* end namespace openfpga */
 
 #endif