Skip to content

Comments

Updated ghdl_interface.py per #458#459

Merged
kraigher merged 4 commits intoVUnit:masterfrom
GlenNicholls:master
Mar 23, 2019
Merged

Updated ghdl_interface.py per #458#459
kraigher merged 4 commits intoVUnit:masterfrom
GlenNicholls:master

Conversation

@GlenNicholls
Copy link
Contributor

@GlenNicholls GlenNicholls commented Mar 21, 2019

This update allows a TCL script to be passed to GTKWave when the -g flag is passed if the environment has the set_sim_option('ghdl.init_file.gui', '<fileName>.tcl') set. The limitation is that only a single file can be passed, however <fileName>.tcl can source other TCL scripts if desired.

@GlenNicholls
Copy link
Contributor Author

GlenNicholls commented Mar 21, 2019

Another thing to note is that ghdl.init_file.gui might be better suited as gtkwave.init_file.gui to avoid confusion, but I left it using the interface name for simplicity.

@kraigher
Copy link
Collaborator

kraigher commented Mar 21, 2019

As you mentioned it would be good if the name conveyed that gtkwave was involved. Maybe calling the sim_option ghdl.gtkwave_script would be better.

Also the sim option should be mentioned in the documentation. The source for the documentation is within ui.py where there is a list of sim options in a docstring. Just adding the new option there with a small description is enough.

@GlenNicholls
updated documentation for new simulation option for GHDL/GTK along wi…
e8fd91b 
…th changing sim option to be more obvious about how GTK is involved
kraigher
kraigher requested changes Mar 22, 2019
View reviewed changes
vunit/ui.py Outdated
``ghdl.gtkwave_script.gui``
A user defined TCL-file that is sourced after the design has been loaded in the GUI.
For example this can be used to configure the waveform viewer.
During script evaluation the ``vunit_tb_path`` variable is defined
Copy link
Collaborator

@kraigher kraigher Mar 22, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not see how vunit_tb_path tcl variable is available so this documentation is inaccurate. Maybe copy paste error?

Copy link
Contributor Author

@GlenNicholls GlenNicholls Mar 22, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, sorry about that

Suggested change
During script evaluation the ``vunit_tb_path`` variable is defined

@kraigher kraigher merged commit f135038 into VUnit:master Mar 23, 2019
@eine eine mentioned this pull request Jun 25, 2019
Open
@umarcor
Copy link
Member

umarcor commented Jun 25, 2019

I tried adding vu.set_sim_option('ghdl.gtkwave_script.gui', 'addWave.tcl') to my run.py, where addWave.tcl is #455 (comment). It fails with:

GTKWave Analyzer v3.3.101 (w)1999-2019 BSI

[0] start time.
[1400000000] end time.
GTKWAVE | Executing Tcl script '"/src/addWave.tcl"'
GTKWAVE | couldn't read file ""/src/addWave.tcl"": no such file or directory
WM Destroy

However, if I replace https://github.com/VUnit/vunit/blob/master/vunit/ghdl_interface.py#L276 with cmd += ["--script", "{}".format(abspath(init_file))], it works as expected.

@GlenNicholls, might those additional double quotes be platform-dependent?

@umarcor umarcor mentioned this pull request Jun 25, 2019
Open
@eine eine mentioned this pull request Oct 8, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kraigher kraigher kraigher requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@GlenNicholls @kraigher @umarcor