A collection of unique identifiers. Allows for fast fresh identifier generation.

NB: use the functions in Clash.Netlist.Id. Don't use the constructor directly.

An IdentifierSetMonad supports unique name generation for Clash Netlist

Structures that hold an IdentifierSet

Identifier set without identifiers

Make a identifier set filled with given identifiers

Remove all identifiers from a set

HDL identifier. Consists of a base name and a number of extensions. An identifier with a base name of "foo" and a list of extensions [1, 2] will be rendered as "foo_1_2".

Note: The Eq instance of Identifier is case insensitive! E.g., two identifiers with base names fooBar and FoObAR are considered the same. However, identifiers are stored case preserving. This means Clash won't generate two identifiers with differing case, but it will try to keep capitalization.

The goal of this data structure is to greatly simplify how Clash deals with identifiers internally. Any Identifier should be trivially printable to any HDL.

NB: use the functions in Clash.Netlist.Id. Don't use these constructors directly.

Like addRaw, unsafeMake creates an identifier that will be spliced at verbatim in the HDL. As opposed to addRaw, the resulting Identifier might be generated at a later point as it is NOT added to an IdentifierSet.

Convert an identifier to string. Use unmake if you need the IdentifierType too.

Convert an identifier to string. Use unmake if you need the IdentifierType too.

Union of two identifier sets. Errors if given sets have been made with different options enabled.

Make unique identifier based on given string

Make unique basic identifier based on given string

Make unique basic identifier based on given string. If given string can't be converted to a basic identifier (i.e., it would yield an empty string) the alternative name is used.

Make unique identifier. Uses makeBasic if first argument is Basic

Add an identifier to an IdentifierSet

Add identifiers to an IdentifierSet

Add a string as is to an IdentifierSet. Should only be used for identifiers that should be spliced at verbatim in HDL, such as port names. It's sanitized version will still be added to the identifier set, to prevent freshly generated variables clashing with the raw one.

Given identifier "foo_1_2" return "foo_1_2_0". If "foo_1_2_0" is already a member of the given set, return "foo_1_2_1" instead, etc. Identifier returned is guaranteed to be unique.

Same as deepenM, but returns N fresh identifiers. For example, given "foo_23" is would return "foo_23_0", "foo_23_1", ...

Given identifier "foo_1_2" return "foo_1_3". If "foo_1_3" is already a member of the given set, return "foo_1_4" instead, etc. Identifier returned is guaranteed to be unique.

Same as nextM, but returns N fresh identifiers

Given identifier "foo_1_2" and a prefix "bar", return an identifier called "bar_foo". Identifier returned is guaranteed to be unique according to the rules of nextIdentifier.

Given identifier "foo_1_2" and a suffix "bar", return an identifier called "foo_bar". Identifier returned is guaranteed to be unique according to the rules of nextIdentifier.

Convert a Clash Core Id to an identifier. Makes sure returned identifier is unique.

Is given string a valid basic identifier in given HDL?

Is given string a valid extended identifier in given HDL?