CFile.h

[詳解]

//=============================================================================
/// @file
/// ファイル入出力クラスヘッダファイル
///
/// ファイル入出力クラスヘッダファイルです。
///
/// $Id: CFile.h 245 2019-03-20 15:03:41Z admin $
/// $Date: 2019-03-21 00:03:41 +0900 (2019/03/21 (木)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

//=============================================================================
// インクルードファイル
#include <LibCommonDef.h>

//=============================================================================
// マクロ定義
#define CP_UTF16 ( 1200 ) ///< UTF-16コードページ

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// ファイル入出力クラス
    ///
    /// ファイル入出力クラスです。
    ///
    /// @attention なし
    ///
    class LIB_COMMON_API CFile {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CFile() noexcept;

        //---------------------------------------------------------------------
        /// デストラクタ
        ///
        /// デストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual ~CFile() noexcept;

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// ファイルハンドル取得関数
        ///
        /// ファイルハンドル取得関数です。
        ///
        /// @param     なし
        /// @return    ファイルハンドル
        /// @attention なし
        ///
        inline virtual HANDLE GetHandle() const noexcept { return m_hFile; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// 作成関数
        ///
        /// 作成関数です。
        ///
        /// @param[in] pszPath   ファイルパス
        /// @param[in] uCodePage コードページ種別
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Create( wchar_t const* pszPath, UINT uCodePage = CP_UTF16 ) noexcept;

        //---------------------------------------------------------------------
        /// オープン関数
        ///
        /// オープン関数です。
        ///
        /// @param[in] pszPath ファイルパス
        /// @param[in] bWrite  書き込み許可フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Open( wchar_t const* pszPath, bool bWrite = false ) noexcept;

        //---------------------------------------------------------------------
        /// 追記モードオープン関数
        ///
        /// 追記モードオープン関数です。
        ///
        /// @param[in] pszPath   ファイルパス
        /// @param[in] uCodePage コードページ種別
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OpenAppend( wchar_t const* pszPath, UINT uCodePage = CP_UTF16 ) noexcept;

        //---------------------------------------------------------------------
        /// クローズ関数
        ///
        /// クローズ関数です。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual void Close() noexcept;

        //---------------------------------------------------------------------
        /// リード関数
        ///
        /// リード関数です。
        ///
        /// @param[out] pBuffer バッファポインタ
        /// @param[in]  nSize   バッファサイズ
        /// @return     リードサイズ
        /// @attention  なし
        ///
        virtual LONGLONG Read( void* pBuffer, LONGLONG nSize ) noexcept;

        //---------------------------------------------------------------------
        /// ライト関数
        ///
        /// ライト関数です。
        ///
        /// @param[in] pBuffer バッファポインタ
        /// @param[in] nSize   バッファサイズ
        /// @return    ライトサイズ
        /// @attention  なし
        ///
        virtual LONGLONG Write( void const* pBuffer, LONGLONG nSize ) noexcept;

        //---------------------------------------------------------------------
        /// ファイルサイズ取得関数
        ///
        /// ファイルサイズ取得関数です。
        ///
        /// @param     なし
        /// @return    ファイルサイズ
        /// @attention なし
        ///
        virtual LONGLONG GetFileSize() const noexcept;

        //---------------------------------------------------------------------
        /// ファイルポインタ取得関数
        ///
        /// ファイルポインタ取得関数です。
        ///
        /// @param     なし
        /// @return    ファイルポインタ
        /// @attention なし
        ///
        virtual LONGLONG GetFilePoint() const noexcept;

        //---------------------------------------------------------------------
        /// ファイルポインタ設定関数
        ///
        /// ファイルポインタ設定関数です。
        ///
        /// @param[in] nPoint ファイルポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetFilePoint( LONGLONG nPoint ) noexcept;

        //---------------------------------------------------------------------
        /// ファイル終端設定関数
        ///
        /// ファイル終端設定関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetFileEnd() noexcept;

        //---------------------------------------------------------------------
        /// コードバイトリード関数
        ///
        /// コードバイトリード関数です。
        ///
        /// @param[in,out] pBuffer バッファポインタ
        /// @param[in,out] nCount  リードカウント参照
        /// @param[in]     nSize   リードサイズ
        /// @return        実行結果
        /// -              true  成功
        /// -              false 失敗
        /// @attention     なし
        ///
        virtual bool ReadCodeBytes( unsigned char pBuffer[ MB_LEN_MAX ], int& nCount, int nSize ) noexcept;

        //---------------------------------------------------------------------
        /// コードページ入力関数
        ///
        /// コードページ入力関数です。
        ///
        /// @param[out] ruCodePage コードページ種別参照
        /// @param[out] rnUtf8     UTF-8コードページ確率参照
        /// @param[out] rnSJis     S-JISコードページ確率参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool InputCodePage( UINT& ruCodePage, int& rnUtf8, int& rnSJis ) noexcept;

        //---------------------------------------------------------------------
        /// BOM出力関数
        ///
        /// BOM出力関数です。
        ///
        /// @param[in] uCodePage コードページ種別
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputBom( UINT uCodePage ) noexcept;

        //=====================================================================
        // 静的公開関数
    public:
        //---------------------------------------------------------------------
        /// BOMデータ取得関数
        ///
        /// BOMデータ取得関数です。
        ///
        /// @param[in]  uCodePage コードページ種別
        /// @param[out] nSize     バッファサイズ参照
        /// @return     BOMデータ配列ポインタ
        /// @attention  なし
        ///
        static char unsigned const* GetBomData( UINT uCodePage, int& nSize ) noexcept;

        //---------------------------------------------------------------------
        /// ASCIIコード判定関数
        ///
        /// ASCIIコード判定関数です。
        ///
        /// @param[in] ch 文字コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool IsAscii( char unsigned ch ) noexcept;

        //---------------------------------------------------------------------
        /// S-JIS第１バイト判定関数
        ///
        /// S-JIS第１バイト判定関数です。
        ///
        /// @param[in] ch 文字コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool IsFirstByteSjis( char unsigned ch ) noexcept;

        //---------------------------------------------------------------------
        /// S-JIS第２バイト判定関数
        ///
        /// S-JIS第２バイト判定関数です。
        ///
        /// @param[in] ch 文字コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool IsSecondByteSjis( char unsigned ch ) noexcept;

        //---------------------------------------------------------------------
        /// S-JIS確定第１バイト判定関数
        ///
        /// S-JIS確定第１バイト判定関数です。
        ///
        /// @param[in] ch 文字コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool IsConfirmedFirstByteSjis( char unsigned ch ) noexcept;

        //---------------------------------------------------------------------
        /// S-JIS半角カナ判定関数
        ///
        /// S-JIS半角カナ判定関数です。
        ///
        /// @param[in] ch 文字コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool IsKanaSjis( char unsigned ch ) noexcept;

        //---------------------------------------------------------------------
        /// S-JIS確定半角カナ判定関数
        ///
        /// S-JIS確定半角カナ判定関数です。
        ///
        /// @param[in] ch 文字コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool IsConfirmedKanaSjis( char unsigned ch ) noexcept;

        //---------------------------------------------------------------------
        /// Unicode半角カナ判定関数
        ///
        /// Unicode半角カナ判定関数です。
        ///
        /// @param[in] ch 文字コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool IsKanaUnicode( wchar_t ch ) noexcept;

        //---------------------------------------------------------------------
        /// UTF-8コードサイズ取得関数
        ///
        /// UTF-8コードサイズ取得関数です。
        ///
        /// @param[in]  ch   UTF-8第１バイトコード
        /// @param[out] nSize コードサイズ参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetCodeSizeUtf8( char unsigned ch, int& nSize ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        HANDLE m_hFile;     ///< ファイルハンドル
        UINT   m_uCodePage; ///< コードページ種別

        //=====================================================================
        // 削除関数
    private:
        CFile( CFile const& ) = delete;
        CFile& operator=( CFile const& ) = delete;
    };
}

#pragma managed( pop )