-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e7f7a40
commit 715e4c3
Showing
3 changed files
with
32 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# LARA Visualization Tool | ||
|
||
Clava integration of LARA's web tool for visualization and analysis of the AST and its source code. | ||
|
||
For more details, see the [LARA Framework repository](https://github.com/specs-feup/lara-framework). | ||
|
||
## Usage | ||
|
||
To launch or update the visualization tool, execute the following statements: | ||
|
||
```js | ||
import VisualizationTool from "clava-js/api/visualization/VisualizationTool.js"; | ||
|
||
await VisualizationTool.visualize(); | ||
``` | ||
|
||
Once ready, Clava will provide the URL that should be opened in the browser to access the web interface. The function can also change the AST root and URL domain and port. | ||
|
||
Other properties will allow the user to know other important information from the server: | ||
|
||
```js | ||
VisualizationTool.isLaunched; // true if the server is running | ||
VisualizationTool.url; // URL where the server is running | ||
VisualizationTool.port; // port to which the server is listening | ||
VisualizationTool.hostname; // hostname to which the server is listening | ||
``` | ||
|
||
For more details, refer to the `GenericVisualizationTool` documentation, from [LARA](https://github.com/specs-feup/lara-framework). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
ClavaLaraApi/src-lara/clava/visualization/VisualizationTool.js
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.