Commit 611826c1 authored by Ludovic Apvrille's avatar Ludovic Apvrille

Adding a first help framework

parent a68b2152
...@@ -54,7 +54,8 @@ make ultraclean Clean the repository from binaries and compilation artif ...@@ -54,7 +54,8 @@ make ultraclean Clean the repository from binaries and compilation artif
make ttooljavac Build TTool only with javac make ttooljavac Build TTool only with javac
make ttoolnotest Build TTool with gradle, but do not execute test. Performs the install make ttoolnotest Build TTool with gradle, but do not execute test. Performs the install
make allnotest Builld all apps, but do not execute tests. Performs the install make allnotest Builld all apps, but do not execute tests. Performs the install
make ttoolhelp Generate the help of TTool in HTML format
Other targets: Other targets:
...@@ -127,6 +128,10 @@ export WEBCRAWLER_SERVER_BINARY = $(TTOOL_BUILD)/webcrawler-server.jar ...@@ -127,6 +128,10 @@ export WEBCRAWLER_SERVER_BINARY = $(TTOOL_BUILD)/webcrawler-server.jar
export JTTOOL_DIR = $(TTOOL_PATH)/jttool export JTTOOL_DIR = $(TTOOL_PATH)/jttool
export JTTOOL_BINARY = $(TTOOL_BUILD)/jttool.jar export JTTOOL_BINARY = $(TTOOL_BUILD)/jttool.jar
export TTOOL_HELP_DIR = $(TTOOL_PATH)/src/main/resources/help
MD_FILES=$(wildcard src/main/resources/help/*.md)
MD2HTML=$(MD_FILES:.md=.html)
all: ttool launcher ttool-cli graphminimize graphshow tiftranslator tmltranslator rundse remotesimulator webcrawler install all: ttool launcher ttool-cli graphminimize graphshow tiftranslator tmltranslator rundse remotesimulator webcrawler install
allnotest: GRADLE_OPTIONS += $(GRADLE_NO_TEST) allnotest: GRADLE_OPTIONS += $(GRADLE_NO_TEST)
...@@ -141,7 +146,7 @@ ttoolnotest: ...@@ -141,7 +146,7 @@ ttoolnotest:
$(TTOOL_BINARY): FORCE $(TTOOL_BINARY): FORCE
@($(GRADLE) :ttool:build $(GRADLE_OPTIONS)) || ($(ERROR_MSG) $(GRADLE_VERSION) $(GRADLE_VERSION_NEEDED)&& $(MAKE) -C $(TTOOL_DIR) -e $@) @($(GRADLE) :ttool:build $(GRADLE_OPTIONS)) || ($(ERROR_MSG) $(GRADLE_VERSION) $(GRADLE_VERSION_NEEDED)&& $(MAKE) -C $(TTOOL_DIR) -e $@)
ttooljavac: ttooljavac:
$(MAKE) -C $(TTOOL_DIR) $(MAKE) -C $(TTOOL_DIR)
$(MAKE) -C $(TTOOLCLI_DIR) $(MAKE) -C $(TTOOLCLI_DIR)
...@@ -196,6 +201,13 @@ $(WEBCRAWLER_SERVER_BINARY): FORCE ...@@ -196,6 +201,13 @@ $(WEBCRAWLER_SERVER_BINARY): FORCE
$(JTTOOL_BINARY): FORCE $(JTTOOL_BINARY): FORCE
@$(MAKE) -C $(JTTOOL_DIR) -e $@ @$(MAKE) -C $(JTTOOL_DIR) -e $@
ttoolhelp: html
html: $(MD2HTML)
%.html: %.md
pandoc $< -f markdown -t html -s -o $@
# ======================================== # ========================================
# ========== DOCUMENTATION ========== # ========== DOCUMENTATION ==========
# ======================================== # ========================================
......
/* Copyright or (C) or Copr. GET / ENST, Telecom-Paris, Ludovic Apvrille
*
* ludovic.apvrille AT enst.fr
*
* This software is a computer program whose purpose is to allow the
* edition of TURTLE analysis, design and deployment diagrams, to
* allow the generation of RT-LOTOS or Java code from this diagram,
* and at last to allow the analysis of formal validation traces
* obtained from external tools, e.g. RTL from LAAS-CNRS and CADP
* from INRIA Rhone-Alpes.
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
package help;
import common.ConfigurationTTool;
import common.SpecConfigTTool;
import launcher.RTLLauncher;
import myutil.PluginManager;
import myutil.TraceManager;
import ui.MainGUI;
import ui.util.IconManager;
import ui.window.JDialogSystemCGeneration;
import ui.*;
import java.io.File;
import java.util.BitSet;
import java.util.*;
/**
* Class HelpEntry
* Creation: 28/02/2019
* Version 2.0 28/02/2019
*
* @author Ludovic APVRILLE
*/
public class HelpEntry {
public String pathToHTMLFile;
public String masterKeyword;
public String[] keywords;
public String htmlContent;
Vector<HelpEntry> entries;
public HelpEntry() {
entries = new Vector<>();
}
}
/* Copyright or (C) or Copr. GET / ENST, Telecom-Paris, Ludovic Apvrille
*
* ludovic.apvrille AT enst.fr
*
* This software is a computer program whose purpose is to allow the
* edition of TURTLE analysis, design and deployment diagrams, to
* allow the generation of RT-LOTOS or Java code from this diagram,
* and at last to allow the analysis of formal validation traces
* obtained from external tools, e.g. RTL from LAAS-CNRS and CADP
* from INRIA Rhone-Alpes.
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
package help;
import common.ConfigurationTTool;
import common.SpecConfigTTool;
import launcher.RTLLauncher;
import myutil.PluginManager;
import myutil.TraceManager;
import ui.MainGUI;
import ui.util.IconManager;
import ui.window.JDialogSystemCGeneration;
import ui.*;
import java.io.File;
import java.util.BitSet;
import java.util.*;
/**
* Class HelpManager
* Creation: 28/02/2019
* Version 2.0 28/02/2019
*
* @author Ludovic APVRILLE
*/
public class HelpManager {
private boolean helpLoaded = false;
Vector<HelpEntry> entries;
public HelpManager() {
entries = new Vector<>();
}
// Returns false in case of failure
public boolean loadEntries() {
helpLoaded = true;
}
}
...@@ -39,6 +39,7 @@ ...@@ -39,6 +39,7 @@
package ui; package ui;
import help.HelpManager;
import myutil.*; import myutil.*;
import avatartranslator.AvatarSpecification; import avatartranslator.AvatarSpecification;
import common.ConfigurationTTool; import common.ConfigurationTTool;
...@@ -329,6 +330,9 @@ public class MainGUI implements ActionListener, WindowListener, KeyListener, Per ...@@ -329,6 +330,9 @@ public class MainGUI implements ActionListener, WindowListener, KeyListener, Per
private JFrameInteractiveSimulation jfis; private JFrameInteractiveSimulation jfis;
private JFrameAvatarInteractiveSimulation jfais; private JFrameAvatarInteractiveSimulation jfais;
// Help
HelpManager helpManager;
// Invariants // Invariants
Invariant currentInvariant; Invariant currentInvariant;
...@@ -555,6 +559,9 @@ public class MainGUI implements ActionListener, WindowListener, KeyListener, Per ...@@ -555,6 +559,9 @@ public class MainGUI implements ActionListener, WindowListener, KeyListener, Per
//split.setDividerLocation(220); //split.setDividerLocation(220);
} }
// Help
helpManager = new HelpManager();
// //
// ToolBar // ToolBar
......
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title></title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<p>The architecture is used to capture abstract hardware nodes that can be connected through buses.</p>
</body>
</html>
The architecture is used to capture abstract hardware nodes that can be connected through buses.
\ No newline at end of file
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title></title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<p>The clock divider parameter specifies the relation between the main hardware clock (which is assumed to be unique) and the clock of the corresponding hardware node.</p>
<p>Said differently, a clock divider of &quot;x&quot; means that the clock of this nodes runs at mainclock/x MHz.</p>
</body>
</html>
The clock divider parameter specifies the relation between the main hardware clock (which is assumed to be unique) and the clock of the corresponding hardware node.
Said differently, a clock divider of "x" means that the clock of this nodes runs at mainclock/x MHz.
\ No newline at end of file
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title></title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<p>The CPU node abstracts a CPU. It simulation semantics ...</p>
</body>
</html>
The CPU node abstracts a CPU.
It simulation semantics ...
\ No newline at end of file
Diplodocus targets the hardware/software partitioning of embedded systems
\ No newline at end of file
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title></title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<p>TTool is a tool for assisting designer to create the architecture and the software of embedded systems.</p>
<p>TTool can be executed on Microsoft Windows, MacOS and Linux Operating Systems.</p>
<p>TTool supports the three main modeling profiles: - Diplodocus - Avatar - SysML-Sec</p>
</body>
</html>
TTool is a tool for assisting designer to create the architecture and the software of embedded systems.
TTool can be executed on Microsoft Windows, MacOS and Linux Operating Systems.
TTool supports the three main modeling profiles:
- Diplodocus
- Avatar
- SysML-Sec
\ No newline at end of file
- general TTool general
- diplodocus.md diplodocus hardware software partitioning dse design space exploration
-- architecture
--- cpu
----clockdivider clock_divider clock divider cpu
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment