DwmFileIO.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2004-2007, 2016, 2017, 2020, 2024
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
//  PURPOSE, OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================
 
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
 
#ifndef _DWMFILEIO_HH_
#define _DWMFILEIO_HH_
 
#include <array>
#include <cassert>
#include <cstdint>
#include <cstdio>
#include <deque>
#include <iostream>
#include <list>
#include <map>
#include <set>
#include <string>
#include <tuple>
#include <unordered_map>
#include <unordered_set>
#include <variant>
#include <vector>
 
#include "DwmPortability.hh"
#include "DwmFileIOCapable.hh"
#include "DwmVariantFromIndex.hh"
 
namespace Dwm {
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class FileIO
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, char & c);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, char c);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, uint8_t & c);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, uint8_t c);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, bool & b);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, bool b);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, int16_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, int16_t val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, uint16_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, uint16_t val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, int32_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, int32_t val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, uint32_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, uint32_t val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, int64_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, const int64_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, uint64_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, const uint64_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, float & val);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, float val);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, double & val);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, const double & val);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE * f, std::string & s);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, const std::string & s);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE *f, FileReadable & val)
    { return val.Read(f); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE *f, HasFileRead auto & val)
    { return val.Read(f); }
      
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE * f, const FileWritable & val)
    { return(val.Write(f)); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE *f, const HasFileWrite auto & val)
    { return val.Write(f); }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _firstT, typename _secondT>
    static size_t Read(FILE *f, std::pair<_firstT,_secondT> & p)
    {
      size_t  rc = 0;
      if (f)
        if (Read(f, p.first) > 0)
          if (Read(f, p.second) > 0)
            rc = 1;
      return(rc);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _firstT, typename _secondT>
    static size_t Write(FILE *f, const std::pair<_firstT,_secondT> & p)
    {
      size_t  rc = 0;
      if (f)
        if (Write(f, p.first) > 0)
          if (Write(f, p.second) > 0)
            rc = 1;
      return(rc);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Compare, typename _Alloc>
    static size_t Read(FILE *f, std::map<_keyT, _valueT, _Compare, _Alloc> & m)
    {
      return(PairAssocContRead<std::map<_keyT, _valueT, _Compare, _Alloc> >(f, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Compare, typename _Alloc>
    static size_t
    Write(FILE *f, const std::map<_keyT, _valueT, _Compare, _Alloc> & m)
    {
      return(ContainerWrite<std::map<_keyT,_valueT> >(f, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Compare, typename _Alloc>
    static size_t
    Read(FILE *f, std::multimap<_keyT, _valueT, _Compare, _Alloc> & m)
    {
      return(PairAssocContRead<std::multimap<_keyT,_valueT,_Compare,_Alloc> >(f, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Compare, typename _Alloc>
    static size_t 
    Write(FILE *f, const std::multimap<_keyT,_valueT, _Compare, _Alloc> & m)
    {
      return(ContainerWrite<std::multimap<_keyT,_valueT,_Compare,_Alloc> >(f, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, size_t N>
    static size_t Read(FILE *f, std::array<_valueT, N> & a)
    {
      size_t  rc = 1;
      for (size_t i = 0; i < N; ++i) {
        if (! Read(f, a[i])) {
          rc = 0;
          break;
        }
      }
      return rc;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, size_t N>
    static size_t Write(FILE *f, const std::array<_valueT, N> & a)
    {
      size_t  rc = 1;
      for (size_t i = 0; i < N; ++i) {
        if (! Write(f, a[i])) {
          rc = 0;
          break;
        }
      }
      return rc;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static size_t Read(FILE *f, std::vector<_valueT, _Alloc> & v)
    {
      return(ContainerRead<std::vector<_valueT, _Alloc> >(f, v));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static size_t Write(FILE *f, const std::vector<_valueT, _Alloc> & v)
    {
      return(ContainerWrite<std::vector<_valueT, _Alloc> >(f, v));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static size_t Read(FILE *f, std::deque<_valueT, _Alloc> & d)
    {
      return(ContainerRead<std::deque<_valueT, _Alloc> >(f, d));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static size_t Write(FILE *f, const std::deque<_valueT, _Alloc> & d)
    {
      return(ContainerWrite<std::deque<_valueT, _Alloc> >(f, d));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static size_t Read(FILE *f, std::list<_valueT, _Alloc> & l)
    {
      return(ContainerRead<std::list<_valueT, _Alloc> >(f, l));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static size_t Write(FILE *f, const std::list<_valueT, _Alloc> & l)
    {
      return(ContainerWrite<std::list<_valueT, _Alloc> >(f, l));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Compare, typename _Alloc>
    static size_t Read(FILE *f, std::set<_valueT, _Compare, _Alloc> & l)
    {
      return(ContainerRead<std::set<_valueT, _Compare, _Alloc> >(f, l));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Compare, typename _Alloc>
    static size_t Write(FILE *f, const std::set<_valueT, _Compare, _Alloc> & l)
    {
      return(ContainerWrite<std::set<_valueT, _Compare, _Alloc> >(f, l));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Compare, typename _Alloc>
    static size_t Read(FILE *f, std::multiset<_valueT, _Compare, _Alloc> & l)
    {
      return(ContainerRead<std::multiset<_valueT, _Compare, _Alloc> >(f, l));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Compare, typename _Alloc>
    static size_t
    Write(FILE *f, const std::multiset<_valueT, _Compare, _Alloc> & l)
    {
      return(ContainerWrite<std::multiset<_valueT, _Compare, _Alloc> >(f, l));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Args>
    static size_t Read(FILE *f, std::tuple<Args...> & t)
    {
      return(std::apply([&f](auto && ...args)
      {
        auto  read_tuple_mem = [&f](auto && x) { return Read(f, x); };
        return (read_tuple_mem(args) && ...);
      }, t));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Args>
    static size_t Write(FILE *f, const std::tuple<Args...> & t)
    {
      return(std::apply([&f](auto && ...args)
      {
        auto  write_tuple_mem = [&f](auto && x) { return Write(f, x); };
        return (write_tuple_mem(args) && ...);
      }, t));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Read(FILE *fp, std::monostate & sm)
    {
      return 1;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static size_t Write(FILE *fp, const std::monostate & sm)
    {
      return 1;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Ts>
    static size_t Read(FILE *fp, std::variant<Ts...> & v)
    {
      size_t    rc = 0;
      uint64_t  index = 0;
      if (Read(fp, index)) {
        if (index < std::variant_size_v<std::variant<Ts...>>) {
          v = VariantFromIndex<Ts...>(index);
          std::visit([&] (auto && arg) { rc = Read(fp, arg); }, v);
        }
      }
      return rc;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Ts>
    static size_t Write(FILE *fp, const std::variant<Ts...> & v)
    {
      size_t    rc = 0;
      uint64_t  index = v.index();
      if (Write(fp, index)) {
        std::visit([&] (const auto & arg) { rc = Write(fp, arg); }, v);
      }
      return rc;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<typename _keyT, typename _valueT, typename _Hash,
             typename _Pred, typename _Alloc>
    static size_t
    Read(FILE *f, std::unordered_map<_keyT,_valueT,_Hash,_Pred,_Alloc> & hm)
    {
      return(PairAssocContRead<std::unordered_map<_keyT,_valueT,_Hash,_Pred,_Alloc> >(f, hm));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<typename _keyT, typename _valueT, typename _Hash,
             typename _Pred, typename _Alloc>
    static size_t  
    Write(FILE *f, const std::unordered_map<_keyT,_valueT,_Hash,_Pred,_Alloc> & hm)
    {
      return(ContainerWrite<std::unordered_map<_keyT,_valueT,_Hash,_Pred,_Alloc> >(f, hm));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<typename _keyT, typename _valueT, typename _Hash,
             typename _Pred, typename _Alloc>
    static size_t
    Read(FILE *f, std::unordered_multimap<_keyT,_valueT,_Hash,_Pred,_Alloc> & hm)
    {
      return(PairAssocContRead<std::unordered_multimap<_keyT,_valueT,_Hash,_Pred,_Alloc> >(f, hm));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<typename _keyT, typename _valueT, typename _Hash,
             typename _Pred, typename _Alloc>
    static size_t  
    Write(FILE *f, const std::unordered_multimap<_keyT,_valueT,_Hash,_Pred,_Alloc> & hm)
    {
      return(ContainerWrite<std::unordered_multimap<_keyT,_valueT,_Hash,_Pred,_Alloc> >(f, hm));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<typename _valueT, typename _Hash,
             typename _Pred, typename _Alloc>
    static size_t
    Read(FILE *f, std::unordered_set<_valueT,_Hash,_Pred,_Alloc> & hm)
    {
      return(ContainerRead<std::unordered_set<_valueT,_Hash,_Pred,_Alloc> >(f, hm));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<typename _valueT, typename _Hash,
             typename _Pred, typename _Alloc>
    static size_t  
    Write(FILE *f, const std::unordered_set<_valueT,_Hash,_Pred,_Alloc> & hm)
    {
      return(ContainerWrite<std::unordered_set<_valueT,_Hash,_Pred,_Alloc> >(f, hm));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<typename _valueT, typename _Hash,
             typename _Pred, typename _Alloc>
    static size_t
    Read(FILE *f, std::unordered_multiset<_valueT,_Hash,_Pred,_Alloc> & hm)
    {
      return(ContainerRead<std::unordered_multiset<_valueT,_Hash,_Pred,_Alloc> >(f, hm));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template<typename _valueT, typename _Hash,
             typename _Pred, typename _Alloc>
    static size_t  
    Write(FILE *f, const std::unordered_multiset<_valueT,_Hash,_Pred,_Alloc> & hm)
    {
      return(ContainerWrite<std::unordered_multiset<_valueT,_Hash,_Pred,_Alloc> >(f, hm));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Args>
    static size_t ReadV(FILE *f, Args & ...args)
    {
      return (Read(f,args) && ...);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Args>
    static size_t WriteV(FILE *f, const Args & ...args)
    {
      return (Write(f,args) && ...);
    }
    
  private:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _inputIteratorT>
    static size_t Write(FILE *file, _inputIteratorT f, _inputIteratorT l)
    {
      size_t  rc = 0;
      if (file) {
        for ( ; f != l; ++f) {
          if (Write(file, *f) <= 0) {
            break;
          }
        }
        if (f == l)
          rc = 1;
      }
      return(rc);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _containerT>
    static size_t ContainerRead(FILE *f, _containerT & c)
    {
      size_t  rc = 0;
      if (! c.empty())
        c.clear();
      if (f) {
        uint64_t  numEntries;
        if (Read(f, numEntries)) {
          uint64_t  i = 0;
          for ( ; i < numEntries; ++i) {
            typename _containerT::value_type  val;
            if (Read(f, val) > 0)
              c.insert(c.end(), std::move(val));
            else
              break;
          }
          if (i == numEntries)
            rc = 1;
        }
      }
      return(rc);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _containerT>
    static size_t ContainerWrite(FILE *f, const _containerT & c)
    {
      size_t  rc = 0;
      if (f) {
        uint64_t  numEntries = c.size();
        if (Write(f, numEntries)) {
          if (numEntries) {
            rc = Write<typename _containerT::const_iterator>(f, 
                                                             c.begin(), c.end());
          }
          else {
            rc = 1;
          }
        }
      }
      return(rc);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _containerT>
    static size_t PairAssocContRead(FILE *f, _containerT & m)
    {
      ssize_t  rc = 0;
      if (! m.empty())
        m.clear();
      if (f) {
        uint64_t  numEntries;
        if (Read(f, numEntries)) {
          uint64_t i = 0;
          for ( ; i < numEntries; ++i) {
            typename _containerT::key_type  key;
            if (Read(f, key) > 0) {
              typename _containerT::mapped_type  val;
              if (Read(f, val) > 0) {
                m.insert(typename _containerT::value_type(std::move(key),
                                                          std::move(val)));
              }
              else {
                break;
              }
            }
            else {
              break;
            }
          }
          if (i == numEntries)
            rc = 1;
        }
      }
      return(rc);
    }
 
  };
 
 
}  // namespace Dwm
 
#endif  // _DWMFILEIO_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------