FStreamSupport.h

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_Streams_iostream_FStreamSupport_h_
#define _Stroika_Foundation_Streams_iostream_FStreamSupport_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include <filesystem>
#include <fstream>
 
#include "Stroika/Foundation/Characters/String.h"
#include "Stroika/Foundation/IO/FileSystem/Common.h"
 
namespace Stroika::Foundation::Streams::iostream {
 
    using Characters::String;
 
    /*
     *  OpenInputFileStream () is like the ifstream::open CTOR - but throws FILE exceptions on failure.
     *
     * There is no need to include ios_base::in among the open-modes as this is included automatically.
     *
     * A very common thing to include would be ios_base::binary (DEFAULT ON), if you want to assure no CR/LF transformations done, or pass '0'
     * to remove the 'ios_base::binary' default.
     *
     *  \note This calls https://en.cppreference.com/w/cpp/io/basic_ios/exceptions to force any future failed operations to throw (including open)
     *
     */
    ifstream& OpenInputFileStream (ifstream* ifStream, const filesystem::path& fileName, ios_base::openmode _Mode = ios_base::binary);
    ifstream& OpenInputFileStream (ifstream& tmpIFStream, const filesystem::path& fileName, ios_base::openmode _Mode = ios_base::binary);
 
    /*
     *  OpenOutputFileStream () is like the ofstream::open CTOR - but throws FILE exceptions on failure.
     *
     * There is no need to include ios_base::out among the open-modes as this is included automatically.
     *
     * A very common thing to include would be ios_base::binary (DEFAULT ON), if you want to assure no CR/LF transformations done.
     *
     * Another very common thing to include would be ios_base::trunc (DEFAULT ON).
     *
     *  \note This calls https://en.cppreference.com/w/cpp/io/basic_ios/exceptions to force any future failed operations to throw (including open)
     *
     */
    ofstream& OpenOutputFileStream (ofstream* ofStream, const filesystem::path& fileName, ios_base::openmode _Mode = ios_base::trunc | ios_base::binary);
    ofstream& OpenOutputFileStream (ofstream& tmpOfStream, const filesystem::path& fileName,
                                    ios_base::openmode _Mode = ios_base::trunc | ios_base::binary);
 
}
 
#endif /*_Stroika_Foundation_Streams_iostream_FStreamSupport_h_*/