Natvisをcmakeで認識してvsのprojectに追加する方法

Question

Visual Studioのデバッガでの表示をカスタマイズするものとしてNatvisがあるわけですが、
Create custom views of native objects in the debugger | Microsoft Docs

.vcxprojでそれを追加して認識させるためには

  <ItemGroup>
    <Natvis Include="inferior_vector.natvis" />
  </ItemGroup>

のように追加すればいいとわかっています。

現在CMakeを使ってVSのプロジェクトを生成している都合上、CMakeで認識して上記のようなものを吐かせたいわけです。

CMake側での対応としては
Support natvis source file type in the MSVC Project Generator (#16043) · Issues · CMake / CMake · GitLab
というのがあって、CMake version 3.7.0に含まれているはずです。

しかしどうやって利用すればいいのかわかりません。

extension:cmake natvisでGithubを調べてみても、

SET_SOURCE_FILES_PROPERTIES(<natvis files> LANGUAGE natvis)

のようにしているものか、あとはadd_executableに直接渡している例が殆どで(他のはライブラリビルド時に含めるものなので今回は除外)それらはいずれも動きません(前者はなんの効果もなく、後者は認識されない拡張子で弾かれる)

${CMAKE_SOURCE_DIR}/../inferioir/vector/inferior_vector.natvisを認識させるにはどのように下記のスクリプトを書き換えればいいでしょうか？

cmake_minimum_required(VERSION 3.7.0)
enable_language(CXX)
set(CMAKE_CXX_STANDARD 14) # C++14...
set(CMAKE_CXX_STANDARD_REQUIRED ON) #...is required...
set(CMAKE_CXX_EXTENSIONS OFF) #...without compiler extensions like gnu++11

#
# Set our project name
#
project(inferior_test)

#
# Source files
#
set(inferior_test_src
    main.cpp
)

#
# find inferior
#
include_directories(${CMAKE_SOURCE_DIR}/..)

#
# find iutest
#
if(EXISTS ${CMAKE_SOURCE_DIR}/../iutest/include)
  set(IUTEST_ROOT_DIR ${CMAKE_SOURCE_DIR}/../iutest)
endif()

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/../cmake/modules)
include(FindIutest)
find_package(IUTEST)
include_directories(${IUTEST_INCLUDE_DIR})

#
# Update compiler waring flags
#
if(MSVC)
  # Force to always compile with W4
  if(CMAKE_CXX_FLAGS MATCHES "/W[0-4]")
    string(REGEX REPLACE "/W[0-4]" "/W4" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
  else()
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")
  endif()
elseif(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_GNUCXX)
  # Update if necessary
  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wno-long-long -pedantic")
endif()

#
# Compile
#
add_executable(inferior_test ${inferior_test_src})

#
# Link
#
if(WIN32)
  target_link_libraries(inferior_test ws2_32)
endif()

# - Try to find iutest include dirs
#
# Usage of this module as follows:
#
#     find_package(IUTEST)
#
# Variables used by this module, they can change the default behaviour and need
# to be set before calling find_package:
#
#  IUTEST_ROOT_DIR          Set this variable to the root installation of
#                            iutest if the module has problems finding the
#                            proper installation path.
#
# Variables defined by this module:
#
#  IUTEST_FOUND             System has iutest, include and library dirs found
#  IUTEST_INCLUDE_DIR       The iutest include directories.

find_path(IUTEST_ROOT_DIR
        NAMES include/iutest.hpp
        )

find_path(IUTEST_INCLUDE_DIR
        NAMES iutest.hpp
        HINTS ${IUTEST_ROOT_DIR}/include
)

include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(IUTEST DEFAULT_MSG
    IUTEST_INCLUDE_DIR
)

---

追記

set(inferior_test_src
    main.cpp
    ${CMAKE_SOURCE_DIR}/../inferioir/vector/inferior_vector.natvis
)

のように変更しましたがだめですね。

The CXX compiler identification is MSVC 19.12.25835.0
Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Tools/MSVC/14.12.25827/bin/Hostx86/x64/cl.exe
Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Tools/MSVC/14.12.25827/bin/Hostx86/x64/cl.exe -- works
Detecting CXX compiler ABI info
Detecting CXX compiler ABI info - done
Detecting CXX compile features
Detecting CXX compile features - done
The C compiler identification is MSVC 19.12.25835.0
Check for working C compiler: C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Tools/MSVC/14.12.25827/bin/Hostx86/x64/cl.exe
Check for working C compiler: C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Tools/MSVC/14.12.25827/bin/Hostx86/x64/cl.exe -- works
Detecting C compiler ABI info
Detecting C compiler ABI info - done
Detecting C compile features
Detecting C compile features - done
Found IUTEST: C:/Users/yumetodo/Documents/git/inferior/iutest/include  
Configuring done
CMake Error at CMakeLists.txt:55 (add_executable):
  Cannot find source file:

    C:/Users/yumetodo/Documents/git/inferior/inferioir/vector/inferior_vector.natvis

  Tried extensions .c .C .c++ .cc .cpp .cxx .m .M .mm .h .hh .h++ .hm .hpp
  .hxx .in .txx


CMake Error: CMake can not determine linker language for target: inferior_test
Generating done

CMake: 3.10.1
Visual Studio 2017

Answer 1

こんにちは。

CMakeのソースを見てみましたが、ソース・ファイルの１つとして指定すればよさそうです。
.natvisを使ってVisual Studioのデバッグを見やすくするのソースをちょっと修正してやってみたらうまくいきました。

natvis_test.cpp（元記事のソースにコンストラクタとデストラクタを追加しました）

#include <iostream>
#include <algorithm>

struct MyArray
{
    int*    m_data;
    int     m_size;
    MyArray(std::size_t iSize) : m_data(new int[iSize]), m_size(iSize)
    {
        std::fill(m_data, m_data+m_size, 0);
    }
    ~MyArray()
    {
        delete[] m_data;
    }
};

int main()
{
    MyArray array( 10 );
    return 0;
}

MyArray.natvis（元記事のままです）

<?xml version="1.0" encoding="utf-8"?> 
<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
  <Type Name="MyArray">
    <DisplayString>{{[size] = {m_size}}}</DisplayString>
    <Expand>
      <Item Name="size">m_size</Item>
      <ArrayItems>
        <Size>m_size</Size>
        <ValuePointer>m_data</ValuePointer>
      </ArrayItems>
    </Expand>
  </Type>
</AutoVisualizer>

CMakeLists.txt（オリジナルです）

project(natvis_test)

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4 /EHsc")

add_executable(natvis_test natvis_test.cpp MyArray.natvis)

これでQiitaの記事のようにarrayの内容が表示されました。

Visual Studio 2017 Community
CMake 3.10.2

---

natvis知りませんでしたが、便利そうですね。
一々xmlファイルを作る根性はないですが、STL用のnatvisファイルって提供されていると良いですね。

Comments

[yumetodo]

だめですね・・・なんでだろう

[yumetodo]

とりあえずPC再起動してみるか

[yumetodo]

あああ、単純にnatvisファイルへのパスが間違っていたというかtypoしていた(inferioirじゃなくてinferior)。あたしってば本当におバカ。

[Chironian]

どんまい

[yumetodo]

検索可能性がない話なので
https://qiita.com/yumetodo/items/bd8f556ab56298f19ba8
に追記しました。