Tools for Integrating Gamer with VS Code #382

technic960183 · 2024-12-04T08:58:19Z

These files help user to setup an environment to work on Gamer in Visual Studio Code.

README.md: Contains instructions of setup and usages.
c_cpp_properties.json: Contains the IntelliSense configuration.
gamercpp.natvis: Contains the visualization configuration for debugger.
launch.json: Contains the debug configuration.
tasks.json: Contains the build configuration.
extract_macros.py: Script to extract the macros from the Makefile.log to c_cpp_properties.json.
copy_to_vscode.sh: Script to copy the files to .vscode/ directory and set up the working path.

Note:
Now gamercpp.natvis contain Timer_t only. This can let us check that the NATVIS works correctly. We could add more type of structures and classes in the future.

And creating .vscode directory if not exists

Update copy_to_vscode.sh exclusions to not copy README.md.

vivi235711

Hi, I've tested the setup on both my MacBook Air (M1) and spock. The run on spock works without any issues when OpenMP is disabled. However, on the Mac with the new architecture, they only support LLVM instead of GDB, leading to differences in implementation.

To make it work on the Mac, here's what I did:
Install llvm for lldm-mi:

brew install llvm
echo 'export PATH="/usr/local/opt/llvm/bin:$PATH"' >> ~/.zshrc
echo 'export LDFLAGS="-L/usr/local/opt/llvm/lib"' >> ~/.zshrc
echo 'export CPPFLAGS="-I/usr/local/opt/llvm/include"' >> ~/.zshrc

Install lldb-mi:

git clone https://github.com/lldb-tools/lldb-mi.git
cmake -DCMAKE_CXX_FLAGS="-I/usr/local/opt/llvm/include" -DCMAKE_CXX_COMPILER="/usr/local/opt/llvm/bin/clang++" ..
cmake --build .

Lastly, I updated the launch.json file with the following configuration:

"MIMode": "lldb",
"miDebuggerPath": "/Users/vivi/develop/lldb-mi/build/src/lldb-mi",
"miDebuggerArgs": "-Q",

Here, the miDebuggerPath is set to the directory where lldb-mi is installed.

With these changes, I was able to get the application running on my Mac.

I haven't tried it on Windows yet. If cross-platform compatibility is required, additional adjustments may be necessary. Let me know if you have any thought.

vivi235711 · 2024-12-27T09:07:33Z

tool/vscode/copy_to_vscode.sh

+if [ ! -d "$(realpath "$TARGET_DIR")" ]; then
+  echo "Target directory $(realpath "$TARGET_DIR") does not exist."
+  mkdir -p "$(realpath "$TARGET_DIR")"
+  echo "Target directory $(realpath "$TARGET_DIR") created."
+fi


The realpath has different usage at mac os. Is it necessary to avoid the problem of not absolute path? If not, maybe can switch to

if [ ! -d "$TARGET_DIR" ]; then echo "Target directory $TARGET_DIR does not exist." mkdir -p "$TARGET_DIR" echo "Target directory $TARGET_DIR created." fi

so it can run at both os.

I have removed all of the realpath. I would like to make the message to be more informative before.
Please help me to test it again. Thanks!

vivi235711 · 2024-12-27T09:10:00Z

tool/vscode/copy_to_vscode.sh

+    echo "$filename copied."
+  fi
+
+  sed -i "s/Gamer_Working_SubDir/$WORKING_DIR/g" "$TARGET_DIR/$filename"


The usage of sed is different between linux and mac os.

sed "s/Gamer_Working_SubDir/$WORKING_DIR/g" "$TARGET_DIR/$filename" > "$TARGET_DIR/$filename.tmp" && mv "$TARGET_DIR/$filename.tmp" "$TARGET_DIR/$filename"

This might can run on both os.

I change the way to setup the working directory. So sed is not needed anymore.

vivi235711 · 2024-12-31T08:31:53Z

tool/vscode/tasks.json

I think it will be more convenient if it can automatically copy the new build gamer into the work directory. What do you think?

Also maybe run sh generate_make.sh automatically?

I have integrated copying the new executable into the building task.
And added a new task for configuring.

vivi235711 · 2024-12-31T11:22:42Z

doc/wiki/Developing-with-VS-Code.md

