SymbolReplaceHelpers (issie)

SymbolReplaceHelpers Module

Namespace: global
Assembly: Renderer.dll

Functions and values

Function or value	Description
`addNumberPort pType pNum sym edgeOpt` Full Usage: `addNumberPort pType pNum sym edgeOpt` Parameters: pType : `PortType` pNum : `int` sym : `Symbol` edgeOpt : `Edge option` Returns: `Symbol`	add the port specified by its type and number to the given symbol if edgeOpt is None the port will be added on the same edge as the port with the highest number pType : `PortType` pNum : `int` sym : `Symbol` edgeOpt : `Edge option` Returns: `Symbol`
`addPorts pType pNumList edgeOpt sym` Full Usage: `addPorts pType pNumList edgeOpt sym` Parameters: pType : `PortType` pNumList : `int list` edgeOpt : `Edge option` sym : `Symbol` Returns: `Symbol`	add the ports specified by the type and the list of port numbers if edgeOpt is None they will be added on the same edge as the port with the highest number pType : `PortType` pNumList : `int list` edgeOpt : `Edge option` sym : `Symbol` Returns: `Symbol`
`changeAdderComponent symModel compId oldComp newCompType` Full Usage: `changeAdderComponent symModel compId oldComp newCompType` Parameters: symModel : `Model` compId : `ComponentId` oldComp : `Component` newCompType : `ComponentType` Returns: `Symbol`	symModel : `Model` compId : `ComponentId` oldComp : `Component` newCompType : `ComponentType` Returns: `Symbol`
`changeBusComparef symModel compId constantVal constantText` Full Usage: `changeBusComparef symModel compId constantVal constantText` Parameters: symModel : `Model` compId : `ComponentId` constantVal : `bigint` constantText : `string` Returns: `Symbol`	Updates the value of a busCompare1 component and returns the updated symbol symModel : `Model` compId : `ComponentId` constantVal : `bigint` constantText : `string` Returns: `Symbol`
`changeConstantf symModel compId constantVal constantText` Full Usage: `changeConstantf symModel compId constantVal constantText` Parameters: symModel : `Model` compId : `ComponentId` constantVal : `bigint` constantText : `string` Returns: `Symbol`	Updates the value of a constant1 component and returns the updated symbol symModel : `Model` compId : `ComponentId` constantVal : `bigint` constantText : `string` Returns: `Symbol`
`changeCounterComponent symModel compId oldComp newCompType` Full Usage: `changeCounterComponent symModel compId oldComp newCompType` Parameters: symModel : `Model` compId : `ComponentId` oldComp : `Component` newCompType : `ComponentType` Returns: `Symbol`	symModel : `Model` compId : `ComponentId` oldComp : `Component` newCompType : `ComponentType` Returns: `Symbol`
`changeCustom symModel compId oldComp newCompType` Full Usage: `changeCustom symModel compId oldComp newCompType` Parameters: symModel : `Model` compId : `ComponentId` oldComp : `Component` newCompType : `ComponentType` Returns: `Symbol`	symModel : `Model` compId : `ComponentId` oldComp : `Component` newCompType : `ComponentType` Returns: `Symbol`
`changeGateComponent symModel compId gateType n` Full Usage: `changeGateComponent symModel compId gateType n` Parameters: symModel : `Model` compId : `ComponentId` gateType : `GateComponentType` n : `int` Returns: `Symbol`	symModel : `Model` compId : `ComponentId` gateType : `GateComponentType` n : `int` Returns: `Symbol`
`changeInputValue symModel compId newVal` Full Usage: `changeInputValue symModel compId newVal` Parameters: symModel : `Model` compId : `ComponentId` newVal : `bigint` Returns: `Symbol`	This function should be called for Input1 components only. Sets the default value to be used in simulations for an Input1 component if it is not driven. symModel : `Model` compId : `ComponentId` newVal : `bigint` Returns: `Symbol`
`changeJoinNum symModel compId newNum` Full Usage: `changeJoinNum symModel compId newNum` Parameters: symModel : `Model` compId : `ComponentId` newNum : `int` Returns: `Symbol`	Set which channel a join uses. The width is left alone: a join carries both, and the properties pane edits them in two boxes. symModel : `Model` compId : `ComponentId` newNum : `int` Returns: `Symbol`
`changeLsbf symModel compId newLsb` Full Usage: `changeLsbf symModel compId newLsb` Parameters: symModel : `Model` compId : `ComponentId` newLsb : `bigint` Returns: `Symbol`	Helper function to change the number of bits expected in the LSB port of BusSelection and BusCompare symModel : `Model` compId : `ComponentId` newLsb : `bigint` Returns: `Symbol`
`changeMergeNComponent symModel compId numInputs` Full Usage: `changeMergeNComponent symModel compId numInputs` Parameters: symModel : `Model` compId : `ComponentId` numInputs : `int` Returns: `Symbol`	symModel : `Model` compId : `ComponentId` numInputs : `int` Returns: `Symbol`
`changeNumberOfBitsf symModel compId newBits` Full Usage: `changeNumberOfBitsf symModel compId newBits` Parameters: symModel : `Model` compId : `ComponentId` newBits : `int` Returns: `Symbol`	symModel : `Model` compId : `ComponentId` newBits : `int` Returns: `Symbol`
`changeReversedInputs symModel compId` Full Usage: `changeReversedInputs symModel compId` Parameters: symModel : `Model` compId : `ComponentId` Returns: `Symbol`	symModel : `Model` compId : `ComponentId` Returns: `Symbol`
`changeSplitNComponent symModel compId numOutputs widths lsbs` Full Usage: `changeSplitNComponent symModel compId numOutputs widths lsbs` Parameters: symModel : `Model` compId : `ComponentId` numOutputs : `int` widths : `int list` lsbs : `int list` Returns: `Symbol`	symModel : `Model` compId : `ComponentId` numOutputs : `int` widths : `int list` lsbs : `int list` Returns: `Symbol`
`createNewPort no hostID portType` Full Usage: `createNewPort no hostID portType` Parameters: no : `int` hostID : `ComponentId` portType : `PortType` Returns: `Port`	no : `int` hostID : `ComponentId` portType : `PortType` Returns: `Port`
`deleteNumberPort pType pNum sym` Full Usage: `deleteNumberPort pType pNum sym` Parameters: pType : `PortType` pNum : `int` sym : `Symbol` Returns: `Symbol`	remove the port specified by its type and number from the given symbol pType : `PortType` pNum : `int` sym : `Symbol` Returns: `Symbol`
`deletePorts pType pNumList sym` Full Usage: `deletePorts pType pNumList sym` Parameters: pType : `PortType` pNumList : `int list` sym : `Symbol` Returns: `Symbol`	delete ports specified by the list of port numbers must be in ascending order because otherwise wrong ports will be deleted pType : `PortType` pNumList : `int list` sym : `Symbol` Returns: `Symbol`
`portNoDown port` Full Usage: `portNoDown port` Parameters: port : `Port` Returns: `Port`	port : `Port` Returns: `Port`
`portNoUp port` Full Usage: `portNoUp port` Parameters: port : `Port` Returns: `Port`	port : `Port` Returns: `Port`
`resizedForLegend symbol` Full Usage: `resizedForLegend symbol` Parameters: symbol : `Symbol` Returns: `Symbol`	Helper function to change the number of bits expected in a port of each component type. A symbol whose width is worked out from the text it draws, redone after that text has changed. Only the IO of an array component needs it: its legend says its own name, its channel and its width - "Join[3].(7:0)" - so changing any of those changes how wide the symbol has to be, and nothing else in Issie has a size that depends on a field the Properties pane can edit. The symbol resized to fit the legend its CURRENT type gives it. Array IO carries its width in its legend rather than in a separate line of text, so changing a width changes how much text there is to fit and the symbol has to follow. Public so that a test can ask whether it does: the resize is invisible from the type alone, and a symbol whose text has outgrown it is exactly what nobody notices until they see it drawn. symbol : `Symbol` Returns: `Symbol`
`updateSymPortMaps newPortMaps newInputPorts newOutputPorts sym` Full Usage: `updateSymPortMaps newPortMaps newInputPorts newOutputPorts sym` Parameters: newPortMaps : `PortMaps` newInputPorts : `Port list` newOutputPorts : `Port list` sym : `Symbol` Returns: `Symbol`	newPortMaps : `PortMaps` newInputPorts : `Port list` newOutputPorts : `Port list` sym : `Symbol` Returns: `Symbol`
`varyNumberOfPorts pType numInPorts numOutPorts sym` Full Usage: `varyNumberOfPorts pType numInPorts numOutPorts sym` Parameters: pType : `PortType` numInPorts : `int` numOutPorts : `int` sym : `Symbol` Returns: `Symbol`	add and remove ports to obtain the given number of input and output ports the ports will be added at the highest index, as well as removed from the end of the port list pType : `PortType` numInPorts : `int` numOutPorts : `int` sym : `Symbol` Returns: `Symbol`
`withNumberOfBits newBits compType` Full Usage: `withNumberOfBits newBits compType` Parameters: newBits : `int` compType : `ComponentType` Returns: `ComponentType`	The component type with a different bus width, for every component that has one. Pure, and separate from the symbol it is applied to, so that "does a width change reach this component type" can be asked without a draw block model. It is worth asking: this match ends in a wildcard that returns the type UNCHANGED, so a component missing from it accepts a width typed into Properties and then silently throws it away - which is how the array IO components behaved until they were added below. newBits : `int` compType : `ComponentType` Returns: `ComponentType`