xckswriter.hpp

Go to the documentation of this file.

/*
 * libxcks
 * Copyright (C) 2022 Julien Couot
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef INC_XCKSWRITER_HPP_0FFE21B6_E2AF_4985_9134_279C8EE17E5D
#define INC_XCKSWRITER_HPP_0FFE21B6_E2AF_4985_9134_279C8EE17E5D
 
//---------------------------------------------------------------------------
#include <ostream>
// #include <filesystem>  // Included in "libxcks/types.hpp"
// #include <string>  // Included in "libxcks/types.hpp"
 
// #include "libxcks/types.hpp"  // Included in #include "libxcks/handlers.hpp"
// #include "libxcks/defs.hpp"  // Included in #include "libxcks/handlers.hpp"
// #include "libxcks/export.hpp"  // Included in #include "libxcks/handlers.hpp"
#include "libxcks/handlers.hpp"
#include "libxcks/ckformatter.hpp"
//---------------------------------------------------------------------------
 
 
namespace libxcks
{
class LIBXCKS_SO_EXPORT XCKSWriter
{
 protected:
  XCKSWriterHandler&          writerHandler;          
  XCKSWriterChecksumProvider& ckProvider;             
  const XCKSWriterOptions&    writerOptions;          
  const Version               version;                
  const ArrayChecksumAlgoId   sumsAlgos;              
  const ChecksumFormatter::ConfigurationProvider& ckfConfProvider;  
 
 public:
  XCKSWriter() = delete;
 
  XCKSWriter(const XCKSWriter&) = delete;
 
  XCKSWriter& operator=(const XCKSWriter&) = delete;
 
  XCKSWriter(XCKSWriterHandler& xcksWriterHandler,
             XCKSWriterChecksumProvider& checksumProvider,
             const XCKSWriterOptions& options,
             const Version version,
             const ArrayChecksumAlgoId& algoIds,
             const ChecksumFormatter::ConfigurationProvider& ckftConfProvider);
 
  virtual ~XCKSWriter();
 
  bool write(std::ostream& os, const std::filesystem::path& basePath,
             const ArrayPath& relativePaths);
 
  bool write(const std::filesystem::path& fileFullPath,
             const ArrayPath& relativePaths);
 
 
  bool write(const std::filesystem::path& filePath,
             const std::filesystem::path& basePath,
             const ArrayPath& relativePaths);
 
  // Since we need some more complicated handlers than the reader, convenience
  // methods are a nonsense.
 
 protected:
  virtual bool doWrite(std::ostream& os, const std::filesystem::path& basePath,
                       const ArrayPath& relativePaths);
 
 private:
  bool checkBaseDirAndPathList(const std::filesystem::path& basePath,
                               const ArrayPath& relativePaths) const;
};
//---------------------------------------------------------------------------
 
 
 
class LIBXCKS_SO_EXPORT ZXCKSWriter : public XCKSWriter
{
 public:
  ZXCKSWriter() = delete;
 
  ZXCKSWriter(const ZXCKSWriter&) = delete;
 
  ZXCKSWriter& operator=(const ZXCKSWriter&) = delete;
 
  ZXCKSWriter(XCKSWriterHandler& xcksWriterHandler,
              XCKSWriterChecksumProvider& checksumProvider,
              const ZXCKSWriterOptions& options,
              const Version version,
              const ArrayChecksumAlgoId& algoIds,
              const ChecksumFormatter::ConfigurationProvider& ckftConfProvider);
 
  virtual ~ZXCKSWriter();
 
  // Since we need some more complicated handlers than the reader, convenience
  // methods are a nonsense.
 
 protected:
  bool doWrite(std::ostream& os, const std::filesystem::path& basePath,
               const ArrayPath& relativePaths) override;
};
//---------------------------------------------------------------------------
 
}  // namespace libxcks
//---------------------------------------------------------------------------
 
#endif  // INC_XCKSWRITER_HPP_0FFE21B6_E2AF_4985_9134_279C8EE17E5D