dump.h

[詳解]

/// @file
/// @brief 共有メモリ情報のダンプ処理関数群のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_DUMP_H
#define AMDAEMON_DUMP_H

#include "amdaemon/env.h"
#include "amdaemon/util/JsonTree.h"

#include <vector>
#include <string>
#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_dump
/// @{

    /// @brief ダンプ対象列挙。
    ///
    /// 関数テンプレート #dump のテンプレート引数に渡す。
    enum class DumpTarget
    {
        All = 0,            ///< 全情報。
        Process,            ///< Daemonプロセス関連情報。
        Common,             ///< 共通情報。
        AbaasLog,           ///< abaas::Log クラス情報。
        Aime,               ///< Aime クラス情報。
        AllnetAuth,         ///< allnet::Auth クラス情報。
        AllnetAccounting,   ///< allnet::Accounting クラス情報。
        AllnetWiFi,         ///< allnet::WiFi クラス情報。
        AppImage,           ///< AppImage クラス情報。
        Backup,             ///< Backup クラス情報。
        BoardIO,            ///< BoardIO クラス情報。
        Can,                ///< Can クラス情報。
        Credit,             ///< Credit クラス情報。
        EMoney,             ///< EMoney クラス情報。
        Error,              ///< Error クラス情報。
        Input,              ///< Input クラス情報。
        Jvs,                ///< Jvs クラス情報。
        LanInstall,         ///< LanInstall クラス情報。
        NetDelivery,        ///< NetDelivery クラス情報。
        Network,            ///< Network クラス情報。
        Output,             ///< Output クラス情報。
        Sequence,           ///< Sequence クラス情報。
        System,             ///< System クラス情報。
        UsbDevice,          ///< UsbDevice クラス情報。
        UsbIO,              ///< UsbIO クラス情報。
    };

    //--------------------
    // JSONツリーへのダンプ
    //--------------------

    /// @brief 共有メモリ情報をダンプする。
    /// @tparam target ダンプ対象列挙値。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @note ダンプ対象列挙値ごとに特殊化される。
    template<DumpTarget target>
    void dump(::amdaemon::util::JsonObjectAdder& tree); // 宣言のみ

    /// @brief 全情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @internal ライブラリ実装メモ: dump.cpp で実装。
    template<>
    void dump<DumpTarget::All>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief 全情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    inline void dumpAll(::amdaemon::util::JsonObjectAdder& tree)
    {
        dump<DumpTarget::All>(tree);
    }

    /// @brief Daemonプロセス関連情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Core
    /// @internal ライブラリ実装メモ: dump.cpp で実装。
    template<>
    void dump<DumpTarget::Process>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief 共通情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Core
    /// @internal ライブラリ実装メモ: dump.cpp で実装。
    template<>
    void dump<DumpTarget::Common>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief abaas::Log クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see abaas::Log
    /// @internal ライブラリ実装メモ: abaas/Log.cpp で実装。
    template<>
    void dump<DumpTarget::AbaasLog>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Aime クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Aime
    /// @internal ライブラリ実装メモ: Aime.cpp で実装。
    template<>
    void dump<DumpTarget::Aime>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief allnet::Auth クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see allnet::Auth
    /// @internal ライブラリ実装メモ: allnet/Auth.cpp で実装。
    template<>
    void dump<DumpTarget::AllnetAuth>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief allnet::Accounting クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see allnet::Accounting
    /// @internal ライブラリ実装メモ: allnet/Accounting.cpp で実装。
    template<>
    void dump<DumpTarget::AllnetAccounting>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief allnet::WiFi クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see allnet::WiFi
    /// @internal ライブラリ実装メモ: allnet/WiFi.cpp で実装。
    template<>
    void dump<DumpTarget::AllnetWiFi>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief AppImage クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see AppImage
    /// @internal ライブラリ実装メモ: AppImage.cpp で実装。
    template<>
    void dump<DumpTarget::AppImage>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Backup クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Backup
    /// @internal ライブラリ実装メモ: Backup.cpp で実装。
    template<>
    void dump<DumpTarget::Backup>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief BoardIO クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see BoardIO
    /// @internal ライブラリ実装メモ: BoardIO.cpp で実装。
    template<>
    void dump<DumpTarget::BoardIO>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Can クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Can
    /// @internal ライブラリ実装メモ: Can.cpp で実装。
    template<>
    void dump<DumpTarget::Can>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Credit クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Credit
    /// @internal ライブラリ実装メモ: Credit.cpp で実装。
    template<>
    void dump<DumpTarget::Credit>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief EMoney クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see EMoney
    /// @internal ライブラリ実装メモ: EMoney.cpp で実装。
    template<>
    void dump<DumpTarget::EMoney>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Error クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Error
    /// @internal ライブラリ実装メモ: Error.cpp で実装。
    template<>
    void dump<DumpTarget::Error>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Input クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Input
    /// @internal ライブラリ実装メモ: Input.cpp で実装。
    template<>
    void dump<DumpTarget::Input>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Jvs クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Jvs
    /// @internal ライブラリ実装メモ: Jvs.cpp で実装。
    template<>
    void dump<DumpTarget::Jvs>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief LanInstall クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see LanInstall
    /// @internal ライブラリ実装メモ: LanInstall.cpp で実装。
    template<>
    void dump<DumpTarget::LanInstall>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief NetDelivery クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see NetDelivery
    /// @internal ライブラリ実装メモ: NetDelivery.cpp で実装。
    template<>
    void dump<DumpTarget::NetDelivery>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Network クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Network
    /// @internal ライブラリ実装メモ: Network.cpp で実装。
    template<>
    void dump<DumpTarget::Network>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Output クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Output
    /// @internal ライブラリ実装メモ: Output.cpp で実装。
    template<>
    void dump<DumpTarget::Output>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief Sequence クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see Sequence
    /// @internal ライブラリ実装メモ: Sequence.cpp で実装。
    template<>
    void dump<DumpTarget::Sequence>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief System クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see System
    /// @internal ライブラリ実装メモ: System.cpp で実装。
    template<>
    void dump<DumpTarget::System>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief UsbDevice クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see UsbIO
    /// @internal ライブラリ実装メモ: UsbDevice.cpp で実装。
    template<>
    void dump<DumpTarget::UsbDevice>(::amdaemon::util::JsonObjectAdder& tree);

    /// @brief UsbIO クラス情報をダンプする。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    /// @see UsbIO
    /// @internal ライブラリ実装メモ: UsbIO.cpp で実装。
    template<>
    void dump<DumpTarget::UsbIO>(::amdaemon::util::JsonObjectAdder& tree);

    //--------------------
    // 文字列へのダンプ
    //--------------------

    /// @brief 共有メモリ情報をダンプする。
    /// @tparam target ダンプ対象列挙値。
    /// @param[in] indent インデントレベル。負数ならば整形しない。
    /// @return ダンプ文字列。
    template<DumpTarget target>
    inline std::wstring dump(std::int32_t indent = 0)
    {
        ::amdaemon::util::JsonTree tree;
        dump<target>(tree);
        return tree.toString(indent);
    }

    /// @brief 全情報をダンプする。
    /// @param[in] indent インデントレベル。負数ならば整形しない。
    /// @return ダンプ文字列。
    inline std::wstring dumpAll(std::int32_t indent = 0)
    {
        return dump<DumpTarget::All>(indent);
    }

    //--------------------
    // バイナリのダンプ
    //--------------------

    /// @brief 全情報バイナリサイズを取得する。
    /// @return 全情報バイナリサイズ。
    std::size_t getDumpBinarySize();

    /// @brief 全情報バイナリをダンプする。
    /// @param[in,out] dest ダンプ先。
    ///
    /// @exception Exception
    /// 引数 dest に nullptr を指定した場合。
    ///
    /// @attention
    /// - 引数 dest は予め領域を確保しておくこと。
    /// - 引数に std::vector{std::uint8_t} 参照を取るオーバロードの利用を推奨する。
    void dumpBinary(void* dest);

    /// @brief 全情報バイナリをダンプする。
    /// @param[in,out] dest ダンプ先。リサイズされる。
    inline void dumpBinary(std::vector<std::uint8_t>& dest)
    {
        dest.resize(getDumpBinarySize());
        dumpBinary(dest.data());
    }

    /// @brief 全情報バイナリから全情報をダンプする。
    /// @param[in] src 全情報バイナリ。
    /// @param[in,out] tree ダンプ先のJSONツリー。
    ///
    /// @exception Exception
    /// 引数 src に nullptr を指定した場合。
    void dumpAllFromBinary(const void* src, ::amdaemon::util::JsonObjectAdder& tree);

    /// @brief 全情報バイナリから全情報をダンプする。
    /// @param[in] src 全情報バイナリ。
    /// @param[in] indent インデントレベル。負数ならば整形しない。
    /// @return ダンプ文字列。
    ///
    /// @exception Exception
    /// 引数 src に nullptr を指定した場合。
    inline std::wstring dumpAllFromBinary(const void* src, std::int32_t indent = 0)
    {
        ::amdaemon::util::JsonTree tree;
        dumpAllFromBinary(src, tree);
        return tree.toString(indent);
    }

/// @}
} // namespace amdaemon

#endif // AMDAEMON_DUMP_H