Compare commits
57 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f96fbc3264 | ||
|
|
71c3d6c3fd | ||
|
|
d0abf90a56 | ||
|
|
de00bb8687 | ||
|
|
f8daa18170 | ||
|
|
42e58ce9cf | ||
|
|
213f4cda8f | ||
|
|
84390b6713 | ||
|
|
4370637d3d | ||
|
|
178a5d96ba | ||
|
|
41b7c4f259 | ||
|
|
5d2c32bcc9 | ||
|
|
9f94cc7dee | ||
|
|
6a71c23fdb | ||
|
|
2ea604d2b5 | ||
|
|
de8dc34efc | ||
|
|
b1a8ef4c77 | ||
|
|
67995ecbb8 | ||
|
|
78c8e6c875 | ||
|
|
75062b67cc | ||
|
|
aac78db2f6 | ||
|
|
0030047df3 | ||
|
|
927b5bbc45 | ||
|
|
546d79ae6d | ||
|
|
2e2494d905 | ||
|
|
a1f003b03c | ||
|
|
9f5ed2e3d2 | ||
|
|
776b6aee02 | ||
|
|
107c2f6470 | ||
|
|
6b210fdbb9 | ||
|
|
6c30519b93 | ||
|
|
39768ec09a | ||
|
|
fdab706e4e | ||
|
|
9efd1d7cd6 | ||
|
|
d2e0138bae | ||
|
|
5946d87a2b | ||
|
|
8efa3ffcc9 | ||
|
|
f60351f779 | ||
|
|
57146f79a0 | ||
|
|
af52efdc51 | ||
|
|
87a4e1736c | ||
|
|
b007a6bdbd | ||
|
|
9adbaf69ee | ||
|
|
f9b0c877f9 | ||
|
|
fdc0b00f6b | ||
|
|
f12ea19369 | ||
|
|
f6a554c897 | ||
|
|
5318b5e4ae | ||
|
|
f55bef23c2 | ||
|
|
78a133505c | ||
|
|
1226a43f89 | ||
|
|
2bc1ce380d | ||
|
|
43e0a13dca | ||
|
|
89b96d53b7 | ||
|
|
9a5d6a083c | ||
|
|
994c9f6248 | ||
|
|
d4202d88e2 |
15
.vscode/launch.json
vendored
15
.vscode/launch.json
vendored
@@ -1,6 +1,13 @@
|
|||||||
{
|
{
|
||||||
"version": "0.2.0",
|
"version": "0.2.0",
|
||||||
"configurations": [
|
"configurations": [
|
||||||
|
{
|
||||||
|
"type": "chrome",
|
||||||
|
"request": "launch",
|
||||||
|
"name": "Launch Chrome",
|
||||||
|
"url": "http://localhost:8090",
|
||||||
|
"webRoot": "${workspaceFolder}/visualization-playground"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "Run Extension (Hot Reload)",
|
"name": "Run Extension (Hot Reload)",
|
||||||
"type": "extensionHost",
|
"type": "extensionHost",
|
||||||
@@ -8,7 +15,7 @@
|
|||||||
"runtimeExecutable": "${execPath}",
|
"runtimeExecutable": "${execPath}",
|
||||||
"args": [
|
"args": [
|
||||||
"--extensionDevelopmentPath=${workspaceFolder}/extension",
|
"--extensionDevelopmentPath=${workspaceFolder}/extension",
|
||||||
"${workspaceFolder}\\demo"
|
"${workspaceFolder}\\demos\\php"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"HOT_RELOAD": "true",
|
"HOT_RELOAD": "true",
|
||||||
@@ -24,7 +31,7 @@
|
|||||||
"runtimeExecutable": "${execPath}",
|
"runtimeExecutable": "${execPath}",
|
||||||
"args": [
|
"args": [
|
||||||
"--extensionDevelopmentPath=${workspaceFolder}/extension",
|
"--extensionDevelopmentPath=${workspaceFolder}/extension",
|
||||||
"${workspaceFolder}\\demo"
|
"${workspaceFolder}\\demos\\php"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"HOT_RELOAD": "true",
|
"HOT_RELOAD": "true",
|
||||||
@@ -40,7 +47,7 @@
|
|||||||
"runtimeExecutable": "${execPath}",
|
"runtimeExecutable": "${execPath}",
|
||||||
"args": [
|
"args": [
|
||||||
"--extensionDevelopmentPath=${workspaceFolder}/extension",
|
"--extensionDevelopmentPath=${workspaceFolder}/extension",
|
||||||
"${workspaceFolder}\\demo"
|
"${workspaceFolder}\\demos\\js"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"HOT_RELOAD": "",
|
"HOT_RELOAD": "",
|
||||||
@@ -55,7 +62,7 @@
|
|||||||
"runtimeExecutable": "${execPath}",
|
"runtimeExecutable": "${execPath}",
|
||||||
"args": [
|
"args": [
|
||||||
"--extensionDevelopmentPath=${workspaceFolder}/extension",
|
"--extensionDevelopmentPath=${workspaceFolder}/extension",
|
||||||
"${workspaceFolder}\\demo"
|
"${workspaceFolder}\\demos\\php"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"HOT_RELOAD": "",
|
"HOT_RELOAD": "",
|
||||||
|
|||||||
5
.vscode/settings.json
vendored
5
.vscode/settings.json
vendored
@@ -4,5 +4,8 @@
|
|||||||
},
|
},
|
||||||
"plantuml.diagramsRoot": "docs",
|
"plantuml.diagramsRoot": "docs",
|
||||||
"plantuml.exportFormat": "png",
|
"plantuml.exportFormat": "png",
|
||||||
"plantuml.exportOutDir": "docs/exported"
|
"plantuml.exportOutDir": "docs/exported",
|
||||||
|
"typescript.updateImportsOnFileMove.enabled": "prompt",
|
||||||
|
"mochaExplorer.files": "./data-extraction/test/**/*.test.ts",
|
||||||
|
"mochaExplorer.require": ["ts-node/register", "source-map-support/register"]
|
||||||
}
|
}
|
||||||
|
|||||||
71
CONTRIBUTING.md
Normal file
71
CONTRIBUTING.md
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
This document extends the [readme](./extension/README.md) of the extension with implementation details.
|
||||||
|
|
||||||
|
## Build Instructions
|
||||||
|
|
||||||
|
- Clone the repository
|
||||||
|
- Run `yarn` in the repository root
|
||||||
|
- Run `yarn build`
|
||||||
|
|
||||||
|
## Dev Instructions
|
||||||
|
|
||||||
|
This project uses yarn workspaces and consists of the sub-projects _data-extraction_, _extension_ and _webview_.
|
||||||
|
To setup a dev environment, follow these steps:
|
||||||
|
|
||||||
|
- Clone the repository
|
||||||
|
- Run `yarn` in the repository root
|
||||||
|
- Run `yarn build` initially (or `yarn dev` for every sub-project)
|
||||||
|
- Run `yarn dev` for the sub-project (i.e. in its folder) you are working on.
|
||||||
|
|
||||||
|
For the _webview_ project, `yarn dev` will serve the react application on port 8080.
|
||||||
|
Certain query parameters need to be set, so that the UI can connect to the debug visualizer extension.
|
||||||
|
|
||||||
|
You can use VS Code to launch and debug the extension.
|
||||||
|
Choose the preconfigured `Run Extension (Dev UI)` as debug configuration
|
||||||
|
so that the extension loads the UI from the webpack server.
|
||||||
|
Otherwise, the extension will start a webserver on its own, hosting the `dist` folder of the _webview_ project.
|
||||||
|
|
||||||
|
## Publish Instructions
|
||||||
|
|
||||||
|
- Follow the Build Instructions
|
||||||
|
- `cd extension`
|
||||||
|
- `yarn pub`
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### webview
|
||||||
|
|
||||||
|
Implements the UI and is hosted inside a webview in VS Code.
|
||||||
|
Can be opened in a browser window.
|
||||||
|
Uses websockets and JSON RPC to communicate with the extension.
|
||||||
|
|
||||||
|
### visualization
|
||||||
|
|
||||||
|
Contains React components that visualize various JSON documents.
|
||||||
|
Also provides infrastructure for selecting the best visualization for a given JSON document.
|
||||||
|
|
||||||
|
### visualization-playground
|
||||||
|
|
||||||
|
A playground to test and play with the visualizations for the web.
|
||||||
|
Is hosted at [https://hediet.github.io/vscode-debug-visualizer/](https://hediet.github.io/vscode-debug-visualizer/).
|
||||||
|
Aims to have fast build times.
|
||||||
|
|
||||||
|
### extension
|
||||||
|
|
||||||
|
Creates the webview in VS Code, hosts a webserver and a websocket server.
|
||||||
|
The webserver serves the _webview_ project that is loaded by the webview.
|
||||||
|
If started with the `Run Extension (Dev UI)` debug configuration, it will load
|
||||||
|
the page from `http://localhost:8080` rather than from its own http server.
|
||||||
|
|
||||||
|
The webview is served from an http server rather than the file system to work around some security mechanisms,
|
||||||
|
which would prevent lazy chunk loading or websockets.
|
||||||
|
|
||||||
|
After the webview is loaded, it connects to the websocket server.
|
||||||
|
The websocket server is used to evaluate expressions and is secured by a random token.
|
||||||
|
|
||||||
|
### data-extraction
|
||||||
|
|
||||||
|
Provides types and a JS runtime for data extraction.
|
||||||
687
LICENSE.md
687
LICENSE.md
@@ -1,21 +1,674 @@
|
|||||||
MIT License
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Copyright (c) 2020 Henning Dieterichs
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Preamble
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
The GNU General Public License is a free, copyleft license for
|
||||||
copies or substantial portions of the Software.
|
software and other kinds of works.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
The licenses for most software and other practical works are designed
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
to take away your freedom to share and change the works. By contrast,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
share and change all versions of a program--to make sure it remains free
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
GNU General Public License for most of our software; it applies also to
|
||||||
SOFTWARE.
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program 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 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and`show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
|
|||||||
@@ -2,7 +2,10 @@
|
|||||||
|
|
||||||
[](https://twitter.com/intent/follow?screen_name=hediet_dev)
|
[](https://twitter.com/intent/follow?screen_name=hediet_dev)
|
||||||
|
|
||||||
See the [extension](extension) directory for the extension readme.
|
See [README.md](./extension/README.md) for the readme of the extension.
|
||||||
|
|
||||||
You can get the extension in the [marketplace](https://marketplace.visualstudio.com/items?itemName=hediet.debug-visualizer).
|
You can get the extension in the [marketplace](https://marketplace.visualstudio.com/items?itemName=hediet.debug-visualizer).
|
||||||
|
|
||||||
|
See [CONTRIBUTING.md](./CONTRIBUTING.md) for build instructions and implementation details.
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
21
data-extraction/LICENSE.md
Normal file
21
data-extraction/LICENSE.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2020 Henning Dieterichs
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@hediet/debug-visualizer-data-extraction",
|
"name": "@hediet/debug-visualizer-data-extraction",
|
||||||
"description": "A library that helps implementing data extractors for the Debug Visualizer VS Code extension.",
|
"description": "A library that helps implementing data extractors for the Debug Visualizer VS Code extension.",
|
||||||
"version": "0.11.0",
|
"version": "0.12.0",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
"author": {
|
"author": {
|
||||||
@@ -23,13 +23,20 @@
|
|||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "webpack --watch --mode development",
|
"dev": "webpack --watch --mode development",
|
||||||
"build": "webpack --mode production"
|
"build": "webpack --mode production",
|
||||||
|
"test": "mocha --require source-map-support/register --require ts-node/register ./test/**/*.test.ts"
|
||||||
},
|
},
|
||||||
"dependencies": {},
|
"dependencies": {},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"typescript": "^3.7.5",
|
"@types/mocha": "^7.0.2",
|
||||||
"@types/plotly.js": "^1.44.28",
|
"coveralls": "^3.0.11",
|
||||||
"@types/node": "^13.7.1",
|
"mocha": "^7.1.1",
|
||||||
|
"mocha-lcov-reporter": "^1.3.0",
|
||||||
|
"nyc": "^15.0.0",
|
||||||
|
"source-map-support": "^0.5.16",
|
||||||
|
"typescript": "^3.8.2",
|
||||||
|
"@types/plotly.js": "1.44.28",
|
||||||
|
"@types/node": "^13.7.4",
|
||||||
"tslint": "^6.0.0",
|
"tslint": "^6.0.0",
|
||||||
"webpack": "^4.41.6",
|
"webpack": "^4.41.6",
|
||||||
"webpack-cli": "^3.3.11",
|
"webpack-cli": "^3.3.11",
|
||||||
|
|||||||
@@ -9,6 +9,9 @@ import {
|
|||||||
import { ExtractedData, DataExtractorInfo } from "../../DataExtractionResult";
|
import { ExtractedData, DataExtractorInfo } from "../../DataExtractionResult";
|
||||||
import { registerDefaultExtractors } from "./default-extractors";
|
import { registerDefaultExtractors } from "./default-extractors";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*/
|
||||||
export class DataExtractorApiImpl implements DataExtractorApi {
|
export class DataExtractorApiImpl implements DataExtractorApi {
|
||||||
public static lastEvalFn: (<T>(expression: string) => T) | undefined;
|
public static lastEvalFn: (<T>(expression: string) => T) | undefined;
|
||||||
|
|
||||||
|
|||||||
@@ -1,2 +1,3 @@
|
|||||||
export * from "./DataExtractorApi";
|
export * from "./DataExtractorApi";
|
||||||
export * from "./injection";
|
export * from "./injection";
|
||||||
|
export { DataExtractorApiImpl } from "./DataExtractorApiImpl";
|
||||||
|
|||||||
31
data-extraction/src/js/helpers/cache.ts
Normal file
31
data-extraction/src/js/helpers/cache.ts
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
import { DataExtractorApiImpl } from "../api";
|
||||||
|
|
||||||
|
const cached = new Map<string, any>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Evaluates an expression
|
||||||
|
*/
|
||||||
|
export function cache<T>(
|
||||||
|
expression: string | (() => T),
|
||||||
|
id: string | number | undefined = undefined
|
||||||
|
): T {
|
||||||
|
let resultFn: () => any;
|
||||||
|
let key: string;
|
||||||
|
if (typeof expression === "string") {
|
||||||
|
const evalFn = DataExtractorApiImpl.lastEvalFn!;
|
||||||
|
resultFn = () => evalFn(expression);
|
||||||
|
key = JSON.stringify({ expr: expression, id });
|
||||||
|
} else {
|
||||||
|
resultFn = () => expression();
|
||||||
|
key = JSON.stringify({ expr: expression.toString(), id });
|
||||||
|
}
|
||||||
|
|
||||||
|
if (cached.has(key)) {
|
||||||
|
return cached.get(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = resultFn();
|
||||||
|
cached.set(key, result);
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
@@ -2,3 +2,4 @@ export * from "./createGraph";
|
|||||||
export * from "./createGraphFromPointers";
|
export * from "./createGraphFromPointers";
|
||||||
export * from "./tryEval";
|
export * from "./tryEval";
|
||||||
export * from "./markedGrid";
|
export * from "./markedGrid";
|
||||||
|
export * from "./cache";
|
||||||
|
|||||||
13
data-extraction/test/main.test.ts
Normal file
13
data-extraction/test/main.test.ts
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
import { DataExtractorApiImpl } from "../";
|
||||||
|
|
||||||
|
describe("extractor", () => {
|
||||||
|
it("should not crash", () => {
|
||||||
|
const dataExtractor = new DataExtractorApiImpl();
|
||||||
|
dataExtractor.registerDefaultExtractors();
|
||||||
|
const result = dataExtractor.getData(
|
||||||
|
() => [1, 2, 3],
|
||||||
|
() => null!,
|
||||||
|
undefined
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -3,14 +3,14 @@
|
|||||||
"target": "esnext",
|
"target": "esnext",
|
||||||
"module": "commonjs",
|
"module": "commonjs",
|
||||||
"strict": true,
|
"strict": true,
|
||||||
"outDir": "dist",
|
|
||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"rootDir": "./src",
|
"rootDir": "./",
|
||||||
"resolveJsonModule": true,
|
"resolveJsonModule": true,
|
||||||
"declaration": true,
|
"declaration": true,
|
||||||
"declarationMap": true,
|
"declarationMap": true,
|
||||||
"newLine": "LF",
|
"newLine": "LF",
|
||||||
"sourceMap": true
|
"sourceMap": true,
|
||||||
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["./src/**/*"]
|
"include": ["./**/*"]
|
||||||
}
|
}
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
"target": "esnext",
|
"target": "esnext",
|
||||||
"module": "commonjs",
|
"module": "commonjs",
|
||||||
"strict": true,
|
"strict": true,
|
||||||
"outDir": "dist",
|
"outDir": "./dist",
|
||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"rootDir": "./src",
|
"rootDir": "./src",
|
||||||
"resolveJsonModule": true,
|
"resolveJsonModule": true,
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ module.exports = {
|
|||||||
},
|
},
|
||||||
plugins: [
|
plugins: [
|
||||||
new CleanWebpackPlugin({
|
new CleanWebpackPlugin({
|
||||||
protectWebpackAssets: true,
|
//protectWebpackAssets: true,
|
||||||
cleanAfterEveryBuildPatterns: ["!**/*.d.ts", "!**/*.d.ts.map"],
|
cleanAfterEveryBuildPatterns: ["!**/*.d.ts", "!**/*.d.ts.map"],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
|
|||||||
89
demo/.vscode/launch.json
vendored
89
demo/.vscode/launch.json
vendored
@@ -1,89 +0,0 @@
|
|||||||
{
|
|
||||||
// Use IntelliSense to find out which attributes exist for C# debugging
|
|
||||||
// Use hover for the description of the existing attributes
|
|
||||||
// For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"type": "java",
|
|
||||||
"name": "CodeLens (Launch) - DemoLinkedLists",
|
|
||||||
"request": "launch",
|
|
||||||
"mainClass": "DemoLinkedLists"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"name": "TypeScript - Demo: Custom Data Extractor",
|
|
||||||
"program": "${workspaceFolder}/js/dist/demo_custom-data-extractor",
|
|
||||||
"skipFiles": ["<node_internals>/**"],
|
|
||||||
"preLaunchTask": "typescript-watch"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"name": "TypeScript - Demo: Doubly Linked List",
|
|
||||||
"program": "${workspaceFolder}/js/dist/demo_doubly-linked-list",
|
|
||||||
"skipFiles": ["<node_internals>/**"],
|
|
||||||
"preLaunchTask": "typescript-watch"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"name": "TypeScript - Demo: Sorting",
|
|
||||||
"program": "${workspaceFolder}/js/dist/demo_sorting",
|
|
||||||
"skipFiles": ["<node_internals>/**"],
|
|
||||||
"preLaunchTask": "typescript-watch"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"name": "TypeScript - Demo: Random Walks",
|
|
||||||
"program": "${workspaceFolder}/js/dist/demo_random-walks",
|
|
||||||
"skipFiles": ["<node_internals>/**"],
|
|
||||||
"preLaunchTask": "typescript-watch"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"name": "TypeScript - Demo: TypeScript ASTs",
|
|
||||||
"program": "${workspaceFolder}/js/dist/demo_typescript-asts",
|
|
||||||
"skipFiles": ["<node_internals>/**"],
|
|
||||||
"preLaunchTask": "typescript-watch",
|
|
||||||
"cwd": "${workspaceFolder}/js"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"name": "JavaScript - Demo: Singly Linked List",
|
|
||||||
"program": "${workspaceFolder}/js/src/demo_singly-linked-list",
|
|
||||||
"skipFiles": ["<node_internals>/**"],
|
|
||||||
"preLaunchTask": "typescript-watch"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "C# - Demo: Linked List",
|
|
||||||
"type": "coreclr",
|
|
||||||
"request": "launch",
|
|
||||||
"preLaunchTask": "csharp-build",
|
|
||||||
"program": "${workspaceFolder}/csharp/bin/Debug/netcoreapp3.1/demo.dll",
|
|
||||||
"args": [],
|
|
||||||
"cwd": "${workspaceFolder}/csharp",
|
|
||||||
"console": "internalConsole",
|
|
||||||
"stopAtEntry": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "PHP - Demo",
|
|
||||||
"type": "php",
|
|
||||||
"request": "launch",
|
|
||||||
"program": "${workspaceFolder}/php/demo.php",
|
|
||||||
"xdebugSettings": {
|
|
||||||
"max_data": -1
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Java - Demo",
|
|
||||||
"type": "java",
|
|
||||||
"request": "launch",
|
|
||||||
"projectName": "java"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
4
demo/.vscode/settings.json
vendored
4
demo/.vscode/settings.json
vendored
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"debugVisualizer.useChromeKioskMode": false,
|
|
||||||
"editor.minimap.enabled": false
|
|
||||||
}
|
|
||||||
4
demo/java/.vscode/settings.json
vendored
4
demo/java/.vscode/settings.json
vendored
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"java.dependency.packagePresentation": "flat",
|
|
||||||
"java.dependency.syncWithFolderExplorer": true
|
|
||||||
}
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "demo",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"license": "MIT",
|
|
||||||
"dependencies": {
|
|
||||||
"@hediet/live-debug": "^0.5.2",
|
|
||||||
"@hediet/node-reload": "0.7.0",
|
|
||||||
"@hediet/std": "^0.4.0",
|
|
||||||
"@types/node": "^13.7.1",
|
|
||||||
"typescript": "^3.5.3"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"dev": "tsc --watch"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
1
demos/cpp/.gitignore
vendored
Normal file
1
demos/cpp/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
main
|
||||||
29
demos/cpp/.vscode/launch.json
vendored
Normal file
29
demos/cpp/.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
{
|
||||||
|
// Use IntelliSense to learn about possible attributes.
|
||||||
|
// Hover to view descriptions of existing attributes.
|
||||||
|
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "g++ build and debug active file",
|
||||||
|
"type": "cppdbg",
|
||||||
|
"request": "launch",
|
||||||
|
"program": "${fileDirname}/${fileBasenameNoExtension}",
|
||||||
|
"args": [],
|
||||||
|
"stopAtEntry": false,
|
||||||
|
"cwd": "${workspaceFolder}",
|
||||||
|
"environment": [],
|
||||||
|
"externalConsole": false,
|
||||||
|
"MIMode": "gdb",
|
||||||
|
"setupCommands": [
|
||||||
|
{
|
||||||
|
"description": "Enable pretty-printing for gdb",
|
||||||
|
"text": "-enable-pretty-printing",
|
||||||
|
"ignoreFailures": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"preLaunchTask": "g++ build active file",
|
||||||
|
"miDebuggerPath": "/usr/bin/gdb"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
25
demos/cpp/.vscode/tasks.json
vendored
Normal file
25
demos/cpp/.vscode/tasks.json
vendored
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
{
|
||||||
|
// See https://go.microsoft.com/fwlink/?LinkId=733558
|
||||||
|
// for the documentation about the tasks.json format
|
||||||
|
"version": "2.0.0",
|
||||||
|
"tasks": [
|
||||||
|
{
|
||||||
|
"type": "shell",
|
||||||
|
"label": "g++ build active file",
|
||||||
|
"command": "/usr/bin/g++",
|
||||||
|
"args": [
|
||||||
|
"-g",
|
||||||
|
"${file}",
|
||||||
|
"-o",
|
||||||
|
"${fileDirname}/${fileBasenameNoExtension}"
|
||||||
|
],
|
||||||
|
"options": {
|
||||||
|
"cwd": "/usr/bin"
|
||||||
|
},
|
||||||
|
"problemMatcher": [
|
||||||
|
"$gcc"
|
||||||
|
],
|
||||||
|
"group": "build"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
14
demos/cpp/main.cpp
Normal file
14
demos/cpp/main.cpp
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
#include <iostream>
|
||||||
|
#include <vector>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
// visualize `myGraphJson`!
|
||||||
|
string myGraphJson = "{\"kind\":{\"graph\":true},"
|
||||||
|
"\"nodes\":[{\"id\":\"1\"},{\"id\":\"2\"}],"
|
||||||
|
"\"edges\":[{\"from\":\"1\",\"to\":\"2\"}]}";
|
||||||
|
cout << myGraphJson;
|
||||||
|
}
|
||||||
19
demos/csharp/.vscode/launch.json
vendored
Normal file
19
demos/csharp/.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
// Use IntelliSense to find out which attributes exist for C# debugging
|
||||||
|
// Use hover for the description of the existing attributes
|
||||||
|
// For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "C# - Demo: Linked List",
|
||||||
|
"type": "coreclr",
|
||||||
|
"request": "launch",
|
||||||
|
"preLaunchTask": "csharp-build",
|
||||||
|
"program": "${workspaceFolder}/bin/Debug/netcoreapp3.1/demo.dll",
|
||||||
|
"args": [],
|
||||||
|
"cwd": "${workspaceFolder}",
|
||||||
|
"console": "internalConsole",
|
||||||
|
"stopAtEntry": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
3
demos/csharp/.vscode/settings.json
vendored
Normal file
3
demos/csharp/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"debugVisualizer.debugAdapterConfigurations": {}
|
||||||
|
}
|
||||||
@@ -1,21 +1,6 @@
|
|||||||
{
|
{
|
||||||
"version": "2.0.0",
|
"version": "2.0.0",
|
||||||
"tasks": [
|
"tasks": [
|
||||||
{
|
|
||||||
"type": "npm",
|
|
||||||
"label": "typescript-watch",
|
|
||||||
"script": "dev",
|
|
||||||
"problemMatcher": "$tsc-watch",
|
|
||||||
"isBackground": true,
|
|
||||||
"presentation": {
|
|
||||||
"reveal": "never"
|
|
||||||
},
|
|
||||||
"path": "js/",
|
|
||||||
"group": {
|
|
||||||
"kind": "build",
|
|
||||||
"isDefault": true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"label": "csharp-build",
|
"label": "csharp-build",
|
||||||
"command": "dotnet",
|
"command": "dotnet",
|
||||||
@@ -52,7 +52,7 @@ namespace Demo
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public ExtractedData Visualize()
|
public string Visualize()
|
||||||
{
|
{
|
||||||
var list = new Node(default(T)!) { Next = this.Head };
|
var list = new Node(default(T)!) { Next = this.Head };
|
||||||
return GraphData.From(new[] { list }, (item, info) =>
|
return GraphData.From(new[] { list }, (item, info) =>
|
||||||
@@ -65,7 +65,7 @@ namespace Demo
|
|||||||
if (item.Next != null)
|
if (item.Next != null)
|
||||||
info.AddEdge(item.Next!, label: item == list ? "head" : "next");
|
info.AddEdge(item.Next!, label: item == list ? "head" : "next");
|
||||||
return info;
|
return info;
|
||||||
});
|
}).ToString();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
21
demos/golang/.vscode/launch.json
vendored
Normal file
21
demos/golang/.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "Launch",
|
||||||
|
"type": "go",
|
||||||
|
"request": "launch",
|
||||||
|
"mode": "auto",
|
||||||
|
"program": "${fileDirname}",
|
||||||
|
"env": {},
|
||||||
|
"args": [],
|
||||||
|
"dlvLoadConfig": {
|
||||||
|
"followPointers": true,
|
||||||
|
"maxVariableRecurse": 1,
|
||||||
|
"maxStringLen": 5000,
|
||||||
|
"maxArrayValues": 64,
|
||||||
|
"maxStructFields": -1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
91
demos/golang/demo.go
Normal file
91
demos/golang/demo.go
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"math/rand"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// If you want to visualize large data structures,
|
||||||
|
// you need to increase Delve's maxStringLen.
|
||||||
|
// (See here https://github.com/microsoft/vscode-go/issues/868 for more info)
|
||||||
|
// You can do this by adding the following configuration to your launch.json:
|
||||||
|
// "dlvLoadConfig": {
|
||||||
|
// "followPointers": true,
|
||||||
|
// "maxVariableRecurse": 1,
|
||||||
|
// "maxStringLen": 5000,
|
||||||
|
// "maxArrayValues": 64,
|
||||||
|
// "maxStructFields": -1
|
||||||
|
// }
|
||||||
|
// For debugging tests, you can set the maxStringLen in settings.json like this:
|
||||||
|
// "go.delveConfig": {
|
||||||
|
// "dlvLoadConfig": {
|
||||||
|
// "followPointers": true,
|
||||||
|
// "maxVariableRecurse": 1,
|
||||||
|
// "maxStringLen": 5000,
|
||||||
|
// "maxArrayValues": 64,
|
||||||
|
// "maxStructFields": -1
|
||||||
|
// },
|
||||||
|
// "apiVersion": 2,
|
||||||
|
// "showGlobalVariables": true
|
||||||
|
// }
|
||||||
|
|
||||||
|
// Open a new Debug Visualizer and visualize "s"
|
||||||
|
func main() {
|
||||||
|
rand.Seed(time.Now().UnixNano())
|
||||||
|
graph := NewGraph()
|
||||||
|
var s string
|
||||||
|
for i := 0; i < 100; i++ {
|
||||||
|
id := strconv.Itoa(i)
|
||||||
|
graph.Nodes = append(graph.Nodes, NodeGraphData{
|
||||||
|
ID: id,
|
||||||
|
Label: id,
|
||||||
|
})
|
||||||
|
if i > 0 {
|
||||||
|
targetId := rand.Intn(i)
|
||||||
|
graph.Edges = append(graph.Edges, EdgeGraphData{
|
||||||
|
From: id,
|
||||||
|
To: strconv.Itoa(targetId),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
s = graph.toString()
|
||||||
|
_ = s
|
||||||
|
//fmt.Printf("%s", s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type Graph struct {
|
||||||
|
Kind map[string]bool `json:"kind"`
|
||||||
|
Nodes []NodeGraphData `json:"nodes"`
|
||||||
|
Edges []EdgeGraphData `json:"edges"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type NodeGraphData struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Label string `json:"label,omitempty"`
|
||||||
|
Color string `json:"color,omitempty"`
|
||||||
|
Shape string `json:"shape,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type EdgeGraphData struct {
|
||||||
|
From string `json:"from"`
|
||||||
|
To string `json:"to"`
|
||||||
|
Label string `json:"label,omitempty"`
|
||||||
|
ID string `json:"id"`
|
||||||
|
Color string `json:"color,omitempty"`
|
||||||
|
Dashes bool `json:"dashes,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewGraph() *Graph {
|
||||||
|
return &Graph{
|
||||||
|
Kind: map[string]bool{"graph": true},
|
||||||
|
Nodes: []NodeGraphData{},
|
||||||
|
Edges: []EdgeGraphData{},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (this *Graph) toString() string {
|
||||||
|
rs, _ := json.Marshal(this)
|
||||||
|
return string(rs)
|
||||||
|
}
|
||||||
3
demos/golang/go.mod
Normal file
3
demos/golang/go.mod
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
module demo
|
||||||
|
|
||||||
|
go 1.13
|
||||||
4
demo/java/.gitignore → demos/java/.gitignore
vendored
4
demo/java/.gitignore → demos/java/.gitignore
vendored
@@ -20,4 +20,6 @@
|
|||||||
*.rar
|
*.rar
|
||||||
|
|
||||||
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
|
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
|
||||||
hs_err_pid*
|
hs_err_pid*
|
||||||
|
|
||||||
|
!lib/**
|
||||||
20
demos/java/.vscode/launch.json
vendored
Normal file
20
demos/java/.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
{
|
||||||
|
// Use IntelliSense to find out which attributes exist for C# debugging
|
||||||
|
// Use hover for the description of the existing attributes
|
||||||
|
// For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"type": "java",
|
||||||
|
"name": "CodeLens (Launch) - DemoLinkedLists",
|
||||||
|
"request": "launch",
|
||||||
|
"mainClass": "DemoLinkedLists"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Java - Demo",
|
||||||
|
"type": "java",
|
||||||
|
"request": "launch",
|
||||||
|
"projectName": "java"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
5
demos/java/.vscode/settings.json
vendored
Normal file
5
demos/java/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"java.dependency.packagePresentation": "flat",
|
||||||
|
"java.dependency.syncWithFolderExplorer": true,
|
||||||
|
"debugVisualizer.debugAdapterConfigurations": {}
|
||||||
|
}
|
||||||
BIN
demos/java/lib/jackson-annotations-2.9.8.jar
Normal file
BIN
demos/java/lib/jackson-annotations-2.9.8.jar
Normal file
Binary file not shown.
BIN
demos/java/lib/jackson-core-2.9.8.jar
Normal file
BIN
demos/java/lib/jackson-core-2.9.8.jar
Normal file
Binary file not shown.
BIN
demos/java/lib/jackson-databind-2.9.8.jar
Normal file
BIN
demos/java/lib/jackson-databind-2.9.8.jar
Normal file
Binary file not shown.
18
demos/js/.vscode/tasks.json
vendored
Normal file
18
demos/js/.vscode/tasks.json
vendored
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"version": "2.0.0",
|
||||||
|
"tasks": [
|
||||||
|
{
|
||||||
|
"type": "npm",
|
||||||
|
"script": "dev",
|
||||||
|
"problemMatcher": "$tsc-watch",
|
||||||
|
"isBackground": true,
|
||||||
|
"presentation": {
|
||||||
|
"reveal": "never"
|
||||||
|
},
|
||||||
|
"group": {
|
||||||
|
"kind": "build",
|
||||||
|
"isDefault": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
13
demos/js/package.json
Normal file
13
demos/js/package.json
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"name": "demo",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@hediet/node-reload": "0.7.3",
|
||||||
|
"@types/node": "^13.7.4",
|
||||||
|
"typescript": "^3.8.2"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"dev": "tsc --watch"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -65,12 +65,6 @@ class Test1 {
|
|||||||
};
|
};
|
||||||
console.log("myValue is AST, annotated with symbol information");
|
console.log("myValue is AST, annotated with symbol information");
|
||||||
debugger;
|
debugger;
|
||||||
|
|
||||||
for (const ident of identifiers) {
|
|
||||||
myValue = ident;
|
|
||||||
console.log("myValue is an identifier");
|
|
||||||
debugger;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
17
demos/php/.vscode/launch.json
vendored
Normal file
17
demos/php/.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
// Use IntelliSense to find out which attributes exist for C# debugging
|
||||||
|
// Use hover for the description of the existing attributes
|
||||||
|
// For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "PHP - Demo",
|
||||||
|
"type": "php",
|
||||||
|
"request": "launch",
|
||||||
|
"program": "${workspaceFolder}/demo.php",
|
||||||
|
"xdebugSettings": {
|
||||||
|
"max_data": -1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
8
demos/php/.vscode/settings.json
vendored
Normal file
8
demos/php/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"debugVisualizer.debugAdapterConfigurations": {
|
||||||
|
"php": {
|
||||||
|
"context": "watch",
|
||||||
|
"expressionTemplate": "${expr}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
7
demos/python/.vscode/launch.json
vendored
Normal file
7
demos/python/.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
// Use IntelliSense to find out which attributes exist for C# debugging
|
||||||
|
// Use hover for the description of the existing attributes
|
||||||
|
// For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": []
|
||||||
|
}
|
||||||
36
demos/python/graph.py
Normal file
36
demos/python/graph.py
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Install the python extension for VS Code
|
||||||
|
# (https:#marketplace.visualstudio.com/items?itemName=ms-python.python).
|
||||||
|
|
||||||
|
# The Debug Visualizer has no support for Python data extractors yet,
|
||||||
|
# so to visualize data, your value must be a valid JSON string representing the data.
|
||||||
|
# See readme for supported data schemas.
|
||||||
|
|
||||||
|
from json import dumps
|
||||||
|
from random import randint
|
||||||
|
|
||||||
|
graph = {
|
||||||
|
"kind": {"graph": True},
|
||||||
|
"nodes": [
|
||||||
|
{"id": "1", "label": "1"}
|
||||||
|
],
|
||||||
|
"edges": []
|
||||||
|
}
|
||||||
|
|
||||||
|
for i in range(2,100):
|
||||||
|
# add a node
|
||||||
|
id = str(i)
|
||||||
|
graph["nodes"].append({"id": id, "label": id})
|
||||||
|
# connects the node to a random edge
|
||||||
|
targetId = str(randint(1, i - 1))
|
||||||
|
graph["edges"].append({"from": id, "to": targetId})
|
||||||
|
json_graph = dumps(graph)
|
||||||
|
print("i is " + str(i))
|
||||||
|
# try setting a breakpoint right above
|
||||||
|
# then put json_graph into the visualization console and press enter
|
||||||
|
# when you step through the code each time you hit the breakpoint
|
||||||
|
# the graph should automatically refresh!
|
||||||
|
|
||||||
|
# example of json_graph visualization with 10 nodes:
|
||||||
|
# https://i.imgur.com/RqZuYHH.png
|
||||||
|
|
||||||
|
print("finished")
|
||||||
10
demos/rust/.gitignore
vendored
Normal file
10
demos/rust/.gitignore
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Generated by Cargo
|
||||||
|
# will have compiled files and executables
|
||||||
|
/target/
|
||||||
|
|
||||||
|
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
|
||||||
|
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
|
||||||
|
Cargo.lock
|
||||||
|
|
||||||
|
# These are backup files generated by rustfmt
|
||||||
|
**/*.rs.bk
|
||||||
16
demos/rust/.vscode/launch.json
vendored
Normal file
16
demos/rust/.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
// Use IntelliSense to learn about possible attributes.
|
||||||
|
// Hover to view descriptions of existing attributes.
|
||||||
|
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"type": "lldb",
|
||||||
|
"request": "launch",
|
||||||
|
"name": "Debug",
|
||||||
|
"program": "${workspaceFolder}/target/debug/rust_demo",
|
||||||
|
"args": [],
|
||||||
|
"cwd": "${workspaceFolder}"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
11
demos/rust/Cargo.toml
Normal file
11
demos/rust/Cargo.toml
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
[package]
|
||||||
|
name = "rust_demo"
|
||||||
|
version = "0.1.0"
|
||||||
|
authors = ["hediet"]
|
||||||
|
edition = "2018"
|
||||||
|
|
||||||
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
serde = { version = "1.0", features = ["derive"] }
|
||||||
|
serde_json = "1.0"
|
||||||
89
demos/rust/src/main.rs
Normal file
89
demos/rust/src/main.rs
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
use serde::Serialize;
|
||||||
|
|
||||||
|
#[derive(Debug, Serialize)]
|
||||||
|
struct Label {
|
||||||
|
label: Option<String>,
|
||||||
|
}
|
||||||
|
#[derive(Debug, Serialize)]
|
||||||
|
struct Row {
|
||||||
|
label: Option<String>,
|
||||||
|
columns: Vec<Column>,
|
||||||
|
}
|
||||||
|
#[derive(Debug, Serialize)]
|
||||||
|
struct Column {
|
||||||
|
content: Option<String>,
|
||||||
|
tag: Option<String>,
|
||||||
|
color: Option<String>,
|
||||||
|
}
|
||||||
|
#[derive(Debug, Serialize)]
|
||||||
|
struct Marker {
|
||||||
|
id: String,
|
||||||
|
row: u64,
|
||||||
|
column: u64,
|
||||||
|
rows: Option<u64>,
|
||||||
|
columns: Option<u64>,
|
||||||
|
label: Option<String>,
|
||||||
|
color: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::trivially_copy_pass_by_ref)]
|
||||||
|
fn is_false(b: &bool) -> bool {
|
||||||
|
!*b
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Serialize)]
|
||||||
|
struct Kind {
|
||||||
|
#[serde(skip_serializing_if = "is_false")]
|
||||||
|
array: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Serialize)]
|
||||||
|
pub struct Grid {
|
||||||
|
kind: Kind,
|
||||||
|
#[serde(rename = "columnLabels")]
|
||||||
|
column_labels: Option<Vec<Label>>,
|
||||||
|
rows: Vec<Row>,
|
||||||
|
markers: Option<Vec<Marker>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn show_arr(a: &[i32]) -> String {
|
||||||
|
let n = a.len();
|
||||||
|
let labels: Vec<Label> = (0..n)
|
||||||
|
.map(|i| Label {
|
||||||
|
label: Some(i.to_string()),
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
let columns: Vec<Column> = a
|
||||||
|
.iter()
|
||||||
|
.map(|x| Column {
|
||||||
|
content: Some(format!("{:?}", x)),
|
||||||
|
tag: Some(x.to_string()),
|
||||||
|
color: None,
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
let row = Row {
|
||||||
|
label: None,
|
||||||
|
columns,
|
||||||
|
};
|
||||||
|
let kind = Kind { array: true };
|
||||||
|
|
||||||
|
let grid = Grid {
|
||||||
|
kind,
|
||||||
|
column_labels: Some(labels),
|
||||||
|
rows: vec![row],
|
||||||
|
markers: None,
|
||||||
|
};
|
||||||
|
|
||||||
|
serde_json::to_string(&grid).unwrap()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
let mut arr = vec![1, 2, 3];
|
||||||
|
let mut _s = show_arr(&arr);
|
||||||
|
for _ in 0..5 {
|
||||||
|
arr.swap(0, 2); // break point
|
||||||
|
_s = show_arr(&arr);
|
||||||
|
}
|
||||||
|
dbg!(arr); // break point
|
||||||
|
println!("Hello, world!");
|
||||||
|
}
|
||||||
5
demos/swift/.gitignore
vendored
Normal file
5
demos/swift/.gitignore
vendored
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
.DS_Store
|
||||||
|
/.build
|
||||||
|
/Packages
|
||||||
|
/*.xcodeproj
|
||||||
|
xcuserdata/
|
||||||
16
demos/swift/.vscode/launch.json
vendored
Normal file
16
demos/swift/.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
// .vscode/launch.json
|
||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
// Running executables
|
||||||
|
{
|
||||||
|
"type": "lldb",
|
||||||
|
"request": "launch",
|
||||||
|
"name": "Run your Executable",
|
||||||
|
"program": "${workspaceFolder}/.build/debug/swiftDemo",
|
||||||
|
"args": [],
|
||||||
|
"cwd": "${workspaceFolder}",
|
||||||
|
"preLaunchTask": "swift-build"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
6
demos/swift/.vscode/settings.json
vendored
Normal file
6
demos/swift/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
// You need to adapt this path to your swift installation.
|
||||||
|
// See here for more info:
|
||||||
|
// https://github.com/vadimcn/vscode-lldb/issues/234
|
||||||
|
"lldb.library": "/home/hediet/swift-5.1.5-RELEASE-ubuntu14.04/usr/lib/liblldb.so"
|
||||||
|
}
|
||||||
23
demos/swift/.vscode/tasks.json
vendored
Normal file
23
demos/swift/.vscode/tasks.json
vendored
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"version": "2.0.0",
|
||||||
|
"tasks": [
|
||||||
|
// compile your SPM project
|
||||||
|
{
|
||||||
|
"label": "swift-build",
|
||||||
|
"type": "shell",
|
||||||
|
"command": "swift build" // for TensorFlow add -Xlinker -ltensorflow
|
||||||
|
},
|
||||||
|
// compile your SPM tests
|
||||||
|
{
|
||||||
|
"label": "swift-build-tests",
|
||||||
|
"type": "process",
|
||||||
|
"command": "swift",
|
||||||
|
"group": "build",
|
||||||
|
"args": [
|
||||||
|
"build",
|
||||||
|
"--build-tests"
|
||||||
|
// for TensorFlow add "-Xlinker", "-ltensorflow"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
22
demos/swift/Package.swift
Normal file
22
demos/swift/Package.swift
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
// swift-tools-version:5.1
|
||||||
|
// The swift-tools-version declares the minimum version of Swift required to build this package.
|
||||||
|
|
||||||
|
import PackageDescription
|
||||||
|
|
||||||
|
let package = Package(
|
||||||
|
name: "swiftDemo",
|
||||||
|
dependencies: [
|
||||||
|
// Dependencies declare other packages that this package depends on.
|
||||||
|
// .package(url: /* package url */, from: "1.0.0"),
|
||||||
|
],
|
||||||
|
targets: [
|
||||||
|
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
|
||||||
|
// Targets can depend on other targets in this package, and on products in packages which this package depends on.
|
||||||
|
.target(
|
||||||
|
name: "swiftDemo",
|
||||||
|
dependencies: []),
|
||||||
|
.testTarget(
|
||||||
|
name: "swiftDemoTests",
|
||||||
|
dependencies: ["swiftDemo"]),
|
||||||
|
]
|
||||||
|
)
|
||||||
5
demos/swift/Sources/swiftDemo/main.swift
Normal file
5
demos/swift/Sources/swiftDemo/main.swift
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
let s = "{\"kind\":{\"graph\":true},"
|
||||||
|
+ "\"nodes\":[{\"id\":\"1\"},{\"id\":\"2\"}],"
|
||||||
|
+ "\"edges\":[{\"from\":\"1\",\"to\":\"2\"}]}";
|
||||||
|
|
||||||
|
print(s)
|
||||||
7
demos/swift/Tests/LinuxMain.swift
Normal file
7
demos/swift/Tests/LinuxMain.swift
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
import XCTest
|
||||||
|
|
||||||
|
import swiftTests
|
||||||
|
|
||||||
|
var tests = [XCTestCaseEntry]()
|
||||||
|
tests += swiftTests.allTests()
|
||||||
|
XCTMain(tests)
|
||||||
9
demos/swift/Tests/swiftDemoTests/XCTestManifests.swift
Normal file
9
demos/swift/Tests/swiftDemoTests/XCTestManifests.swift
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import XCTest
|
||||||
|
|
||||||
|
#if !canImport(ObjectiveC)
|
||||||
|
public func allTests() -> [XCTestCaseEntry] {
|
||||||
|
return [
|
||||||
|
testCase(swiftTests.allTests),
|
||||||
|
]
|
||||||
|
}
|
||||||
|
#endif
|
||||||
47
demos/swift/Tests/swiftDemoTests/swiftDemoTests.swift
Normal file
47
demos/swift/Tests/swiftDemoTests/swiftDemoTests.swift
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
import XCTest
|
||||||
|
import class Foundation.Bundle
|
||||||
|
|
||||||
|
final class swiftTests: XCTestCase {
|
||||||
|
func testExample() throws {
|
||||||
|
// This is an example of a functional test case.
|
||||||
|
// Use XCTAssert and related functions to verify your tests produce the correct
|
||||||
|
// results.
|
||||||
|
|
||||||
|
// Some of the APIs that we use below are available in macOS 10.13 and above.
|
||||||
|
guard #available(macOS 10.13, *) else {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
let fooBinary = productsDirectory.appendingPathComponent("swift")
|
||||||
|
|
||||||
|
let process = Process()
|
||||||
|
process.executableURL = fooBinary
|
||||||
|
|
||||||
|
let pipe = Pipe()
|
||||||
|
process.standardOutput = pipe
|
||||||
|
|
||||||
|
try process.run()
|
||||||
|
process.waitUntilExit()
|
||||||
|
|
||||||
|
let data = pipe.fileHandleForReading.readDataToEndOfFile()
|
||||||
|
let output = String(data: data, encoding: .utf8)
|
||||||
|
|
||||||
|
XCTAssertEqual(output, "Hello, world!\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns path to the built products directory.
|
||||||
|
var productsDirectory: URL {
|
||||||
|
#if os(macOS)
|
||||||
|
for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(".xctest") {
|
||||||
|
return bundle.bundleURL.deletingLastPathComponent()
|
||||||
|
}
|
||||||
|
fatalError("couldn't find the products directory")
|
||||||
|
#else
|
||||||
|
return Bundle.main.bundleURL
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
static var allTests = [
|
||||||
|
("testExample", testExample),
|
||||||
|
]
|
||||||
|
}
|
||||||
2
demos/swift/main.swift
Normal file
2
demos/swift/main.swift
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
import Swift
|
||||||
|
print("Hello, World!")
|
||||||
BIN
docs/exported/main/Main.png
Normal file
BIN
docs/exported/main/Main.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
BIN
docs/input-autocompletion.png
Normal file
BIN
docs/input-autocompletion.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 192 KiB |
20
docs/main.plantuml
Normal file
20
docs/main.plantuml
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
@startuml Main
|
||||||
|
|
||||||
|
[data-extraction]
|
||||||
|
[webview]
|
||||||
|
[extension]
|
||||||
|
[visualization]
|
||||||
|
[visualization-playground]
|
||||||
|
|
||||||
|
[webview] ..> [extension]: "Uses RPC contracts, connects using websockets"
|
||||||
|
[extension] ..> [webview]: "Loads into a Webview in VS Code"
|
||||||
|
|
||||||
|
[webview] ..> [visualization]: "Uses React Components"
|
||||||
|
|
||||||
|
[visualization-playground] ..> [visualization]: "Uses React Components"
|
||||||
|
|
||||||
|
[extension] ..> [data-extraction]: "Injects Runtime into JavaScript applications"
|
||||||
|
|
||||||
|
[webview] ..> [data-extraction]: "Uses common types"
|
||||||
|
|
||||||
|
@enduml
|
||||||
@@ -1,13 +1,42 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
## 0.9.0
|
## 1.0.0
|
||||||
|
|
||||||
- Initial release
|
- "Debug Visualizer: Use Selection as Expression" will open a new view if no Debug Visualizer view was opened.
|
||||||
|
- Enables type based autocompletion in the input field when debugging JavaScript/TypeScript.
|
||||||
|
- Changes license from MIT to GPL-3.0.
|
||||||
|
- Fixes bug where loading animation didn't stop.
|
||||||
|
- Catches visualization errors rather than letting the entire webview crash.
|
||||||
|
|
||||||
## 0.10.0
|
## 0.14.0
|
||||||
|
|
||||||
- Minor refactoring of `@hediet/debug-visualizer-data-extraction`'s API
|
- Submits the expression when the expression input loses focus.
|
||||||
- Improved documentation.
|
- Changes text of command "Open a new Debug Visualizer View" to "Debug Visualizer: New View".
|
||||||
|
- Adds command "Debug Visualizer: Use Selection as Expression" (Shift+F1)
|
||||||
|
- Optimizes load time by splitting code into multiple bundles.
|
||||||
|
- Fixes monaco load errors.
|
||||||
|
- Sets the mode of the expression input to text rather than typescript, as this extension supports multiple languages.
|
||||||
|
- Improves error messages.
|
||||||
|
|
||||||
|
## 0.13.0
|
||||||
|
|
||||||
|
- Adds "debugVisualizer.debugAdapterConfigurations" config to customize the expression template.
|
||||||
|
- Code Restructuring
|
||||||
|
|
||||||
|
## 0.12.1
|
||||||
|
|
||||||
|
- Tries to parse evaluated strings twice as JSON in case of C++/C# escape sequences.
|
||||||
|
|
||||||
|
## 0.12.0
|
||||||
|
|
||||||
|
- Generic Debug Adapter Support (tested with PHP, Java, C#)
|
||||||
|
- Dark Theme Support
|
||||||
|
- Grid Visualizer
|
||||||
|
- Some Bugfixes
|
||||||
|
|
||||||
|
## 0.11.1
|
||||||
|
|
||||||
|
- Fixes crash on start
|
||||||
|
|
||||||
## 0.11.0
|
## 0.11.0
|
||||||
|
|
||||||
@@ -18,6 +47,11 @@
|
|||||||
- Plotly Data Extractor
|
- Plotly Data Extractor
|
||||||
- Some Bugfixes
|
- Some Bugfixes
|
||||||
|
|
||||||
## 0.11.1
|
## 0.10.0
|
||||||
|
|
||||||
- Fixes crash on start
|
- Minor refactoring of `@hediet/debug-visualizer-data-extraction`'s API
|
||||||
|
- Improved documentation.
|
||||||
|
|
||||||
|
## 0.9.0
|
||||||
|
|
||||||
|
- Initial release
|
||||||
|
|||||||
@@ -4,19 +4,37 @@
|
|||||||
|
|
||||||
A VS Code extension for visualizing data structures while debugging.
|
A VS Code extension for visualizing data structures while debugging.
|
||||||
|
|
||||||
Works best with JavaScript/TypeScript.
|
|
||||||
Also tested with C#, Java and PHP. Works with any language that you can debug in VS Code.
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## Supported Languages
|
||||||
|
|
||||||
|
See [demos](./demos/) for demos. These languages and debuggers are verified to work with this extension:
|
||||||
|
|
||||||
|
- JavaScript/TypeScript/... using `node`/`node2`/`extensionHost` or `chrome` debug adapter: [⭐ Full Support](../demos/js)
|
||||||
|
- Go using `go` (Delve) debug adapter: [✅ Rudimentary Support](../demos/golang)
|
||||||
|
- Python using `python` debug adapter: [✅ Rudimentary Support](../demos/python)
|
||||||
|
- C# using `coreclr` debug adapter: [✅ Rudimentary Support](../demos/csharp)
|
||||||
|
- PHP using `php` debug adapter: [✅ Rudimentary Support](../demos/php)
|
||||||
|
- Java using `java` debug adapter: [✅ Rudimentary Support](../demos/java)
|
||||||
|
- C++ using `cppdbg` debug adapter: [✅ Rudimentary Support](../demos/cpp)
|
||||||
|
- Swift using `lldb` debug adapter: [✅ Rudimentary Support](../demos/swift)
|
||||||
|
- Rust using `lldb` debug adapter: [✅ Rudimentary Support](../demos/rust)
|
||||||
|
|
||||||
|
All other languages and debuggers might work too.
|
||||||
|
For languages with _Rudimentary Support_, only JSON strings can be visualized - you must implement some logic that builds this JSON for your data structure!
|
||||||
|
Fully supported languages offer _Data Extractors_ which convert some well known data structures to json.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
After installing this extension, use the command `Open a new Debug Visualizer View` to open a new visualizer view.
|
After installing this extension, use the command `Debug Visualizer: New View` to open a new visualizer view.
|
||||||
In this view you can enter an expression that is evaluated and visualized while stepping through your application.
|
In this view you can enter an expression that is evaluated and visualized while stepping through your application.
|
||||||
|
|
||||||
You can refresh the evaluation and pop out the current visualizer view into a new browser window by using the top right buttons.
|
You can refresh the evaluation and pop out the current visualizer view into a new browser window by using the top right buttons.
|
||||||
You can also unfold the details pane to select a _Data Extractor_ and a _Visualizer_.
|
You can also unfold the details pane to select a _Data Extractor_ and a _Visualizer_.
|
||||||
|
|
||||||
|
Use the command `Debug Visualizer: Use Selection as Expression` (Shift + F1) to use the currently selected text as expression
|
||||||
|
in the most recently opened debug visualizer.
|
||||||
|
|
||||||
## Supported Values
|
## Supported Values
|
||||||
|
|
||||||
Visualizers consume specific JSON data. See [Integrated Visualizers](#Integrated%20Visualizers) for the schema of supported JSON data.
|
Visualizers consume specific JSON data. See [Integrated Visualizers](#Integrated%20Visualizers) for the schema of supported JSON data.
|
||||||
@@ -36,6 +54,7 @@ The following visualizers are built into this extension.
|
|||||||
|
|
||||||
### Graph Visualization
|
### Graph Visualization
|
||||||
|
|
||||||
|
[Demo](https://hediet.github.io/vscode-debug-visualizer/?value=%7B%0A++++%22kind%22%3A+%7B+%22graph%22%3A+true+%7D%2C%0A++++%22nodes%22%3A+%5B%0A++++++++%7B+%22id%22%3A+%221%22%2C+%22label%22%3A+%221%22+%7D%2C%0A++++++++%7B+%22id%22%3A+%222%22%2C+%22label%22%3A+%222%22%2C+%22color%22%3A+%22orange%22+%7D%2C%0A++++++++%7B+%22id%22%3A+%223%22%2C+%22label%22%3A+%223%22+%7D%0A++++%5D%2C%0A++++%22edges%22%3A+%5B%0A++++++++%7B+%22from%22%3A+%221%22%2C+%22to%22%3A+%222%22%2C+%22color%22%3A+%22red%22+%7D%2C%0A++++++++%7B+%22from%22%3A+%221%22%2C+%22to%22%3A+%223%22+%7D%0A++++%5D%0A%7D).
|
||||||
The Graphviz and vis.js visualizers render data that matches the `Graph` interface.
|
The Graphviz and vis.js visualizers render data that matches the `Graph` interface.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -69,6 +88,7 @@ The graphviz visualizer uses the SVG viewer to render the SVG created by `viz.js
|
|||||||
|
|
||||||
### Plotly Visualization
|
### Plotly Visualization
|
||||||
|
|
||||||
|
[Demo](https://hediet.github.io/vscode-debug-visualizer/?value=%7B%22kind%22%3A%7B%22plotly%22%3Atrue%7D%2C%22data%22%3A%5B%7B%22y%22%3A%5B0%2C1%2C2%2C3%2C4%2C3%2C4%2C3%2C2%2C1%2C2%5D%7D%5D%7D).
|
||||||
The plotly visualizer uses plotly and can visualize JSON data matching the following interface:
|
The plotly visualizer uses plotly and can visualize JSON data matching the following interface:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -105,6 +125,7 @@ interface TreeNode<TExtraData> {
|
|||||||
|
|
||||||
### AST Visualization
|
### AST Visualization
|
||||||
|
|
||||||
|
[Demo](https://hediet.github.io/vscode-debug-visualizer/?value=%7B%22kind%22%3A%7B%22text%22%3Atrue%2C%22tree%22%3Atrue%2C%22ast%22%3Atrue%7D%2C%22root%22%3A%7B%22name%22%3A%22SourceFile%22%2C%22id%22%3A%22root%22%2C%22children%22%3A%5B%7B%22name%22%3A%22ClassDeclaration%22%2C%22id%22%3A%22statements%22%2C%22children%22%3A%5B%7B%22name%22%3A%22Identifier%22%2C%22id%22%3A%22name%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A6%2C%22position%22%3A6%7D%2C%22isMarked%22%3Afalse%2C%22value%22%3A%22Test1%22%7D%2C%7B%22name%22%3A%22MethodDeclaration%22%2C%22id%22%3A%22members%22%2C%22children%22%3A%5B%7B%22name%22%3A%22PublicKeyword%22%2C%22id%22%3A%22modifiers%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A8%2C%22position%22%3A14%7D%2C%22isMarked%22%3Afalse%7D%2C%7B%22name%22%3A%22Identifier%22%2C%22id%22%3A%22name%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A4%2C%22position%22%3A22%7D%2C%22isMarked%22%3Afalse%2C%22value%22%3A%22foo%22%7D%2C%7B%22name%22%3A%22Parameter%22%2C%22id%22%3A%22parameters%22%2C%22children%22%3A%5B%7B%22name%22%3A%22Identifier%22%2C%22id%22%3A%22name%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A1%2C%22position%22%3A27%7D%2C%22isMarked%22%3Afalse%2C%22value%22%3A%22a%22%7D%2C%7B%22name%22%3A%22NumberKeyword%22%2C%22id%22%3A%22type%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A7%2C%22position%22%3A29%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A9%2C%22position%22%3A27%7D%2C%22isMarked%22%3Afalse%7D%2C%7B%22name%22%3A%22Block%22%2C%22id%22%3A%22body%22%2C%22children%22%3A%5B%7B%22name%22%3A%22VariableStatement%22%2C%22id%22%3A%22statements%22%2C%22children%22%3A%5B%7B%22name%22%3A%22VariableDeclarationList%22%2C%22id%22%3A%22declarationList%22%2C%22children%22%3A%5B%7B%22name%22%3A%22VariableDeclaration%22%2C%22id%22%3A%22declarations%22%2C%22children%22%3A%5B%7B%22name%22%3A%22Identifier%22%2C%22id%22%3A%22name%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A2%2C%22position%22%3A47%7D%2C%22isMarked%22%3Afalse%2C%22value%22%3A%22x%22%7D%2C%7B%22name%22%3A%22ObjectLiteralExpression%22%2C%22id%22%3A%22initializer%22%2C%22children%22%3A%5B%7B%22name%22%3A%22PropertyAssignment%22%2C%22id%22%3A%22properties%22%2C%22children%22%3A%5B%7B%22name%22%3A%22Identifier%22%2C%22id%22%3A%22name%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A2%2C%22position%22%3A53%7D%2C%22isMarked%22%3Afalse%2C%22value%22%3A%22a%22%7D%2C%7B%22name%22%3A%22FirstLiteralToken%22%2C%22id%22%3A%22initializer%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A2%2C%22position%22%3A56%7D%2C%22isMarked%22%3Afalse%2C%22value%22%3A%225%22%7D%5D%2C%22data%22%3A%7B%22length%22%3A5%2C%22position%22%3A53%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A9%2C%22position%22%3A51%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A13%2C%22position%22%3A47%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A21%2C%22position%22%3A39%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A22%2C%22position%22%3A39%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A27%2C%22position%22%3A37%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A50%2C%22position%22%3A14%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A66%2C%22position%22%3A0%7D%2C%22isMarked%22%3Afalse%7D%2C%7B%22name%22%3A%22EndOfFileToken%22%2C%22id%22%3A%22endOfFileToken%22%2C%22children%22%3A%5B%5D%2C%22data%22%3A%7B%22length%22%3A1%2C%22position%22%3A66%7D%2C%22isMarked%22%3Afalse%7D%5D%2C%22data%22%3A%7B%22length%22%3A67%2C%22position%22%3A0%7D%2C%22isMarked%22%3Atrue%7D%2C%22text%22%3A%22%5Cnclass+Test1+%7B%5Cn%5Ctpublic+foo%28a%3A+number%29+%7B%5Cn%5Ct%5Ctconst+x+%3D+%7B+a%3A+5+%7D%3B%5Cn%5Ct%7D%5Cn%7D%5Cn%22%2C%22fileName%22%3A%22index.ts%22%7D).
|
||||||
The AST (Abstract Syntax Tree) visualizer renders data that matches the `Ast` interface.
|
The AST (Abstract Syntax Tree) visualizer renders data that matches the `Ast` interface.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -239,6 +260,30 @@ Creates Grid visualization data for an array.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
This extension provides these configuration options:
|
||||||
|
|
||||||
|
- `debugVisualizer.debugAdapterConfigurations`
|
||||||
|
|
||||||
|
Allows to set expression templates for specific debug adapter types.
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"debugVisualizer.debugAdapterConfigurations": {
|
||||||
|
"lldb": {
|
||||||
|
"expressionTemplate": "script to_json(\"${expr}\")",
|
||||||
|
"context": "repl"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Configurations here overwrite the built-in support for the corresponding debug adapter type.
|
||||||
|
|
||||||
|
* `debugVisualizer.useChromeKioskMode`
|
||||||
|
|
||||||
|
Specifies whether to pop out Debug Visualization Views with Chrome in Kiosk Mode. Uses the default browser otherwise or if Chrome is not found. Defaults to `true`.
|
||||||
|
|
||||||
# See Also
|
# See Also
|
||||||
|
|
||||||
This extension works very well together with my library [`@hediet/node-reload`](https://github.com/hediet/node-reload) for TypeScript/JavaScript.
|
This extension works very well together with my library [`@hediet/node-reload`](https://github.com/hediet/node-reload) for TypeScript/JavaScript.
|
||||||
|
|||||||
@@ -1,10 +1,11 @@
|
|||||||
{
|
{
|
||||||
"name": "debug-visualizer",
|
"name": "debug-visualizer",
|
||||||
|
"private": true,
|
||||||
"displayName": "Debug Visualizer",
|
"displayName": "Debug Visualizer",
|
||||||
"description": "An extension that visualizes values while debugging.",
|
"description": "An extension that visualizes values while debugging.",
|
||||||
"icon": "docs/logo.png",
|
"icon": "docs/logo.png",
|
||||||
"version": "0.11.1",
|
"version": "1.0.0",
|
||||||
"license": "MIT",
|
"license": "GPL-3.0",
|
||||||
"engines": {
|
"engines": {
|
||||||
"vscode": "^1.35.0"
|
"vscode": "^1.35.0"
|
||||||
},
|
},
|
||||||
@@ -23,6 +24,7 @@
|
|||||||
],
|
],
|
||||||
"activationEvents": [
|
"activationEvents": [
|
||||||
"onCommand:vscode-debug-visualizer.new-visualizer",
|
"onCommand:vscode-debug-visualizer.new-visualizer",
|
||||||
|
"onCommand:vscode-debug-visualizer.visualizer-set-expression",
|
||||||
"onDebug",
|
"onDebug",
|
||||||
"onWebviewPanel:debugVisualizer"
|
"onWebviewPanel:debugVisualizer"
|
||||||
],
|
],
|
||||||
@@ -31,7 +33,18 @@
|
|||||||
"commands": [
|
"commands": [
|
||||||
{
|
{
|
||||||
"command": "vscode-debug-visualizer.new-visualizer",
|
"command": "vscode-debug-visualizer.new-visualizer",
|
||||||
"title": "Open a new Debug Visualizer View"
|
"title": "Debug Visualizer: New View"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "vscode-debug-visualizer.visualizer-set-expression",
|
||||||
|
"title": "Debug Visualizer: Use Selection as Expression"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"keybindings": [
|
||||||
|
{
|
||||||
|
"command": "vscode-debug-visualizer.visualizer-set-expression",
|
||||||
|
"key": "shift+f1",
|
||||||
|
"when": "editorTextFocus"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"configuration": {
|
"configuration": {
|
||||||
@@ -41,26 +54,47 @@
|
|||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": true,
|
"default": true,
|
||||||
"description": "Pop out Debug Visualization Views with Chrome in Kiosk Mode."
|
"description": "Pop out Debug Visualization Views with Chrome in Kiosk Mode."
|
||||||
|
},
|
||||||
|
"debugVisualizer.debugAdapterConfigurations": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"expressionTemplate": {
|
||||||
|
"type:": "string",
|
||||||
|
"description": "A template for the final expression sent to the debugger for evaluation. Use `${expr}` to refer to the currently visualized expression."
|
||||||
|
},
|
||||||
|
"context": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"watch",
|
||||||
|
"repl"
|
||||||
|
],
|
||||||
|
"description": "The context to use for evaluating the expression."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"pub": "vsce publish --yarn --baseImagesUrl https://github.com/hediet/vscode-debug-visualizer/raw/master/extension --baseContentUrl https://github.com/hediet/vscode-debug-visualizer/raw/master/extension",
|
"pub": "vsce publish --yarn --baseImagesUrl https://github.com/hediet/vscode-debug-visualizer/raw/master/extension --baseContentUrl https://github.com/hediet/vscode-debug-visualizer/raw/master/extension",
|
||||||
|
"package": "vsce package --yarn",
|
||||||
"vscode:prepublish": "yarn build",
|
"vscode:prepublish": "yarn build",
|
||||||
"build": "webpack --mode production",
|
"build": "webpack --mode production",
|
||||||
"dev": "tsc -watch -p ./"
|
"dev": "shx rm -rf dist && tsc -watch -p ./"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@hediet/std": "^0.6.0",
|
"@hediet/std": "^0.6.0",
|
||||||
"@hediet/typed-json-rpc": "^0.7.7",
|
"@hediet/typed-json-rpc": "^0.7.7",
|
||||||
"@hediet/typed-json-rpc-websocket-server": "^0.7.7",
|
"@hediet/typed-json-rpc-websocket-server": "^0.7.7",
|
||||||
"chrome-launcher": "^0.11.2",
|
"chrome-launcher": "^0.12.0",
|
||||||
"@hediet/node-reload": "^0.7.2",
|
"@hediet/node-reload": "^0.7.3",
|
||||||
"express": "^4.17.1",
|
"express": "^4.17.1",
|
||||||
"open": "^6.4.0",
|
"open": "^7.0.2",
|
||||||
"serve-static": "^1.14.1",
|
"serve-static": "^1.14.1",
|
||||||
"ws": "^7.1.1",
|
"ws": "^7.2.1",
|
||||||
"crypto-random-string": "^3.1.0"
|
"crypto-random-string": "^3.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
@@ -68,12 +102,13 @@
|
|||||||
"@types/copy-webpack-plugin": "^5.0.0",
|
"@types/copy-webpack-plugin": "^5.0.0",
|
||||||
"@types/express": "^4.17.2",
|
"@types/express": "^4.17.2",
|
||||||
"@types/serve-static": "^1.13.3",
|
"@types/serve-static": "^1.13.3",
|
||||||
"@types/node": "^13.7.1",
|
"@types/node": "^13.7.4",
|
||||||
"@types/vscode": "^1.35.0",
|
"@types/vscode": "1.35.0",
|
||||||
"tslint": "^6.0.0",
|
"tslint": "^6.0.0",
|
||||||
"typescript": "^3.7.5",
|
"typescript": "^3.8.2",
|
||||||
"webpack": "^4.41.6",
|
"webpack": "^4.41.6",
|
||||||
"webpack-cli": "^3.3.11",
|
"webpack-cli": "^3.3.11",
|
||||||
"ts-loader": "^6.2.1"
|
"ts-loader": "^6.2.1",
|
||||||
|
"shx": "^0.3.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
import { Disposable } from "@hediet/std/disposable";
|
import { Disposable } from "@hediet/std/disposable";
|
||||||
import { debugVisualizerUIContract } from "@hediet/debug-visualizer-vscode-shared";
|
import { debugVisualizerUIContract } from "./contract";
|
||||||
import { ConsoleRpcLogger, RequestHandlingError } from "@hediet/typed-json-rpc";
|
import { ConsoleRpcLogger, RequestHandlingError } from "@hediet/typed-json-rpc";
|
||||||
import { EvaluationWatcher, DataSource } from "./DataSource/DataSource";
|
import {
|
||||||
|
EvaluationWatcher,
|
||||||
|
EvaluationWatchService,
|
||||||
|
} from "./EvaluationWatchService";
|
||||||
import { WebSocketStream } from "@hediet/typed-json-rpc-websocket";
|
import { WebSocketStream } from "@hediet/typed-json-rpc-websocket";
|
||||||
import { observable, autorun } from "mobx";
|
import { observable, autorun } from "mobx";
|
||||||
import { Server } from "./Server";
|
import { Server } from "./Server";
|
||||||
@@ -9,13 +12,15 @@ import * as open from "open";
|
|||||||
import chromeLauncher = require("chrome-launcher");
|
import chromeLauncher = require("chrome-launcher");
|
||||||
import { Config } from "./Config";
|
import { Config } from "./Config";
|
||||||
|
|
||||||
export class ConnectionHandler {
|
export class ClientConnection {
|
||||||
public readonly dispose = Disposable.fn();
|
public readonly dispose = Disposable.fn();
|
||||||
@observable
|
@observable
|
||||||
private watcher: EvaluationWatcher | undefined = undefined;
|
private watcher: EvaluationWatcher | undefined = undefined;
|
||||||
|
|
||||||
|
private readonly client: typeof debugVisualizerUIContract["TClientInterface"];
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
dataSource: DataSource,
|
evaluationWatchService: EvaluationWatchService,
|
||||||
stream: WebSocketStream,
|
stream: WebSocketStream,
|
||||||
server: Server,
|
server: Server,
|
||||||
config: Config,
|
config: Config,
|
||||||
@@ -60,9 +65,12 @@ export class ConnectionHandler {
|
|||||||
this.dispose.untrack(this.watcher).dispose();
|
this.dispose.untrack(this.watcher).dispose();
|
||||||
}
|
}
|
||||||
this.watcher = this.dispose.track(
|
this.watcher = this.dispose.track(
|
||||||
dataSource.createEvaluationWatcher(newExpression, {
|
evaluationWatchService.createEvaluationWatcher(
|
||||||
preferredDataExtractor: oldPreferredDataExtractor,
|
newExpression,
|
||||||
})
|
{
|
||||||
|
preferredDataExtractor: oldPreferredDataExtractor,
|
||||||
|
}
|
||||||
|
)
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
openInBrowser: async ({}) => {
|
openInBrowser: async ({}) => {
|
||||||
@@ -76,7 +84,7 @@ export class ConnectionHandler {
|
|||||||
});
|
});
|
||||||
|
|
||||||
let opened = false;
|
let opened = false;
|
||||||
if (config.useChromeKioskMode()) {
|
if (config.useChromeKioskMode) {
|
||||||
opened = await launchChrome(url);
|
opened = await launchChrome(url);
|
||||||
}
|
}
|
||||||
if (!opened) {
|
if (!opened) {
|
||||||
@@ -93,7 +101,7 @@ export class ConnectionHandler {
|
|||||||
getCompletions: async ({ text, column }) => {
|
getCompletions: async ({ text, column }) => {
|
||||||
throwIfNotAuthenticated();
|
throwIfNotAuthenticated();
|
||||||
|
|
||||||
const completions = await dataSource.getCompletions(
|
const completions = await evaluationWatchService.getCompletions(
|
||||||
text,
|
text,
|
||||||
column
|
column
|
||||||
);
|
);
|
||||||
@@ -104,7 +112,9 @@ export class ConnectionHandler {
|
|||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
this.dispose.track(
|
this.client = client;
|
||||||
|
|
||||||
|
this.dispose.track([
|
||||||
Disposable.create(
|
Disposable.create(
|
||||||
autorun(() => {
|
autorun(() => {
|
||||||
if (this.watcher) {
|
if (this.watcher) {
|
||||||
@@ -113,13 +123,24 @@ export class ConnectionHandler {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
)
|
),
|
||||||
);
|
Disposable.create(
|
||||||
|
autorun(() => {
|
||||||
|
client.updateLanguageId({
|
||||||
|
languageId: evaluationWatchService.languageId || null,
|
||||||
|
});
|
||||||
|
})
|
||||||
|
),
|
||||||
|
]);
|
||||||
|
|
||||||
stream.onClosed.then(() => {
|
stream.onClosed.then(() => {
|
||||||
this.dispose();
|
this.dispose();
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public setExpression(expression: string) {
|
||||||
|
this.client.setExpression({ expression });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function launchChrome(url: string): Promise<boolean> {
|
async function launchChrome(url: string): Promise<boolean> {
|
||||||
@@ -1,28 +1,99 @@
|
|||||||
import { workspace } from "vscode";
|
import { workspace } from "vscode";
|
||||||
import { Disposable } from "@hediet/std/disposable";
|
import { Disposable } from "@hediet/std/disposable";
|
||||||
import { EventEmitter, EventSource } from "@hediet/std/events";
|
import { observable } from "mobx";
|
||||||
|
import { DataExtractorId } from "@hediet/debug-visualizer-data-extraction";
|
||||||
|
|
||||||
export const useChromeKioskModeKey = "debugVisualizer.useChromeKioskMode";
|
const useChromeKioskModeKey = "debugVisualizer.useChromeKioskMode";
|
||||||
|
const debugAdapterConfigsKey = "debugVisualizer.debugAdapterConfigurations";
|
||||||
|
|
||||||
export class Config {
|
export class Config {
|
||||||
private changeEventEmitter = new EventEmitter();
|
|
||||||
public readonly onChange: EventSource = this.changeEventEmitter;
|
|
||||||
public dispose = Disposable.fn();
|
public dispose = Disposable.fn();
|
||||||
|
|
||||||
|
@observable
|
||||||
|
private _useChromeKioskMode!: boolean;
|
||||||
|
|
||||||
|
@observable
|
||||||
|
private _debugAdapterConfigs!: DebugAdapterConfigs;
|
||||||
|
|
||||||
|
public get useChromeKioskMode(): boolean {
|
||||||
|
return this._useChromeKioskMode;
|
||||||
|
}
|
||||||
|
|
||||||
|
public get debugAdapterConfigs(): DebugAdapterConfigs {
|
||||||
|
return this._debugAdapterConfigs;
|
||||||
|
}
|
||||||
|
|
||||||
constructor() {
|
constructor() {
|
||||||
|
this.updateConfig();
|
||||||
this.dispose.track(
|
this.dispose.track(
|
||||||
workspace.onDidChangeConfiguration(() => {
|
workspace.onDidChangeConfiguration(() => {
|
||||||
this.changeEventEmitter.emit();
|
this.updateConfig();
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
public useChromeKioskMode(): boolean {
|
private updateConfig(): void {
|
||||||
const c = workspace.getConfiguration();
|
const c = workspace.getConfiguration();
|
||||||
const b = c.get<boolean>(useChromeKioskModeKey);
|
|
||||||
if (b === undefined) {
|
this._useChromeKioskMode = mapUndefined(
|
||||||
return true;
|
c.get<boolean>(useChromeKioskModeKey),
|
||||||
|
true
|
||||||
|
);
|
||||||
|
|
||||||
|
this._debugAdapterConfigs = mapUndefined(
|
||||||
|
c.get<DebugAdapterConfigs>(debugAdapterConfigsKey),
|
||||||
|
{}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public getDebugAdapterConfig(
|
||||||
|
debugAdapterType: string
|
||||||
|
): DebugAdapterConfig | undefined {
|
||||||
|
const c = this.debugAdapterConfigs[debugAdapterType];
|
||||||
|
if (!c) {
|
||||||
|
return undefined;
|
||||||
}
|
}
|
||||||
return b;
|
|
||||||
|
return {
|
||||||
|
context: c.context || "watch",
|
||||||
|
getFinalExpression: ({ expression, preferredExtractorId }) =>
|
||||||
|
evaluateTemplate(c.expressionTemplate || "${expr}", {
|
||||||
|
expr: expression,
|
||||||
|
preferredDataExtractorId: preferredExtractorId || "",
|
||||||
|
}),
|
||||||
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function mapUndefined<T>(val: T | undefined, defaultVal: T) {
|
||||||
|
if (val === undefined) {
|
||||||
|
return defaultVal;
|
||||||
|
}
|
||||||
|
return val;
|
||||||
|
}
|
||||||
|
|
||||||
|
type DebugAdapterConfigs = {
|
||||||
|
[debugAdapter: string]: {
|
||||||
|
context?: "watch" | "repl";
|
||||||
|
expressionTemplate?: "string";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface DebugAdapterConfig {
|
||||||
|
context: "watch" | "repl";
|
||||||
|
getFinalExpression(vars: {
|
||||||
|
expression: string;
|
||||||
|
preferredExtractorId: DataExtractorId | undefined;
|
||||||
|
}): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function evaluateTemplate(
|
||||||
|
template: string,
|
||||||
|
data: Record<string, string>
|
||||||
|
): string {
|
||||||
|
let result = template;
|
||||||
|
for (const [key, val] of Object.entries(data)) {
|
||||||
|
result = result.split(`\${${key}}`).join(val);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,22 +0,0 @@
|
|||||||
import {
|
|
||||||
DataExtractionProviderFactory,
|
|
||||||
DataExtractionProvider,
|
|
||||||
} from "./DataExtractionProvider";
|
|
||||||
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
|
||||||
|
|
||||||
export class ComposedDataExtractionProviderFactory
|
|
||||||
implements DataExtractionProviderFactory {
|
|
||||||
constructor(public readonly factories: DataExtractionProviderFactory[]) {}
|
|
||||||
|
|
||||||
createDataExtractionProvider(
|
|
||||||
session: VsCodeDebugSession
|
|
||||||
): DataExtractionProvider | undefined {
|
|
||||||
for (const f of this.factories) {
|
|
||||||
const provider = f.createDataExtractionProvider(session);
|
|
||||||
if (provider) {
|
|
||||||
return provider;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
import { DataExtractionResult } from "@hediet/debug-visualizer-data-extraction";
|
|
||||||
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
|
||||||
|
|
||||||
export interface DataExtractionProviderFactory {
|
|
||||||
createDataExtractionProvider(
|
|
||||||
session: VsCodeDebugSession
|
|
||||||
): DataExtractionProvider | undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface DataExtractionProvider {
|
|
||||||
evaluate(
|
|
||||||
args: DataExtractionProviderArgs
|
|
||||||
): Promise<
|
|
||||||
| { kind: "data"; result: DataExtractionResult }
|
|
||||||
| { kind: "error"; message: string }
|
|
||||||
>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface DataExtractionProviderArgs {
|
|
||||||
expression: string;
|
|
||||||
preferredExtractor: string | undefined;
|
|
||||||
frameId: number | undefined;
|
|
||||||
}
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
import {
|
|
||||||
DataResult,
|
|
||||||
DataExtractionResult,
|
|
||||||
ExtractedData,
|
|
||||||
isExtractedData,
|
|
||||||
} from "@hediet/debug-visualizer-data-extraction";
|
|
||||||
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
|
||||||
import {
|
|
||||||
DataExtractionProviderFactory,
|
|
||||||
DataExtractionProvider,
|
|
||||||
DataExtractionProviderArgs,
|
|
||||||
} from "./DataExtractionProvider";
|
|
||||||
|
|
||||||
export class GenericDataExtractionProviderFactory
|
|
||||||
implements DataExtractionProviderFactory {
|
|
||||||
createDataExtractionProvider(
|
|
||||||
session: VsCodeDebugSession
|
|
||||||
): DataExtractionProvider | undefined {
|
|
||||||
return new GenericDataExtractionProvider(session);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class GenericDataExtractionProvider implements DataExtractionProvider {
|
|
||||||
constructor(private readonly session: VsCodeDebugSession) {}
|
|
||||||
|
|
||||||
public async evaluate({
|
|
||||||
expression,
|
|
||||||
preferredExtractor,
|
|
||||||
frameId,
|
|
||||||
}: DataExtractionProviderArgs): Promise<
|
|
||||||
| { kind: "data"; result: DataExtractionResult }
|
|
||||||
| { kind: "error"; message: string }
|
|
||||||
> {
|
|
||||||
try {
|
|
||||||
const reply = await this.session.evaluate({
|
|
||||||
expression,
|
|
||||||
frameId,
|
|
||||||
});
|
|
||||||
const resultStr = reply.result;
|
|
||||||
const jsonData = resultStr.substr(1, resultStr.length - 2);
|
|
||||||
const result = JSON.parse(jsonData) as ExtractedData;
|
|
||||||
|
|
||||||
if (!isExtractedData(result)) {
|
|
||||||
throw new Error("Invalid Data");
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
kind: "data",
|
|
||||||
result: {
|
|
||||||
availableExtractors: [],
|
|
||||||
usedExtractor: {
|
|
||||||
id: "generic" as any,
|
|
||||||
name: "Generic",
|
|
||||||
priority: 1,
|
|
||||||
},
|
|
||||||
data: result,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
} catch (error) {
|
|
||||||
return {
|
|
||||||
kind: "error",
|
|
||||||
message: error.message,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
export * from "./DataExtractionProvider";
|
|
||||||
|
|
||||||
import { ComposedDataExtractionProviderFactory } from "./ComposedDataExtractionProviderFactory";
|
|
||||||
import { JsDataExtractionProviderFactory } from "./JsDataExtractionProviderFactory";
|
|
||||||
import { GenericDataExtractionProviderFactory } from "./GenericDataExtractionProviderFactory";
|
|
||||||
|
|
||||||
export const defaultDataExtractionProviderFactory = new ComposedDataExtractionProviderFactory(
|
|
||||||
[
|
|
||||||
new JsDataExtractionProviderFactory(),
|
|
||||||
new GenericDataExtractionProviderFactory(),
|
|
||||||
]
|
|
||||||
);
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
import { Disposable } from "@hediet/std/disposable";
|
|
||||||
import { VsCodeDebugger, VsCodeDebuggerView } from "../VsCodeDebugger";
|
|
||||||
import { DataSourceImpl } from "./DataSourceImpl";
|
|
||||||
import { defaultDataExtractionProviderFactory } from "./DataExtractionProvider";
|
|
||||||
|
|
||||||
export class Sources {
|
|
||||||
public readonly dispose = Disposable.fn();
|
|
||||||
private readonly debugger = this.dispose.track(new VsCodeDebugger());
|
|
||||||
private readonly debuggerView = this.dispose.track(
|
|
||||||
new VsCodeDebuggerView(this.debugger)
|
|
||||||
);
|
|
||||||
|
|
||||||
public readonly dataSource = new DataSourceImpl(
|
|
||||||
this.debuggerView,
|
|
||||||
defaultDataExtractionProviderFactory
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
export * from "./Sources";
|
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
import { EvaluationEngine, Evaluator } from "./EvaluationEngine";
|
||||||
|
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
||||||
|
|
||||||
|
export class ComposedEvaluationEngine implements EvaluationEngine {
|
||||||
|
constructor(public readonly engines: EvaluationEngine[]) {}
|
||||||
|
|
||||||
|
createEvaluator(session: VsCodeDebugSession): Evaluator | undefined {
|
||||||
|
for (const f of this.engines) {
|
||||||
|
const evaluator = f.createEvaluator(session);
|
||||||
|
if (evaluator) {
|
||||||
|
return evaluator;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
import { DataExtractorId } from "@hediet/debug-visualizer-data-extraction";
|
||||||
|
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
||||||
|
import { EvaluationEngine, Evaluator } from "./EvaluationEngine";
|
||||||
|
import { Config, DebugAdapterConfig } from "../../Config";
|
||||||
|
import { GenericEvaluator } from "./GenericEvaluationEngine";
|
||||||
|
import { registerUpdateReconciler, hotClass } from "@hediet/node-reload";
|
||||||
|
|
||||||
|
registerUpdateReconciler(module);
|
||||||
|
|
||||||
|
@hotClass(module)
|
||||||
|
export class ConfiguredEvaluationEngine implements EvaluationEngine {
|
||||||
|
constructor(private readonly config: Config) {}
|
||||||
|
|
||||||
|
createEvaluator(session: VsCodeDebugSession): Evaluator | undefined {
|
||||||
|
const config = this.config.getDebugAdapterConfig(session.session.type);
|
||||||
|
if (!config) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return new ConfiguredEvaluator(session, config);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class ConfiguredEvaluator extends GenericEvaluator {
|
||||||
|
constructor(
|
||||||
|
session: VsCodeDebugSession,
|
||||||
|
private readonly config: DebugAdapterConfig
|
||||||
|
) {
|
||||||
|
super(session);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected getContext() {
|
||||||
|
return this.config.context;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected getFinalExpression({
|
||||||
|
expression,
|
||||||
|
preferredExtractorId,
|
||||||
|
}: {
|
||||||
|
expression: string;
|
||||||
|
preferredExtractorId: DataExtractorId | undefined;
|
||||||
|
}) {
|
||||||
|
return this.config.getFinalExpression({
|
||||||
|
expression,
|
||||||
|
preferredExtractorId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
import {
|
||||||
|
DataExtractionResult,
|
||||||
|
DataExtractorId,
|
||||||
|
} from "@hediet/debug-visualizer-data-extraction";
|
||||||
|
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
||||||
|
import { FormattedMessage } from "../../contract";
|
||||||
|
|
||||||
|
export interface EvaluationEngine {
|
||||||
|
createEvaluator(session: VsCodeDebugSession): Evaluator | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Evaluator {
|
||||||
|
evaluate(
|
||||||
|
args: EvaluationArgs
|
||||||
|
): Promise<
|
||||||
|
| { kind: "data"; result: DataExtractionResult }
|
||||||
|
| { kind: "error"; message: FormattedMessage }
|
||||||
|
>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The language that expressions must be written in.
|
||||||
|
*/
|
||||||
|
readonly languageId: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface EvaluationArgs {
|
||||||
|
expression: string;
|
||||||
|
preferredExtractorId: DataExtractorId | undefined;
|
||||||
|
frameId: number | undefined;
|
||||||
|
}
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
import {
|
||||||
|
DataExtractionResult,
|
||||||
|
DataExtractorId,
|
||||||
|
} from "@hediet/debug-visualizer-data-extraction";
|
||||||
|
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
||||||
|
import {
|
||||||
|
EvaluationEngine,
|
||||||
|
Evaluator,
|
||||||
|
EvaluationArgs,
|
||||||
|
} from "./EvaluationEngine";
|
||||||
|
import { parseEvaluationResultFromGenericDebugAdapter } from "./parseEvaluationResultFromGenericDebugAdapter";
|
||||||
|
import { FormattedMessage } from "../../contract";
|
||||||
|
import { hotClass, registerUpdateReconciler } from "@hediet/node-reload";
|
||||||
|
|
||||||
|
registerUpdateReconciler(module);
|
||||||
|
|
||||||
|
@hotClass(module)
|
||||||
|
export class GenericEvaluationEngine implements EvaluationEngine {
|
||||||
|
createEvaluator(session: VsCodeDebugSession): Evaluator | undefined {
|
||||||
|
return new GenericEvaluator(session);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class GenericEvaluator implements Evaluator {
|
||||||
|
public readonly languageId = "text";
|
||||||
|
|
||||||
|
constructor(private readonly session: VsCodeDebugSession) {}
|
||||||
|
|
||||||
|
public async evaluate({
|
||||||
|
expression,
|
||||||
|
preferredExtractorId,
|
||||||
|
frameId,
|
||||||
|
}: EvaluationArgs): Promise<
|
||||||
|
| { kind: "data"; result: DataExtractionResult }
|
||||||
|
| { kind: "error"; message: FormattedMessage }
|
||||||
|
> {
|
||||||
|
const finalExpression = this.getFinalExpression({
|
||||||
|
expression,
|
||||||
|
preferredExtractorId,
|
||||||
|
});
|
||||||
|
let reply;
|
||||||
|
try {
|
||||||
|
reply = await this.session.evaluate({
|
||||||
|
expression: finalExpression,
|
||||||
|
frameId,
|
||||||
|
context: this.getContext(),
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
return {
|
||||||
|
kind: "error",
|
||||||
|
message: {
|
||||||
|
kind: "list",
|
||||||
|
items: [
|
||||||
|
error.message,
|
||||||
|
`Used debug adapter: ${this.session.session.configuration.type}`,
|
||||||
|
{
|
||||||
|
kind: "inlineList",
|
||||||
|
items: [
|
||||||
|
"Evaluated expression is",
|
||||||
|
{ kind: "code", content: finalExpression },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return parseEvaluationResultFromGenericDebugAdapter(reply.result);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected getFinalExpression(args: {
|
||||||
|
expression: string;
|
||||||
|
preferredExtractorId: DataExtractorId | undefined;
|
||||||
|
}): string {
|
||||||
|
return args.expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected getContext(): "watch" | "repl" {
|
||||||
|
return "watch";
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -7,16 +7,18 @@ import {
|
|||||||
} from "@hediet/debug-visualizer-data-extraction";
|
} from "@hediet/debug-visualizer-data-extraction";
|
||||||
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
import { VsCodeDebugSession } from "../../VsCodeDebugger";
|
||||||
import {
|
import {
|
||||||
DataExtractionProviderFactory,
|
EvaluationEngine,
|
||||||
DataExtractionProvider,
|
Evaluator,
|
||||||
DataExtractionProviderArgs,
|
EvaluationArgs,
|
||||||
} from "./DataExtractionProvider";
|
} from "./EvaluationEngine";
|
||||||
|
import { FormattedMessage } from "../../contract";
|
||||||
|
import { registerUpdateReconciler, hotClass } from "@hediet/node-reload";
|
||||||
|
|
||||||
export class JsDataExtractionProviderFactory
|
registerUpdateReconciler(module);
|
||||||
implements DataExtractionProviderFactory {
|
|
||||||
createDataExtractionProvider(
|
@hotClass(module)
|
||||||
session: VsCodeDebugSession
|
export class JsEvaluationEngine implements EvaluationEngine {
|
||||||
): DataExtractionProvider | undefined {
|
createEvaluator(session: VsCodeDebugSession): Evaluator | undefined {
|
||||||
const supportedDebugAdapters = [
|
const supportedDebugAdapters = [
|
||||||
"node",
|
"node",
|
||||||
"node2",
|
"node2",
|
||||||
@@ -24,27 +26,29 @@ export class JsDataExtractionProviderFactory
|
|||||||
"chrome",
|
"chrome",
|
||||||
];
|
];
|
||||||
if (supportedDebugAdapters.indexOf(session.session.type) !== -1) {
|
if (supportedDebugAdapters.indexOf(session.session.type) !== -1) {
|
||||||
return new JsDataEvaluator(session);
|
return new JsEvaluator(session);
|
||||||
}
|
}
|
||||||
return undefined;
|
return undefined;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class JsDataEvaluator implements DataExtractionProvider {
|
class JsEvaluator implements Evaluator {
|
||||||
|
public readonly languageId = "javascript";
|
||||||
|
|
||||||
constructor(private readonly session: VsCodeDebugSession) {}
|
constructor(private readonly session: VsCodeDebugSession) {}
|
||||||
|
|
||||||
public async evaluate({
|
public async evaluate({
|
||||||
expression,
|
expression,
|
||||||
preferredExtractor,
|
preferredExtractorId,
|
||||||
frameId,
|
frameId,
|
||||||
}: DataExtractionProviderArgs): Promise<
|
}: EvaluationArgs): Promise<
|
||||||
| { kind: "data"; result: DataExtractionResult }
|
| { kind: "data"; result: DataExtractionResult }
|
||||||
| { kind: "error"; message: string }
|
| { kind: "error"; message: FormattedMessage }
|
||||||
> {
|
> {
|
||||||
while (true) {
|
while (true) {
|
||||||
try {
|
try {
|
||||||
const preferredExtractorExpr = preferredExtractor
|
const preferredExtractorExpr = preferredExtractorId
|
||||||
? `"${preferredExtractor}"`
|
? `"${preferredExtractorId}"`
|
||||||
: "undefined";
|
: "undefined";
|
||||||
|
|
||||||
const body = `${getExpressionForDataExtractorApi()}.getData(
|
const body = `${getExpressionForDataExtractorApi()}.getData(
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
export * from "./EvaluationEngine";
|
||||||
|
|
||||||
|
export { ComposedEvaluationEngine } from "./ComposedEvaluationEngine";
|
||||||
|
export { JsEvaluationEngine } from "./JsEvaluationEngine";
|
||||||
|
export { GenericEvaluationEngine } from "./GenericEvaluationEngine";
|
||||||
|
export { ConfiguredEvaluationEngine } from "./ConfiguredEvaluationEngine";
|
||||||
@@ -0,0 +1,114 @@
|
|||||||
|
import {
|
||||||
|
DataExtractionResult,
|
||||||
|
isExtractedData,
|
||||||
|
} from "@hediet/debug-visualizer-data-extraction";
|
||||||
|
import { FormattedMessage } from "../../contract";
|
||||||
|
|
||||||
|
export function parseEvaluationResultFromGenericDebugAdapter(
|
||||||
|
resultText: string
|
||||||
|
):
|
||||||
|
| { kind: "data"; result: DataExtractionResult }
|
||||||
|
| { kind: "error"; message: FormattedMessage } {
|
||||||
|
const jsonData = resultText.trim();
|
||||||
|
|
||||||
|
let resultObj;
|
||||||
|
try {
|
||||||
|
try {
|
||||||
|
let jsonData2;
|
||||||
|
// Remove optionally enclosing characters.
|
||||||
|
if (
|
||||||
|
isEnclosedWith(jsonData, '"') ||
|
||||||
|
isEnclosedWith(jsonData, "'")
|
||||||
|
) {
|
||||||
|
// In case of JavaScript: `"{ "kind": { ... }, "text": "some\ntext" }"`
|
||||||
|
jsonData2 = jsonData.substr(1, jsonData.length - 2);
|
||||||
|
} else {
|
||||||
|
// Just in case no quoting is done.
|
||||||
|
jsonData2 = jsonData;
|
||||||
|
}
|
||||||
|
resultObj = parseJson(jsonData2);
|
||||||
|
} catch (e) {
|
||||||
|
// in case of C++: `"{ \"kind\": { ... }, \"text\": \"some\\ntext\" }"`
|
||||||
|
const str = parseJson(jsonData);
|
||||||
|
// str is now `{ "kind": { ... }, "text": "some\ntext" }"`
|
||||||
|
resultObj = parseJson(str);
|
||||||
|
// result is now { kind: { ... }, text: "some\ntext" }
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isExtractedData(resultObj)) {
|
||||||
|
return {
|
||||||
|
kind: "error",
|
||||||
|
message: {
|
||||||
|
kind: "list",
|
||||||
|
items: [
|
||||||
|
"Evaluation result does not match ExtractedData interface.",
|
||||||
|
{
|
||||||
|
kind: "inlineList",
|
||||||
|
items: [
|
||||||
|
"Evaluation result was:",
|
||||||
|
{
|
||||||
|
kind: "code",
|
||||||
|
content: JSON.stringify(
|
||||||
|
resultObj,
|
||||||
|
undefined,
|
||||||
|
4
|
||||||
|
),
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
return {
|
||||||
|
kind: "error",
|
||||||
|
message: e.message,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
kind: "data",
|
||||||
|
result: {
|
||||||
|
availableExtractors: [],
|
||||||
|
usedExtractor: {
|
||||||
|
id: "generic" as any,
|
||||||
|
name: "Generic",
|
||||||
|
priority: 1,
|
||||||
|
},
|
||||||
|
data: resultObj,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function isEnclosedWith(str: string, char: string): boolean {
|
||||||
|
return str.startsWith(char) && str.endsWith(char);
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseJson(str: string) {
|
||||||
|
try {
|
||||||
|
return JSON.parse(str);
|
||||||
|
} catch (error) {
|
||||||
|
throw new FormattedError({
|
||||||
|
kind: "list",
|
||||||
|
items: [
|
||||||
|
"Could not parse evaluation result as JSON:",
|
||||||
|
error.message,
|
||||||
|
{
|
||||||
|
kind: "inlineList",
|
||||||
|
items: [
|
||||||
|
"Evaluation result was:",
|
||||||
|
{
|
||||||
|
kind: "code",
|
||||||
|
content: str,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class FormattedError {
|
||||||
|
constructor(public readonly message: FormattedMessage) {}
|
||||||
|
}
|
||||||
@@ -1,16 +1,20 @@
|
|||||||
import { DataExtractorId } from "@hediet/debug-visualizer-data-extraction";
|
import { DataExtractorId } from "@hediet/debug-visualizer-data-extraction";
|
||||||
import {
|
import { DataExtractionState, CompletionItem } from "../contract";
|
||||||
DataExtractionState,
|
|
||||||
CompletionItem,
|
|
||||||
} from "@hediet/debug-visualizer-vscode-shared";
|
|
||||||
|
|
||||||
export interface DataSource {
|
export interface EvaluationWatchService {
|
||||||
createEvaluationWatcher(
|
createEvaluationWatcher(
|
||||||
expression: string,
|
expression: string,
|
||||||
options: EvaluationWatcherOptions
|
options: EvaluationWatcherOptions
|
||||||
): EvaluationWatcher;
|
): EvaluationWatcher;
|
||||||
|
|
||||||
getCompletions(text: string, column: number): Promise<CompletionItem[]>;
|
getCompletions(text: string, column: number): Promise<CompletionItem[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The language the expressions must be written in.
|
||||||
|
* `undefined`, if unknown.
|
||||||
|
* This field is observable.
|
||||||
|
*/
|
||||||
|
readonly languageId: string | undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface EvaluationWatcherOptions {
|
export interface EvaluationWatcherOptions {
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user