Coverage for tsfpga/build_step_tcl_hook.py: 100%

1# -------------------------------------------------------------------------------------------------- 

2# Copyright (c) Lukas Vik. All rights reserved. 

3# 

4# This file is part of the tsfpga project, a project platform for modern FPGA development. 

5# https://tsfpga.com 

6# https://github.com/tsfpga/tsfpga 

7# -------------------------------------------------------------------------------------------------- 

8 

9from pathlib import Path 

10 

11 

12class BuildStepTclHook: 

13 """ 

14 Represent a TCL file that shall be used as hook in one of the build steps. 

15 """ 

16 

17 def __init__(self, tcl_file: Path, hook_step: str) -> None: 

18 """ 

19 Arguments: 

20 tcl_file: Path to a TCL file. 

21 hook_step: Name of a build step, e.g. ``STEPS.ROUTE_DESIGN.TCL.PRE``. 

22 See 

23 https://docs.xilinx.com/r/en-US/ug894-vivado-tcl-scripting/Defining-Tcl-Hook-Scripts 

24 for a list of the available build steps in AMD Vivado. 

25 """ 

26 self.tcl_file = tcl_file 

27 self.hook_step = hook_step 

28 

29 @property 

30 def step_is_synth(self) -> bool: 

31 """ 

32 True if the build step is in synthesis. False otherwise. 

33 """ 

34 return "synth" in self.hook_step.lower() 

35 

36 def __str__(self) -> str: 

37 result = str(self.__class__.__name__) + ":" 

38 return result + f"{self.hook_step}:{self.tcl_file}"