labview-fpga-hdl-tools 2.0.0.dev2__tar.gz → 2.0.0.dev3__tar.gz

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: labview-fpga-hdl-tools
-Version: 2.0.0.dev2
+Version: 2.0.0.dev3
 Summary: LabVIEW FPGA HDL Tools
 License: MIT
 Author: Salvador Santolucito

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/check_syntax.py

@@ -83,12 +83,9 @@ def _validate_ini(config):
             if invalid_path:
                 invalid_paths.append(invalid_path)
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _get_check_syntax_status_from_log(log_contents):
@@ -109,16 +106,7 @@ def _get_check_syntax_status_from_log(log_contents):
 
 def _run_check_syntax(config, generated_tcl_path):
     """Run the generated check-syntax TCL script in Vivado batch mode."""
-    vivado_executable = common.get_vivado_executable(config.vivado_tools_folder)
-    if not vivado_executable:
-        raise ValueError("VivadoToolsFolder setting is missing from configuration")
-
-    vivado_abs = os.path.abspath(vivado_executable)
-    if not os.path.exists(vivado_abs):
-        raise FileNotFoundError(
-            f"Vivado executable not found at: {vivado_abs}\n"
-            f"Please check your --vivado argument or VivadoToolsFolder setting in nihdlsettings.py"
-        )
+    vivado_abs = common.resolve_vivado_executable_abs(config)
 
     vivado_project_dir = os.path.join(os.getcwd(), config.vivado_project_folder)
     log_path = os.path.join(vivado_project_dir, "check_syntax.log")
@@ -128,19 +116,24 @@ def _run_check_syntax(config, generated_tcl_path):
         if os.path.exists(path):
             os.remove(path)
 
-    command = (
-        f'"{vivado_abs}" -mode batch '
-        f'-source "{generated_tcl_path}" '
-        f'-log "{log_path}" '
-        f'-journal "{journal_path}"'
-    )
+    command = [
+        vivado_abs,
+        "-mode",
+        "batch",
+        "-source",
+        generated_tcl_path,
+        "-log",
+        log_path,
+        "-journal",
+        journal_path,
+    ]
 
     reporter.detail(f"Generated TCL script: {generated_tcl_path}")
     reporter.detail(f"Vivado executable: {vivado_abs}")
     reporter.detail(f"Working directory: {vivado_project_dir}")
-    reporter.detail(f"Running command: {command}")
+    reporter.detail(f"Running command: {' '.join(command)}")
 
-    result = subprocess.run(command, cwd=vivado_project_dir, shell=True, check=False)
+    result = subprocess.run(command, cwd=vivado_project_dir, check=False)
 
     if not os.path.exists(log_path):
         raise RuntimeError("Vivado check-syntax log file was not created.")

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/common.py

@@ -237,7 +237,8 @@ def _parse_vhdl_entity(vhdl_path):
 
     except Exception as e:
         reporter.error(f"Error parsing VHDL file: {str(e)}")
-        traceback.print_exc()
+        if reporter.verbose:
+            traceback.print_exc()
         return None, []
 
 
@@ -406,10 +407,16 @@ def apply_hdl_excludes(file_list, excluded_abspaths):
 
 
 def run_command(cmd, cwd=None, capture_output=True, check=False):
-    """Run a shell command and return its output.
+    """Run a command and return its output.
+
+    The command is given as a pre-tokenized argument list (for example
+    ``[vivado_abs, "-mode", "batch", ...]``) and is executed directly without a
+    shell. Passing an argument list means arguments containing spaces or
+    shell-significant characters are passed through verbatim (no quoting bugs)
+    and there is no shell-injection surface.
 
     Args:
-        cmd: Command string to run through the shell.
+        cmd: The command to run, as a list of arguments.
         cwd: Working directory to run the command in, if any.
         capture_output: When True, capture stdout and return it as a string.
             When False, let the command's output stream to the console and
