GCC-XMLを使ってC++ソースコードからXMLドキュメントを生成する

CMakeモジュールにおけるFindGCCXMLの詳細解説

FindGCCXMLは、CMakeのモジュールの一つで、GCC-XMLフロントエンドの実行ファイルを検出するためのものです。このモジュールは、以下の変数を定義します。

• GCCXML: GCC-XMLの実行ファイルへのパス
• GCCXML_FOUND: GCC-XMLが見つかったかどうかを示すブール値
• GCCXML_VERSION: GCC-XMLのバージョン

FindGCCXMLを使用するには、CMakeLists.txtファイルに以下のコードを追加する必要があります。

find_package(GCCXML REQUIRED)

if(GCCXML_FOUND)
  message(STATUS "GCC-XML found: ${GCCXML}")
  # GCC-XMLを使用するコード
else()
  message(STATUS "GCC-XML not found")
endif()

FindGCCXMLは、以下の方法でGCC-XMLの実行ファイルを検出します。

1. 環境変数 GCCXML_EXECUTABLE が設定されている場合は、その値を使用します。

2. パス $PATH に gccxml または g++-xml という名前の実行ファイルが存在するかどうかを確認します。

3. 以下のレジストリキーをチェックします。

   • Windows: HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\App Paths\gccxml.exe
   • macOS: /usr/local/bin/gccxml

FindGCCXMLのオプション

FindGCCXMLは以下のオプションを受け付けます。

• GCCXML_ROOT_DIR: GCC-XMLのインストールディレクトリを指定します。
• GCCXML_EXECUTABLE: GCC-XMLの実行ファイルへのパスを指定します。
• GCCXML_REQUIRED: GCC-XMLが見つからなかった場合にエラーを出力するかどうかを指定します。

FindGCCXMLの詳細については、以下のリソースを参照してください。

補足

• FindGCCXMLは、CMakeバージョン3.5以降で使用できます。
• GCC-XMLは、C++ソースコードからXMLドキュメントを生成するためのツールです。
• 生成されたXMLドキュメントは、Doxygenなどのツールでドキュメントを生成するために使用できます。

例

以下の例は、FindGCCXMLを使用してGCC-XMLの実行ファイルを見つけ、そのバージョンを出力するコードです。

find_package(GCCXML REQUIRED)

if(GCCXML_FOUND)
  message(STATUS "GCC-XML found: ${GCCXML}")
  message(STATUS "GCC-XML version: ${GCCXML_VERSION}")
else()
  message(STATUS "GCC-XML not found")
endif()

このコードを実行すると、以下の出力が出力されます。

-- Found GCC-XML: /usr/bin/gccxml
-- GCC-XML version: 1.14.1

注意

FindGCCXMLは、すべての環境で動作するとは限りません。必要に応じて、上記のオプションを使用して、FindGCCXMLの動作をカスタマイズする必要があります。

FindGCCXMLモジュールのサンプルコード集

GCC-XMLの実行ファイルとバージョンを出力する

find_package(GCCXML REQUIRED)

if(GCCXML_FOUND)
  message(STATUS "GCC-XML found: ${GCCXML}")
  message(STATUS "GCC-XML version: ${GCCXML_VERSION}")
else()
  message(STATUS "GCC-XML not found")
endif()

GCC-XMLを使用してC++ソースコードからXMLドキュメントを生成する

find_package(GCCXML REQUIRED)

if(GCCXML_FOUND)
  set(SOURCE_FILE "example.cpp")
  set(OUTPUT_FILE "example.xml")

  # GCC-XMLを使用してXMLドキュメントを生成
  add_custom_command(
    OUTPUT ${OUTPUT_FILE}
    COMMAND ${GCCXML} -o ${OUTPUT_FILE} ${SOURCE_FILE}
    )

  # 生成されたXMLドキュメントをDoxygenで処理
  add_custom_command(
    OUTPUT ${OUTPUT_FILE}.html
    COMMAND doxygen ${OUTPUT_FILE}
    )
else()
  message(STATUS "GCC-XML not found")
endif()

GCCXMLのインストールディレクトリを指定する

find_package(GCCXML REQUIRED
  GCCXML_ROOT_DIR "/usr/local/gccxml")

if(GCCXML_FOUND)
  message(STATUS "GCC-XML found: ${GCCXML}")
  message(STATUS "GCC-XML version: ${GCCXML_VERSION}")
else()
  message(STATUS "GCC-XML not found")
endif()

GCCXMLの実行ファイルへのパスを指定する

find_package(GCCXML REQUIRED
  GCCXML_EXECUTABLE "/usr/bin/gccxml-11")

if(GCCXML_FOUND)
  message(STATUS "GCC-XML found: ${GCCXML}")
  message(STATUS "GCC-XML version: ${GCCXML_VERSION}")
else()
  message(STATUS "GCC-XML not found")
endif()

GCC-XMLが見つからなかった場合にエラーを出力しない

find_package(GCCXML)

if(GCCXML_FOUND)
  message(STATUS "GCC-XML found: ${GCCXML}")
  message(STATUS "GCC-XML version: ${GCCXML_VERSION}")
else()
  message(STATUS "GCC-XML not found")
endif()

GCC-XMLを使用するその他の方法

手動でGCC-XMLを実行する

gccxml -o example.xml example.cpp

このコマンドは、example.cpp という名前のC++ソースコードファイルから example.xml という名前のXMLドキュメントを生成します。

CMakeのExternalProjectモジュールを使用する

ExternalProjectモジュールを使用して、GCC-XMLをビルドしてインストールすることができます。

set(GCCXML_URL "https://github.com/gccxml/gccxml.git")
set(GCCXML_TAG "v1.14.1")

externalproject_add(
  name gccxml
  URL ${GCCXML_URL}
  TAG ${GCCXML_TAG}
  BUILD_IN_SOURCE 1
  )

# GCC-XMLを使用してXMLドキュメントを生成
add_custom_command(
  OUTPUT example.xml
  COMMAND ${GCCXML_BINARY_DIR}/gccxml -o ${OUTPUT_FILE} example.cpp
  )

このコードは、gccxml という名前のExternalProjectを追加します。このExternalProjectは、https://github.com/gccxml/gccxml.git からソースコードをダウンロードしてビルドします。

CMakeのFetchContentモジュールを使用する

FetchContentモジュールを使用して、GCC-XMLのソースコードをダウンロードしてビルドすることができます。

fetch_content(
  NAME gccxml
  GIT_REPOSITORY "https://github.com/gccxml/gccxml.git"
  TAG "v1.14.1"
  )

# GCC-XMLを使用してXMLドキュメントを生成
add_custom_command(
  OUTPUT example.xml
  COMMAND ${GCCXML_SOURCE_DIR}/bin/gccxml -o ${OUTPUT_FILE} example.cpp
  )

このコードは、gccxml という名前のFetchContentモジュールを追加します。このモジュールは、https://github.com/gccxml/gccxml.git からソースコードをダウンロードしてビルドします。

FindGCCXMLモジュールは、GCC-XMLの実行ファイルを見つけるための便利なツールです。ただし、必要に応じて、上記のような他の方法を使用してGCC-XMLを使用することもできます。