Skip to content

Commit fda4c64

Browse files
eyckeyck
committed
Merge branch 'release/2.16.0'
2 parents 539e5de + 79a5343 commit fda4c64

File tree

134 files changed

+5360
-569
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

134 files changed

+5360
-569
lines changed

‎README.md‎

Lines changed: 40 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,43 @@ Legend:
3030
* Mouse Scroll wheel: MScrl
3131
* Context any means Name List, Value List or Waveform
3232

33-
| Input | Modifier | Context | Action |
34-
|-----------|----------|----------|-----------------------------------|
35-
| LMB klick | | any | select |
36-
| LMB klick | Shift | Waveform | move selected marker to position |
37-
| LMB klick | Control | Waveform | move cursor to position |
38-
| LMB drag | | Waveform | zoom to range |
39-
| MMB klick | | Waveform | move selected marker to position |
40-
| MScrl | | any | scroll window up/down |
41-
| MScrl | Shift | any | scroll window left/right |
42-
| Key left | | Waveform | scroll window to the left (slow) |
43-
| Key right | | Waveform | scroll window to the right (slow) |
44-
| Key left | Shift | Waveform | scroll window to the left (fast) |
45-
| Key right | Shift | Waveform | scroll window to the right (fast) |
46-
| Key up | | Waveform | move selection up |
47-
| Key down | | Waveform | move selection down |
48-
| Key up | Control | Waveform | move selected track up |
49-
| Key down | Control | Waveform | move selected track down |
50-
| Key + | Control | Waveform | zoom in |
51-
| Key - | Control | Waveform | zoom out |
52-
| Key Pos1 | | Waveform | jump to selected marker |
53-
| Key End | | Waveform | jump to cursor |
54-
| Key Del | | any | delete selected entries |
33+
| Input | Modifier | Context | Action |
34+
|------------|----------|----------|-----------------------------------|
35+
| LMB click | | any | select |
36+
| LMB click | Shift | Waveform | move selected marker to position |
37+
| LMB click | Control | Waveform | move cursor to position |
38+
| LMB drag | | Waveform | zoom to range |
39+
| MMB click | | Waveform | move selected marker to position |
40+
| MScrl | | any | scroll window up/down |
41+
| MScrl | Shift | any | scroll window left/right |
42+
| MScrl | Control | Waveform | zoom in/out |
43+
| Key left | | Waveform | scroll window to the left (slow) |
44+
| Key right | | Waveform | scroll window to the right (slow) |
45+
| Key left | Shift | Waveform | scroll window to the left (fast) |
46+
| Key right | Shift | Waveform | scroll window to the right (fast) |
47+
| Key up | | Waveform | move selection up |
48+
| Key down | | Waveform | move selection down |
49+
| Key up | Control | Waveform | move selected track up |
50+
| Key down | Control | Waveform | move selected track down |
51+
| Key + | Control | Waveform | zoom in |
52+
| Key - | Control | Waveform | zoom out |
53+
| Key Pos1 | | Waveform | jump to selected marker |
54+
| Key End | | Waveform | jump to cursor |
55+
| Key Del | | any | delete selected entries |
56+
| LMB click | | ZoomBar | increment/decrement 1 page |
57+
| LMB drag | | ZoomBar | drag both markers (pan) |
58+
| LMB drag | Control | ZoomBar | drag one marker (zoom) |
59+
| MMB drag | | ZoomBar | drag one marker (zoom) |
60+
| xMB dclick | | ZoomBar | pan to position |
61+
| MScrl | | ZoomBar | scroll window left/right |
62+
| MScrl | Shift | ZoomBar | scroll window left/right double speed |
63+
| MScrl | Control | ZoomBar | zoom in/out |
64+
| Key left | | ZoomBar | scroll window to the left (slow) |
65+
| Key right | | ZoomBar | scroll window to the right (slow) |
66+
| Key up | | ZoomBar | scroll window to the left (slow) |
67+
| Key down | | ZoomBar | scroll window to the right (slow) |
68+
| Key PgUp | | ZoomBar | scroll window to the left (fast) |
69+
| Key PgDown | | ZoomBar | scroll window to the right (fast) |
70+
| Key Pos1 | | ZoomBar | scroll to begin |
71+
| Key End | | ZoomBar | scroll to end |
72+

