BmnIFileReader.cxx

Go to the documentation of this file.

// headers from this target
#include "BmnIFileReader.h"
 
// o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o
// ================== BmnIFileReader public methods ==================
// o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o
 
BmnIFileReader::BmnIFileReader(const BmnFileType fileType, const std::string& fileName)
    : fFilePath(fileName)
    , fProcessingFlags(BmnBinaryFileProcessingOptions::None)
    , fFileType(fileType)
{}
 
BmnIFileReader::BmnIFileReader(const BmnFileType fileType, std::string&& fileName) noexcept
    : fFilePath(std::move(fileName))
    , fProcessingFlags(BmnBinaryFileProcessingOptions::None)
    , fFileType(fileType)
{}
 
BmnIFileReader::BmnIFileReader(const BmnFileType fileType, const std::filesystem::path& filePath)
    : fFilePath(filePath)
    , fProcessingFlags(BmnBinaryFileProcessingOptions::None)
    , fFileType(fileType)
{}
 
BmnIFileReader::BmnIFileReader(const BmnFileType fileType, std::filesystem::path&& filePath) noexcept
    : fFilePath(std::move(filePath))
    , fProcessingFlags(BmnBinaryFileProcessingOptions::None)
    , fFileType(fileType)
{}
 
void BmnIFileReader::Open(const std::string& fileName, const BmnBinaryFileProcessingOptions processingFlags)
{
    if (fileName.empty())
        LOG(warning) << "You passed an empty string into `BmnFileReaderZstd::Open`!\n";
    else
        fFilePath = fileName;
    return Open(processingFlags);
}
 
void BmnIFileReader::Open(std::string&& fileName, const BmnBinaryFileProcessingOptions processingFlags)
{
    if (fileName.empty())
        LOG(warning) << "You passed an empty string into `BmnFileReaderZstd::Open`!\n";
    else
        fFilePath = std::move(fileName);
    return Open(processingFlags);
}
 
void BmnIFileReader::Open(const std::filesystem::path& filePath, const BmnBinaryFileProcessingOptions processingFlags)
{
    if (filePath.empty())
        LOG(warning) << "You passed an empty path into `BmnFileReaderZstd::Open`!\n";
    else
        fFilePath = filePath;
    return Open(processingFlags);
}
 
void BmnIFileReader::Open(std::filesystem::path&& filePath, const BmnBinaryFileProcessingOptions processingFlags)
{
    if (filePath.empty())
        LOG(warning) << "You passed an empty path into `BmnFileReaderZstd::Open`!\n";
    else
        fFilePath = std::move(filePath);
    return Open(processingFlags);
}
 
// o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o
// ================== BmnIFileReader protected method ==================
// o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o
 
bool BmnIFileReader::PerformStandardChecksBeforeOpening(const BmnBinaryFileProcessingOptions processingFlags)
{
    if (processingFlags != BmnBinaryFileProcessingOptions::None)
        fProcessingFlags = processingFlags;
    if (fFilePath.empty()) {
        LOG(error) << "No filepath provided before calling `BmnFileReaderZstd::Open` command!\n";
        return false;
    }
    try {
        if (!std::filesystem::exists(fFilePath) || std::filesystem::is_directory(fFilePath)) {
            LOG(error) << "You should provide an existing file! Provided path: " << fFilePath << '\n';
            return false;
        }
    } catch (const std::bad_alloc& errorDescription) {
        LOG(error) << "Filesystem failure! Reason: " << errorDescription.what() << '\n';
        return false;
    } catch (const std::filesystem::filesystem_error& errorDescription) {
        LOG(error) << "Filesystem failure! Reason: " << errorDescription.what() << '\n';
        return false;
    }
    if (!HasAnyFlags(fProcessingFlags, BmnBinaryFileProcessingOptions::ReadBinary)) {
        LOG(error) << "`BmnFileReaderZstd` expects `BmnBinaryFileProcessingOptions::ReadBinary` flag!\n";
        return false;
    }
    if (HasAnyFlags(fProcessingFlags, cg_writeFileFlags))
        LOG(warning) << "You've set some `BmnBinaryFileProcessingOptions` flags for writing while opening a file for "
                        "reading - double-check your code!\n";
    if (HasAnyFlags(fProcessingFlags, cg_compressionIntensityFlags))
        LOG(warning) << "You've set some `BmnBinaryFileProcessingOptions` flags for compressing intensity while "
                        "opening a file for decompressing - double-check your code!\n";
    if (HasAnyFlags(fProcessingFlags, cg_compressionMemoryFlags))
        LOG(warning) << "You've set some `BmnBinaryFileProcessingOptions` flags for compressing memory while opening a "
                        "file for decompressing - double-check your code!\n";
    Close();
    return true;
}