@@ -421,7 +428,7 @@ def run_command(cmd, cwd=None, capture_output=True, check=False):
         The captured stdout (stripped) when ``capture_output`` is True, otherwise
         an empty string.
     """
-    reporter.detail(f"Running command: {cmd}")
+    reporter.detail(f"Running command: {' '.join(str(arg) for arg in cmd)}")
 
     kwargs = {}
     if cwd:
@@ -429,14 +436,12 @@ def run_command(cmd, cwd=None, capture_output=True, check=False):
 
     if capture_output:
         # Capture and return output
-        result = subprocess.run(
-            cmd, shell=True, text=True, capture_output=True, check=check, **kwargs
-        )
+        result = subprocess.run(cmd, text=True, capture_output=True, check=check, **kwargs)
         # Check if stdout is None before calling strip()
         return result.stdout.strip() if result.stdout is not None else ""
     else:
         # Don't capture output (let it go to console)
-        subprocess.run(cmd, shell=True, check=check, **kwargs)
+        subprocess.run(cmd, check=check, **kwargs)
         return ""  # Return empty string instead of None
 
 
@@ -495,6 +500,48 @@ def get_invalid_paths_error(invalid_paths):
     return error_msg
 
 
+def build_settings_error(missing_settings, invalid_paths):
+    """Return the standard missing-settings / invalid-paths message, or "" if none.
+
+    Combines the missing-settings and invalid-path messages with the shared hint
+    used by every ``_validate_ini``. Returns an empty string when there is
+    nothing to report, so callers can do ``if error: raise ValueError(error)``
+    (or report-and-return) without repeating the concatenation and hint text.
+    """
+    if not (missing_settings or invalid_paths):
+        return ""
+    return (
+        get_missing_settings_error(missing_settings)
+        + get_invalid_paths_error(invalid_paths)
+        + "\nPlease update your configuration file and try again."
+    )
+
+
+def resolve_vivado_executable_abs(config):
+    """Resolve the Vivado executable to an absolute path.
+
+    Args:
+        config: CommandConfiguration providing ``vivado_tools_folder``.
+
+    Returns:
+        str: Absolute path to the Vivado executable.
+
+    Raises:
+        ValueError: if the executable cannot be resolved from the configuration.
+        FileNotFoundError: if the resolved executable does not exist on disk.
+    """
+    vivado_executable = get_vivado_executable(config.vivado_tools_folder)
+    if not vivado_executable:
+        raise ValueError("VivadoToolsFolder setting is missing from configuration")
+    vivado_abs = os.path.abspath(vivado_executable)
+    if not os.path.exists(vivado_abs):
+        raise FileNotFoundError(
+            f"Vivado executable not found at: {vivado_abs}\n"
+            "Please check your VivadoToolsFolder setting in nihdlsettings.py"
+        )
+    return vivado_abs
+
+
 def collect_missing_settings(config, required):
     """Return the labels of required settings that are unset (falsy) on config.
 
@@ -517,23 +564,21 @@ def collect_missing_settings(config, required):
 def raise_for_missing_settings(missing_settings, invalid_paths):
     """Raise ``ValueError`` for missing settings or invalid paths, if any.
 
-    Missing settings take precedence over invalid paths. Produces the standard
-    launch-style messages shared by the launch commands. Does nothing when both
-    lists are empty.
+    Missing settings take precedence over invalid paths (only one message is
+    raised). Uses the shared ``get_missing_settings_error`` /
+    ``get_invalid_paths_error`` builders so the wording matches the
+    ``_validate_ini`` validators. Does nothing when both lists are empty.
     """
     if missing_settings:
-        error_msg = "Missing required configuration settings:\n"
-        for setting in missing_settings:
-            error_msg += f"  - {setting}\n"
-        error_msg += "\nCheck your nihdlsettings.py file and try again."
-        raise ValueError(error_msg)
-
+        raise ValueError(
+            get_missing_settings_error(missing_settings)
+            + "\nPlease update your configuration file and try again."
+        )
     if invalid_paths:
-        error_msg = "The following settings have invalid paths:\n"
-        for path in invalid_paths:
-            error_msg += f"  - {path}\n"
-        error_msg += "\nCheck your configuration and try again."
-        raise ValueError(error_msg)
+        raise ValueError(
+            get_invalid_paths_error(invalid_paths)
+            + "\nPlease update your configuration file and try again."
+        )
 
 
 def generate_guid():

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/compile_modelsim_lib.py

@@ -69,11 +69,9 @@ def _validate_ini(config):
                 f"{config.modelsim_tools_folder}"
             )
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _libraries_already_built(out_folder, libraries):
@@ -134,16 +132,7 @@ def _is_progress_line(line):
 
 def _run_compile_simlib(config, tcl_path, out_folder, libraries):
     """Run the generated compile_simlib TCL script in Vivado batch mode."""
-    vivado_executable = common.get_vivado_executable(config.vivado_tools_folder)
-    if not vivado_executable:
-        raise ValueError("VivadoToolsFolder setting is missing from configuration")
-
-    vivado_abs = os.path.abspath(vivado_executable)
-    if not os.path.exists(vivado_abs):
-        raise FileNotFoundError(
-            f"Vivado executable not found at: {vivado_abs}\n"
-            f"Please check your VivadoToolsFolder setting in nihdlsettings.py"
-        )
+    vivado_abs = common.resolve_vivado_executable_abs(config)
 
     os.makedirs(out_folder, exist_ok=True)
     # Use a distinct name for Vivado's session log/journal. compile_simlib
