aboutsummaryrefslogtreecommitdiffstats
path: root/QtVsTools.Core/NatvisHelper.cs
blob: 04532f3ef5a55c4cb7c3973191997269d20ceebe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

using System;
using System.IO;
using System.Threading;
using EnvDTE;
using Microsoft.VisualStudio.Shell;
using Microsoft.Win32;

using Tasks = System.Threading.Tasks;

namespace QtVsTools.Core
{
    using Common;
    using VisualStudio;

    public static class NatvisHelper
    {
        private static Tasks.Task _initTask;
        private static string _visualizersPath;

        public static void CopyVisualizersFiles(string qtNamespace = null)
        {
            if (string.IsNullOrEmpty(qtNamespace))
                return;

            ThreadHelper.JoinableTaskFactory.Run(async () =>
                await CopyVisualizersFilesAsync(qtNamespace));
        }

        public static async Tasks.Task CopyVisualizersFilesAsync(string qtNamespace = null)
        {
            string[] files = {
                "QtMSBuild\\vs-debugtools\\natvis\\qt5.natvis",
                "QtMSBuild\\vs-debugtools\\natvis\\qt6.natvis"
            };
            foreach (var file in files)
                await CopyVisualizersFileAsync(file, qtNamespace);
        }

        private static async Tasks.Task CopyVisualizersFileAsync(string filename, string qtNamespace)
        {
            await EnsureVisualizersPathInitializedAsync();

            try {
                string visualizerFile;
                var text = await Utils.ReadAllTextAsync(Path.Combine(Utils.PackageInstallPath,
                    filename));

                if (string.IsNullOrEmpty(qtNamespace)) {
                    text = text.Replace("##NAMESPACE##::", string.Empty);
                    visualizerFile = Path.GetFileName(filename);
                } else {
                    text = text.Replace("##NAMESPACE##", qtNamespace);
                    visualizerFile = filename.Substring(0, filename.IndexOf('.'))
                        + $"_{qtNamespace.Replace("::", "_")}.natvis";
                }

                if (!Directory.Exists(_visualizersPath))
                    Directory.CreateDirectory(_visualizersPath);

                await Utils.WriteAllTextAsync(Path.Combine(_visualizersPath, visualizerFile), text);
            } catch (Exception exception) {
                exception.Log();
            }
        }

        private static async Tasks.Task EnsureVisualizersPathInitializedAsync()
        {
            if (!string.IsNullOrEmpty(_visualizersPath))
                return;

            var initTask = _initTask;
            if (initTask == null) {
                var task = InitializeVisualizersPathAsync();
                initTask = Interlocked.CompareExchange(ref _initTask, task, null) ?? task;
            }
            await initTask;
        }

        private static async Tasks.Task InitializeVisualizersPathAsync()
        {
            await VsShell.UiThreadAsync(() =>
            {
                ThreadHelper.ThrowIfNotOnUIThread();
                try {
                    if (VsServiceProvider.GetService<DTE>() is not { } dte)
                        throw new InvalidOperationException("Unable to get service: DTE");

                    using var vsRootKey = Registry.CurrentUser.OpenSubKey(dte.RegistryRoot);
                    if (vsRootKey?.GetValue("VisualStudioLocation") is string vsLocation)
                        _visualizersPath = Path.Combine(vsLocation, "Visualizers");
                } catch (Exception exception) {
                    exception.Log();
                }

                if (string.IsNullOrEmpty(_visualizersPath)) {
                    _visualizersPath = Path.Combine(Environment.GetFolderPath(Environment
                        .SpecialFolder.MyDocuments),
#if VS2022
                        @"Visual Studio 2022\Visualizers\");
#elif VS2019
                        @"Visual Studio 2019\Visualizers\");
#endif
                }
            });
        }
    }
}