Added AST visualization functionality based on d3 (#178)

- nmodl.ast now has ast_view function that visualize in memory AST representation using d3.js based radial tree - necessary html, css and js files are added - get_nmodl_example_dir is removed and taken case by python modules Todo: utility tools should be outside the main repo (see #190)
BlueBrain · May 7, 2019 · 42058f5 · 42058f5
1 parent f378285
commit 42058f5
Show file tree

Hide file tree

Showing 12 changed files with 413 additions and 32 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -110,6 +110,8 @@ set(PROJECT_VERSION ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR})
 # generate file with version number from git and nrnunits.lib file path
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/config/config.cpp.in
                ${CMAKE_CURRENT_BINARY_DIR}/config.cpp @ONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/nmodl/config.py.in ${PROJECT_SOURCE_DIR}/nmodl/config.py
+               @ONLY)
 
 # generate Doxyfile with correct source paths
 configure_file(${PROJECT_SOURCE_DIR}/docs/Doxyfile.in ${PROJECT_SOURCE_DIR}/docs/Doxyfile)

diff --git a/nmodl/ast.py b/nmodl/ast.py
@@ -1 +1,33 @@
 from ._nmodl.ast import *  # noqa
+from .config import *
+
+def ast_view(nmodl_ast):
+    """Visualize given NMODL AST by converting to JSON form"""
+    from ._nmodl import to_json
+    from distutils.dir_util import copy_tree
+    import getpass
+    import json
+    import os
+    import tempfile
+    import webbrowser
+
+    installed_viz_tool = os.path.join(PROJECT_INSTALL_DIR, "share", "viz")
+    if os.path.exists(installed_viz_tool):
+        viz_tool_dir = installed_viz_tool
+    else:
+        viz_tool_dir = os.path.join(PROJECT_SOURCE_DIR, "share", "viz")
+
+    work_dir = os.path.join(tempfile.gettempdir(), getpass.getuser(), "nmodl")
+
+    # first copy necessary files to temp work directory
+    copy_tree(viz_tool_dir, work_dir)
+
+    # prepare json data
+    with open(os.path.join(work_dir, 'ast.js'), 'w') as outfile:
+        json_data = json.loads(to_json(nmodl_ast, True, True, True))
+        outfile.write('var astRoot = %s;' % json.dumps(json_data))
+
+    # open browser with ast
+    url = 'file://' + os.path.join(work_dir, "index.html")
+    webbrowser.open(url, new=1, autoraise=True)
+
diff --git a/nmodl/config.py.in b/nmodl/config.py.in
@@ -0,0 +1,2 @@
+PROJECT_SOURCE_DIR="@PROJECT_SOURCE_DIR@"
+PROJECT_INSTALL_DIR="@CMAKE_INSTALL_PREFIX@"
diff --git a/nmodl/dsl.py b/nmodl/dsl.py
@@ -1 +1,13 @@
 from ._nmodl import *
+from .config import *
+
+
+def example_dir():
+    import os
+    """Return directory containing NMODL examples"""
+    installed_example = os.path.join(PROJECT_INSTALL_DIR, "share", "example")
+    if os.path.exists(installed_example):
+        return installed_example
+    else:
+        return os.path.join(PROJECT_SOURCE_DIR, "share", "example")
+
diff --git a/share/viz/css/tree.css b/share/viz/css/tree.css
@@ -0,0 +1,51 @@
+#ast {
+    position: fixed;
+    left: 0px;
+    right: 0px;
+    top: 0px;
+    bottom: 0px;
+}
+
+.node {
+    cursor: pointer;
+}
+
+.node circle {
+    fill: #ffc8c8 !important;
+    stroke: #c57bc4;
+    stroke-width: 2.5px;
+}
+
+.node text {
+    font-size: 12px !important;
+    font-family: sans-serif;
+    fill: #1f1f92;
+}
+
+.link {
+    fill: none;
+    stroke: #DCA5DB;
+    stroke-width: 3px;
+}
+
+.templink {
+    fill: none;
+    stroke: red;
+    stroke-width: 3px;
+}
+
+.dots {
+    cursor: pointer;
+}
+
+.tooltip {
+    background: #23298aeb;
+    white-space: pre;
+    padding: 10px;
+    border-radius: 3px;
+    color: white;
+    font-size: 13px;
+    font-family: "Monaco";
+    position: "absolute";
+    z-index: 10;
+}
diff --git a/share/viz/index.html b/share/viz/index.html
@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+    <meta charset="UTF-8">
+    <title>NMODL AST Visualization</title>
+    <link rel="stylesheet" href="css/tree.css">
+</head>
+
+<body>
+    <div id="ast"></div>
+
+    <script src="js/d3.min.js"></script>
+    <script src="ast.js"></script>
+    <script src="js/tree.js"></script>
+</body>
+
+</html>
diff --git a/share/viz/js/d3.min.js b/share/viz/js/d3.min.js