+
+### Run build task
+
+After configuring Gamer with [configure.py](https://github.com/gamer-project/gamer/wiki/Installation%3A-Configure.py), select `Terminal` > `Run Build Task...` or press `Ctrl + Shift + B` to start the build task. This will update the macros, providing IntelliSense highlighting support.


It seems that debugging with parallel at vscode is difficult (not only mpi, but also openmp). Should we remind to disable mpi and openmp here?

I have added a note for the macOS users. But have not provide an explicit solusion yet.

- Add new tasks for configuring GAMER - Copy the executable after building - Update wiki for the new tasks - Remove `realpath` from the copy script - Add a note for macOS users And some other minor improvements - Make build-GAMER as a sequence of tasks - Fix typos: `Gamer` -> `GAMER` - Remove unnecessary information from `tool/vscode/README`.

- Make tasks as a `.sh` script - Avoid the use of `sed` in the bash script - Update wiki accordingly - Update `tool/vscode/README` accordingly

technic960183

Thansk for the review and the comments.

The main change in this update is to add a new task for setup the working directory under bin/. And the copy script will only be executed once.

As the commit messages, the minor updates are:

Improvements as the code review comments

Add new tasks for configuring GAMER and update wiki accordingly
Copy the executable after building
Remove realpath from the copy script
Add a note for macOS users

And some other minor improvements

Fix typos: Gamer -> GAMER
Remove unnecessary information from tool/vscode/README.
Make tasks as .sh scripts
Avoid the use of sed in the bash script
Update wiki accordingly
Update tool/vscode/README accordingly

Please help me to review these updates, thanks!

technic960183 · 2025-01-02T15:08:59Z

tool/vscode/copy_to_vscode.sh

+if [ ! -d "$(realpath "$TARGET_DIR")" ]; then
+  echo "Target directory $(realpath "$TARGET_DIR") does not exist."
+  mkdir -p "$(realpath "$TARGET_DIR")"
+  echo "Target directory $(realpath "$TARGET_DIR") created."
+fi


I have removed all of the realpath. I would like to make the message to be more informative before.
Please help me to test it again. Thanks!

technic960183 · 2025-01-02T15:20:52Z

tool/vscode/tasks.json

I have integrated copying the new executable into the building task.
And added a new task for configuring.

technic960183 · 2025-01-06T15:28:38Z

tool/vscode/copy_to_vscode.sh

+    echo "$filename copied."
+  fi
+
+  sed -i "s/Gamer_Working_SubDir/$WORKING_DIR/g" "$TARGET_DIR/$filename"


I change the way to setup the working directory. So sed is not needed anymore.

technic960183 · 2025-01-06T15:43:43Z

doc/wiki/Developing-with-VS-Code.md

+
+### Run build task
+
+After configuring Gamer with [configure.py](https://github.com/gamer-project/gamer/wiki/Installation%3A-Configure.py), select `Terminal` > `Run Build Task...` or press `Ctrl + Shift + B` to start the build task. This will update the macros, providing IntelliSense highlighting support.


I have added a note for the macOS users. But have not provide an explicit solusion yet.

hyschive · 2025-01-15T08:45:51Z

@technic960183 Please resolve the conflicts

technic960183 added 6 commits November 14, 2024 14:45

Add extract_macros.py and c_cpp template.

992749b

Add copy_to_vscode.sh

8402442

Add task.json, launch.json and gamercpp.natvis

d96887f

Support dynamic working dir for copy_to_vscode

cd3097a

And creating .vscode directory if not exists

Add README.md for VS Code integration

f60fab6

Update copy_to_vscode.sh exclusions to not copy README.md.

Add wiki page for developing with VS Code

fb85f66

hyschive requested a review from vivi235711 December 21, 2024 06:58

hyschive assigned vivi235711 Dec 21, 2024

hyschive added enhancement tool Useful analysis and visualization tools new feature and removed enhancement labels Dec 21, 2024

vivi235711 reviewed Dec 31, 2024

View reviewed changes

technic960183 added 2 commits January 6, 2025 23:40

Add new task set-working-bin.

1134194

- Make tasks as a `.sh` script - Avoid the use of `sed` in the bash script - Update wiki accordingly - Update `tool/vscode/README` accordingly

technic960183 commented Jan 6, 2025

View reviewed changes

technic960183 requested a review from vivi235711 January 6, 2025 15:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tools for Integrating Gamer with VS Code #382

Tools for Integrating Gamer with VS Code #382

technic960183 commented Dec 4, 2024 •

edited

Loading

vivi235711 left a comment •

edited

Loading

vivi235711 Dec 27, 2024

technic960183 Jan 2, 2025

vivi235711 Dec 27, 2024

technic960183 Jan 6, 2025

vivi235711 Dec 31, 2024

vivi235711 Dec 31, 2024

technic960183 Jan 2, 2025

vivi235711 Dec 31, 2024

technic960183 Jan 6, 2025 •

edited

Loading

technic960183 left a comment

technic960183 Jan 2, 2025

technic960183 Jan 2, 2025

technic960183 Jan 6, 2025

technic960183 Jan 6, 2025 •

edited

Loading

hyschive commented Jan 15, 2025


		### Run build task

		After configuring Gamer with [configure.py](https://github.com/gamer-project/gamer/wiki/Installation%3A-Configure.py), select `Terminal` > `Run Build Task...` or press `Ctrl + Shift + B` to start the build task. This will update the macros, providing IntelliSense highlighting support.

Tools for Integrating Gamer with VS Code #382

Are you sure you want to change the base?

Tools for Integrating Gamer with VS Code #382

Conversation

technic960183 commented Dec 4, 2024 • edited Loading

vivi235711 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

technic960183 Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

technic960183 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

technic960183 Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

hyschive commented Jan 15, 2025

technic960183 commented Dec 4, 2024 •

edited

Loading

vivi235711 left a comment •

edited

Loading

technic960183 Jan 6, 2025 •

edited

Loading

technic960183 Jan 6, 2025 •

edited

Loading