Supporting debugging could be really helpful for new people

[joshring]

I got debugging to work, but it's a bit of workaround, see https://github.com/joshring/c3-debugging

Debugging currently works quite nicely with the C or C++ extension from microsoft but you must enable
File->Preferences->Settings and set "debug.allowBreakpointsEverywhere"

Then add file: .vscode/launch.json

File content:

{
    // 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": "gdb with C++ devtools",
            "type": "cppdbg",
            "request": "launch",
            "program": "${workspaceFolder}/build/your_project_exe_name",
            "args": [],
            "cwd": "${workspaceFolder}/build",
            "environment": [],
            "MIMode": "gdb",
            "miDebuggerPath": "/usr/bin/gdb",
            "setupCommands": [
                {
                    "text": "-enable-pretty-printing",
                }
            ],
            "preLaunchTask": "c3cbuild",
            "stopAtEntry": true,
        }
    ]
}

Add file .vscode/tasks.json

File content:

{
    "version": "2.0.0",
    "type":"shell",
    "tasks": [
        {
            "type": "shell",
            "command": "c3c",
            "args": ["build"],
            "label": "c3cbuild",
            "presentation": {
                "echo": true,
		"reveal": "never",
		"focus": false,
		"panel": "dedicated",
		"showReuseMessage": false,
		"clear": false,
		"revealProblems": "onProblem",
		"close": true
            },
            "problemMatcher": {
                "owner": "c3c",
                "fileLocation": [
                    "relative",
                    "${workspaceFolder}"
                ],
                "pattern": {
                    "regexp": "^(.*):(\\d+):(\\d+)\\s+(Warning|Error):\\s+(.*)$",
                    "file": 1,
                    "line": 2,
                    "column": 3,
                    "severity": 4,
                    "message": 5
                }
            }
        }
    ]
}

Alternatively it seems the extension itself can support debugging and automate the above, which seems interesting
https://code.visualstudio.com/api/extension-guides/debugger-extension

[ManuLinares]

I have a simpler approach to debugging with vscode using the CodeLLDB extension: vadimcn.vscode-lldb

With this config (or similar) you can set breakpoints, debug .c3 files and the compiler itself

.vscode/launch.json

{
  "configurations": [
    {
      "name": "Debug C3 current .c3 file",
      "type": "lldb",
      "request": "launch",
      "program": "${workspaceFolder}/.c3-debug-bin",
      "cwd": "${workspaceFolder}",
      "stopOnEntry": false,
      "sourceLanguages": ["c3"],
      "preLaunchTask": "c3: compile current file (debug)"
    },

    {
    "name": "Debug C3C Compiler",
    "type": "lldb",
    "request": "launch",
    "program": "${workspaceFolder}/build-debug/c3c",
    "args": [
        "compile-only",
        "${file}",
        "--single-module=yes",
        "-o",
        "${workspaceFolder}/.c3-debug-bin"
    ],
    "cwd": "${workspaceFolder}",
    "stopOnEntry": false,
    "sourceLanguages": ["c", "c3"],
    "preLaunchTask": "c3: build compiler"
    }
  ]
}

.vscode/tasks.json

{
  "tasks": [
    {
      "label": "c3: build compiler",
      "type": "shell",
      "command": "./build_debug.sh",
      "group": "build"
    },
    {
      "label": "c3: compile current file (debug)",
      "type": "shell",
      "command": "build-debug/c3c",
      "args": [
        "compile",
        "--stdlib",
        "${workspaceFolder}/lib/std/",
        "-g",
        "${file}",
        "-o",
        "${workspaceFolder}/.c3-debug-bin"
      ],
      "dependsOn": "c3: build compiler"
    }
  ]
}

---

the build_debug.sh is just the way I build the compiler. It will depend on our system but mine is:

build_debug.sh

#!/usr/bin/env bash
set -e
mkdir -p build-debug
CFLAGS="-march=x86-64 -mtune=generic -O0 -g3 -pipe \
        -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer"
CXXFLAGS="$CFLAGS"
cmake \
  -B build-debug \
  -G Ninja \
  -D C3_LINK_DYNAMIC=ON \
  -D CMAKE_BUILD_TYPE=Debug \
  -D CMAKE_C_FLAGS_DEBUG="$CFLAGS" \
  -D CMAKE_CXX_FLAGS_DEBUG="$CXXFLAGS" \
  -D CMAKE_EXPORT_COMPILE_COMMANDS=ON \
  -S .
ninja -C build-debug