@@ -165,12 +154,19 @@ def _run_compile_simlib(config, tcl_path, out_folder, libraries):
                     "try again."
                 ) from exc
 
-    command = (
-        f'"{vivado_abs}" -mode batch '
-        f'-source "{tcl_path}" '
-        f'-log "{log_path}" '
-        f'-journal "{journal_path}"'
-    )
+    # Build the argument list explicitly and run without a shell so paths that
+    # contain spaces or shell-significant characters are passed through verbatim.
+    command = [
+        vivado_abs,
+        "-mode",
+        "batch",
+        "-source",
+        tcl_path,
+        "-log",
+        log_path,
+        "-journal",
+        journal_path,
+    ]
 
     # Run with the MODELSIM environment variable unset so compile_simlib does
     # not read or modify a global modelsim.ini; it writes a fresh one into the
@@ -181,7 +177,7 @@ def _run_compile_simlib(config, tcl_path, out_folder, libraries):
     reporter.detail(f"Vivado executable: {vivado_abs}")
     reporter.detail(f"Output directory:  {out_folder}")
     reporter.detail(f"Libraries:         {', '.join(libraries)}")
-    reporter.detail(f"Running command:   {command}")
+    reporter.detail(f"Running command:   {' '.join(command)}")
     reporter.success("")
     reporter.success("=" * 78)
     reporter.success("Compiling the Xilinx ModelSim simulation libraries with Vivado.")
@@ -201,7 +197,7 @@ def _run_compile_simlib(config, tcl_path, out_folder, libraries):
     process = subprocess.Popen(
         command,
         cwd=out_folder,
-        shell=True,
+        shell=False,
         env=env,
         stdout=subprocess.PIPE,
         stderr=subprocess.STDOUT,

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/compile_project.py

@@ -25,12 +25,12 @@ def _generate_compile_project_tcl(config, output_path):
 
 def _validate_ini(config):
     """Validate required settings and paths for compile-project."""
-    missing_settings = []
+    missing_settings = common.collect_missing_settings(
+        config,
+        [("vivado_project_folder", "VivadoProjectSettings.VivadoProjectFolder")],
+    )
     invalid_paths = []
 
-    if not config.vivado_project_folder:
-        missing_settings.append("VivadoProjectSettings.VivadoProjectFolder")
-
     if not config.vivado_tcl_scripts_folder:
         missing_settings.append("VivadoProjectSettings.VivadoTclScriptsFolder")
     else:
@@ -72,12 +72,9 @@ def _validate_ini(config):
             if invalid_path:
                 invalid_paths.append(invalid_path)
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _get_compile_status_from_log(log_contents):
@@ -103,16 +100,7 @@ def _get_compile_status_from_log(log_contents):
 
 def _run_compile_project(config, generated_tcl_path):
     """Run the generated compile-project TCL script in Vivado batch mode."""
-    vivado_executable = common.get_vivado_executable(config.vivado_tools_folder)
-    if not vivado_executable:
-        raise ValueError("VivadoToolsFolder setting is missing from configuration")
-
-    vivado_abs = os.path.abspath(vivado_executable)
-    if not os.path.exists(vivado_abs):
-        raise FileNotFoundError(
-            f"Vivado executable not found at: {vivado_abs}\n"
-            f"Please check your --vivado argument or VivadoToolsFolder setting in nihdlsettings.py"
-        )
+    vivado_abs = common.resolve_vivado_executable_abs(config)
 
     current_dir = os.getcwd()
     vivado_project_dir = os.path.join(current_dir, config.vivado_project_folder)
@@ -123,18 +111,23 @@ def _run_compile_project(config, generated_tcl_path):
         if os.path.exists(path):
             os.remove(path)
 
-    command = (
-        f'"{vivado_abs}" -mode batch '
-        f'-source "{generated_tcl_path}" '
-        f'-log "{log_path}" '
-        f'-journal "{journal_path}"'
-    )
+    command = [
+        vivado_abs,
+        "-mode",
+        "batch",
+        "-source",
+        generated_tcl_path,
+        "-log",
+        log_path,
+        "-journal",
+        journal_path,
+    ]
 
     reporter.detail(f"Vivado executable: {vivado_abs}")
     reporter.detail(f"Working directory: {vivado_project_dir}")
-    reporter.detail(f"Running command: {command}")
+    reporter.detail(f"Running command: {' '.join(command)}")
 
-    result = subprocess.run(command, cwd=vivado_project_dir, shell=True, check=False)
+    result = subprocess.run(command, cwd=vivado_project_dir, check=False)
 
     if not os.path.exists(log_path):
         raise RuntimeError("Vivado compile-project log file was not created.")

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/create_lvbitx.py

@@ -211,7 +211,8 @@ def create_lv_bitx(config=None):
         return result  # Return the result code
     except Exception as e:
         reporter.error(f"Unhandled exception: {str(e)}")
-        import traceback
+        if reporter.verbose:
+            import traceback
 
-        traceback.print_exc()
+            traceback.print_exc()
         return 1  # Return error code on exception

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/create_modelsim_project.py

@@ -61,11 +61,9 @@ def _validate_ini(config):
                     f"{config.modelsim_tools_folder}"
                 )
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _get_vsim_executable(modelsim_path):

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/create_vivado_project.py

