Path.h

[詳解]

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

#ifndef AMDAEMON_UTIL_PATH_H
#define AMDAEMON_UTIL_PATH_H

#include "amdaemon/env.h"

#include <string>

namespace amdaemon
{
namespace util
{
    /// パス操作処理を提供する静的クラス。
    class Path
    {
    public:
        /// @brief 指定したパスのファイルまたはディレクトリが存在するか否かを取得する。
        /// @param[in] path パス。
        /// @retval true  存在する場合。
        /// @retval false 存在しない場合。
        static bool exists(const std::wstring& path);

        /// @brief 指定したパスのファイルが存在するか否かを取得する。
        /// @param[in] path パス。
        /// @retval true  存在する場合。
        /// @retval false 存在しないか、ファイルではない場合。
        /// @see File::exists
        static bool existsFile(const std::wstring& path);

        /// @brief 指定したパスのディレクトリが存在するか否かを取得する。
        /// @param[in] path パス。
        /// @retval true  存在する場合。
        /// @retval false 存在しないか、ディレクトリではない場合。
        static bool existsDirectory(const std::wstring& path);

        /// @brief 指定したパスがドライブレターを含んでいるか否かを取得する。
        /// @param[in] path パス。
        /// @retval true  ドライブレターを含んでいる場合。
        /// @retval false ドライブレターを含んでいない場合。
        ///
        /// 引数 path が2文字以上であり、
        /// かつ1文字目がアルファベット、2文字目が ':' である場合に true を返す。
        ///
        /// Windows環境であるか否かは問わない。
        static bool hasDriveLetter(const std::wstring& path);

        /// @brief 指定したパスが絶対パスであるか否かを取得する。
        /// @param[in] path パス。
        /// @retval true  絶対パスである場合。
        /// @retval false 絶対パスではない場合。
        ///
        /// 引数 path が下記のいずれかを満たす場合に true を返す。
        ///
        /// - 1文字以上かつ1文字目がディレクトリ区切り文字である場合。
        /// - Windows環境であり、かつ静的メンバ関数 #hasDriveLetter が true を返す場合。
        static bool isRooted(const std::wstring& path);

        /// @brief 実行ファイルのパスを取得する。
        /// @return 実行ファイルのパス。取得に失敗した場合は空文字列。
        static std::wstring getExecutableFile();

        /// @brief 実行ファイルの配置先ディレクトリパスを取得する。
        /// @return 実行ファイルの配置先ディレクトリパス。取得に失敗した場合は空文字列。
        ///
        /// 取得に成功した場合、戻り値の末尾は必ずディレクトリ区切り文字となる。
        static std::wstring getExecutableDirectory();

        /// @brief パスをフルパスに変換する。
        /// @param[in] path パス。
        /// @return フルパス。変換できなかった場合は空文字列。
        static std::wstring toFull(const std::wstring& path);

        /// @brief パスからその末端要素のファイル名またはディレクトリ名を取得する。
        /// @param[in] path パス。
        /// @return ファイル名またはディレクトリ名。取得できなかった場合は空文字列。
        ///
        /// ファイル名の場合、拡張子を含む。
        ///
        /// パスの末尾がディレクトリ区切り文字である場合は空文字列を返す。
        static std::wstring getName(const std::wstring& path);

        /// @brief パスからその末端要素のファイル名またはディレクトリ名を拡張子なしで取得する。
        /// @param[in] path パス。
        /// @return
        ///     ファイル名またはディレクトリ名((拡張子なし))。取得できなかった場合は空文字列。
        ///
        /// 静的メンバ関数 #getName とは異なり、拡張子を含まない。
        /// パスがファイルであるかディレクトリであるかは考慮しないため、
        /// ディレクトリ名であっても "." を含む場合は拡張子として取り除かれる。
        ///
        /// パスの末尾がディレクトリ区切り文字である場合は空文字列を返す。
        static std::wstring getNameWithoutExtension(const std::wstring& path);

        /// @brief パスから拡張子("." 付き)を取得する。
        /// @param[in] path パス。
        /// @return "." 付きの拡張子。拡張子が無い場合は空文字列。
        ///
        /// パスがファイルであるかディレクトリであるかは考慮しないため、
        /// ディレクトリであっても "." を含む場合は拡張子として扱われる。
        ///
        /// パスの末尾がディレクトリ区切り文字である場合は空文字列を返す。
        static std::wstring getExtension(const std::wstring& path);

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

#endif // AMDAEMON_UTIL_PATH_H