sof.h

Go to the documentation of this file.

 
#pragma once
 
// Inc Library
#include <string>
#include <string_view>
#include <cstring>
#include <memory>
 
// Inc HAA
#include "dbc.h"
#include "helper.h"
 
// Inc Rich
#include "so.h"
 
 
class SOF : public SO {
 
  struct SOFData {
    FILE * file_{};                  
    std::string name_{};             
    std::string mode_{};             
    ~SOFData() {
      if( file_ )
        (void) fclose( file_ );
    }
  };
 
  std::shared_ptr<SOFData> f_;     
 
 
protected:
#ifndef DBC_IS_VOID
  bool invariant() const noexcept override {     /* LCOV_EXCL_START */
    return f_ != nullptr;
  }                                              /* LCOV_EXCL_STOP */
#endif
 
 
public:
  explicit SOF( const std::string & p_name, const std::string & p_mode )
    : SO(),
      f_(std::make_shared<SOFData>()) {
    f_->file_ = nullptr;
    f_->name_ = p_name;
    f_->mode_ = p_mode;
 
    DBC_INV_CTOR(SOF);
  }
 
 
  SOF( const SOF & p_other ) : SO(p_other), f_(p_other.f_) {
    DBC_INV_CTOR(SOF);
  }
 
 
  ~SOF() override {
    DBC_INV_CTOR(SOF);
  }
 
 
  SOF() = delete;
  SOF( SOF && ) = delete;
  SOF & operator=( const SOF & ) = delete;
  SOF & operator=( SOF && ) = delete;
 
 
public: /* accessor */
  std::string getFName() const { return f_->name_; }
 
 
  std::string getFMode() const { return f_->mode_; }
 
 
public: /* virtual */
  [[nodiscard]] SOF * dup() const override { return new SOF( *this ); }
 
 
  std::string opequal() const override { return "--nostringval--"; }
 
 
  std::string opequalequal() const override { return "-file-"; }
 
 
  OTCode ot() const override { return OTCode::F; }
 
 
  std::string type() const override { return "filetype"; }
 
 
  bool equal( const SO * p_other ) const override {
    auto o = dynamic_cast<const SOF *>( p_other );
    return o ? f_ == o->f_ : false;
  }
 
 
public: /* other */
  bool isOpen() const { return f_->file_ != nullptr; }
 
 
  bool readLeonLine( std::string & p_str );
 
 
  OpError open();
 
  
  OpError flush();
 
  
  OpError close( int (*p_fclose)(FILE *) = fclose );
 
 
  OpError readline( std::string & p_str, bool & p_eof );
 
 
  OpError readstring( std::string & p_str, bool & p_eof );
 
 
  OpError writestring( const std::string & p_data );
 
  
  OpError writestring( std::string_view p_data );
 
};