@@ -18,6 +18,7 @@ The tool supports:
 import glob
 import os
 import shutil
+import stat
 import subprocess
 from collections import defaultdict
 from enum import Enum
@@ -290,7 +291,7 @@ def _copy_long_path_files(file_list, vivado_project_dir, tcl_base_dir):
         if vivado_path_len > path_len_limit:
             target_path = os.path.join(target_folder_long, os.path.basename(file))
             if os.path.exists(target_path):
-                os.chmod(target_path, 0o777)  # Make the file writable
+                os.chmod(target_path, os.stat(target_path).st_mode | stat.S_IWUSR)  # writable
             try:
                 shutil.copy2(file, target_path)
                 new_file_list.append(target_path)
@@ -471,19 +472,16 @@ def _validate_ini(config):
     Raises:
         ValueError: If any required settings are missing or invalid
     """
-    missing_settings = []
+    missing_settings = common.collect_missing_settings(
+        config,
+        [
+            ("vivado_project_folder", "VivadoProjectSettings.VivadoProjectFolder"),
+            ("top_level_entity", "VivadoProjectSettings.TopLevelEntity"),
+            ("fpga_part", "VivadoProjectSettings.FPGAPart"),
+        ],
+    )
     invalid_paths = []
 
-    # Check VivadoProjectSettings
-    if not config.vivado_project_folder:
-        missing_settings.append("VivadoProjectSettings.VivadoProjectFolder")
-
-    if not config.top_level_entity:
-        missing_settings.append("VivadoProjectSettings.TopLevelEntity")
-
-    if not config.fpga_part:
-        missing_settings.append("VivadoProjectSettings.FPGAPart")
-
     # Don't validate Vivado path if skip_vivado is set
     if not config.skip_vivado:
         if not config.vivado_tools_folder:
@@ -541,14 +539,9 @@ def _validate_ini(config):
         if invalid_path:
             invalid_paths.append(invalid_path)
 
-    # Construct error message
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    # If any issues found, raise an error with the helpful message
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _validate_constraints_files(config):
@@ -563,13 +556,9 @@ def _validate_constraints_files(config):
             if invalid_path:
                 invalid_paths.append(invalid_path)
 
-    # Construct error message
-    error_msg = common.get_invalid_paths_error(invalid_paths)
-
-    # If any issues found, raise an error with the helpful message
-    if invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error([], invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _create_project(mode: ProjectMode, config):
@@ -703,14 +692,21 @@ def _create_project(mode: ProjectMode, config):
 
     if mode == ProjectMode.NEW:
         # Create a new project
-        command = f'"{vivado_abs}" -mode batch -source {new_proj_path}'
+        command = [vivado_abs, "-mode", "batch", "-source", new_proj_path]
     elif mode == ProjectMode.UPDATE:
         # Update the existing project
-        command = f'"{vivado_abs}" {project_name}.xpr -mode batch -source {update_proj_path}'
+        command = [
+            vivado_abs,
+            f"{project_name}.xpr",
+            "-mode",
+            "batch",
+            "-source",
+            update_proj_path,
+        ]
     else:
         raise ValueError(f"Unsupported mode: {mode}")
 
-    reporter.detail(f"Running command: {command}")
+    reporter.detail(f"Running command: {' '.join(command)}")
 
     # In skip_vivado mode, create a mock project file and skip Vivado execution
     if config.skip_vivado:
@@ -723,23 +719,25 @@ def _create_project(mode: ProjectMode, config):
         return 0
 
     try:
-        output = common.run_command(
+        # Stream Vivado output live (capture_output=False) so the user sees
+        # progress during the slow compile and so the failure message below
+        # actually has output "above" to point at.
+        common.run_command(
             command,
             cwd=os.getcwd(),
+            capture_output=False,
             check=True,
         )
     except subprocess.CalledProcessError as e:
-        os.chdir(current_dir)
         action = "updating" if mode == ProjectMode.UPDATE else "creating"
         raise RuntimeError(
             f"Vivado exited with a non-zero status ({e.returncode}) while {action} the "
             f"project. Review the Vivado output above and vivado.log for details."
         ) from e
-
-    # Change back to the original directory
-    os.chdir(current_dir)
-
-    reporter.detail(output)
+    finally:
+        # Always restore the working directory, even if Vivado raised, so later
+        # relative-path resolution in the same run is not corrupted.
+        os.chdir(current_dir)
 
 
 def _create_project_handler(config, overwrite=False, update=False):

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/gen_labview_target_plugin.py

@@ -20,6 +20,7 @@ import csv  # For reading signal definitions from CSV
 import os  # For file and directory operations
 import re
 import shutil  # For file copying operations
+import stat
 import xml.etree.ElementTree as ET  # For XML generation and manipulation # noqa: N817
 from xml.dom.minidom import parseString  # For pretty-formatted XML output
 
@@ -616,7 +617,7 @@ def _copy_fpgafiles(
             target_path = os.path.join(dest_deps_folder, base_filename)
 
             if os.path.exists(target_path):
-                os.chmod(target_path, 0o777)  # Make the file writable
+                os.chmod(target_path, os.stat(target_path).st_mode | stat.S_IWUSR)  # writable
             # Check file paths before copy
             if file and target_path:
                 shutil.copy2(file, target_path)
@@ -646,7 +647,7 @@ def _copy_menu_files(plugin_folder, menus_folder):
                 dst_file = os.path.join(dest_dir, file)
                 # Make destination writable if it exists
                 if os.path.exists(dst_file):
-                    os.chmod(dst_file, 0o777)
+                    os.chmod(dst_file, os.stat(dst_file).st_mode | stat.S_IWUSR)
                 # Add null check before copy
                 if src_file is not None and dst_file is not None:
                     shutil.copy2(src_file, dst_file)
@@ -688,29 +689,19 @@ def _validate_ini(config):
     # generation.
     missing_settings, invalid_paths = generate_vhdl._validate_generated_vhdl_settings(config)
 
-    # Required general settings
-    if not config.target_family:
-        missing_settings.append("GeneralSettings.TargetFamily")
-
-    if not config.base_target:
-        missing_settings.append("GeneralSettings.BaseTarget")
-
-    # Required plugin settings
-    if not config.lv_target_plugin_output_folder:
-        missing_settings.append("LVFPGATargetSettings.LVTargetPluginOutputFolder")
-
-    if not config.lv_target_name:
-        missing_settings.append("LVFPGATargetSettings.LVTargetName")
-
-    if not config.lv_target_guid:
-        missing_settings.append("LVFPGATargetSettings.LVTargetGUID")
-
-    # Validate input files and folders
-    if not config.boardio_output:
-        missing_settings.append("LVFPGATargetSettings.BoardIOXML")
-
-    if not config.clock_output:
-        missing_settings.append("LVFPGATargetSettings.ClockXML")
+    # Required presence-only settings (list settings with path validation follow).
+    missing_settings += common.collect_missing_settings(
+        config,
+        [
+            ("target_family", "GeneralSettings.TargetFamily"),
+            ("base_target", "GeneralSettings.BaseTarget"),
+            ("lv_target_plugin_output_folder", "LVFPGATargetSettings.LVTargetPluginOutputFolder"),
+            ("lv_target_name", "LVFPGATargetSettings.LVTargetName"),
+            ("lv_target_guid", "LVFPGATargetSettings.LVTargetGUID"),
+            ("boardio_output", "LVFPGATargetSettings.BoardIOXML"),
+            ("clock_output", "LVFPGATargetSettings.ClockXML"),
+        ],
+    )
 
     # Check list settings
     if not config.hdl_file_lists:
@@ -750,14 +741,9 @@ def _validate_ini(config):
             if invalid_path:
                 invalid_paths.append(invalid_path)
 
-    # Construct error message
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    # If any issues found, raise an error with the helpful message
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def gen_lv_target_support(config=None):

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/generate_vhdl.py

@@ -40,8 +40,13 @@ def _map_datatype_to_vhdl(data_type):
         return "std_logic"
 
     elif data_type.startswith(("U", "I")):
-        # Handle U8, U16, U32, U64, I8, I16, I32, I64
-        bit_width = int(data_type[1:])
+        # Handle U8, U16, U32, U64, I8, I16, I32, I64. Degrade gracefully to a
+        # sentinel (like the FXP/Array branches) instead of crashing the whole
+        # flow when the CSV holds a malformed U*/I* data type.
+        try:
+            bit_width = int(data_type[1:])
+        except ValueError:
+            return "INVALID_DATA_TYPE"
         return f"std_logic_vector({bit_width - 1} downto 0)"
 
     elif data_type.startswith("FXP"):
@@ -220,7 +225,7 @@ def _render_generated_vhdl(template_paths, output_folder, context):
         context (dict): kwargs passed to ``Template.render``.
 
     Raises:
-        SystemExit: If an error occurs during VHDL generation.
+        RuntimeError: If an error occurs during VHDL generation.
     """
     try:
         os.makedirs(output_folder, exist_ok=True)
