Cloning and matching

[mkorbel1]

Description & Motivation

This PR introduces a couple ideas:

• Requiring a clone to be included on Logics and Interfaces
• Adding APIs to Module that take advantage of those capabilities

The addTyped* functions on Module are parameterized and return the same datatype as was received. Additionally, Module now supports LogicStructures of any type as ports, though the SV still packs them on the interface. These functions are also useful for creating ports when you want the widths/dimensions to match the original argument.

There's also some add*InterfacePorts functions for Interfaces, which basically just wrap the more common way to create interfaces by calling clone and connectIO. There's one for arbitrary Interfaces and one for PairInterfaces.

Also, this adds packed to base Logic as a no-op so that you can safely use addTyped* functions but force a simple logic as the input (rather than an arbitrary structure).

Also, this PR adjusts naming of (non-reserved) LogicStructure elements in generated SystemVerilog to prefix with the name of the structure, which makes the generated SV more readable.

Related Issue(s)

N/A

Partially addresses #609 by exposing original in BusSubset
Fix #578
Close #519 -- we're deprecating PairInterface.clone.

Testing

Added new testing for new functionality.

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

No, though there's new expectations for any implemented Interfaces and LogicStructures if they wish to properly handle these APIs.

Deprecated PairInterface.clone (the constructor, not the method)

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

Yes, API docs included and updated user guide.

[desmonddak]

Looks good and I tried it on FPConverter which dramatically simplified the IO handling of a LogicStructure. This will apply to FPAdder FPMultiplier, the two square root components, and the Fixed2Float, Float2Fixed.

[mkorbel1]

Thank you for reviewing, @desmonddak !

[desmonddak]

This looks like a major cleanup. I even see a LogicStructure naming change that will help SV output (I noticed with Fixed2Float, I think I can verify it and remove a named in the component).

[desmonddak]

So I notice a change from addMatchedOutput to addTypedOutput in that the latter is unhappy with the passing in of a FixedPoint as second argument.

[desmonddak]

Ahh. This is where a clone function is passed.

[desmonddak]

New changes look good.