mapbox / mapbox/variant

Visual Studio debugger support

Open
#155 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
384
Forks
96
PR merge metrics
No merged PRs in 30d

Description

I created a Visual Studio Native Visualizer file for variant.
This file enable the debugger to view the value in a variant variable.
There are two files here:

  1. Variant.natvis - the XML describe how to view the variant in VS debugger
  2. InstallVSDebuggerVariantSupport.bat - simple batch file to copy the nativs file to VS debugger folder
  3. One can also just add it to the project itself, the debugger will peek it up from there.

The natvis file support up to 20 types, if you think we need to support more, tell me and I will upload a new file.
VS Natvis format requires to explicitly describe each variant (with 1, 2, 3... types).
I use the boost::variant nativs file as a reference, and there it describe up to 20.

Enjoy :-)

VariantVSDebuggerSupoort.zip

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the attached Variant.natvis and InstallVSDebuggerVariantSupport.bat files, along with the repository's existing project layout and contribution guidance. Confirm how Visual Studio Native Visualizer files are expected to be included, then verify that variant values can be inspected in the debugger for the supported types; done means the support is available through the project or documented installation path.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
devtools
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.