@@ -259,7 +264,10 @@ def _validate_generated_vhdl_settings(config):
         tuple: ``(missing_settings, invalid_paths)`` lists describing any
         problems found. Both empty means the VHDL-generation settings are valid.
     """
-    missing_settings = []
+    missing_settings = common.collect_missing_settings(
+        config,
+        [("generated_vhdl_output_folder", "LVFPGATargetSettings.GeneratedVhdlOutputFolder")],
+    )
     invalid_paths = []
 
     # Validate input CSV if custom IO is included
@@ -277,10 +285,6 @@ def _validate_generated_vhdl_settings(config):
             if invalid_path:
                 invalid_paths.append(invalid_path)
 
-    # Validate output folder setting
-    if not config.generated_vhdl_output_folder:
-        missing_settings.append("LVFPGATargetSettings.GeneratedVhdlOutputFolder")
-
     return missing_settings, invalid_paths
 
 
@@ -307,11 +311,9 @@ def gen_generated_vhdl(config=None):
 
     # Validate that required settings for generation are present
     missing_settings, invalid_paths = _validate_generated_vhdl_settings(config)
-    if missing_settings or invalid_paths:
-        error_msg = common.get_missing_settings_error(missing_settings)
-        error_msg += common.get_invalid_paths_error(invalid_paths)
-        error_msg += "\nPlease update your configuration file and try again."
-        reporter.error(f"Error: {error_msg}")
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        reporter.error(f"Error: {error}")
         return 1
 
     context = _build_generated_vhdl_context(config)

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/get_window_netlist.py

@@ -75,7 +75,14 @@ def _get_window_netlist(config):
 
         try:
             common.run_command(
-                f'"{vivado_abs}" {project_name}.xpr -mode batch -source {get_netlist_tcl_path}',
+                [
+                    vivado_abs,
+                    f"{project_name}.xpr",
+                    "-mode",
+                    "batch",
+                    "-source",
+                    get_netlist_tcl_path,
+                ],
                 cwd=os.getcwd(),
                 capture_output=False,
                 check=True,
@@ -248,7 +255,10 @@ def _validate_ini(config):
     Raises:
         ValueError: If any required settings are missing or paths are invalid
     """
