Community
+This presently just has the Announcements page, but more may be added in the future.
+Announcements
+*
+ + +
+
+
+ +
+
+
+
+
diff --git a/docs/DeveloperInfo.html b/docs/DeveloperInfo.html
new file mode 100644
index 0000000..427e272
--- /dev/null
+++ b/docs/DeveloperInfo.html
@@ -0,0 +1,64 @@
+
+
+
+
+ + If you encounter any problems using or downloading the software, please see the Gihub Issue page, or create a new issue on the ISSIE GitHub repository. + Any feedback and suggestions are also welcome! +
+ +
+
+
+ + +
+ + + +
+ + + +
+
+
+
+
diff --git a/docs/Download.html b/docs/Download.html
new file mode 100644
index 0000000..afb1686
--- /dev/null
+++ b/docs/Download.html
@@ -0,0 +1,62 @@
+
+
+
+
+ + Marco's Dissertation or his Poster. +
+ + +
-
+
- Issie is designed to be usable without needing a User Manual. Developer information can be found in the + Github README. + +
+ + + +
+ The project is hosted on Github where you can report issues, fork the project and submit pull + requests. Please take a look at the contribution guidelines for more information. Contact Tom Clarke + for more information about development. +
+ + + +
+
+
+ + +
+ + +
+
+
+
+
diff --git a/docs/UserGuide.html b/docs/UserGuide.html
new file mode 100644
index 0000000..3d52944
--- /dev/null
+++ b/docs/UserGuide.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+ Latest stable release: Click here for the latest GitHub release page, where the latest .zip and .tar file can be found.
+
+ Possibly unstable: Download latest master .zip
+
+ + +
+ Currently no known incompatibilities. Linux users can run the windows .zip file under WINE. + See Getting Started for information about how to run the binaries. +
+ + +
+ All releases: Click here
+
+
+ Latest release notes: Click here
+
+
+
+
+
+
+
diff --git a/docs/blog.md b/docs/blog.md
new file mode 100644
index 0000000..99a8091
--- /dev/null
+++ b/docs/blog.md
@@ -0,0 +1,2 @@
+
+
diff --git a/docs/community.html b/docs/community.html
new file mode 100644
index 0000000..cdc8329
--- /dev/null
+++ b/docs/community.html
@@ -0,0 +1,62 @@
+
+
+
+
+
+
+
+ Contents
+-
+
- + 1 Project Info + + +
- + 2 Components + + +
- + 3 Wires + + +
- 4 Width Inference +
- + 5 Circuit Simulation + + +
- 6 Verilog Output +
- 7 Memory Editor +
+
+ CURRENTLY IN PROGRESS, CHECK BACK SOON! +
+
+
+
+
+
diff --git a/docs/img/communityAnnouncements.png b/docs/img/communityAnnouncements.png
new file mode 100644
index 0000000..c662b40
Binary files /dev/null and b/docs/img/communityAnnouncements.png differ
diff --git a/docs/img/faceToolsActions.png b/docs/img/faceToolsActions.png
new file mode 100644
index 0000000..8b095fc
Binary files /dev/null and b/docs/img/faceToolsActions.png differ
diff --git a/docs/img/faceToolsProfiles.png b/docs/img/faceToolsProfiles.png
new file mode 100644
index 0000000..64dcc4e
Binary files /dev/null and b/docs/img/faceToolsProfiles.png differ
diff --git a/docs/img/fake.png b/docs/img/fake.png
new file mode 100644
index 0000000..8b33cdf
Binary files /dev/null and b/docs/img/fake.png differ
diff --git a/docs/img/logo-template.pdn b/docs/img/logo-template.pdn
new file mode 100644
index 0000000..52606f5
Binary files /dev/null and b/docs/img/logo-template.pdn differ
diff --git a/docs/img/logo.png b/docs/img/logo.png
new file mode 100644
index 0000000..3b8d6f9
Binary files /dev/null and b/docs/img/logo.png differ
diff --git a/docs/img/modAvailable.png b/docs/img/modAvailable.png
new file mode 100644
index 0000000..2f8ba0b
Binary files /dev/null and b/docs/img/modAvailable.png differ
diff --git a/docs/img/modInstalled.png b/docs/img/modInstalled.png
new file mode 100644
index 0000000..43afed9
Binary files /dev/null and b/docs/img/modInstalled.png differ
diff --git a/docs/img/modInstalling.png b/docs/img/modInstalling.png
new file mode 100644
index 0000000..ab9f5b7
Binary files /dev/null and b/docs/img/modInstalling.png differ
diff --git a/docs/img/mordhauConfig.png b/docs/img/mordhauConfig.png
new file mode 100644
index 0000000..0f47134
Binary files /dev/null and b/docs/img/mordhauConfig.png differ
diff --git a/docs/img/settings.png b/docs/img/settings.png
new file mode 100644
index 0000000..c211fab
Binary files /dev/null and b/docs/img/settings.png differ
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..36e1dbf
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,198 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+ Contributing
+Branching
+-
+
- Create a feature branch in git. +
- Fork and clone locally. +
Style Guidelines
+-
+
- Follow F# Coding Guidelines. +
- Take into consideration FSharpLint output. +
- Fantomas should be run to ensure formatting is consistent. +
Testing
+Testing is done in the tests libraries using Expecto which is able to load in any +testing framework you may need, but is strongly encouraged to keep things consistent and use Expecto tests and FsCheck +for any property-based testing.
+-
+
- Add test cases where needed. +
- Tests are run as part of the build process, please ensure they pass. +
- Note that pure F# should be tested - GUI cannot easily be tested. +
Documentation
+Documentation is built dynamically from F# script files and markdown files using FSharp.Formatting.
+The Reference documentation is dynamically generated, and descriptions specified by using /// rather than // for comments, see the Formatting documentation
+for more information.
-
+
- Add documentation as necessary, pages can be modified and created in the
./docsrcdirectory.
+ - Documentation is built during the build process. +
- Consider adding examples if adding new features. +
- Markdown Syntax +
Building
+-
+
- Build the solution with Visual Studio,
build.cmdorbuild.sh.
+ - All binaries will be in
./binafter being built.
+ - +When you're ready to commit the code use `build.cmd/sh -t "Release". This will clean up directories, stage, +and build everything for release. Once you've confirmed it looks good, commit to your branch and make your PR. + +
- Please note in order to build the Linux images you must have
Dockerinstalled.
+
Releasing
+-
+
-
+Create the distributables via the
Distbuild task, then create the delta and sig files with theCreateDiffstask. Upload all of the files +related to the new version to the release. +
+
+
+
+
+ 
+
+
+ Merging
+-
+
- Send a pull request and have it reviewed. +
+
+
+
+
+
+
+
+
+
Discover, Learn & Create with the ISSIE circuit schematic editor!
+
+ About ISSIE
+ Acknowledgements
+
+ +
+
+ + +
+ + +
+
+
+
+ + +
+ + + +
+
+ + + +
+ + + +
+
+ + + +
+
+ +
+ +
+ + + + +
+ + +
+
+ + +
+ + +
+
+
+
+
diff --git a/docs/marco-poster.pdf b/docs/marco-poster.pdf
new file mode 100644
index 0000000..b49578f
Binary files /dev/null and b/docs/marco-poster.pdf differ
diff --git a/docs/marco-report.pdf b/docs/marco-report.pdf
new file mode 100644
index 0000000..e281d73
Binary files /dev/null and b/docs/marco-report.pdf differ
diff --git a/docs/reference/bustypes-componentid.html b/docs/reference/bustypes-componentid.html
new file mode 100644
index 0000000..cd921e7
--- /dev/null
+++ b/docs/reference/bustypes-componentid.html
@@ -0,0 +1,93 @@
+
+
+
+
+ + + +
+ Issie (Interactive Schematic Simulator and Integrated Editor) is a very easy to use and capable hierarchical block schematic based digital logic editor and simulator, + originally made for the 1st year undergraduate Digital Electronics and Computer Architecture module at the + Department of Electronic and Electrical Engineering, Imperial College London, by 3rd year students at the same institution. +
++ Issie has been well tested on designs with up to 15,000 schematic components. We expect it to be reasonably performant on much larger designs as well. + The simulation speed is approximately 2000 component-clocks per ms. Thus a circuit with 1000 components would run at 2000 clocks per second. Issie + creates fully synchronous circuits with a single clock: logic with asynchronous loops is currently not supported. +
++ Issie is coded in F# transpiled to Javascript by FABLE, and uses a pure F# drawing library. +
+ + +
+
+
+
+
+ Contents
+ ++ ISSIE has an extensive and complete library of components available in the 'Catalogue' menu. + Components include low-level gates and flipflops as + well as larger blocks: RAMs, ROMs, n-bit registers and adders. The lack of HDL-based combinational logic is partly filled by + special components: Bus Select (extracts a bit-field), Bus Compare (decodes a min-term of a bus). Components defined as Verilog + combinational logic are a likely future addition. +
+
+ Viewer components are used to (optionally) view simulation waveforms of nodes on subsheets. Wire label components allow any number of + nodes on one design sheet to be connected without visible wires. +
+
+ 
+
+ + + +
+ ISSIE schematic component ports are connected using drag-and-drop: each connection represents a wire or bus. + ISSIE has two methods of routing wires: Auto-routing and Manual-routing. Wires will all start out as Auto-routed, + which means that the wire's path is created automatically by the program. This path will update when moving any connected components. + ISSIE also allows for manual routing, where the user may manipulate segments of the wire as desired to make the circuit more readable. Effort has + been put into making this functionality intuitive, with automatic reversion to auto-routing when wire topology changes, and auto-routing of + endpoints when parts of a wire are manually routed. +
+ + + +
+ Wires will automatically be created the correct width using a width inference algorithm. + Wires connecting two ports of incompatible widths will be highlighted red and an error message shown, as will multiply driven wires. + Additional sanity checks (e.g. for combinational loops, or unconnected ports) are made before simulation with errors highlighted visually. +
+
+ 
+
+ + + + +
+ ISSIE includes two simulations in order to inspect and test circuit schematics: The step simulator, and waveform simulator. + This allows users to visualise the information in different ways to best suit their needs and understanding. +
+ + + +
+ Step Simulation allows the user to 'step' or cycle through each clock tick, and view the current design sheet's Output and Viewer component information. + It also allows users to view how the state changes in stateful components such as RAM. +
+
+ 
+
+ + + + +
+ Waveform Simulation allows the user to see the values in each selected connected circuit element (Netlist) over time as a waveform. + The waveform simulator allows users to move waveforms up/down in the list to make the simulation more readable. + Users may cycle through the simulator using the arrows to directly go to a specific clock cycle. + Alternatively there is a scrollbar for the Waveform simulator that will automatically lengthen the simulation once the end is reached. + The values in the waveform simulator can be viewed in various formats: binary, hexadecimal, unsigned decimal and signed decimal. + The Waveform Simulator also features a draggable sidebar to partition screen space dynamically between waveforms and circuit. +
+
+ 
+
+ + +
+ Waveform Simulation also allows for the simulation and contents viewing of memory components such as RAM. +
+ +
+ 
+
+ + + + + +
+ Users may convert their ISSIE schematic design into a Verilog file using the 'Write design as verilog' option found in the header bar of the application. + This allows great flexibility as ISSIE designs may be used in more complex design tools and other programs that use Verilog; + allowing ISSIE to be used as a top-level design that can be further developed if needed. Verilog output for simulation or synthesis is documented + as part of the Verilog write process, this includes links to a [YoSys](http://bygone.clairexen.net/yosys/download.html) workflow for synthesis on FPGAs. + Imperial College users can download a pre-installed VM for this workflow, the VHDL output is standalone and should work with other synthesis methods. +
+ + +
+ ISSIE allows users to directly edit the contents of Memory components, for more versitility and ease of use. Memory contents can also be exported and imported via .ram files. +
+
+ 
+
+ + + +
+ + +
-
+
- Marco Selvatici for the 8K lines of base code written for his 3rd year BEng FYP +
- Edoardo Santi for work improving Issie over Summer 2020. +
- High Level Programming 2020 cohort for providing the base code of the draw block +
- Jo Merrick for work improving ISSIE for her 3rd year BEng Project +
- Dr Tom Clarke for his continued work maintaining and improving ISSIE throughout +
- All 2020/2021 1st year undergraduate students of the EEE department, Imperial College London, for acting as unpaid beta-testers! +
+
+ +
+
+
diff --git a/docs/reference/bustypes-connectionid.html b/docs/reference/bustypes-connectionid.html
new file mode 100644
index 0000000..5bb3412
--- /dev/null
+++ b/docs/reference/bustypes-connectionid.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/bustypes-connectionswidth.html b/docs/reference/bustypes-connectionswidth.html
new file mode 100644
index 0000000..04b3493
--- /dev/null
+++ b/docs/reference/bustypes-connectionswidth.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+
+
+
diff --git a/docs/reference/bustypes-inputportid.html b/docs/reference/bustypes-inputportid.html
new file mode 100644
index 0000000..a99e69f
--- /dev/null
+++ b/docs/reference/bustypes-inputportid.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ ConnectionsWidth
+
+
+ Namespace: global
+ Parent Module: BusTypes
+
+
+ Instance members
+| Instance member | Description |
+
+
+ x.Count
+
+
+ Signature: int
+ + |
+
+
+ CompiledName: |
+
+
+
+ x.IsEmpty
+
+
+ Signature: bool
+ + |
+
+
+ CompiledName: |
+
+
+
+ [key]
+
+
+ Signature: key:ConnectionId -> int option
+ + |
+
+
+ CompiledName: |
+
+
+
+
+
+ +
+
+
diff --git a/docs/reference/bustypes-inputportnumber.html b/docs/reference/bustypes-inputportnumber.html
new file mode 100644
index 0000000..ac368c9
--- /dev/null
+++ b/docs/reference/bustypes-inputportnumber.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/bustypes-outputportid.html b/docs/reference/bustypes-outputportid.html
new file mode 100644
index 0000000..29c9e40
--- /dev/null
+++ b/docs/reference/bustypes-outputportid.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/bustypes-outputportnumber.html b/docs/reference/bustypes-outputportnumber.html
new file mode 100644
index 0000000..d9dd58e
--- /dev/null
+++ b/docs/reference/bustypes-outputportnumber.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/bustypes-widthinfererror.html b/docs/reference/bustypes-widthinfererror.html
new file mode 100644
index 0000000..f28a0d4
--- /dev/null
+++ b/docs/reference/bustypes-widthinfererror.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/commontypes-canvasstate.html b/docs/reference/commontypes-canvasstate.html
new file mode 100644
index 0000000..03a97ee
--- /dev/null
+++ b/docs/reference/commontypes-canvasstate.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+
+
+
diff --git a/docs/reference/commontypes-component.html b/docs/reference/commontypes-component.html
new file mode 100644
index 0000000..5b48fa6
--- /dev/null
+++ b/docs/reference/commontypes-component.html
@@ -0,0 +1,241 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ CanvasState
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ F# data describing the contents of a single schematic sheet.
+ +Instance members
+| Instance member | Description |
+
+
+ x.Item1
+
+
+ Signature: Component list
+ + |
+ + + | +
+
+
+ x.Item2
+
+
+ Signature: Connection list
+ + |
+ + + | +
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-componenttype.html b/docs/reference/commontypes-componenttype.html
new file mode 100644
index 0000000..f65be66
--- /dev/null
+++ b/docs/reference/commontypes-componenttype.html
@@ -0,0 +1,507 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Component
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ JSComponent mapped to F# record. +Id uniquely identifies the component within a sheet and is used by draw2d library. +Label is optional descriptor displayed on schematic.
+ +Record Fields
+| Record Field | Description |
+
+
+ H
+
+
+ Signature: int
+ + |
+
+
+ 
+ 
+
+
+ |
+
+
+
+ Id
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ InputPorts
+
+
+ Signature: Port list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Label
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ OutputPorts
+
+
+ Signature: Port list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Type
+
+
+ Signature: ComponentType
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ W
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ X
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Y
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-connection.html b/docs/reference/commontypes-connection.html
new file mode 100644
index 0000000..527fb5c
--- /dev/null
+++ b/docs/reference/commontypes-connection.html
@@ -0,0 +1,150 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ ComponentType
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ And
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ AsyncROM(Memory)
+
+
+ Signature: Memory
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ BusSelection(OutputWidth,OutputLSBit)
+
+
+ Signature: int * int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Custom(CustomComponentType)
+
+
+ Signature: CustomComponentType
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Demux2
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ DFF
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ DFFE
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Input(BusWidth)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ IOLabel
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ MergeWires
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Mux2
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Nand
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ NbitsAdder(BusWidth)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Nor
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Not
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Or
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Output(BusWidth)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ RAM(Memory)
+
+
+ Signature: Memory
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Register(BusWidth)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ RegisterE(BusWidth)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ROM(Memory)
+
+
+ Signature: Memory
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SplitWire(BusWidth)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Xnor
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Xor
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-customcomponenttype.html b/docs/reference/commontypes-customcomponenttype.html
new file mode 100644
index 0000000..10b621d
--- /dev/null
+++ b/docs/reference/commontypes-customcomponenttype.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Connection
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ JSConnection mapped to F# record. +Id uniquely identifies connection globally and is used by library.
+ +Record Fields
+| Record Field | Description |
+
+
+ Id
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Source
+
+
+ Signature: Port
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Target
+
+
+ Signature: Port
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Vertices
+
+
+ Signature: (float * float) list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-loadedcomponent.html b/docs/reference/commontypes-loadedcomponent.html
new file mode 100644
index 0000000..aa263c5
--- /dev/null
+++ b/docs/reference/commontypes-loadedcomponent.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ CustomComponentType
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ Name identified the LoadedComponent used. +The labels define legends on symbol. +Label strings are unique per CustomComponent. +Multiple CustomComponent instances are differentiated by Component data.
+ +Record Fields
+| Record Field | Description |
+
+
+ InputLabels
+
+
+ Signature: (string * int) list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Name
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ OutputLabels
+
+
+ Signature: (string * int) list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-memory.html b/docs/reference/commontypes-memory.html
new file mode 100644
index 0000000..e79411f
--- /dev/null
+++ b/docs/reference/commontypes-memory.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ LoadedComponent
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ Static data describing a schematic sheet loaded as a custom component. +Every sheet is always identified with a file from which it is loaded/saved. +Name is human readable (and is the filename - without extension) and identifies sheet. +File path is the sheet directory and name (with extension). +InputLabels, OutputLabels are the I/O connections. +The I/O connection integers are bus widths. +The I/O connection strings are human readable. The strings are guaranteed +to be unique in the I/O connection list. I.e. An input label may be the same +as an output label, but two input (or output) labels cannot be the same. +The position in the I/O connections list is important as it implicitly +indicates the port number. For example, the first element in the InputLabels +list is related to the Component's Port with PortNumber 0. +Two instances of a loaded component have the same LoadedComponent data.
+ +Record Fields
+| Record Field | Description |
+
+
+ CanvasState
+
+
+ Signature: CanvasState
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ FilePath
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ InputLabels
+
+
+ Signature: (string * int) list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Name
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ OutputLabels
+
+
+ Signature: (string * int) list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-numberbase.html b/docs/reference/commontypes-numberbase.html
new file mode 100644
index 0000000..20b0e7b
--- /dev/null
+++ b/docs/reference/commontypes-numberbase.html
@@ -0,0 +1,147 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Memory
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ AddressWidth
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Data
+
+
+ Signature: int64 list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ WordWidth
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-port.html b/docs/reference/commontypes-port.html
new file mode 100644
index 0000000..0cf6200
--- /dev/null
+++ b/docs/reference/commontypes-port.html
@@ -0,0 +1,158 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ NumberBase
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ Bin
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Dec
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Hex
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SDec
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-porttype.html b/docs/reference/commontypes-porttype.html
new file mode 100644
index 0000000..b1d3105
--- /dev/null
+++ b/docs/reference/commontypes-porttype.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Port
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ A component I/O. +Id (like any other Id) is a string generated with 32 random hex charactes, +so it is (practically) globally unique. These Ids are used by the draw2d +library to uniquely refer to ports and components. They are generated via: +http://www.draw2d.org/draw2d_touch/jsdoc_6/#!/api/draw2d.util.UUID. +PortNumber is used to identify which port on a component, contiguous from 0 +separately for inputs and outputs. +HostId is the unique Id of the component where the port is. For example, +all three ports on the same And component will have the same HostId.
+ +Record Fields
+| Record Field | Description |
+
+
+ HostId
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Id
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ PortNumber
+
+
+ Signature: int option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ PortType
+
+
+ Signature: PortType
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/commontypes-project.html b/docs/reference/commontypes-project.html
new file mode 100644
index 0000000..2857022
--- /dev/null
+++ b/docs/reference/commontypes-project.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ PortType
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ Input
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Output
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammessagetype-jsdiagrammsg.html b/docs/reference/diagrammessagetype-jsdiagrammsg.html
new file mode 100644
index 0000000..b4fc612
--- /dev/null
+++ b/docs/reference/diagrammessagetype-jsdiagrammsg.html
@@ -0,0 +1,165 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Project
+
+
+ Namespace: global
+ Parent Module: CommonTypes
+
+
+ Type for an open project which represents a complete design. +ProjectPath is directory containing project files. +OpenFileName is name of file from which current schematic sheet is loaded/saved. +LoadedComponents contains the list of schematic sheets, each as a component, one per sheet.
+ +Record Fields
+| Record Field | Description |
+
+
+ LoadedComponents
+
+
+ Signature: LoadedComponent list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ OpenFileName
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ProjectPath
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammessagetype-keyboardshortcutmsg.html b/docs/reference/diagrammessagetype-keyboardshortcutmsg.html
new file mode 100644
index 0000000..d3aedfc
--- /dev/null
+++ b/docs/reference/diagrammessagetype-keyboardshortcutmsg.html
@@ -0,0 +1,165 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ JSDiagramMsg
+
+
+ Namespace: global
+ Parent Module: DiagramMessageType
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ InferWidths(unit)
+
+
+ Signature: unit
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ InitCanvas(JSCanvas)
+
+
+ Signature: JSCanvas
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SelectComponent(JSComponent)
+
+
+ Signature: JSComponent
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetHasUnsavedChanges(bool)
+
+
+ Signature: bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ UnselectComponent(unit)
+
+
+ Signature: unit
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammessagetype-memoryeditordata.html b/docs/reference/diagrammessagetype-memoryeditordata.html
new file mode 100644
index 0000000..bdd0968
--- /dev/null
+++ b/docs/reference/diagrammessagetype-memoryeditordata.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ KeyboardShortcutMsg
+
+
+ Namespace: global
+ Parent Module: DiagramMessageType
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ AltC
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ AltShiftZ
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ AltV
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ AltZ
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CtrlS
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammessagetype-msg.html b/docs/reference/diagrammessagetype-msg.html
new file mode 100644
index 0000000..c8774f7
--- /dev/null
+++ b/docs/reference/diagrammessagetype-msg.html
@@ -0,0 +1,759 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ MemoryEditorData
+
+
+ Namespace: global
+ Parent Module: DiagramMessageType
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ Address
+
+
+ Signature: int option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ NumberBase
+
+
+ Signature: NumberBase
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ OnlyDiff
+
+
+ Signature: bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammessagetype-popupdialogdata.html b/docs/reference/diagrammessagetype-popupdialogdata.html
new file mode 100644
index 0000000..2f36e52
--- /dev/null
+++ b/docs/reference/diagrammessagetype-popupdialogdata.html
@@ -0,0 +1,167 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Msg
+
+
+ Namespace: global
+ Parent Module: DiagramMessageType
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ AddWaveSimFile(string,WaveSimModel)
+
+
+ Signature: string * WaveSimModel
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ChangeRightTab(RightTab)
+
+
+ Signature: RightTab
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CloseDiagramNotification
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CloseFilesNotification
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CloseMemoryEditorNotification
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ClosePopup
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CloseProject
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ClosePropertiesNotification
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CloseSimulationNotification
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CloseWaveSimNotification
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ EndSimulation
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ IncrementSimulationClockTick
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ JSDiagramMsg(JSDiagramMsg)
+
+
+ Signature: JSDiagramMsg
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ KeyboardShortcutMsg(KeyboardShortcutMsg)
+
+
+ Signature: KeyboardShortcutMsg
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ MenuAction(MenuCommand,Msg -> unit)
+
+
+ Signature: MenuCommand * Msg -> unit
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ReloadSelectedComponent(int)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SelectionHasChanged
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetClipboard(CanvasState)
+
+
+ Signature: CanvasState
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetCreateComponent(Component)
+
+
+ Signature: Component
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetDragMode(DragMode)
+
+
+ Signature: DragMode
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetFilesNotification(...)
+
+
+ Signature: (Msg -> unit) -> (type)
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetHighlighted(...)
+
+
+ Signature: ComponentId list * ConnectionId list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetMemoryEditorNotification(...)
+
+
+ Signature: (Msg -> unit) -> (type)
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetPopupDialogInt(int option)
+
+
+ Signature: int option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetPopupDialogMemorySetup(...)
+
+
+ Signature: (int * int) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetPopupDialogText(string option)
+
+
+ Signature: string option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetPopupDialogTwoInts(...)
+
+
+ Signature: int option * IntMode
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetPopupMemoryEditorData(...)
+
+
+ Signature: MemoryEditorData option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetProject(Project)
+
+
+ Signature: Project
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetPropertiesNotification(...)
+
+
+ Signature: (Msg -> unit) -> (type)
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetSimulationBase(NumberBase)
+
+
+ Signature: NumberBase
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetSimulationGraph(SimulationGraph)
+
+
+ Signature: SimulationGraph
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetSimulationNotification(...)
+
+
+ Signature: (Msg -> unit) -> (type)
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetTopMenu(TopMenu)
+
+
+ Signature: TopMenu
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SetViewerWidth(int)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ShowPopup(PopupDialogData -> (type))
+
+
+ Signature: PopupDialogData -> (type)
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ StartSimulation(...)
+
+
+ Signature: Result<SimulationData,SimulationError>
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ StartWaveSim(...)
+
+
+ Signature: Result<WaveSimModel,SimulationError option>
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammessagetype-righttab.html b/docs/reference/diagrammessagetype-righttab.html
new file mode 100644
index 0000000..2623365
--- /dev/null
+++ b/docs/reference/diagrammessagetype-righttab.html
@@ -0,0 +1,147 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ PopupDialogData
+
+
+ Namespace: global
+ Parent Module: DiagramMessageType
+
+
+ Possible fields that may (or may not) be used in a dialog popup.
+ +Record Fields
+| Record Field | Description |
+
+
+ Int
+
+
+ Signature: int option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Int2
+
+
+ Signature: int option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ MemoryEditorData
+
+
+ Signature: MemoryEditorData option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ MemorySetup
+
+
+ Signature: (int * int) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Text
+
+
+ Signature: string option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammessagetype-topmenu.html b/docs/reference/diagrammessagetype-topmenu.html
new file mode 100644
index 0000000..4c6abb6
--- /dev/null
+++ b/docs/reference/diagrammessagetype-topmenu.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ RightTab
+
+
+ Namespace: global
+ Parent Module: DiagramMessageType
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ Catalogue
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Properties
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Simulation
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ WaveSim
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammessagetype-wavesimmodel.html b/docs/reference/diagrammessagetype-wavesimmodel.html
new file mode 100644
index 0000000..2b1c1ec
--- /dev/null
+++ b/docs/reference/diagrammessagetype-wavesimmodel.html
@@ -0,0 +1,273 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ TopMenu
+
+
+ Namespace: global
+ Parent Module: DiagramMessageType
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ Closed
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Files
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Project
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammodeltype-model.html b/docs/reference/diagrammodeltype-model.html
new file mode 100644
index 0000000..e7a8ed2
--- /dev/null
+++ b/docs/reference/diagrammodeltype-model.html
@@ -0,0 +1,417 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ WaveSimModel
+
+
+ Namespace: global
+ Parent Module: DiagramMessageType
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ ClkWidth
+
+
+ Signature: float
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Cursor
+
+
+ Signature: uint32
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ LastCanvasState
+
+
+ Signature: JSCanvasState option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ LastClk
+
+
+ Signature: uint32
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Ports
+
+
+ Signature: WaveSimPort array
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Radix
+
+
+ Signature: NumberBase
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Selected
+
+
+ Signature: bool array
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SimData
+
+
+ Signature: SimulationData array
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ WaveAdder
+
+
+ Signature: WaveAdderModel
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ WaveData
+
+
+ Signature: SimTime array
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ WaveNames
+
+
+ Signature: WaveName array
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/diagrammodeltype-notifications.html b/docs/reference/diagrammodeltype-notifications.html
new file mode 100644
index 0000000..7fb34f3
--- /dev/null
+++ b/docs/reference/diagrammodeltype-notifications.html
@@ -0,0 +1,183 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Model
+
+
+ Namespace: global
+ Parent Module: DiagramModelType
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ Clipboard
+
+
+ Signature: CanvasState
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CreateComponent
+
+
+ Signature: Component option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CurrentSelected
+
+
+ Signature: Component list * Connection list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ CurrProject
+
+
+ Signature: Project option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Diagram
+
+
+ Signature: Draw2dWrapper
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ DragMode
+
+
+ Signature: DragMode
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ HasUnsavedChanges
+
+
+ Signature: bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Hilighted
+
+
+ Signature: ComponentId list * ConnectionId list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ LastSelected
+
+
+ Signature: Component list * Connection list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ LastUsedDialogWidth
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Notifications
+
+
+ Signature: Notifications
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Popup
+
+
+ Signature: (PopupDialogData -> (type)) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ PopupDialogData
+
+
+ Signature: PopupDialogData
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ RightTab
+
+
+ Signature: RightTab
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ SelectedComponent
+
+
+ Signature: Component option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Simulation
+
+
+ Signature: Result<SimulationData,SimulationError> option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ TopMenu
+
+
+ Signature: TopMenu
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ViewerWidth
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ WaveSim
+
+
+ Signature: Map<string,WaveSimModel> * SimulationError option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/draw2dwrapper-displaymodetype.html b/docs/reference/draw2dwrapper-displaymodetype.html
new file mode 100644
index 0000000..fe01b48
--- /dev/null
+++ b/docs/reference/draw2dwrapper-displaymodetype.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Notifications
+
+
+ Namespace: global
+ Parent Module: DiagramModelType
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ FromDiagram
+
+
+ Signature: ((Msg -> unit) -> (type)) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ FromFiles
+
+
+ Signature: ((Msg -> unit) -> (type)) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ FromMemoryEditor
+
+
+ Signature: ((Msg -> unit) -> (type)) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ FromProperties
+
+
+ Signature: ((Msg -> unit) -> (type)) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ FromSimulation
+
+
+ Signature: ((Msg -> unit) -> (type)) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ FromWaveSim
+
+
+ Signature: ((Msg -> unit) -> (type)) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/filesio-jsonhelpers.html b/docs/reference/filesio-jsonhelpers.html
new file mode 100644
index 0000000..8d3850a
--- /dev/null
+++ b/docs/reference/filesio-jsonhelpers.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ DisplayModeType
+
+
+ Namespace: global
+ Parent Module: Draw2dWrapper
+
+
+ Determines size of schematic. +ToDo - make this more flexible and expose sizes
+ +Union Cases
+| Union Case | Description |
+
+
+ DispMode((type))
+
+
+ Signature: (type)
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-bustypes.html b/docs/reference/global-bustypes.html
new file mode 100644
index 0000000..e26c6b9
--- /dev/null
+++ b/docs/reference/global-bustypes.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ JsonHelpers
+
+ Namespace: global
+ Parent Module: FilesIO
+
+ Attributes:
+[<AutoOpen>]
+
+
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ jsonStringToState(jsonString)
+
+
+ Signature: jsonString:string -> Result<CanvasState,string>
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ stateToJsonString(arg1, arg2)
+
+
+ Signature: (Component list * Connection list) -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-buswidthinferer.html b/docs/reference/global-buswidthinferer.html
new file mode 100644
index 0000000..3a36a77
--- /dev/null
+++ b/docs/reference/global-buswidthinferer.html
@@ -0,0 +1,116 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+ BusTypes
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+
+ | Type | Description |
| + ComponentId + | ++ + | +
| + ConnectionId + | ++ + | +
| + ConnectionsWidth + | ++ + | +
| + InputPortId + | ++ + | +
| + InputPortNumber + | ++ + | +
| + OutputPortId + | ++ + | +
| + OutputPortNumber + | ++ + | +
| + WidthInferError + | ++ + | +
+
+
+
+
+
+
+
diff --git a/docs/reference/global-canvasstateanalyser.html b/docs/reference/global-canvasstateanalyser.html
new file mode 100644
index 0000000..5738a98
--- /dev/null
+++ b/docs/reference/global-canvasstateanalyser.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ BusWidthInferer
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ getConnectionWidth(...)
+
+
+ Signature: connectionsWidth:ConnectionsWidth -> connId:ConnectionId -> int option
+ + |
+
+
+
+
+
+ Lookup the width of a connection in the connectionsWidth map or fail. + + + |
+
+
+
+ inferConnectionsWidth(arg1, arg2)
+
+
+ Signature: (Component list * Connection list) -> Result<ConnectionsWidth,WidthInferError>
+ + |
+
+
+
+
+
+ Infer width of all connections or return an error + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-commontypes.html b/docs/reference/global-commontypes.html
new file mode 100644
index 0000000..ea4efe4
--- /dev/null
+++ b/docs/reference/global-commontypes.html
@@ -0,0 +1,268 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ CanvasStateAnalyser
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+ | Type | Description |
| + MapData + | +
+ Return all the Ids of all input ports across all components. +Return also the ComponentId which may be used in error messages. + + + |
+
Functions and values
+| Function or value | Description |
+
+
+ analyseState(arg1, arg2)
+
+
+ Signature: (Component list * Connection list) -> SimulationError option
+ + |
+
+
+
+
+
+ Analyse a CanvasState and return any error (or None). + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-dependencymerger.html b/docs/reference/global-dependencymerger.html
new file mode 100644
index 0000000..d112c73
--- /dev/null
+++ b/docs/reference/global-dependencymerger.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ CommonTypes
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+ | Type | Description |
| + CanvasState + | +
+ F# data describing the contents of a single schematic sheet. + + + |
+
| + Component + | +
+ JSComponent mapped to F# record. +Id uniquely identifies the component within a sheet and is used by draw2d library. +Label is optional descriptor displayed on schematic. + + + |
+
| + ComponentType + | ++ + | +
| + Connection + | +
+ JSConnection mapped to F# record. +Id uniquely identifies connection globally and is used by library. + + + |
+
| + CustomComponentType + | +
+ Name identified the LoadedComponent used. +The labels define legends on symbol. +Label strings are unique per CustomComponent. +Multiple CustomComponent instances are differentiated by Component data. + + + |
+
| + HighLightColor + | +
+ Colors to highlight components +Case name is used (lowercase) as HTML color name +See JSHelpers.getColorString +lots of colors can be added, see https://www.w3schools.com/colors/colors_names.asp + + + |
+
| + LoadedComponent + | +
+ Static data describing a schematic sheet loaded as a custom component. +Every sheet is always identified with a file from which it is loaded/saved. +Name is human readable (and is the filename - without extension) and identifies sheet. +File path is the sheet directory and name (with extension). +InputLabels, OutputLabels are the I/O connections. +The I/O connection integers are bus widths. +The I/O connection strings are human readable. The strings are guaranteed +to be unique in the I/O connection list. I.e. An input label may be the same +as an output label, but two input (or output) labels cannot be the same. +The position in the I/O connections list is important as it implicitly +indicates the port number. For example, the first element in the InputLabels +list is related to the Component's Port with PortNumber 0. +Two instances of a loaded component have the same LoadedComponent data. + + + |
+
| + Memory + | ++ + | +
| + NumberBase + | ++ + | +
| + Port + | +
+ A component I/O. +Id (like any other Id) is a string generated with 32 random hex charactes, +so it is (practically) globally unique. These Ids are used by the draw2d +library to uniquely refer to ports and components. They are generated via: +http://www.draw2d.org/draw2d_touch/jsdoc_6/#!/api/draw2d.util.UUID. +PortNumber is used to identify which port on a component, contiguous from 0 +separately for inputs and outputs. +HostId is the unique Id of the component where the port is. For example, +all three ports on the same And component will have the same HostId. + + + |
+
| + PortType + | ++ + | +
| + Project + | +
+ Type for an open project which represents a complete design. +ProjectPath is directory containing project files. +OpenFileName is name of file from which current schematic sheet is loaded/saved. +LoadedComponents contains the list of schematic sheets, each as a component, one per sheet. + + + |
+
Functions and values
+| Function or value | Description |
+
+
+ draw2dCanvasHeight
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ draw2dCanvasWidth
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-diagrammessagetype.html b/docs/reference/global-diagrammessagetype.html
new file mode 100644
index 0000000..4f054c4
--- /dev/null
+++ b/docs/reference/global-diagrammessagetype.html
@@ -0,0 +1,285 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ DependencyMerger
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ mergeDependencies(...)
+
+
+ Signature: currDiagramName:string -> graph:SimulationGraph -> (Component list * Connection list) -> loadedDependencies:LoadedComponent list -> Result<SimulationGraph,SimulationError>
+ + |
+
+
+
+
+
+ Try to resolve all the dependencies in a graph, and replace the reducer +of the custom components with a simulationgraph. +Return an error if there are problems with the dependencies. +For example, if the graph of an ALU refers to custom component such as +adders, replace them with the actual simulation graph for the adders. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-diagrammodeltype.html b/docs/reference/global-diagrammodeltype.html
new file mode 100644
index 0000000..7e07417
--- /dev/null
+++ b/docs/reference/global-diagrammodeltype.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ DiagramMessageType
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+ | Type | Description |
| + DiagEl + | ++ + | +
| + DragMode + | ++ + | +
| + IntMode + | ++ + | +
| + JSDiagramMsg + | ++ + | +
| + KeyboardShortcutMsg + | ++ + | +
| + MemoryEditorData + | ++ + | +
| + MenuCommand + | ++ + | +
| + Msg + | ++ + | +
| + PopupDialogData + | +
+ Possible fields that may (or may not) be used in a dialog popup. + + + |
+
| + RightTab + | ++ + | +
| + Sample + | ++ + | +
| + SimTime + | ++ + | +
| + StateSample + | ++ + | +
| + TopMenu + | ++ + | +
| + WaveAdderModel + | ++ + | +
| + WaveName + | ++ + | +
| + WaveSimModel + | ++ + | +
| + WaveSimPort + | ++ + | +
| + Waveform + | ++ + | +
| + Wire + | ++ + | +
Functions and values
+| Function or value | Description |
+
+
+ initWA
+
+
+ Signature: WaveAdderModel
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ initWS
+
+
+ Signature: WaveSimModel
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-draw2dwrapper.html b/docs/reference/global-draw2dwrapper.html
new file mode 100644
index 0000000..b8037ce
--- /dev/null
+++ b/docs/reference/global-draw2dwrapper.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+ DiagramModelType
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+
+ | Type | Description |
| + Model + | ++ + | +
| + Notifications + | ++ + | +
+
+
+
+
+
+
+
diff --git a/docs/reference/global-extractor.html b/docs/reference/global-extractor.html
new file mode 100644
index 0000000..830821f
--- /dev/null
+++ b/docs/reference/global-extractor.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+ Draw2dWrapper
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+
+ | Type | Description |
| + DisplayModeType + | +
+ Determines size of schematic. +ToDo - make this more flexible and expose sizes + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-filemenuview.html b/docs/reference/global-filemenuview.html
new file mode 100644
index 0000000..30d7245
--- /dev/null
+++ b/docs/reference/global-filemenuview.html
@@ -0,0 +1,573 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Extractor
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ extractComponent(jsComponent)
+
+
+ Signature: jsComponent:JSComponent -> Component
+ + |
+
+
+
+
+
+ Transform a JSComponent into an f# data structure. + + + |
+
+
+
+ extractConnection(jsConnection)
+
+
+ Signature: jsConnection:JSConnection -> Connection
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ extractState(arg1, arg2)
+
+
+ Signature: (JSComponent list * JSConnection list) -> CanvasState
+ + |
+
+
+
+
+
+ Transform the JSCanvasState into an f# data structure. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-filesio.html b/docs/reference/global-filesio.html
new file mode 100644
index 0000000..2f46dcb
--- /dev/null
+++ b/docs/reference/global-filesio.html
@@ -0,0 +1,354 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ FileMenuView
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ addFileToProject model dispatch
+
+
+ Signature: model:Model -> dispatch:(Msg -> unit) -> unit
+ + |
+
+
+
+
+
+ Create a new file in this project and open it automatically. + + + |
+
+
+
+ bitNums(a, b)
+
+
+ Signature: (a:int * b:int) -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ clkAdvance(sD)
+
+
+ Signature: sD:SimulationData -> SimulationData
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ compsConns2portLst(...)
+
+
+ Signature: model:Model -> simData:SimulationData -> diagElLst:DiagEl list -> WaveSimPort []
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ currWS(model)
+
+
+ Signature: model:Model -> WaveSimModel
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ driveOut simGraph targetCompId inPortN
+
+
+ Signature: simGraph:Map<'?8513,SimulationComponent> -> targetCompId:ComponentId -> inPortN:InputPortNumber -> ('?8513 * OutputPortNumber) option
+ + Type parameters: '?8513 |
+
+
+
+
+
+ Returns a tuple option representing the output to which the target input is connected + + + |
+
+
+
+ extractSimData simData nCycles
+
+
+ Signature: simData:SimulationData -> nCycles:uint32 -> SimulationData []
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ extractSimTime model portFunc simData
+
+
+ Signature: model:'?8528 -> portFunc:('?8528 -> SimulationData -> WaveSimPort []) -> simData:SimulationData -> Sample []
+ + Type parameters: '?8528 |
+
+
+
+
+
+
+ |
+
+
+
+ extractWaveData(...)
+
+
+ Signature: model:'a -> portFunc:('a -> SimulationData -> WaveSimPort []) -> simDataArr:SimulationData [] -> SimTime []
+ + Type parameters: 'a |
+
+
+
+
+
+
+ |
+
+
+
+ extractWaveNames simData model portFunc
+
+
+ Signature: simData:SimulationData -> model:Model -> portFunc:(Model -> SimulationData -> WaveSimPort []) -> string []
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ findName simGraph arg2
+
+
+ Signature: simGraph:SimulationGraph -> WaveSimPort -> (string * (int * int)) list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ getCurrFile(model)
+
+
+ Signature: model:Model -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ getSelected(model)
+
+
+ Signature: model:Model -> DiagEl list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ initFileWS(model)
+
+
+ Signature: model:Model -> Msg
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ limBits(name)
+
+
+ Signature: name:string -> (int * int) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ makeSimData(model)
+
+
+ Signature: model:Model -> Result<SimulationData,SimulationError> option * Result<(Map<string,WaveSimModel> * SimulationError option),'a> option
+ + Type parameters: 'a |
+
+
+
+
+
+
+ |
+
+
+
+ processComp simData cId
+
+
+ Signature: simData:SimulationData -> cId:ComponentId -> WaveSimPort []
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ procIns simData compId inputs
+
+
+ Signature: simData:SimulationData -> compId:ComponentId -> inputs:InputPortNumber [] -> WaveSimPort []
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ reloadablePorts model simData
+
+
+ Signature: model:Model -> simData:SimulationData -> WaveSimPort []
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ remDuplicates(arrWithDup)
+
+
+ Signature: arrWithDup:WaveSimPort [] -> WaveSimPort []
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ saveOpenFileAction(model)
+
+
+ Signature: model:Model -> unit
+ + |
+
+
+
+
+
+ Save the file currently open. + + + |
+
+
+
+ selected2portLst model simData
+
+
+ Signature: model:Model -> simData:SimulationData -> WaveSimPort []
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ simLst model dispatch portsFunc
+
+
+ Signature: model:Model -> dispatch:(Msg -> unit) -> portsFunc:(Model -> SimulationData -> WaveSimPort []) -> Msg
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ simWireData2Wire(wireData)
+
+
+ Signature: wireData:Bit list -> bigint
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ viewNoProjectMenu model dispatch
+
+
+ Signature: model:Model -> dispatch:(Msg -> unit) -> (type)
+ + |
+
+
+
+
+
+ Display the initial Open/Create Project menu at the beginning if no project +is open. + + + |
+
+
+
+ viewTopMenu model dispatch
+
+
+ Signature: model:Model -> dispatch:(Msg -> unit) -> (type)
+ + |
+
+
+
+
+
+ Display top menu. + + + |
+
+
+
+ wSPort2Name simGraph p
+
+
+ Signature: simGraph:SimulationGraph -> p:WaveSimPort -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-helpers.html b/docs/reference/global-helpers.html
new file mode 100644
index 0000000..25916a4
--- /dev/null
+++ b/docs/reference/global-helpers.html
@@ -0,0 +1,198 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ FilesIO
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+ | Module | Description |
| + JsonHelpers + | ++ + | +
Functions and values
+| Function or value | Description |
+
+
+ askForExistingProjectPath()
+
+
+ Signature: unit -> string option
+ + |
+
+
+
+
+
+ Ask the user to choose a project file, with a dialog window. +Return the folder containing the chosen project file. +Return None if the user exits withouth selecting a path. + + + |
+
+
+
+ askForNewProjectPath()
+
+
+ Signature: unit -> string option
+ + |
+
+
+
+
+
+ Ask the user a new project path, with a dialog window. +Return None if the user exits withouth selecting a path. + + + |
+
+
+
+ baseName(filePath)
+
+
+ Signature: filePath:string -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ createEmptyDgmFile folderPath baseName
+
+
+ Signature: folderPath:string -> baseName:string -> unit
+ + |
+
+
+
+
+
+ Create new empty diagram file. Automatically add the .dgm suffix. + + + |
+
+
+
+ dirName(filePath)
+
+
+ Signature: filePath:string -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ pathJoin(args)
+
+
+ Signature: args:string [] -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ removeFile folderPath baseName
+
+
+ Signature: folderPath:string -> baseName:string -> unit
+ + |
+
+
+
+
+
+ Asyncronously remove file. + + + |
+
+
+
+ savePngFile folderPath baseName png
+
+
+ Signature: folderPath:string -> baseName:string -> png:'a -> unit
+ + Type parameters: 'a |
+
+
+
+
+
+ Save a PNG file (encoded base64, as from draw2d) +Overwrite existing file if needed + + + |
+
+
+
+ saveStateToFile(...)
+
+
+ Signature: folderPath:string -> baseName:string -> (Component list * Connection list) -> unit
+ + |
+
+
+
+
+
+ Save state to file. Automatically add the .dgm suffix. + + + |
+
+
+
+ tryCreateFolder(path)
+
+
+ Signature: path:string -> Result<unit,string>
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ tryLoadComponentsFromPath(folderPath)
+
+
+ Signature: folderPath:string -> Result<LoadedComponent list,string>
+ + |
+
+
+
+
+
+ Try to load all diagram components from a file path. +Return a string with error if not possible. + + + |
+
+
+
+ writeFile path data
+
+
+ Signature: path:string -> data:'b -> unit
+ + Type parameters: 'b |
+
+
+
+
+
+ Write utf8 encoded data to file. +Create file if it does not exist. + + + |
+
+
+
+ writeFileBase64 path data
+
+
+ Signature: path:string -> data:'?8952 -> unit
+ + Type parameters: '?8952 |
+
+
+
+
+
+ Write base64 encoded data to file. +Create file if it does not exist. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-jstypes.html b/docs/reference/global-jstypes.html
new file mode 100644
index 0000000..a0fad4e
--- /dev/null
+++ b/docs/reference/global-jstypes.html
@@ -0,0 +1,151 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Helpers
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ assertThat cond msg
+
+
+ Signature: cond:bool -> msg:string -> unit
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ cropToLength len fromStart str
+
+
+ Signature: len:int -> fromStart:bool -> str:string -> string
+ + |
+
+
+
+
+
+ Crop a string to the specified length.
+fromStart indicates whether you want the first |
+
+
+
+ listSet lst item idx
+
+
+ Signature: lst:'a list -> item:'a -> idx:int -> 'a list
+ + Type parameters: 'a |
+
+
+
+
+
+ Set an element of the list at the specified position. +This function is slow: O(n). Do not use unless necessary. + + + |
+
+
+
+ pow2(exponent)
+
+
+ Signature: exponent:int -> int
+ + |
+
+
+
+
+
+ Return 2^exponent. + + + |
+
+
+
+ pow2int64(exponent)
+
+
+ Signature: exponent:int -> int64
+ + |
+
+
+
+
+
+ Return 2^exponent, packed into an int64. + + + |
+
+
+
+ tryFindError(lst)
+
+
+ Signature: lst:Result<'a,'b> list -> Result<'a list,'b>
+ + Type parameters: 'a, 'b |
+
+
+
+
+
+ Return the first error found in a list of results, or the list of Oks if +there are none. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-main.html b/docs/reference/global-main.html
new file mode 100644
index 0000000..893e4a2
--- /dev/null
+++ b/docs/reference/global-main.html
@@ -0,0 +1,186 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+ JSTypes
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+
+ | Type | Description |
| + JSCanvas + | ++ + | +
| + JSCanvasState + | ++ + | +
| + JSComponent + | ++ + | +
| + JSComponents + | ++ + | +
| + JSConnection + | ++ + | +
| + JSConnections + | ++ + | +
| + JSPort + | ++ + | +
| + JSPorts + | ++ + | +
| + JSVertices + | ++ + | +
+
+
+
+
+
+
+
diff --git a/docs/reference/global-numberhelpers.html b/docs/reference/global-numberhelpers.html
new file mode 100644
index 0000000..bc83bb1
--- /dev/null
+++ b/docs/reference/global-numberhelpers.html
@@ -0,0 +1,309 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Main
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ argFlagIsOn(flags)
+
+
+ Signature: flags:string list -> bool
+ + |
+
+
+
+
+
+ Returns true if any of flags are present as command line argument. + + + |
+
+
+
+ args
+
+
+ Signature: string list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ createMainWindow()
+
+
+ Signature: unit -> unit
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ debug
+
+
+ Signature: bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ hasDebugArgs()
+
+
+ Signature: unit -> bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ mainWindow
+
+
+ Signature: (type) option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-simulationbuilder.html b/docs/reference/global-simulationbuilder.html
new file mode 100644
index 0000000..2b26e14
--- /dev/null
+++ b/docs/reference/global-simulationbuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ NumberHelpers
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ bin(num)
+
+
+ Signature: num:int -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ bin64(num)
+
+
+ Signature: num:int64 -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ bitToString(bit)
+
+
+ Signature: bit:Bit -> string
+ + |
+
+
+
+
+
+ Convert a bit to string. + + + |
+
+
+
+ convertIntToWireData width num
+
+
+ Signature: width:int -> num:int64 -> WireData
+ + |
+
+
+
+
+
+ Convert an int into a Bit list with the provided width. The Least +Significant Bits are the one with low index (e.g. LSB is at position 0, MSB +is at position N). Little Endian. +If the number has more bits than width, then more bits will be returned. + + + |
+
+
+
+ convertWireDataToInt(bits)
+
+
+ Signature: bits:WireData -> int64
+ + |
+
+
+
+
+
+ Convert a list of Bits into an int. The Least Significant Bits are the one +with low index (e.g. LSB is at position 0, MSB is at position N). +Little Endian. + + + |
+
+
+
+ dec(num)
+
+
+ Signature: num:int -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ dec64(num)
+
+
+ Signature: num:int64 -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ hex(num)
+
+
+ Signature: num:int -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ hex64(num)
+
+
+ Signature: num:int64 -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ sDec64(num)
+
+
+ Signature: num:int64 -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ strToInt(str)
+
+
+ Signature: str:string -> Result<int64,string>
+ + |
+
+
+
+
+
+ Try to convert a string to an int, or return an error message if that was +not possible. + + + |
+
+
+
+ strToIntCheckWidth str width
+
+
+ Signature: str:string -> width:int -> Result<int64,string>
+ + |
+
+
+
+
+
+ Convert a string to a number making sure that it has no more bits than +specified in width. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-simulationgraphanalyser.html b/docs/reference/global-simulationgraphanalyser.html
new file mode 100644
index 0000000..55b6691
--- /dev/null
+++ b/docs/reference/global-simulationgraphanalyser.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationBuilder
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ getLabelConnections comps conns
+
+
+ Signature: comps:Component list -> conns:Connection list -> Connection list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ runCanvasStateChecksAndBuildGraph(...)
+
+
+ Signature: (Component list * Connection list) -> Result<SimulationGraph,SimulationError>
+ + |
+
+
+
+
+
+ Validate a diagram and generate its simulation graph. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-simulationrunner.html b/docs/reference/global-simulationrunner.html
new file mode 100644
index 0000000..068dc65
--- /dev/null
+++ b/docs/reference/global-simulationrunner.html
@@ -0,0 +1,244 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationGraphAnalyser
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ analyseSimulationGraph(...)
+
+
+ Signature: diagramName:string -> graph:SimulationGraph -> connections:Connection list -> SimulationError option
+ + |
+
+
+
+
+
+ Analyse a SimulationGraph and return any error (or None). +The SimulationGraph should be fully merged with its dependency, so this +function has to be called after the dependency merger has finished. +This function assumes that there are no cyclic dependencies. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-simulator.html b/docs/reference/global-simulator.html
new file mode 100644
index 0000000..0ce8292
--- /dev/null
+++ b/docs/reference/global-simulator.html
@@ -0,0 +1,176 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationRunner
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ diffReducerInputsOrOutputs newIO oldIO
+
+
+ Signature: newIO:Map<'a,WireData> -> oldIO:Map<'a,WireData> -> Map<'a,WireData>
+ + Type parameters: 'a |
+
+
+
+
+
+ Function to determine what reducer inputs or outputs have changed. + + + |
+
+
+
+ extractIncompleteSimulationIOs(...)
+
+
+ Signature: simulationIOs:SimulationIO list -> graph:SimulationGraph -> (SimulationIO * WireData) list
+ + |
+
+
+
+
+
+ Simlar to extractSimulationIOs, but do not fail if a bit is not set, just +ignore it. + + + |
+
+
+
+ extractSimulationIOs simulationIOs graph
+
+
+ Signature: simulationIOs:SimulationIO list -> graph:SimulationGraph -> (SimulationIO * WireData) list
+ + |
+
+
+
+
+
+ Given a list of IO nodes (i.e. Inputs or outputs) extract their value. +If they dont all have a value, an error is thrown. + + + |
+
+
+
+ feedClockTick(graph)
+
+
+ Signature: graph:SimulationGraph -> SimulationGraph
+ + |
+
+
+
+
+
+ Send one global clock tick to all clocked components, and return the updated +simulationGraph. + + + |
+
+
+
+ feedSimulationInput(...)
+
+
+ Signature: graph:SimulationGraph -> inputId:ComponentId -> wireData:WireData -> SimulationGraph
+ + |
+
+
+
+
+
+ Feed zero to a simulation input. +This function is supposed to be used with Components of type Input. + + + |
+
+
+
+ getSimulationIOs(components)
+
+
+ Signature: components:Component list -> SimulationIO list * SimulationIO list
+ + |
+
+
+
+
+
+ Get ComponentIds, ComponentLabels and wire widths of all input and output +nodes. + + + |
+
+
+
+ getSimulationIOsFromGraph(graph)
+
+
+ Signature: graph:SimulationGraph -> SimulationIO list * SimulationIO list
+ + |
+
+
+
+
+
+ Get ComponentIds, ComponentLabels and wire widths of all input and output +nodes in a simulationGraph. + + + |
+
+
+
+ InitialiseGraphWithZeros inputIds graph
+
+
+ Signature: inputIds:SimulationIO list -> graph:SimulationGraph -> SimulationGraph
+ + |
+
+
+
+
+
+ Feed zeros to all simulation inputs, and feed a single clock tick. +This way all combinational logic has been touched once and had produced its +outputs. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-simulatortypes.html b/docs/reference/global-simulatortypes.html
new file mode 100644
index 0000000..ba2b15a
--- /dev/null
+++ b/docs/reference/global-simulatortypes.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Simulator
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ extractSimulationIOs
+
+
+ Signature: SimulationIO list -> SimulationGraph -> (SimulationIO * WireData) list
+ + |
+
+
+
+
+
+ Expose the extractSimulationIOs function from SimulationRunner. + + + |
+
+
+
+ extractStatefulComponents(graph)
+
+
+ Signature: graph:SimulationGraph -> SimulationComponent list
+ + |
+
+
+
+
+
+ Get some info and the state of all stateful components in a graph. + + + |
+
+
+
+ feedClockTick
+
+
+ Signature: SimulationGraph -> SimulationGraph
+ + |
+
+
+
+
+
+ Expose the feedClockTick function from SimulationRunner. + + + |
+
+
+
+ feedSimulationInput
+
+
+ Signature: SimulationGraph -> ComponentId -> WireData -> SimulationGraph
+ + |
+
+
+
+
+
+ Expose the feedSimulationInput function from SimulationRunner. + + + |
+
+
+
+ prepareSimulation(...)
+
+
+ Signature: diagramName:string -> (Component list * Connection list) -> loadedDependencies:LoadedComponent list -> Result<SimulationData,SimulationError>
+ + |
+
+
+
+
+
+ Builds the graph and simulates it with all inputs zeroed. + + + |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/global-synchronousutils.html b/docs/reference/global-synchronousutils.html
new file mode 100644
index 0000000..1af757c
--- /dev/null
+++ b/docs/reference/global-synchronousutils.html
@@ -0,0 +1,281 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+ SimulatorTypes
+
+ Namespace: global
+
+
+
+
+ Nested types and modules
+
+
+
+
+
+
+
+
+ | Type | Description |
| + Bit + | ++ + | +
| + ComponentId + | ++ + | +
| + ComponentLabel + | ++ + | +
| + ConnectionId + | ++ + | +
| + InputPortId + | ++ + | +
| + InputPortNumber + | ++ + | +
| + IsClockTick + | ++ + | +
| + OutputPortId + | ++ + | +
| + OutputPortNumber + | ++ + | +
| + ReducerInput + | ++ + | +
| + ReducerOutput + | ++ + | +
| + SimulationComponent + | ++ + | +
| + SimulationComponentState + | ++ + | +
| + SimulationData + | ++ + | +
| + SimulationError + | ++ + | +
| + SimulationGraph + | ++ + | +
| + SimulationIO + | ++ + | +
| + WireData + | ++ + | +
+
+
+
+
+
+
+
diff --git a/docs/reference/index.html b/docs/reference/index.html
new file mode 100644
index 0000000..d83dc4b
--- /dev/null
+++ b/docs/reference/index.html
@@ -0,0 +1,239 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SynchronousUtils
+
+ Namespace: global
+
+
+
+
+
+ Functions and values
+| Function or value | Description |
+
+
+ calculateCustomComponentsCombinatorialPaths(...)
+
+
+ Signature: diagramName:string -> graph:SimulationGraph -> CustomCompsCombPaths option
+ + |
+
+
+
+
+
+ For each dependecy in a simulation graph, create a map containing: +- key: name of the custom component. +- value: a map with: +- key: each InputPortNumber +- value: a list of OutputPortNumber combinatorially connected to the +input. +An input is considered combinatorially connected to an output if there is at +least one logic path connecting an input directly with the output. In other +words, there must be at least one route from the input to output that does +not encounter any synchronous component. +Return None if such information cannot be inferred, for example if there is +a circular dependency. + + + |
+
+
+
+ couldBeSynchronousComponent(compType)
+
+
+ Signature: compType:ComponentType -> bool
+ + |
+
+
+
+
+
+ Tells wether a component is clocked or not. Note that Custom components may +be clocked (cannot tell without recursively analysing them), so they are +considered synchronous. + + + |
+
+
+
+ getCombinatorialOutputs(...)
+
+
+ Signature: combRoutes:CustomCompsCombPaths -> node:SimulationComponent -> inputPortNumberOpt:InputPortNumber option -> Map<OutputPortNumber,(ComponentId * InputPortNumber) list>
+ + |
+
+
+
+
+
+ Given a map of combinatorial routes from inputs to outputs for every +simulation graph, perform a lookup to find the combinatorial routes from a +given input to the outputs. Then filter the outputs of the custom node to +only point to the combinatorial children (i.e. the ones connected to the +combinatorial outptus). + + + |
+
+
+
+ getCustomComponentType(_arg1)
+
+
+ Signature: _arg1:ComponentType -> CustomComponentType
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ getCustomName(_arg1)
+
+
+ Signature: _arg1:ComponentType -> string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ getNodeOrFail graph id
+
+
+ Signature: graph:SimulationGraph -> id:ComponentId -> SimulationComponent
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ hasSynchronousComponents(graph)
+
+
+ Signature: graph:Map<ComponentId,SimulationComponent> -> bool
+ + |
+
+
+
+
+
+ Find out whether a simulation graph has some synchronous components. + + + |
+
+
+
+ isCustom(_arg1)
+
+
+ Signature: _arg1:ComponentType -> bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ isInput(_arg1)
+
+
+ Signature: _arg1:ComponentType -> bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ isOutput(_arg1)
+
+
+ Signature: _arg1:ComponentType -> bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/jstypes-jscanvas.html b/docs/reference/jstypes-jscanvas.html
new file mode 100644
index 0000000..314c321
--- /dev/null
+++ b/docs/reference/jstypes-jscanvas.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+ issie
+ + +global Namespace
+
+
+
+
+
+
+
+ | Module | Description |
| + CommonTypes + | ++ + | +
| + Helpers + | ++ + | +
| + Main + | ++ + | +
| + DiagramMessageType + | ++ + | +
| + DiagramModelType + | ++ + | +
| + Draw2dWrapper + | ++ + | +
| + Extractor + | ++ + | +
| + FileMenuView + | ++ + | +
| + FilesIO + | ++ + | +
| + JSTypes + | ++ + | +
| + CanvasStateAnalyser + | ++ + | +
| + DependencyMerger + | ++ + | +
| + NumberHelpers + | ++ + | +
| + SimulationBuilder + | ++ + | +
| + SimulationGraphAnalyser + | ++ + | +
| + SimulationRunner + | ++ + | +
| + Simulator + | ++ + | +
| + SimulatorTypes + | ++ + | +
| + SynchronousUtils + | ++ + | +
| + BusTypes + | ++ + | +
| + BusWidthInferer + | ++ + | +
+
+
+
+
+ +
+
+
diff --git a/docs/reference/jstypes-jscanvasstate.html b/docs/reference/jstypes-jscanvasstate.html
new file mode 100644
index 0000000..a21d41c
--- /dev/null
+++ b/docs/reference/jstypes-jscanvasstate.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+
+
+
diff --git a/docs/reference/jstypes-jscomponent.html b/docs/reference/jstypes-jscomponent.html
new file mode 100644
index 0000000..d912d4c
--- /dev/null
+++ b/docs/reference/jstypes-jscomponent.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ JSCanvasState
+
+
+ Namespace: global
+ Parent Module: JSTypes
+
+
+ Instance members
+| Instance member | Description |
+
+
+ x.Item1
+
+
+ Signature: JSComponent list
+ + |
+ + + | +
+
+
+ x.Item2
+
+
+ Signature: JSConnection list
+ + |
+ + + | +
+
+
+
+
+ +
+
+
diff --git a/docs/reference/jstypes-jscomponents.html b/docs/reference/jstypes-jscomponents.html
new file mode 100644
index 0000000..8598954
--- /dev/null
+++ b/docs/reference/jstypes-jscomponents.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/jstypes-jsconnection.html b/docs/reference/jstypes-jsconnection.html
new file mode 100644
index 0000000..d8261af
--- /dev/null
+++ b/docs/reference/jstypes-jsconnection.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/jstypes-jsconnections.html b/docs/reference/jstypes-jsconnections.html
new file mode 100644
index 0000000..dd2452f
--- /dev/null
+++ b/docs/reference/jstypes-jsconnections.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/jstypes-jsport.html b/docs/reference/jstypes-jsport.html
new file mode 100644
index 0000000..3a9edfe
--- /dev/null
+++ b/docs/reference/jstypes-jsport.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/jstypes-jsports.html b/docs/reference/jstypes-jsports.html
new file mode 100644
index 0000000..ff1efef
--- /dev/null
+++ b/docs/reference/jstypes-jsports.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/jstypes-jsvertices.html b/docs/reference/jstypes-jsvertices.html
new file mode 100644
index 0000000..c5fa310
--- /dev/null
+++ b/docs/reference/jstypes-jsvertices.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+ +
+
+
diff --git a/docs/reference/simulatortypes-bit.html b/docs/reference/simulatortypes-bit.html
new file mode 100644
index 0000000..487a3f7
--- /dev/null
+++ b/docs/reference/simulatortypes-bit.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+
+ issie
++ +
+
+
+
+
diff --git a/docs/reference/simulatortypes-componentid.html b/docs/reference/simulatortypes-componentid.html
new file mode 100644
index 0000000..0c72fb1
--- /dev/null
+++ b/docs/reference/simulatortypes-componentid.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ Bit
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ One
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Zero
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-componentlabel.html b/docs/reference/simulatortypes-componentlabel.html
new file mode 100644
index 0000000..7b8d07c
--- /dev/null
+++ b/docs/reference/simulatortypes-componentlabel.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ ComponentId
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ ComponentId(string)
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-connectionid.html b/docs/reference/simulatortypes-connectionid.html
new file mode 100644
index 0000000..cb62186
--- /dev/null
+++ b/docs/reference/simulatortypes-connectionid.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ ComponentLabel
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ ComponentLabel(string)
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-inputportid.html b/docs/reference/simulatortypes-inputportid.html
new file mode 100644
index 0000000..8b6a713
--- /dev/null
+++ b/docs/reference/simulatortypes-inputportid.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ ConnectionId
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ ConnectionId(string)
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-inputportnumber.html b/docs/reference/simulatortypes-inputportnumber.html
new file mode 100644
index 0000000..96e8078
--- /dev/null
+++ b/docs/reference/simulatortypes-inputportnumber.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ InputPortId
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ InputPortId(string)
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-isclocktick.html b/docs/reference/simulatortypes-isclocktick.html
new file mode 100644
index 0000000..b486d4e
--- /dev/null
+++ b/docs/reference/simulatortypes-isclocktick.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ InputPortNumber
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ InputPortNumber(int)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-outputportid.html b/docs/reference/simulatortypes-outputportid.html
new file mode 100644
index 0000000..1f0268a
--- /dev/null
+++ b/docs/reference/simulatortypes-outputportid.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ IsClockTick
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ No
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Yes(SimulationComponentState)
+
+
+ Signature: SimulationComponentState
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-outputportnumber.html b/docs/reference/simulatortypes-outputportnumber.html
new file mode 100644
index 0000000..0fd1dfb
--- /dev/null
+++ b/docs/reference/simulatortypes-outputportnumber.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ OutputPortId
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ OutputPortId(string)
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-reducerinput.html b/docs/reference/simulatortypes-reducerinput.html
new file mode 100644
index 0000000..89ec868
--- /dev/null
+++ b/docs/reference/simulatortypes-reducerinput.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ OutputPortNumber
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ OutputPortNumber(int)
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-reduceroutput.html b/docs/reference/simulatortypes-reduceroutput.html
new file mode 100644
index 0000000..d63f0be
--- /dev/null
+++ b/docs/reference/simulatortypes-reduceroutput.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ ReducerInput
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ CustomSimulationGraph
+
+
+ Signature: SimulationGraph option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Inputs
+
+
+ Signature: Map<InputPortNumber,WireData>
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ IsClockTick
+
+
+ Signature: IsClockTick
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-simulationcomponent.html b/docs/reference/simulatortypes-simulationcomponent.html
new file mode 100644
index 0000000..0dc06e6
--- /dev/null
+++ b/docs/reference/simulatortypes-simulationcomponent.html
@@ -0,0 +1,219 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ ReducerOutput
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ NewCustomSimulationGraph
+
+
+ Signature: SimulationGraph option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ NewState
+
+
+ Signature: SimulationComponentState
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Outputs
+
+
+ Signature: Map<OutputPortNumber,WireData> option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-simulationcomponentstate.html b/docs/reference/simulatortypes-simulationcomponentstate.html
new file mode 100644
index 0000000..1d2b39f
--- /dev/null
+++ b/docs/reference/simulatortypes-simulationcomponentstate.html
@@ -0,0 +1,147 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationComponent
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ CustomSimulationGraph
+
+
+ Signature: SimulationGraph option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Id
+
+
+ Signature: ComponentId
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Inputs
+
+
+ Signature: Map<InputPortNumber,WireData>
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Label
+
+
+ Signature: ComponentLabel
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Outputs
+
+
+ Signature: Map<OutputPortNumber,(ComponentId * InputPortNumber) list>
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Reducer
+
+
+ Signature: ReducerInput -> ReducerOutput
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ State
+
+
+ Signature: SimulationComponentState
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Type
+
+
+ Signature: ComponentType
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-simulationdata.html b/docs/reference/simulatortypes-simulationdata.html
new file mode 100644
index 0000000..7ec86fc
--- /dev/null
+++ b/docs/reference/simulatortypes-simulationdata.html
@@ -0,0 +1,183 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationComponentState
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Union Cases
+| Union Case | Description |
+
+
+ DffState(Bit)
+
+
+ Signature: Bit
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ NoState
+
+
+ Signature:
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ RamState(Memory)
+
+
+ Signature: Memory
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ RegisterState(WireData)
+
+
+ Signature: WireData
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-simulationerror.html b/docs/reference/simulatortypes-simulationerror.html
new file mode 100644
index 0000000..40ff344
--- /dev/null
+++ b/docs/reference/simulatortypes-simulationerror.html
@@ -0,0 +1,147 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationData
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ ClockTickNumber
+
+
+ Signature: int
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Graph
+
+
+ Signature: SimulationGraph
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Inputs
+
+
+ Signature: SimulationIO list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ IsSynchronous
+
+
+ Signature: bool
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ NumberBase
+
+
+ Signature: NumberBase
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Outputs
+
+
+ Signature: SimulationIO list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-simulationgraph.html b/docs/reference/simulatortypes-simulationgraph.html
new file mode 100644
index 0000000..c6c81ea
--- /dev/null
+++ b/docs/reference/simulatortypes-simulationgraph.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationError
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Record Fields
+| Record Field | Description |
+
+
+ ComponentsAffected
+
+
+ Signature: ComponentId list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ ConnectionsAffected
+
+
+ Signature: ConnectionId list
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ InDependency
+
+
+ Signature: string option
+ + |
+
+
+
+
+
+
+ |
+
+
+
+ Msg
+
+
+ Signature: string
+ + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-simulationio.html b/docs/reference/simulatortypes-simulationio.html
new file mode 100644
index 0000000..feda715
--- /dev/null
+++ b/docs/reference/simulatortypes-simulationio.html
@@ -0,0 +1,117 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationGraph
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Instance members
+| Instance member | Description |
+
+
+ x.Count
+
+
+ Signature: int
+ + |
+
+
+ CompiledName: |
+
+
+
+ x.IsEmpty
+
+
+ Signature: bool
+ + |
+
+
+ CompiledName: |
+
+
+
+ [key]
+
+
+ Signature: key:ComponentId -> SimulationComponent
+ + |
+
+
+ CompiledName: |
+
+
+
+
+
+
+
+
diff --git a/docs/reference/simulatortypes-wiredata.html b/docs/reference/simulatortypes-wiredata.html
new file mode 100644
index 0000000..f76815b
--- /dev/null
+++ b/docs/reference/simulatortypes-wiredata.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+ SimulationIO
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Instance members
+| Instance member | Description |
+
+
+ x.Item1
+
+
+ Signature: ComponentId
+ + |
+ + + | +
+
+
+ x.Item2
+
+
+ Signature: ComponentLabel
+ + |
+ + + | +
+
+
+ x.Item3
+
+
+ Signature: int
+ + |
+ + + | +
+
+
+
+
+
+
+
diff --git a/docs/release-notes.html b/docs/release-notes.html
new file mode 100644
index 0000000..10770da
--- /dev/null
+++ b/docs/release-notes.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+
+ issie
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WireData
+
+
+ Namespace: global
+ Parent Module: SimulatorTypes
+
+
+ Instance members
+| Instance member | Description |
+
+
+ x.Head
+
+
+ Signature: Bit
+ + |
+
+
+ CompiledName: |
+
+
+
+ x.IsEmpty
+
+
+ Signature: bool
+ + |
+
+
+ CompiledName: |
+
+
+
+ [index]
+
+
+ Signature: index:int -> Bit
+ + |
+
+
+ CompiledName: |
+
+
+
+ x.Length
+
+
+ Signature: int
+ + |
+
+
+ CompiledName: |
+
+
+
+ x.Tail
+
+
+ Signature: Bit list
+ + |
+
+
+ CompiledName: |
+
Static members
+| Static member | Description |
+
+
+ List.Empty
+
+
+ Signature: Bit list
+ + |
+
+
+ CompiledName: |
+
+
+
+
+
+
+
+
diff --git a/docsrc/content/community.fsx b/docsrc/content/community.fsx
new file mode 100644
index 0000000..f50f70f
--- /dev/null
+++ b/docsrc/content/community.fsx
@@ -0,0 +1,9 @@
+(**
+# Community #
+
+This presently just has the Announcements page, but more may be added in the future.
+
+## Announcements ##
+**)
+
+
diff --git a/docsrc/content/contributing.fsx b/docsrc/content/contributing.fsx
new file mode 100644
index 0000000..645e4ac
--- /dev/null
+++ b/docsrc/content/contributing.fsx
@@ -0,0 +1,60 @@
+(**
+# Contributing #
+
+## Branching ##
+
+ - Create a feature branch in git.
+ - Fork and clone locally.
+
+## Style Guidelines ##
+
+ - Follow [F# Coding Guidelines](https://docs.microsoft.com/en-us/dotnet/fsharp/style-guide/formatting).
+ - Take into consideration [FSharpLint](https://github.com/fsprojects/FSharpLint) output.
+ - [Fantomas](https://github.com/fsprojects/fantomas) should be run to ensure formatting is consistent.
+
+## Testing ##
+
+Testing is done in the tests libraries using [Expecto](https://github.com/haf/expecto) which is able to load in any
+testing framework you may need, but is strongly encouraged to keep things consistent and use Expecto tests and [FsCheck](https://github.com/fscheck/FsCheck)
+for any property-based testing.
+
+ - Add test cases where needed.
+ - Tests are run as part of the build process, please ensure they pass.
+ - Note that pure F# should be tested - GUI cannot easily be tested.
+
+## Documentation ##
+
+Documentation is built dynamically from F# script files and markdown files using [FSharp.Formatting](https://github.com/fsprojects/FSharp.Formatting).
+The Reference documentation is dynamically generated, and descriptions specified by using `///` rather than `//` for comments, see the Formatting documentation
+for more information.
+
+ - Add documentation as necessary, pages can be modified and created in the `./docsrc` directory.
+ - Documentation is built during the build process.
+ - Consider adding examples if adding new features.
+ - [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax)
+
+## Building ##
+
+ - Build the solution with Visual Studio, `build.cmd` or `build.sh`.
+ - All binaries will be in `./bin` after being built.
+ - When you're ready to commit the code use `build.cmd/sh -t "Release". This will clean up directories, stage,
+ and build everything for release. Once you've confirmed it looks good, commit to your branch and make your PR.
+ - Please note in order to build the Linux images you must have `Docker` installed.
+
+## Releasing ##
+
+ - Create the distributables via the `Dist` build task, then create the delta and sig files with the `CreateDiffs` task. Upload all of the files
+ related to the new version to the release.
+
+
+
+
+ issie
++
+
+
+
+
+ v0.5.0 - Issie 1st release
+-
+
- Change name to Issie - Interative Simulation and Schematic Integrated Editor. +
- Mend build system - now HMR works. +
- Breaking change - alter size of NOT gates => any old sheet with the NOT gates will crash the software on load. +
v0.4.0 - DECAD 1st release
+-
+
- Major update to build system. +
- Upgrade all packages to latest. +
- Mend bug in loading of exact wire and bus positions. +
- Change name to DECAD. +
0.2 - March, 2020
+-
+
- End of FYP Release +
v0.1-beta
+-
+
- User feedback release +
+
+
+
+
+
+
+## Merging ##
+
+ - Send a pull request and have it reviewed.
+
+*)
\ No newline at end of file
diff --git a/docsrc/content/index.fsx b/docsrc/content/index.fsx
new file mode 100644
index 0000000..16cf65e
--- /dev/null
+++ b/docsrc/content/index.fsx
@@ -0,0 +1,68 @@
+(**
+# What is Issie?
+
+Issie (Intuitive Schematic Simulator and Interactive Editor) is a very easy to use and capable block schematic based digital logic editor and simulator,
+originally made for the 1st year undergraduate Digital Electronics and Computer Architecture module at the
+Department of Electronic and Electrical Engineering, Imperial College London.
+
+Issie is coded in F# transpiled to Javascript by [FABLE](http://fable.io), and uses the
+very capable [Draw2D](https://github.com/freegroup/draw2d)
+library.
+
+## Acknowledgements:
+
+* Marco Selvatici for the 8K lines of base code written for his 3rd year BEng [FYP](https://github.com/MarcoSelvatici/DEflow)
+* An awesome automatic FAKE build system based on Cody Johnson's [MordhausBuddy](https://github.com/Shmew/MordhauBuddy)
+* Edoardo Santi for work improving Issie over Summer 2020.
+
+## Background and Technical Details
+
+Marco's [Dissertation](https://tomcl.github.com/issie/marco-report.pdf) or his [Poster](https://tomcl.github.com/issie/marco-poster.pdf).
+
+
+
+
+
+## How to get Issie
+
+Go to the [releases](https://github.com/tomcl/issie/releases) page on the Github repo and download the
+package most applicable to your operating system.
+
+You only need to download the `.exe` for Windows or `.AppImage` for Linux. The other files are for auto-updating
+which is handled by the application. (You will see an update button pop up in the top right-hand corner.)
+
+With Linux:
+
+ - Most distributions are supported, if you have an issue please let me know and I will try to fix it.
+ - It is distributed in [AppImage](https://appimage.org/) format, which is plug and play for most popular distros.
+ - You may need to right click and go to properties to give it permissions to execute.
+ - Some distributions such as Debian will need the start up flag `--no-sandbox` in order to run.
+
+With Windows:
+
+ - The installer is easy to install, a single click in fact.
+
+
+
+
+
+
+
+
+
+
+## Documentation ##
+
+ - Functionality - Some example use cases for the application.
+ - [API Reference](reference/index.html) contains automatically generated documentation for all types, modules
+ and functions in the library. This includes additional brief samples on using most of the functions.
+ This is only helpful if you plan on contributing.
+
+## Contributing ##
+
+The project is hosted on [Github][gh] where you can [report issues][issues], fork the project and submit pull
+requests. Please take a look at the [contribution guidelines](contributing.html) for more information.
+
+ [gh]: https://github.com/tomcl/issie
+ [issues]: https://github.com/tomcl/issie/issues
+
+*)
diff --git a/docsrc/files/img/communityAnnouncements.png b/docsrc/files/img/communityAnnouncements.png
new file mode 100644
index 0000000..c662b40
Binary files /dev/null and b/docsrc/files/img/communityAnnouncements.png differ
diff --git a/docsrc/files/img/faceToolsActions.png b/docsrc/files/img/faceToolsActions.png
new file mode 100644
index 0000000..8b095fc
Binary files /dev/null and b/docsrc/files/img/faceToolsActions.png differ
diff --git a/docsrc/files/img/faceToolsProfiles.png b/docsrc/files/img/faceToolsProfiles.png
new file mode 100644
index 0000000..64dcc4e
Binary files /dev/null and b/docsrc/files/img/faceToolsProfiles.png differ
diff --git a/docsrc/files/img/fake.png b/docsrc/files/img/fake.png
new file mode 100644
index 0000000..8b33cdf
Binary files /dev/null and b/docsrc/files/img/fake.png differ
diff --git a/docsrc/files/img/logo-template.pdn b/docsrc/files/img/logo-template.pdn
new file mode 100644
index 0000000..52606f5
Binary files /dev/null and b/docsrc/files/img/logo-template.pdn differ
diff --git a/docsrc/files/img/logo.png b/docsrc/files/img/logo.png
new file mode 100644
index 0000000..3b8d6f9
Binary files /dev/null and b/docsrc/files/img/logo.png differ
diff --git a/docsrc/files/img/modAvailable.png b/docsrc/files/img/modAvailable.png
new file mode 100644
index 0000000..2f8ba0b
Binary files /dev/null and b/docsrc/files/img/modAvailable.png differ
diff --git a/docsrc/files/img/modInstalled.png b/docsrc/files/img/modInstalled.png
new file mode 100644
index 0000000..43afed9
Binary files /dev/null and b/docsrc/files/img/modInstalled.png differ
diff --git a/docsrc/files/img/modInstalling.png b/docsrc/files/img/modInstalling.png
new file mode 100644
index 0000000..ab9f5b7
Binary files /dev/null and b/docsrc/files/img/modInstalling.png differ
diff --git a/docsrc/files/img/mordhauConfig.png b/docsrc/files/img/mordhauConfig.png
new file mode 100644
index 0000000..0f47134
Binary files /dev/null and b/docsrc/files/img/mordhauConfig.png differ
diff --git a/docsrc/files/img/settings.png b/docsrc/files/img/settings.png
new file mode 100644
index 0000000..c211fab
Binary files /dev/null and b/docsrc/files/img/settings.png differ
diff --git a/docsrc/files/marco-poster.pdf b/docsrc/files/marco-poster.pdf
new file mode 100644
index 0000000..b49578f
Binary files /dev/null and b/docsrc/files/marco-poster.pdf differ
diff --git a/docsrc/files/marco-report.pdf b/docsrc/files/marco-report.pdf
new file mode 100644
index 0000000..e281d73
Binary files /dev/null and b/docsrc/files/marco-report.pdf differ
diff --git a/docsrc/tools/templates/template.cshtml b/docsrc/tools/templates/template.cshtml
new file mode 100644
index 0000000..bec8515
--- /dev/null
+++ b/docsrc/tools/templates/template.cshtml
@@ -0,0 +1,55 @@
+
+
+
+
+
+ 
+
+
+