Coverage for hdl_registers/generator/reserved_keywords.py: 100%
5 statements
« prev ^ index » next coverage.py v7.8.0, created at 2025-04-29 06:41 +0000
« prev ^ index » next coverage.py v7.8.0, created at 2025-04-29 06:41 +0000
1# --------------------------------------------------------------------------------------------------
2# Copyright (c) Lukas Vik. All rights reserved.
3#
4# This file is part of the hdl-registers project, an HDL register generator fast enough to run
5# in real time.
6# https://hdl-registers.com
7# https://github.com/hdl-registers/hdl-registers
8# --------------------------------------------------------------------------------------------------
10from hdl_registers.generator.c.reserved_keywords import RESERVED_C_KEYWORDS
11from hdl_registers.generator.cpp.reserved_keywords import RESERVED_CPP_KEYWORDS
12from hdl_registers.generator.html.reserved_keywords import RESERVED_HTML_KEYWORDS
13from hdl_registers.generator.python.reserved_keywords import RESERVED_PYTHON_KEYWORDS
15# All reserved keywords that shall yield an error if used for register data.
16# Note that only the keywords from software generator languages are included here.
17# E.g. VHDL and Verilog are not included.
18# This is because an erroneous use of a reserved keyword in HDL code will be detected early
19# when e.g. simulating or building.
20# The reserved keyword mechanism is in place for detecting keyword usage that would give an error
21# in the generated software code after e.g. a 1-hour FPGA build.
22# That's where the mechanism makes sense and adds value.
23# In general we want to keep the reserved keywords set as small as possible.
24# The more language support the more reserved keywords we have to add, which is actually a problem.
25RESERVED_KEYWORDS = (
26 RESERVED_C_KEYWORDS | RESERVED_CPP_KEYWORDS | RESERVED_HTML_KEYWORDS | RESERVED_PYTHON_KEYWORDS
27)