-    missing_settings = []
+    missing_settings = common.collect_missing_settings(
+        config,
+        [("lv_window_netlist_output_folder", "LVWindowNetlistSettings.LVWindowFolder")],
+    )
     invalid_paths = []
 
     # Check required paths for window netlist generation
@@ -274,9 +284,6 @@ def _validate_ini(config):
                     f"Vivado has issues with long paths. Please use a shorter path for your project."
                 )
 
-    if not config.lv_window_netlist_output_folder:
-        missing_settings.append("LVWindowNetlistSettings.LVWindowFolder")
-
     # Check for Vivado tools path
     if not config.vivado_tools_folder:
         missing_settings.append("VivadoProjectSettings.VivadoToolsFolder")
@@ -289,14 +296,9 @@ def _validate_ini(config):
         if invalid_path:
             invalid_paths.append(invalid_path)
 
-    # Construct error message using common utility functions
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    # If any issues found, raise an error with the helpful message
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def get_window(config=None):

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/install_dependencies.py

@@ -106,8 +106,8 @@ def _write_dep_marker(repo, repo_name, tag, requested, repo_url, repo_path, deps
     for stale in deps_dir.glob(f"{repo_name}-*{_DEP_INFO_SUFFIX}"):
         try:
             stale.unlink()
-        except OSError:
-            pass
+        except OSError as e:
+            reporter.detail(f"    [INFO] Could not remove stale marker {stale.name}: {e}")
 
     commit = _get_commit_hash(repo_path) or "unknown"
     installed = datetime.datetime.now(datetime.timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
@@ -360,7 +360,17 @@ def _clone_repo_at_tag(repo, tag_or_spec, base_dir, delete_allowed=False, allow_
             response = "y"
             reporter.detail(f"    Auto-deleting and re-cloning (--delete flag set)")
         else:
-            response = input(f"    Delete and re-clone? (y/N): ").strip().lower()
+            try:
+                response = input(f"    Delete and re-clone? (y/N): ").strip().lower()
+            except EOFError:
+                # Non-interactive/CI run: there is no stdin to prompt on. Default
+                # to the safe "keep existing clone" choice instead of crashing;
+                # pass --delete to force a re-clone in automated runs.
+                reporter.detail(
+                    "    No interactive input available; keeping existing clone "
+                    "(pass --delete to force a re-clone)."
+                )
+                response = "n"
 
         if response in ["y", "yes"]:
             reporter.detail(f"    Deleting {repo_path}...")

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/install_labview_target_plugin.py

@@ -72,7 +72,10 @@ def _validate_ini(config):
     Raises:
         ValueError: If any required settings are missing or paths are invalid
     """
-    missing_settings = []
+    missing_settings = common.collect_missing_settings(
+        config,
+        [("lv_target_name", "LVFPGATargetSettings.LVTargetName")],
+    )
     invalid_paths = []
 
     # Check required settings for installation
@@ -88,9 +91,6 @@ def _validate_ini(config):
         if invalid_path:
             invalid_paths.append(invalid_path)
 
-    if not config.lv_target_name:
-        missing_settings.append("LVFPGATargetSettings.LVTargetName")
-
     if not config.lv_target_plugin_output_folder:
         missing_settings.append("LVFPGATargetSettings.LVTargetPluginOutputFolder")
     else:
@@ -103,14 +103,9 @@ def _validate_ini(config):
         if invalid_path:
             invalid_paths.append(invalid_path)
 
-    # Construct error message
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    # If any issues found, raise an error with the helpful message
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def install_lv_target_support(config=None):

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/launch_modelsim.py

@@ -30,9 +30,7 @@ def _validate_ini(config):
             )
 
     if not common.get_modelsim_entity(config):
-        missing_settings.append(
-            "ModelSimSettings.ModelSimEntity (or VivadoProjectSettings.TopLevelEntity)"
-        )
+        missing_settings.append("ModelSimSettings.ModelSimEntity (set via set_modelsim_top_entity)")
 
     common.raise_for_missing_settings(missing_settings, invalid_paths)
 
@@ -95,14 +93,17 @@ def launch_modelsim(batch=False, config=None):
             return result.returncode
         reporter.success("Simulation completed successfully")
     else:
-        # GUI mode: launch vsim detached
+        # GUI mode: launch vsim in its own window and return immediately.
         if platform.system() == "Windows":
-            cmd = f'start "" "{vsim_exe}" -do {do_file}'
-            return_code = subprocess.call(cmd, shell=True, cwd=project_dir)
+            # Use cmd's "start" (as an argument list, shell=False) to open vsim
+            # in its own window with no shell-injection surface. This also runs
+            # vsim launchers that are batch files, which CreateProcess cannot
+            # execute directly.
+            cmd = ["cmd", "/c", "start", "", vsim_exe, "-do", do_file]
+            return_code = subprocess.call(cmd, cwd=project_dir)
         else:
-            cmd = [vsim_exe, "-do", do_file]
             subprocess.Popen(
-                cmd,
+                [vsim_exe, "-do", do_file],
                 cwd=project_dir,
                 stdout=subprocess.DEVNULL,
                 stderr=subprocess.DEVNULL,

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/launch_vivado.py

@@ -26,7 +26,10 @@ def _validate_ini(config):
     Raises:
         ValueError: If any required settings are missing
     """
-    missing_settings = []
+    missing_settings = common.collect_missing_settings(
+        config,
+        [("vivado_project_folder", "VivadoProjectSettings.VivadoProjectFolder")],
+    )
     invalid_paths = []
 
     # Check required Vivado settings
@@ -40,9 +43,6 @@ def _validate_ini(config):
         if invalid_path:
             invalid_paths.append(invalid_path)
 
-    if not config.vivado_project_folder:
-        missing_settings.append("VivadoProjectSettings.VivadoProjectFolder")
-
     common.raise_for_missing_settings(missing_settings, invalid_paths)
 
 
@@ -102,13 +102,18 @@ def launch_vivado(config=None):
         reporter.success("SKIP VIVADO: Validation successful, skipping Vivado launch")
         return 0
 
-    # Launch Vivado
+    # Launch Vivado. project_arg (an existing .xpr) is optional.
     if platform.system() == "Windows":
-        # On Windows, use start to launch in a new window
-        cmd = f'start "" "{vivado_abs}" {project_arg}'
-        return_code = subprocess.call(cmd, shell=True, cwd=vivado_project_dir)
+        # Use cmd's "start" to open Vivado in its own window and return
+        # immediately. Passed as an argument list (shell=False) so there is no
+        # shell-injection surface, and so Vivado's vivado.bat launcher -- a batch
+        # file that CreateProcess cannot run directly -- is executed by cmd.
+        cmd = ["cmd", "/c", "start", "", vivado_abs]
+        if project_arg:
+            cmd.append(project_arg)
+        return_code = subprocess.call(cmd, cwd=vivado_project_dir)
     else:
-        # On Linux/macOS, launch directly
+        # On Linux/macOS, launch directly (blocks until Vivado exits).
         cmd = [vivado_abs]
         if project_arg:
             cmd.append(project_arg)

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/migrate_clip.py

@@ -289,7 +289,8 @@ def _generate_board_io_csv_from_clip_xml(input_xml_path, clip_output_csv):
 
     except Exception as e:
         reporter.error(f"Error processing XML: {str(e)}")
-        traceback.print_exc()
+        if reporter.verbose:
+            traceback.print_exc()
 
 
 def _process_constraint_file(input_xml_path, output_folder, instance_path):
@@ -340,7 +341,8 @@ def _process_constraint_file(input_xml_path, output_folder, instance_path):
 
     except Exception as e:
         reporter.error(f"Error processing XDC file {os.path.basename(input_xml_path)}: {str(e)}")
-        traceback.print_exc()
+        if reporter.verbose:
+            traceback.print_exc()
 
 
 def _generate_clip_to_window_signals(input_xml_path, output_vhdl_path):
@@ -430,7 +432,8 @@ def _generate_clip_to_window_signals(input_xml_path, output_vhdl_path):
 
     except Exception as e:
         reporter.error(f"Error generating CLIP to Window signals: {e}")
-        traceback.print_exc()
+        if reporter.verbose:
+            traceback.print_exc()
         return False, [f"Critical error: {str(e)}"]
 
 
@@ -573,7 +576,17 @@ def _validate_ini(config):
     Raises:
         ValueError: If any required settings are missing or paths are invalid
     """
-    missing_settings = []
+    missing_settings = common.collect_missing_settings(
+        config,
+        [
+            ("clip_output_csv", "CLIPMigrationSettings.LVTargetBoardIO"),
+            ("clip_inst_example", "CLIPMigrationSettings.CLIPInstantiationExample"),
+            (
+                "clip_to_window_signal_definitions",
+                "CLIPMigrationSettings.CLIPtoWindowSignalDefinitions",
+            ),
+        ],
+    )
     invalid_paths = []
 
     # Check required paths
@@ -587,9 +600,6 @@ def _validate_ini(config):
         if invalid_path:
             invalid_paths.append(invalid_path)
 
-    if not config.clip_output_csv:
-        missing_settings.append("CLIPMigrationSettings.LVTargetBoardIO")
-
     if not config.clip_top_hdl:
         missing_settings.append("CLIPMigrationSettings.CLIPHDLTop")
     else:
@@ -600,9 +610,6 @@ def _validate_ini(config):
         if invalid_path:
             invalid_paths.append(invalid_path)
 
-    if not config.clip_inst_example:
-        missing_settings.append("CLIPMigrationSettings.CLIPInstantiationExample")
-
     # Note: CLIPXDCIn is optional, so we don't check if it's missing -
     #   but if they are present, validate them
     # Only check for CLIPEntityPath and XDC output folder if there are XDC paths
@@ -621,17 +628,9 @@ def _validate_ini(config):
             if invalid_path:
                 invalid_paths.append(invalid_path)
 
-    if not config.clip_to_window_signal_definitions:
-        missing_settings.append("CLIPMigrationSettings.CLIPtoWindowSignalDefinitions")
-
-    # Construct error message
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    # If any issues found, raise an error with the helpful message
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def migrate_clip(config=None):

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/labview_fpga_hdl_tools/sim_modelsim.py

@@ -33,10 +33,9 @@ def _validate_ini(config):
     if not common.get_modelsim_entity(config):
         missing_settings.append("ModelSimSettings.ModelSimEntity (set via set_modelsim_top_entity)")
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-    if error_msg:
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def sim_modelsim(do_file=None, config=None):

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "labview-fpga-hdl-tools"
-version = "2.0.0.dev2"
+version = "2.0.0.dev3"
 description = "LabVIEW FPGA HDL Tools"
 authors = [
   "Salvador Santolucito <salvador.santolucito@gmail.com>"