‎doc/com.minres.scviewer.doc/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/target/

‎doc/com.minres.scviewer.doc/.project‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>com.minres.scviewer.doc</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
</buildSpec>
9+
<natures>
10+
</natures>
11+
</projectDescription>

‎doc/com.minres.scviewer.doc/pom.xml‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
4+
<artifactId>com.minres.scviewer.doc</artifactId>
5+
<version>1.0.0-SNAPSHOT</version>
6+
<packaging>pom</packaging>
7+
<parent>
8+
<groupId>com.minres.scviewer</groupId>
9+
<artifactId>com.minres.scviewer.parent</artifactId>
10+
<version>2.16.0</version>
11+
<relativePath>../..</relativePath>
12+
</parent>
13+
14+
<properties>
15+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
16+
<asciidoctor.maven.plugin.version>2.0.0</asciidoctor.maven.plugin.version>
17+
<asciidoctorj.pdf.version>1.6.2</asciidoctorj.pdf.version>
18+
<help.plugin.target.dir>../../plugins/com.minres.scviewer.e4.application.help</help.plugin.target.dir>
19+
</properties>
20+
21+
<build>
22+
<plugins>
23+
<plugin>
24+
<groupId>org.asciidoctor</groupId>
25+
<artifactId>asciidoctor-maven-plugin</artifactId>
26+
<version>${asciidoctor.maven.plugin.version}</version>
27+
<dependencies>
28+
<dependency>
29+
<groupId>org.asciidoctor</groupId>
30+
<artifactId>asciidoctorj-pdf</artifactId>
31+
<version>${asciidoctorj.pdf.version}</version>
32+
</dependency>
33+
</dependencies>
34+
<configuration>
35+
<sourceDirectory>src/asciidoc</sourceDirectory>
36+
<sourceDocumentName>SCViewerHelp.adoc</sourceDocumentName>
37+
<headerFooter>true</headerFooter>
38+
</configuration>
39+
<executions>
40+
<execution>
41+
<id>output-html</id>
42+
<phase>generate-resources</phase>
43+
<goals>
44+
<goal>process-asciidoc</goal>
45+
</goals>
46+
<configuration>
47+
<sourceHighlighter>coderay</sourceHighlighter>
48+
<backend>html</backend>
49+
<attributes>
50+
<toc />
51+
<linkcss>false</linkcss>
52+
</attributes>
53+
</configuration>
54+
</execution>
55+
<execution>
56+
<id>output-docbook</id>
57+
<phase>generate-resources</phase>
58+
<goals>
59+
<goal>process-asciidoc</goal>
60+
</goals>
61+
<configuration>
62+
<backend>docbook</backend>
63+
</configuration>
64+
</execution>
65+
<execution>
66+
<id>output-pdf</id>
67+
<phase>generate-resources</phase>
68+
<goals>
69+
<goal>process-asciidoc</goal>
70+
</goals>
71+
<configuration>
72+
<backend>pdf</backend>
73+
<sourceHighlighter>coderay</sourceHighlighter>
74+
<attributes>
75+
<icons>font</icons>
76+
<pagenums />
77+
<toc />
78+
<idprefix />
79+
<idseparator>-</idseparator>
80+
</attributes>
81+
</configuration>
82+
</execution>
83+
</executions>
84+
</plugin>
85+
<plugin>
86+
<groupId>org.apache.maven.plugins</groupId>
87+
<artifactId>maven-resources-plugin</artifactId>
88+
<version>2.6</version>
89+
<executions>
90+
<execution>
91+
<id>copy-asciidoc-resources</id>
92+
<phase>generate-resources</phase>
93+
<goals>
94+
<goal>copy-resources</goal>
95+
</goals>
96+
<configuration>
97+
<resources>
98+
<resource>
99+
<directory>target/generated-docs/</directory>
100+
<includes>
101+
<include>SCViewerHelp.xml</include>
102+
<include>**/*.jpg</include>
103+
<include>**/*.png</include>
104+
<include>**/*.svg</include>
105+
</includes>
106+
</resource>
107+
</resources>
108+
<outputDirectory>src/docbkx</outputDirectory>
109+
</configuration>
110+
</execution>
111+
</executions>
112+
</plugin>
113+
<plugin>
114+
<groupId>com.agilejava.docbkx</groupId>
115+
<artifactId>docbkx-maven-plugin</artifactId>
116+
<version>2.0.17</version>
117+
<executions>
118+
<execution>
119+
<!-- <phase>generate-sources</phase> -->
120+
<phase>generate-resources</phase>
121+
<goals>
122+
<goal>generate-eclipse</goal>
123+
</goals>
124+
</execution>
125+
</executions>
126+
<dependencies>
127+
<dependency>
128+
<groupId>org.docbook</groupId>
129+
<artifactId>docbook-xml</artifactId>
130+
<version>4.4</version>
131+
<scope>runtime</scope>
132+
</dependency>
133+
</dependencies>
134+
<configuration>
135+
<sourceDirectory>src/docbkx</sourceDirectory>
136+
<targetDirectory>${help.plugin.target.dir}</targetDirectory>
137+
<preProcess>
138+
<copy todir="${help.plugin.target.dir}/images">
139+
<fileset dir="src/docbkx/images" />
140+
</copy>
141+
<copy todir="${help.plugin.target.dir}/css">
142+
<fileset dir="src/docbkx/css" />
143+
</copy>
144+
</preProcess>
145+
<imgSrcPath>./</imgSrcPath>
146+
147+
<useExtensions>1</useExtensions>
148+
<highlightSource>1</highlightSource>
149+
<highlightDefaultLanguage>java</highlightDefaultLanguage>
150+
<calloutsExtension>1</calloutsExtension>
151+
<paperType>A4</paperType>
152+
<!--<fop1Extensions>1</fop1Extensions>
153+
<foCustomization>${basedir}/conf/customization-fopdf.xsl</foCustomization>-->
154+
155+
<!-- This copies content (images, etc) for the HTML version -->
156+
<!-- Any parameters specific to HTML version go here -->
157+
<htmlStylesheet>css/narrow_style.css</htmlStylesheet>
158+
<!-- <includes>titlepage/titlepage.templates.xml</includes> -->
159+
<includes>SCViewerHelp.xml</includes>
160+
<chunkedOutput>true</chunkedOutput>
161+
<xincludeSupported>true</xincludeSupported>
162+
<!-- <foCustomization>src/test/resources/docbook-fo.xsl</foCustomization> -->
163+
<eclipsePluginId>com.minres.scviewer.e4.application.help</eclipsePluginId>
164+
</configuration>
165+
</plugin>
166+
</plugins>
167+
</build>
168+
</project>

‎doc/com.minres.scviewer.doc/src/asciidoc/Overview.adoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[#_introduction]
2+
== Introduction
3+
4+
[#_overview]
5+
=== SCViewer overview
6+
7+
SCViewer is composed of a set of eclipse plugins to display VCD and transaction streams
8+
created by the SystemC VCD trace implementation and the SystemC Verification Library (SCV).
9+
For further description of the SCV please refer to
10+
http://www.accellera.org/activities/committees/systemc-verification.
11+
12+
13+
[#_features]
14+
=== SCViewer features
15+
16+
Features include:
17+
18+
* support of VCD files (compressed and uncompressed)
19+
** real numbers
20+
** showing vectors and real numbers as analog (step-wise & continuous)
21+
* various value representations of bit vectors
22+
* support of SCV transaction recordings in various formats
23+
** text log files (compressed and uncompressed)
24+
** sqlite based
25+
** visualization of transaction relations

‎doc/com.minres.scviewer.doc/src/asciidoc/Reference.adoc‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
[#_reference]
2+
== Reference
3+
4+
In this section you will find detailed descriptions of all GUI and menu elements of the SCViewer including their functions and keyboard shortcuts.
5+
6+
[#_keybindings]
7+
=== Key Shortcuts
8+
9+
Legend:
10+
11+
* Left Mouse Button: LMB
12+
* Middle Mouse Button: MMB
13+
* Mouse Scroll wheel: MScrl
14+
* Context any means Name List, Value List or Waveform
15+
16+
[cols="1,1,1,4",options="header"]
17+
|===
18+
| Input | Modifier | Context | Action
19+
| LMB click | | any | select
20+
| LMB click | Shift | Waveform | move selected marker to position
21+
| LMB click | Control | Waveform | move cursor to position
22+
| LMB drag | | Waveform | zoom to range
23+
| MMB click | | Waveform | move selected marker to position
24+
| MScrl | | any | scroll window up/down
25+
| MScrl | Shift | any | scroll window left/right
26+
| Key left | | Waveform | scroll window to the left (slow)
27+
| Key right | | Waveform | scroll window to the right (slow)
28+
| Key left | Shift | Waveform | scroll window to the left (fast)
29+
| Key right | Shift | Waveform | scroll window to the right (fast)
30+
| Key up | | Waveform | move selection up
31+
| Key down | | Waveform | move selection down
32+
| Key up | Control | Waveform | move selected track up
33+
| Key down | Control | Waveform | move selected track down
34+
| Key + | Control | Waveform | zoom in
35+
| Key - | Control | Waveform | zoom out
36+
| Key Pos1 | | Waveform | jump to selected marker
37+
| Key End | | Waveform | jump to cursor
38+
| Key Del | | any | delete selected entries
39+
| LMB click | | ZoomBar | increment/decrement 1 page
40+
| LMB drag | | ZoomBar | drag both markers (pan)
41+
| LMB drag | Control | ZoomBar | drag one marker (zoom)
42+
| MMB drag | | ZoomBar | drag one marker (zoom)
43+
| xMB dclick | | ZoomBar | pan to position
44+
| MScrl | | ZoomBar | scroll window left/right
45+
| MScrl | Shift | ZoomBar | scroll window left/right double speed
46+
| MScrl | Control | ZoomBar | zoom in/out
47+
| Key left | | ZoomBar | scroll window to the left (slow)
48+
| Key right | | ZoomBar | scroll window to the right (slow)
49+
| Key up | | ZoomBar | scroll window to the left (slow)
50+
| Key down | | ZoomBar | scroll window to the right (slow)
51+
| Key PgUp | | ZoomBar | scroll window to the left (fast)
52+
| Key PgDown | | ZoomBar | scroll window to the right (fast)
53+
| Key Pos1 | | ZoomBar | scroll to begin
54+
| Key End | | ZoomBar | scroll to end
55+
|===

‎doc/com.minres.scviewer.doc/src/asciidoc/SCViewerHelp.adoc‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
[#_start]
2+
= SCViewer User Guide
3+
:title-logo-image: image:Minres_logo_docs.png[width=750, align="right"]
4+
:doctype: book
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: inline
7+
:coderay-css: class
8+
:listing-caption: Listing
9+
:icons: font
10+
//add table-of-contents (toc) and set its depth
11+
:toc:
12+
:toclevels: 3
13+
:data-uri:
14+
:sectnums:
15+
:toc-title: Contents
16+
:homepage: https://www.minres.com/
17+
:keywords:
18+
:title-page:
19+
:xrefstyle: short
20+
:table-caption: Table
21+
:figure-caption: Figure
22+
:appendix-caption: Appendix
23+
:section-refsig: Chapter
24+
//set directories
25+
:imagesdir: ./images
26+
:iconsdir: ./icons
27+
:stylesdir: ./styles
28+
:scriptsdir: ./js
29+
:pdf-themesdir: ./themes
30+
:pdf-theme: mnrs-doc
31+
:pdf-fontsdir: ./fonts
32+
33+
34+
// unset toc, otherwise it appears in table cells -> known bug, should be fixed in later versions!
35+
:toc!:
36+
37+
include::Overview.adoc[]
38+
39+
include::Reference.adoc[]

0 commit comments

Comments
 (0)