Add support for vscode

.gitignore

@@ -239,3 +239,6 @@ _Pvt_Extensions/
 ModelManifest.xml
 
 .cache/
+
+# Visual Studio Code
+.vscode/

.vscode/extensions.json

@@ -0,0 +1,11 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+    // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+    // List of extensions which should be recommended for users of this workspace.
+    "recommendations": [
+        "ms-vscode.cmake-tools",                    // CMake for Debugging C/C++
+        "llvm-vs-code-extensions.vscode-clangd",    // Optional intellisense-like features with LLVM/clangd
+        "theodevelop.bison-flex-lang",              // For flex/bison source files
+    ],
+}

.vscode/launch.json

@@ -0,0 +1,34 @@
+{
+    // 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": "(lldb) Launch",
+            "type": "lldb",
+            "request": "launch",
+            // Resolved by CMake Tools:
+            "program": "${command:cmake.launchTargetPath}",
+            // "--header-file=<output_header>", "-o<output_source>", "<input_source>"
+            "args": [],
+            "cwd": "${workspaceFolder}",
+            "terminal": "integrated",
+            "stopOnEntry": false,
+            // Non-Windows is unnecessary but it helps to ensure PATH correctly
+            "env": {
+                "PATH": "${env:PATH}:${command:cmake.launchTargetDirectory}"
+            },
+            "windows": {
+                // Warning: CodeLLDB is still slower than WinDbg (cppvsdbg) in Windows
+                //          and don't support C++ (string/vector) for MSVC ABI - this codebase is C99
+                "env": {
+                    "PATH": "${env:PATH};${command:cmake.launchTargetDirectory}"
+                }
+            },
+            "initCommands": [
+                "settings set target.process.follow-fork-mode parent"
+            ]
+        },
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+    "editor.insertSpaces": true,
+    "editor.tabSize": 4,
+    "editor.detectIndentation": true,
+    "files.trimTrailingWhitespace": true,
+    "[markdown]": {
+        "files.trimTrailingWhitespace": false,
+    },
+    "editor.rulers": [80,120],
+    "git.rebaseWhenSync": true,
+    "git.pruneOnFetch": true,
+    // "cmake.preferredGenerators": ["Ninja Multi-Config"],
+    "cmake.generator": "Ninja Multi-Config",
+    "cmake.options.statusBarVisibility": "compact",
+    "cmake.useCMakePresets": "never",
+    "C_Cpp.intelliSenseEngine": "disabled",
+}

CMakeLists.txt

@@ -61,6 +61,11 @@ if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
             endforeach()
             message(STATUS "Using /MT STATIC runtime")
         endif ()
+
+        # MSVC's incremental linking is offering little to no benefit,
+        # disable it for faster link times (and prevent ilk binary bloat).
+        # NOTE: Frequent build with vscode is hitting resource busy for the the ilk files.
+        add_link_options("/INCREMENTAL:NO")
     endif ()
 endif ()
 

README.md

@@ -35,7 +35,10 @@ The release page includes the full Changelog but you may also see the [changelog
 
 ## HowTo
 
-You may use win_flex and win_bison directly on the command line or [use them via CustomBuildRules in VisualStudio](custom_build_rules/README.md).
+You may use `win_flex` and `win_bison`:
+- directly on the command line
+- [via CustomBuildRules in VisualStudio](custom_build_rules/README.md).
+- via [CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) in [vscode-like editors](vscode/README.md).
 
 
 ## Example flex/bison files

vscode/README.md

@@ -0,0 +1,49 @@
+
+# How to setup vscode-like editors for debugging win_flex/win_bison
+
+Here is a simple guide (based on the [MS documentation](https://code.visualstudio.com/docs/cpp/cmake-linux)):
+1. Make sure the [Prerequisites](https://code.visualstudio.com/docs/cpp/cmake-linux#_prerequisites) are installed.
+2. [Select a compiler kit](https://code.visualstudio.com/docs/cpp/cmake-linux#_select-a-kit), any of the native `amd64` version of MSVC is recommended for compatibility - any of the rest with `x86` is cross-compiling a 32-bit version of `win_flex`/`win_bison`.
+
+![Select a compiler kit](./1_compiler.png)
+
+NOTE: Click `Scan for kits` when setting up C/C++ debugging for the first time if there is no compiler kits found yet.
+
+3. Due to `win_flex`/`win_bison` being separate executables/targets, debugging will need to [select a launch target](https://github.com/microsoft/vscode-cmake-tools/blob/main/docs/debug-launch.md#select-a-launch-target).
+
+![Select a launch targe](./2_target.png)
+
+4. Optionally switch between build types - usually between `Release` or `Debug` builds, make sure `Debug` is selected when debugging or there will be no debug symbols to hit breakpoints.
+
+![Debug build type](./3_build.png)
+
+5. Both `win_flex` and `win_bison` requires arguments for the target input/output source files, just add the arguments as how `win_flex` or `win_bison` was called from the command line where each space-separated argument is an element in [.vscode/launch.json](.vscode/launch.json)'s `args` array separated by commas, based on [flex-bison-example](https://github.com/meyerd/flex-bison-example),
+  - here is a sample for `win_flex` target:
+```json
+            "args": [
+                "calc.l",
+            ],
+```
+  - here is a sample for `win_bison` target:
+```json
+            "args": [
+                "-d",
+                "calc.y",
+            ],
+```
+  - NOTE: This example uses source files without full path was achieved by setting `cwd`
+```json
+            "cwd": "${workspaceFolder}/../flex-bison-example",
+```
+
+6. Setup the codebase for inspection [debugging](https://code.visualstudio.com/docs/editor/debugging), eg. breakpoints (with `F9`), [logpoints](https://github.com/vadimcn/codelldb/blob/master/MANUAL.md#logpoints).
+
+![Breakpoint](./4_breakpoint.png)
+
+7. Hit `F5` to start debugging, or click the `launch` button.
+
+![Launch](./5_launch.png)
+
+8. Here is how it looks like when the program pauses at a breakpoint, refer to the official [Debugging guide](https://code.visualstudio.com/docs/debugtest/debugging#_debugger-user-interface) for more information.
+
+![Pause](./6_pause.png)