FStreamSupport.cpp

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include "Stroika/Foundation/Execution/Exceptions.h"
#include "Stroika/Foundation/Execution/Throw.h"
#if qStroika_Foundation_Common_Platform_Windows
#include "Stroika/Foundation/Execution/Platform/Windows/Exception.h"
#endif
 
#include "FStreamSupport.h"
 
using namespace Stroika::Foundation;
using namespace Stroika::Foundation::Streams;
using namespace Stroika::Foundation::Streams::iostream;
 
namespace {
    /**
     *  fstream::open () sets failbit on failed open. But most other operations set 'badbit' when things
     *  go wrong (like failed writes).
     */
    constexpr auto kErrBitsToTreatAsExceptions_ = ifstream::badbit | ifstream::failbit;
}
 
/*
 ********************************************************************************
 ********************** iostream::OpenInputFileStream ***************************
 ********************************************************************************
 */
ifstream& Streams::iostream::OpenInputFileStream (ifstream* ifStream, const filesystem::path& fileName, ios_base::openmode mode)
{
    RequireNotNull (ifStream);
    ifStream->exceptions (kErrBitsToTreatAsExceptions_); // so throws on failed open
    ifStream->open (fileName, mode | ios_base::in);
    Assert (ifStream->is_open ());
    return *ifStream;
}
 
ifstream& Streams::iostream::OpenInputFileStream (ifstream& tmpIFStream, const filesystem::path& fileName, ios_base::openmode mode)
{
    OpenInputFileStream (&tmpIFStream, fileName, mode);
    return tmpIFStream;
}
 
/*
 ********************************************************************************
 ****************** StreamUtils::OpenOutputFileStream ***************************
 ********************************************************************************
 */
ofstream& Streams::iostream::OpenOutputFileStream (ofstream* ofStream, const filesystem::path& fileName, ios_base::openmode mode)
{
    RequireNotNull (ofStream);
    ofStream->exceptions (kErrBitsToTreatAsExceptions_); // so throws on failed open
    ofStream->open (fileName, mode | ios_base::out);
    Assert (ofStream->is_open ());
    return *ofStream;
}
 
ofstream& Streams::iostream::OpenOutputFileStream (ofstream& tmpOfStream, const filesystem::path& fileName, ios_base::openmode mode)
{
    OpenOutputFileStream (&tmpOfStream, fileName, mode);
    return tmpOfStream;
}