aboutsummaryrefslogtreecommitdiffstats
path: root/src/grt/grt-wave_opt-design.ads
diff options
context:
space:
mode:
authorJonas Baggett <jonas17b@gmail.com>2016-11-01 19:23:38 +0100
committertgingold <tgingold@users.noreply.github.com>2016-11-01 19:23:38 +0100
commitb869a4acb52358fe8ca5decaac826af056bfdfca (patch)
treebf9f65e7be9f06ab401e5f23f22194846aa1c389 /src/grt/grt-wave_opt-design.ads
parentdc6a82418653ce5b732d2bc26b393d3259fd93d5 (diff)
downloadghdl-b869a4acb52358fe8ca5decaac826af056bfdfca.tar.gz
ghdl-b869a4acb52358fe8ca5decaac826af056bfdfca.tar.bz2
ghdl-b869a4acb52358fe8ca5decaac826af056bfdfca.zip
There is a new --write-opt-file option that will create a wave option file with all the signals of the design. (#179)
The --wave-opt-file option is renamed to --read-opt-file for consistency Some code cleanup and bug fixes
Diffstat (limited to 'src/grt/grt-wave_opt-design.ads')
-rw-r--r--src/grt/grt-wave_opt-design.ads60
1 files changed, 60 insertions, 0 deletions
diff --git a/src/grt/grt-wave_opt-design.ads b/src/grt/grt-wave_opt-design.ads
new file mode 100644
index 000000000..54a96acfa
--- /dev/null
+++ b/src/grt/grt-wave_opt-design.ads
@@ -0,0 +1,60 @@
+-- GHDL Run Time (GRT) - Wave option file package for reading the tree.
+-- Copyright (C) 2016 Jonas Baggett
+--
+-- GHDL is free software; you can redistribute it and/or modify it under
+-- the terms of the GNU General Public License as published by the Free
+-- Software Foundation; either version 2, or (at your option) any later
+-- version.
+--
+-- GHDL is distributed in the hope that it will be useful, but WITHOUT ANY
+-- WARRANTY; without even the implied warranty of MERCHANTABILITY or
+-- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+-- for more details.
+--
+-- You should have received a copy of the GNU General Public License
+-- along with GCC; see the file COPYING. If not, write to the Free
+-- Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+-- 02111-1307, USA.
+--
+-- As a special exception, if other files instantiate generics from this
+-- unit, or you link this unit with other files to produce an executable,
+-- this unit does not by itself cause the resulting executable to be
+-- covered by the GNU General Public License. This exception does not
+-- however invalidate any other reasons why the executable file might be
+-- covered by the GNU Public License.
+
+-- Description: Wave option file child package doing the link between the
+-- design and the other wave option packages.
+-- Provides functions to find in the tree which signals are to be
+-- displayed or not.
+-- When State = Display_Tree, it reads the tree created after
+-- parsing the wave option file and filters signals accordingly.
+-- When State = Write_File, it calls File.Update_Tree to create
+-- the tree from the design tree and write the signal paths of all
+-- the design to a new wave option file.
+
+with Grt.Types; use Grt.Types;
+
+package Grt.Wave_Opt.Design is
+ pragma Preelaborate;
+
+ -- Returns the top element of the tree corresponding to the index given, but
+ -- only if the name given matches with it. Otherwise returns null
+ function Get_Top_Cursor (Tree_Index : Tree_Index_Type; Name : Ghdl_C_String)
+ return Elem_Acc;
+
+ -- If there is an element in the parent element given that matches the name
+ -- given, returns it, otherwise returns null
+ function Get_Cursor
+ (Parent : Elem_Acc; Name : Ghdl_C_String; Is_Signal : Boolean := False)
+ return Elem_Acc;
+
+ -- Returns true if the element given is not null, which means it exists in
+ -- the tree of the VHDL elements to be displayed
+ function Is_Displayed (Cursor : Elem_Acc) return Boolean;
+
+ -- If relevent, read the whole tree and check if every element was found in
+ -- design
+ procedure Last_Checks;
+
+end Grt.Wave_Opt.Design;