[generate] Use input_visualizer/ instead of visualizer: key in generators.yaml

Author: mpsijm

bin/generate.py

@@ -191,13 +191,14 @@ class VisualizerInvocation(Invocation):
     def __init__(self, problem, string):
         super().__init__(problem, string, allow_absolute=True, allow_relative=False)
 
-    # Run the visualizer, taking {name} as a command line argument.
-    # Stdin and stdout are not used.
-    # {name} is no longer used and hardcoded to `testcase` (see #273), and {seed} is also not used.
+    # Run the visualizer, passing the test case input to stdin.
     def run(self, bar, cwd):
         assert isinstance(self.program, program.Visualizer), "Visualizer program must be built!"
 
-        result = self.program.run(cwd, args=self._sub_args())
+        in_path = cwd / "testcase.in"
+
+        with in_path.open("rb") as in_file:
+            result = self.program.run(cwd, args=self._sub_args(), stdin=in_file)
 
         if result.status == ExecStatus.TIMEOUT:
             bar.debug(f"{Style.RESET_ALL}-> {shorten_path(self.problem, cwd)}")
@@ -325,7 +326,6 @@ def __init__(self, generator_config):
     "generate",
     "copy",
     "solution",
-    "visualizer",
     "random_salt",
     "retries",
     "count",
@@ -337,7 +337,6 @@ def __init__(self, generator_config):
     "testdata.yaml",
     "include",
     "solution",
-    "visualizer",
     "random_salt",
     "retries",
 ]
@@ -348,7 +347,6 @@ def __init__(self, generator_config):
 
 # Holds all inheritable configuration options. Currently:
 # - config.solution
-# - config.visualizer
 # - config.random_salt
 class Config:
     # Used at each directory or testcase level.
@@ -360,13 +358,6 @@ def parse_solution(p, x, path):
             return None
         return SolutionInvocation(p, x)
 
-    @staticmethod
-    def parse_visualizer(p, x, path):
-        assert_type("Visualizer", x, [type(None), str], path)
-        if x is None:
-            return None
-        return VisualizerInvocation(p, x)
-
     @staticmethod
     def parse_random_salt(p, x, path):
         assert_type("Random_salt", x, [type(None), str], path)
@@ -377,7 +368,6 @@ def parse_random_salt(p, x, path):
     INHERITABLE_KEYS: Final[Sequence] = [
         # True: use an AC submission by default when the solution: key is not present.
         ("solution", True, parse_solution),
-        ("visualizer", None, parse_visualizer),
         ("random_salt", "", parse_random_salt),
         # Non-portable keys only used by BAPCtools:
         # The number of retries to run a generator when it fails, each time incrementing the {seed}
@@ -386,7 +376,6 @@ def parse_random_salt(p, x, path):
     ]
 
     solution: SolutionInvocation
-    visualizer: Optional[VisualizerInvocation]
     random_salt: str
     retries: int
 
@@ -1007,21 +996,21 @@ def needed(ext):
         def generate_visualization():
             nonlocal meta_yaml
 
-            if not t.config.visualizer:
-                return True
             if config.args.no_visualizer:
                 return True
+            if not generator_config.visualizer:
+                return True
 
             visualizer_hash = {
-                "visualizer_hash": t.config.visualizer.hash(),
-                "visualizer": t.config.visualizer.cache_command(),
+                "visualizer_hash": generator_config.visualizer.hash(),
+                "visualizer": generator_config.visualizer.cache_command(),
             }
 
             if meta_yaml.get("visualizer_hash") == visualizer_hash:
                 return True
 
             # Generate visualization
-            t.config.visualizer.run(bar, cwd)
+            generator_config.visualizer.run(bar, cwd)
 
             meta_yaml["visualizer_hash"] = visualizer_hash
             write_yaml(meta_yaml, meta_path, allow_yamllib=True)
@@ -1456,6 +1445,13 @@ def __init__(self, problem, restriction=None):
         # Files that should be processed
         self.restriction = restriction
 
+        # The input visualizer is shared between all test cases.
+        self.visualizer: Optional[VisualizerInvocation] = (
+            VisualizerInvocation(problem, "/input_visualizer")
+            if (problem.path / "input_visualizer").is_dir()
+            else None
+        )
+
         if yaml_path.is_file():
             self.yaml = read_yaml(yaml_path)
             self.has_yaml = True
@@ -1780,7 +1776,6 @@ def add_included_case(t: TestcaseRule):
     def build(self, build_visualizers=True, skip_double_build_warning=False):
         generators_used: set[Path] = set()
         solutions_used: set[Path] = set()
-        visualizers_used: set[Path] = set()
 
         # Collect all programs that need building.
         # Also, convert the default submission into an actual Invocation.
@@ -1801,14 +1796,12 @@ def collect_programs(t):
                             default_solution = DefaultSolutionInvocation(self)
                         t.config.solution = default_solution
                     solutions_used.add(t.config.solution.program_path)
-            if build_visualizers and t.config.visualizer:
-                visualizers_used.add(t.config.visualizer.program_path)
 
         self.root_dir.walk(collect_programs, dir_f=None)
 
         def build_programs(
             program_type: type[program.Generator | program.Visualizer | run.Submission],
-            program_paths: set[Path],
+            program_paths: Iterable[Path],
         ):
             programs = list[program.Generator | program.Visualizer | run.Submission]()
             for program_path in program_paths:
@@ -1844,7 +1837,10 @@ def build_program(p):
         # TODO: Consider building all types of programs in parallel as well.
         build_programs(program.Generator, generators_used)
         build_programs(run.Submission, solutions_used)
-        build_programs(program.Visualizer, visualizers_used)
+        build_programs(
+            program.Visualizer,
+            [self.visualizer.program_path] if build_visualizers and self.visualizer else [],
+        )
 
         self.problem.validators(validate.InputValidator)
         if not self.problem.interactive and not self.problem.multi_pass:
@@ -1854,10 +1850,6 @@ def build_program(p):
         def cleanup_build_failures(t):
             if t.config.solution and t.config.solution.program is None:
                 t.config.solution = None
-            if not build_visualizers or (
-                t.config.visualizer and t.config.visualizer.program is None
-            ):
-                t.config.visualizer = None
 
         self.root_dir.walk(cleanup_build_failures, dir_f=None)
 

bin/program.py

@@ -605,10 +605,11 @@ def __init__(self, problem: "Problem", path: Path, **kwargs):
         )
 
     # Run the visualizer.
-    # Stdin and stdout are not used.
-    def run(self, cwd, args=[]):
+    # Stdout is not used.
+    def run(self, cwd, stdin, args=[]):
         assert self.run_command is not None
         return self._exec_command(
             self.run_command + args,
             cwd=cwd,
+            stdin=stdin,
         )