textfile.hpp

Go to the documentation of this file.

/** ************************************************************************************************
 * \file
 * This header file is part of module \alib_files of the \aliblong.
 *
 * \emoji :copyright: 2013-2024 A-Worx GmbH, Germany.
 * Published under \ref mainpage_license "Boost Software License".
 **************************************************************************************************/
#ifndef HPP_ALIB_FILES_TEXTFILE
#define HPP_ALIB_FILES_TEXTFILE 1
#if !defined(ALIB_DOX)  // todo remove
 
#if !defined(HPP_ALIB_FILES_FTREE)
#   include "alib/files/ftree.hpp"
#endif
 
#if !defined(HPP_ALIB_MONOMEM_MASTRING)
#   include "alib/monomem/mastring.hpp"
#endif
 
#if !defined (HPP_ALIB_MONOMEM_STDCONTAINERMA)
#   include "alib/monomem/stdcontainerma.hpp"
#endif
namespace alib { namespace files {
 
/** ************************************************************************************************
 * Todox
 * Todox: explain the strict monotonic behaviour and that the allocator must not be used
 *        outside during operation, because it will be reset with destruction
 **************************************************************************************************/
class TextFile
{
  protected:
    MonoAllocator*              allocator;  ///< The given allocator
    MonoAllocator::Snapshot     priorUsage; ///< The state of the given allocator with construction.
 
  public:
    /** The text lines */
    std::vector<MAString, StdContMA<MAString>>*   Lines;
 
    /**
     * Constructor.
     * @param allocator The allocator to use.
     */
    ALIB_API
    TextFile(monomem::MonoAllocator* allocator);
 
    /** Destructor. Resets the #allocator to the state it was in when this object was
     *  constructed. */
    ~TextFile();
 
    /**
     * Reads the file into field #Lines.
     *  @param filePath             The path of the file.
     *  @param extraSpacePercentage If given, the allocated line strings are extended by a
     *                              percentage of the original line length. This avoids
     *                              the allocation of new intermediate strings, and hence might
     *                              be small speed optimization. If for example only replacements
     *                              are made that shorten the lines, this parameter should not be
     *                              given. Defaults to \c 0.
     *  @return \alib{lang::system;SystemErrors;SystemErrors::OK} if all went well, otherwise an
     *  error code.
     */
    ALIB_API
    lang::system::SystemErrors  Read(const String& filePath, int extraSpacePercentage= 0);
 
    /**
     * Writes the #Lines into the given \p{filePath}.
     *  @param filePath     The path of the file.
     */
    ALIB_API
    lang::system::SystemErrors  Write(const String& filePath);
 
    /**
     * Resets the file
     */
    ALIB_API
    void                        Reset();
};
 
} // namespace alib[::files]
 
/// Type alias in namespace \b alib.
using     TextFile          =   files::TextFile;
 
} // namespace [alib]
 
#endif //!defined(ALIB_DOX)  // todo remove
 
 
#endif // HPP_ALIB_FILES_TEXTFILE