Fix script command

Author: KelvinChung2000

FABulous/FABulous.py

@@ -50,6 +50,8 @@ def main():
         description="The command line interface for FABulous"
     )
 
+    script_group = parser.add_mutually_exclusive_group()
+
     parser.add_argument(
         "project_dir",
         help="The directory to the project folder",
@@ -63,15 +65,16 @@ def main():
         help="Create a new project",
     )
 
-    parser.add_argument(
+    script_group.add_argument(
         "-fs",
         "--FABulousScript",
         default="",
         help="Run FABulous with a FABulous script. A FABulous script is a text file containing only FABulous commands"
         "This will automatically exit the CLI once the command finish execution, and the exit will always happen gracefully.",
         type=Path,
     )
-    parser.add_argument(
+
+    script_group.add_argument(
         "-ts",
         "--TCLScript",
         default="",
@@ -80,6 +83,12 @@ def main():
         type=Path,
     )
 
+    script_group.add_argument(
+        "-p",
+        "--commands",
+        help="execute <commands> (to chain commands, separate them with semicolon + whitespace: 'cmd1; cmd2')",
+    )
+
     parser.add_argument(
         "-log",
         default=False,
@@ -186,29 +195,45 @@ def main():
             os.getenv("FAB_PROJ_LANG"),
             projectDir,
             Path().cwd(),
-            FABulousScript=args.FABulousScript,
-            TCLScript=args.TCLScript,
             force=args.force,
         )
         fab_CLI.debug = args.debug
 
-        if args.verbose == 2:
-            fab_CLI.verbose = True
-        if args.metaDataDir:
-            if Path(args.metaDataDir).exists():
-                metaDataDir = args.metaDataDir
-
-        if args.log:
-            with open(args.log, "w") as log:
-                with redirect_stdout(log):
-                    logger.info("Logging to file: " + args.log)
-                    logger.info(f"Setting current working directory to: {projectDir}")
-                    os.chdir(projectDir)
-                    fab_CLI.cmdloop()
+        if commands := args.commands:
+            commands = commands.split("; ")
+            for c in commands:
+                if fab_CLI.onecmd_plus_hooks(c):
+                    exit(1)
+            else:
+                logger.info(
+                    f'Commands "{'; '.join(i.strip() for i in commands)}" executed successfully'
+                )
+                exit(0)
+        elif args.FABulousScript != Path(""):
+            if fab_CLI.onecmd_plus_hooks(f"run_script {args.FABulousScript}"):
+                exit(1)
+            else:
+                logger.info(
+                    f"FABulous script {args.FABulousScript} executed successfully"
+                )
+                exit(0)
+        elif args.TCLScript != Path(""):
+            if fab_CLI.onecmd_plus_hooks(f"run_script {args.TCLScript}"):
+                exit(1)
+            else:
+                logger.info(f"TCL script {args.TCLScript} executed successfully")
+                exit(0)
         else:
-            logger.info(f"Setting current working directory to: {projectDir}")
-            os.chdir(projectDir)
-            fab_CLI.cmdloop()
+            if args.verbose == 2:
+                fab_CLI.verbose = True
+
+            if args.log:
+                with open(args.log, "w") as log:
+                    with redirect_stdout(log):
+                        fab_CLI.cmdloop()
+            else:
+                exit_code = fab_CLI.cmdloop()
+                exit(exit_code)
 
 
 if __name__ == "__main__":

FABulous/FABulous_CLI/FABulous_CLI.py

@@ -115,8 +115,6 @@ def __init__(
         writerType: str | None,
         projectDir: Path,
         enteringDir: Path,
-        FABulousScript: Path = Path(),
-        TCLScript: Path = Path(),
         force: bool = False,
     ):
         """Initialises the FABulous shell instance.
@@ -136,7 +134,6 @@ def __init__(
         super().__init__(
             persistent_history_file=f"{os.getenv('FAB_PROJ_DIR')}/{META_DATA_DIR}/.fabulous_history",
             allow_cli_args=False,
-            startup_script=str(FABulousScript) if not FABulousScript.is_dir() else "",
         )
         self.enteringDir = enteringDir
 
@@ -212,22 +209,6 @@ def __init__(
             CMD_HELPER, "Helper commands are disabled until fabric is loaded"
         )
 
-        if not TCLScript.is_dir() and TCLScript.exists():
-            self._startup_commands.append(f"run_tcl {Path(TCLScript).absolute()}")
-            self._startup_commands.append("exit")
-        elif not TCLScript.is_dir() and not TCLScript.exists():
-            logger.error(f"Cannot find {TCLScript}")
-            exit(1)
-
-        if not FABulousScript.is_dir() and FABulousScript.exists():
-            self._startup_commands.append(
-                f"run_script {Path(FABulousScript).absolute()}"
-            )
-            self._startup_commands.append("exit")
-        elif not FABulousScript.is_dir() and not FABulousScript.exists():
-            logger.error(f"Cannot find {FABulousScript}")
-            exit(1)
-
     def onecmd(self, *arg, **kwargs):
         """Override the onecmd method to handle exceptions."""
         try:
@@ -637,7 +618,6 @@ def do_gen_top_wrapper(self, *ignored):
         logger.info("Generated top wrapper")
 
     @with_category(CMD_FABRIC_FLOW)
-    @allow_blank
     def do_run_FABulous_fabric(self, *ignored):
         """Generates the fabric based on the CSV file, creates bitstream specification
         of the fabric, top wrapper of the fabric, Nextpnr model of the fabric and
@@ -646,11 +626,11 @@ def do_run_FABulous_fabric(self, *ignored):
         Does this by calling the respective functions 'do_gen_[function]'.
         """
         logger.info("Running FABulous")
-        self.do_gen_fabric()
-        self.do_gen_bitStream_spec()
-        self.do_gen_top_wrapper()
-        self.do_gen_model_npnr()
-        self.do_gen_geometry()
+        self.onecmd_plus_hooks("gen_fabric")
+        self.onecmd_plus_hooks("gen_bitStream_spec")
+        self.onecmd_plus_hooks("gen_top_wrapper")
+        self.onecmd_plus_hooks("gen_model_npnr")
+        self.onecmd_plus_hooks("gen_geometry")
         logger.info("FABulous fabric flow complete")
         return
 
@@ -970,9 +950,9 @@ def do_run_FABulous_bitstream(self, args):
         else:
             logger.info("No external primsLib found.")
 
-        self.do_synthesis(do_synth_args)
-        self.do_place_and_route(str(json_file_path))
-        self.do_gen_bitStream_binary(str(fasm_file_path))
+        self.onecmd_plus_hooks(f"synthesis {do_synth_args}")
+        self.onecmd_plus_hooks(f"place_and_route {json_file_path}")
+        self.onecmd_plus_hooks(f"gen_bitStream_binary {fasm_file_path}")
 
     @with_category(CMD_SCRIPT)
     @with_argparser(filePathRequireParser)