Início / coding / Perguntas / 79561543
Accepted
Jepessen
Asked: 2025-04-08 16:25:56 +0800 CST

Mostrar o valor `boost::uuids::uuid` no depurador do Visual Studio com Natvis

  • 772

Em um projeto de biblioteca CMake, tenho uma classe que é basicamente um wrapper para boost::uuids::uuid:

class UUID {
public:

  static bool IsValidUUIDText(std::string_view text);
  static UUID CreateNull();

public:

  UUID();
  UUID(const UUID& other);
   UUID(UUID&& other);
  UUID(std::string_view id);
  UUID(const std::array<uint8_t, 16>& byteArray);
  ~UUID();

  std::string getText() const;
  std::array<uint8_t, 16> getByteArray() const;
   size_t getHash() const;

public:

  bool operator==(const UUID& other) const;
  bool operator!=(const UUID& other) const;
  bool operator<(const UUID& other) const;
  bool operator>(const UUID& other) const;
  bool operator<=(const UUID& other) const;
  bool operator>=(const UUID& other) const;
  UUID& operator=(const UUID& other);
  UUID& operator=(UUID&& other) noexcept;

private:

  boost::uuids::uuid* m_uuid{ nullptr };
};

inline std::ostream& operator<<(std::ostream& os, const UUID& uuid) {
  os << uuid.getText();
  return os;
}

Gostaria de mostrar o valor do UUID nas janelas do depurador do Visual Studio (Locals, por exemplo). Então, criei um arquivo .natvis seguindo este outro tópico e o coloquei em uma resourcespasta no meu projeto CMake.

<?xml version="1.0" encoding="utf-8"?>
<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
  <Type Name="boost::uuids::uuid">
    <DisplayString>{{{data[0],nvoXb}{data[1],nvoXb}{data[2],nvoXb}{data[3],nvoXb}-{data[4],nvoXb}{data[5],nvoXb}-{data[6],nvoXb}{data[7],nvoXb}-{data[8],nvoXb}{data[9],nvoXb}-{data[10],nvoXb}{data[11],nvoXb}{data[12],nvoXb}{data[13],nvoXb}{data[14],nvoXb}{data[15],nvoXb}}}</DisplayString>
  </Type>
</AutoVisualizer>

Então CMakeLists.txtadicionei o sinalizador /NATVIS:

cmake_minimum_required (VERSION ${PROJECT_CMAKE_VERSION})

project (mylib)

add_definitions (-DBOOST_UUID_FORCE_AUTO_LINK)
add_definitions (-DMYLIB_EXPORTS)


find_package (Boost CONFIG REQUIRED QUIET)

set (PROJECT_SRC
  UUID.cpp
  Exception.cpp
  )

add_library (${PROJECT_NAME} SHARED ${PROJECT_SRC})
target_link_libraries(${PROJECT_NAME} PRIVATE ${Boost_LIBRARIES})
target_compile_features (${PROJECT_NAME} PUBLIC ${PROJECT_CXX_STANDARD})
target_include_directories (${PROJECT_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/../../)
target_include_directories (${PROJECT_NAME} PUBLIC ${Boost_INCLUDE_DIRS})

if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
  get_filename_component(NATVIS_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../resources/natvis/mulib.natvis" ABSOLUTE)
  message (STATUS "MyLib natvis file is ${NATVIS_DIR}")
  target_link_options(${PROJECT_NAME} PRIVATE  /NATVIS:${NATVIS_DIR})
endif()

O CMake está configurado e a mensagem aparece. Mas quando depuro a biblioteca, o .natvis parece não funcionar, vejo os dados simples de boost::uuids::uuid.

Como posso corrigir isso e mostrar a string UUID na janela do depurador?

c++

1 respostas

  1. Best Answer

    Você está complicando demais as coisas. Basta adicionar o .natvisarquivo às suas fontes de destino e tudo funcionará como esperado¹:

    add_library (${PROJECT_NAME} SHARED ${PROJECT_SRC})
# ...
target_sources(${PROJECT_NAME} 
  PRIVATE
  $<$<CXX_COMPILER_ID:MSVC>:${CMAKE_CURRENT_SOURCE_DIR}/../../../resources/natvis/mulib.natvis>
)

    Não há necessidade de ajustes manuais nas flags do compilador. No entanto, você deve garantir que o arquivo natvis seja colocado dentro da árvore de código-fonte do CMake, como parte das práticas recomendadas gerais do CMake.

    ¹ - O tratamento adequado de .natvisarquivos foi adicionado ao CMake na versão 3.7

    • 2

relate perguntas