lfilesystem_CFile.h

Go to the documentation of this file.

/*
 * ======================================================================================
 *  __    ____  __  __  ____  ___
 * (  )  (_  _)(  \/  )( ___)/ __)
 *  )(__  _)(_  )    (  )__) \__ \
 * (____)(____)(_/\/\_)(____)(___/
 *
 *  This file is part of the Limes open source library and is licensed under the terms of the GNU Public License.
 *
 *  Commercial licenses are available; contact the maintainers at ben.the.vining@gmail.com to inquire for details.
 *
 * ======================================================================================
 */
 
#pragma once
 
#include <cstdio>
#include "lfilesystem/lfilesystem_Export.h"
#include "lfilesystem/lfilesystem_FilesystemEntry.h"
 
namespace limes::files
{
 
class File;
 
class LFILE_EXPORT CFile final
{
public:
    enum class Mode
    {
        Read,           
        Write,          
        Append,         
        ReadExtended,   
        WriteExtended,  
        AppendExtended  
    };
 
 
    CFile() = default;
 
    explicit CFile (std::FILE* fileHandle) noexcept;
 
    explicit CFile (const Path& filepath, Mode mode) noexcept;
 
    CFile (CFile&& other) noexcept;
 
 
    ~CFile() noexcept;
 
    CFile& operator= (CFile&& other) noexcept;
 
    CFile (const CFile&) = delete;
    CFile& operator=(const CFile&) = delete;
 
 
    [[nodiscard]] std::FILE* get() const noexcept;
 
    std::FILE* operator->() const noexcept;
 
    std::FILE& operator*() const;
 
    [[nodiscard]] Path getPath() const;
 
    operator std::FILE*() const noexcept;
 
    void close() noexcept;
 
    bool open (const Path& filepath, Mode mode) noexcept;
 
    [[nodiscard]] bool isOpen() const noexcept;
 
    explicit operator bool() const noexcept;
 
    [[nodiscard]] File getFile() const;
 
    [[nodiscard]] static CFile createTempFile();
 
private:
    std::FILE* ptr { nullptr };
};
 
}  // namespace limes::files