File.h

[詳解]

/// @file
/// @brief ファイル操作処理を提供する静的クラス File のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_UTIL_FILE_H
#define AMDAEMON_UTIL_FILE_H

#include "amdaemon/env.h"

#include <string>
#include <fstream>
#include <cstdint>

namespace amdaemon
{
namespace util
{
    /// ファイル操作処理を提供する静的クラス。
    class File
    {
    public:
        /// @brief ファイルが存在するか否かを取得する。
        /// @param[in] path ファイルパス。
        /// @retval true  存在する場合。
        /// @retval false 存在しないか、ファイルではない場合。
        /// @see Path::existsFile
        ///
        /// Path::existsFile を呼び出す。
        static bool exists(const std::wstring& path);

        /// @brief ファイルサイズを取得する。
        /// @param[in] path ファイルパス。
        /// @return ファイルサイズ。ファイルが存在しない場合は -1 。
        static std::int64_t getSize(const std::wstring& path);

        /// @brief ファイルを読み取り用に開く。
        /// @param[in] path ファイルパス。
        /// @param[in] mode オープンモード。
        /// @return ストリーム。開けなかった場合はエラービットが立っている。
        static std::ifstream openRead(
            const std::wstring& path,
            std::ios_base::openmode mode = std::ios_base::in);

        /// @brief ファイルを読み取り用に開く。
        /// @param[in] path ファイルパス。
        /// @param[in] mode オープンモード。
        /// @return ストリーム。開けなかった場合はエラービットが立っている。
        static std::wifstream openReadWide(
            const std::wstring& path,
            std::ios_base::openmode mode = std::ios_base::in);

        /// @brief ファイルを書き出し用に開く。
        /// @param[in] path ファイルパス。
        /// @param[in] mode オープンモード。
        /// @return ストリーム。開けなかった場合はエラービットが立っている。
        static std::ofstream openWrite(
            const std::wstring& path,
            std::ios_base::openmode mode = std::ios_base::out);

        /// @brief ファイルを書き出し用に開く。
        /// @param[in] path ファイルパス。
        /// @param[in] mode オープンモード。
        /// @return ストリーム。開けなかった場合はエラービットが立っている。
        static std::wofstream openWriteWide(
            const std::wstring& path,
            std::ios_base::openmode mode = std::ios_base::out);

    private:
        // インスタンス化禁止
        File();                         // 宣言のみ
        File(const File&);              // 宣言のみ
        File& operator=(const File&);   // 宣言のみ
    };
} // namespace util
} // namespace amdaemon

#endif // AMDAEMON_UTIL_FILE_H