basicfileinfo.h

Go to the documentation of this file.

#ifndef TAG_PARSER_BASICFILEINFO_H
#define TAG_PARSER_BASICFILEINFO_H
 
#include "./global.h"
 
#include <c++utilities/conversion/stringconversion.h>
#include <c++utilities/io/nativefilestream.h>
 
#include <cstdint>
#include <string>
 
namespace TagParser {
 
class TAG_PARSER_EXPORT BasicFileInfo {
public:
    // constructor, destructor
    explicit BasicFileInfo();
    explicit BasicFileInfo(std::string &&path);
    explicit BasicFileInfo(std::string_view path);
    BasicFileInfo(const BasicFileInfo &) = delete;
    BasicFileInfo &operator=(const BasicFileInfo &) = delete;
    virtual ~BasicFileInfo();
 
    // methods to control associated file stream
    void open(bool readOnly = false);
    void reopen(bool readOnly = false);
    bool isOpen() const;
    bool isReadOnly() const;
    void close();
    void invalidate();
    CppUtilities::NativeFileStream &stream();
    const CppUtilities::NativeFileStream &stream() const;
 
    // methods to get, set path (components)
    const std::string &path() const;
    void setPath(std::string_view path);
    void setPath(std::string &&path);
    static std::string fileName(std::string_view path, bool cutExtension = false);
    std::string fileName(bool cutExtension = false) const;
    static std::string extension(std::string_view path);
    std::string extension() const;
    static std::string pathWithoutExtension(std::string_view fullPath);
    std::string pathWithoutExtension() const;
    static std::string containingDirectory(std::string_view path);
    std::string containingDirectory() const;
    static std::string_view pathForOpen(std::string_view url);
 
    // methods to get, set the file size
    std::uint64_t size() const;
    void reportSizeChanged(std::uint64_t newSize);
    void reportPathChanged(std::string_view newPath);
    void reportPathChanged(std::string &&newPath);
 
protected:
    virtual void invalidated();
 
private:
    std::string m_path;
    CppUtilities::NativeFileStream m_file;
    std::uint64_t m_size;
    bool m_readOnly;
};
 
inline bool BasicFileInfo::isOpen() const
{
    return m_file.is_open();
}
 
inline bool BasicFileInfo::isReadOnly() const
{
    return m_readOnly;
}
 
inline CppUtilities::NativeFileStream &BasicFileInfo::stream()
{
    return m_file;
}
 
inline const CppUtilities::NativeFileStream &BasicFileInfo::stream() const
{
    return m_file;
}
 
inline const std::string &BasicFileInfo::path() const
{
    return m_path;
}
 
inline std::uint64_t BasicFileInfo::size() const
{
    return m_size;
}
 
inline void BasicFileInfo::reportSizeChanged(std::uint64_t newSize)
{
    m_size = newSize;
}
 
inline void BasicFileInfo::reportPathChanged(std::string_view newPath)
{
    m_path = newPath;
}
 
inline void BasicFileInfo::reportPathChanged(std::string &&newPath)
{
    m_path = std::move(newPath);
}
 
inline std::string_view BasicFileInfo::pathForOpen(std::string_view url)
{
    return CppUtilities::startsWith(url, "file:/") ? url.data() + 6 : url.data();
}
 
} // namespace TagParser
 
#endif // TAG_PARSER_BASICFILEINFO_H