DwmStreamIO.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 _DWMSTREAMIO_HH_
#define _DWMSTREAMIO_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 "DwmStreamIOCapable.hh"
#include "DwmVariantFromIndex.hh"
 
namespace Dwm {
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class StreamIO
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, char & c);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, char c);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, uint8_t & c);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, uint8_t c);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, bool & b);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, bool b);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, int16_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, int16_t val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, uint16_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, uint16_t val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, int32_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, int32_t val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, uint32_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, uint32_t val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, int64_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, const int64_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, uint64_t & val);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, const uint64_t & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, float & val);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, float val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, double & val);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, const double & val);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, std::string & s);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, const std::string & s);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, StreamReadable & val)
    {
      return(val.Read(is));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, HasStreamRead auto & t)
    { return t.Read(is); }
     
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, const StreamWritable & val)
    {
      return(val.Write(os));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream &
    Write(std::ostream & os, const HasStreamWrite auto & t)
    { return t.Write(os); }
      
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _firstT, typename _secondT>
    static std::istream & Read(std::istream & is,
                               std::pair<_firstT, _secondT> & p)
    {
      if (is) {
        if (Read(is, p.first))
          Read(is, p.second);
      }
      return(is);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _firstT, typename _secondT>
    static std::ostream & Write(std::ostream & os,
                                const std::pair<_firstT,_secondT> & p)
    {
      if (os) {
        if (Write(os, p.first)) {
          Write(os, p.second);
        }
      }
      return(os);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Compare, typename _Alloc>
    static std::istream & Read(std::istream & is,
                               std::map<_keyT, _valueT, _Compare, _Alloc> & m)
    {
      return(PairAssocContRead<std::map<_keyT, _valueT, _Compare, _Alloc> >(is, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Compare, typename _Alloc>
    static std::ostream & Write(std::ostream & os,
                                const std::map<_keyT,_valueT, _Compare, _Alloc> & m)
    {
      return(ContainerWrite<std::map<_keyT,_valueT,_Compare,_Alloc> >(os, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Compare, typename _Alloc>
    static std::istream &
    Read(std::istream & is, std::multimap<_keyT,_valueT,_Compare,_Alloc> & m)
    {
      return(PairAssocContRead<std::multimap<_keyT,_valueT,_Compare,_Alloc> >(is, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Compare, typename _Alloc>
    static std::ostream & 
    Write(std::ostream & os,
          const std::multimap<_keyT,_valueT, _Compare, _Alloc> & m)
    {
      return(ContainerWrite<std::multimap<_keyT,_valueT,_Compare,_Alloc> >(os, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, size_t N>
    static std::istream & Read(std::istream & is,
                               std::array<_valueT, N> & a)
    {
      if (is) {
        for (size_t i = 0; i < N; ++i) {
          if (! Read(is, a[i])) {
            break;
          }
        }
      }
      return is;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, size_t N>
    static std::ostream & Write(std::ostream & os,
                                const std::array<_valueT, N> & a)
    {
      if (os) {
        for (size_t i = 0; i < N; ++i) {
          if (! Write(os, a[i])) {
            break;
          }
        }
      }
      return os;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static std::istream & Read(std::istream & is,
                               std::vector<_valueT, _Alloc> & v)
    {
      return(ContainerRead<std::vector<_valueT, _Alloc> >(is, v));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static std::ostream & Write(std::ostream & os,
                                const std::vector<_valueT, _Alloc> & v)
    {
      return(ContainerWrite<std::vector<_valueT, _Alloc> >(os, v));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static std::istream & Read(std::istream & is,
                               std::deque<_valueT, _Alloc> & d)
    {
      return(ContainerRead<std::deque<_valueT, _Alloc> >(is, d));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static std::ostream & Write(std::ostream & os,
                                const std::deque<_valueT, _Alloc> & d)
    {
      return(ContainerWrite<std::deque<_valueT, _Alloc> >(os, d));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static std::istream & Read(std::istream & is,
                               std::list<_valueT, _Alloc> & l)
    {
      return(ContainerRead<std::list<_valueT, _Alloc> >(is, l));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Alloc>
    static std::ostream & Write(std::ostream & os,
                                const std::list<_valueT, _Alloc> & l)
    {
      return(ContainerWrite<std::list<_valueT, _Alloc> >(os, l));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Compare, typename _Alloc>
    static std::istream & Read(std::istream & is,
                               std::set<_valueT, _Compare, _Alloc> & l)
    {
      return(ContainerRead<std::set<_valueT, _Compare, _Alloc> >(is, l));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Compare, typename _Alloc>
    static std::ostream & Write(std::ostream & os,
                                const std::set<_valueT, _Compare, _Alloc> & l)
    {
      return(ContainerWrite<std::set<_valueT, _Compare, _Alloc> >(os, l));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Compare, typename _Alloc>
    static std::istream & Read(std::istream & is,
                               std::multiset<_valueT, _Compare, _Alloc> & l)
    {
      return(ContainerRead<std::multiset<_valueT, _Compare, _Alloc> >(is, l));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Compare, typename _Alloc>
    static std::ostream & 
    Write(std::ostream & os, 
          const std::multiset<_valueT, _Compare, _Alloc> & l)
    {
      return(ContainerWrite<std::multiset<_valueT, _Compare, _Alloc> >(os, l));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Args>
    static std::istream & Read(std::istream & is, 
                               std::tuple<Args...> & t)
    {
      std::apply([&is](auto&&... args) {((Read(is,args)) && ...);}, t);
      return is;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Args>
    static std::ostream & Write(std::ostream & os, 
                                const std::tuple<Args...> & t)
    {
      std::apply([&os](auto&&... args) {((Write(os,args)) && ...);}, t);
      return os;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Hash, typename _Pred, typename _Alloc>
    static std::istream & 
    Read(std::istream & is,
         std::unordered_map<_keyT, _valueT, _Hash, _Pred, _Alloc> & m)
    {
      return(PairAssocContRead<std::unordered_map<_keyT, _valueT, _Hash, _Pred, _Alloc> >(is, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Hash, typename _Pred, typename _Alloc>
    static std::ostream & 
    Write(std::ostream & os,
          const std::unordered_map<_keyT, _valueT, _Hash, _Pred, _Alloc> & m)
    {
      return(ContainerWrite<std::unordered_map<_keyT,_valueT,_Hash,_Pred,_Alloc> >(os, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT,
              typename _Hash, typename _Pred, typename _Alloc>
    static std::istream & Read(std::istream & is,
                               std::unordered_multimap<_keyT, _valueT, _Hash, _Pred, _Alloc> & m)
    {
      return(PairAssocContRead<std::unordered_multimap<_keyT, _valueT, _Hash, _Pred, _Alloc> >(is, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _keyT, typename _valueT, 
              typename _Hash, typename _Pred, typename _Alloc>
    static std::ostream & 
    Write(std::ostream & os,
          const std::unordered_multimap<_keyT, _valueT, _Hash, _Pred, _Alloc> & m)
    {
      return(ContainerWrite<std::unordered_multimap<_keyT,_valueT,_Hash,_Pred,_Alloc> >(os, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Hash, 
              typename _Pred, typename _Alloc>
    static std::istream & 
    Read(std::istream & is,
         std::unordered_set<_valueT, _Hash, _Pred, _Alloc> & m)
    {
      return(ContainerRead<std::unordered_set<_valueT, _Hash, _Pred, _Alloc> >(is, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Hash,
              typename _Pred, typename _Alloc>
    static std::ostream & 
    Write(std::ostream & os,
          const std::unordered_set<_valueT, _Hash, _Pred, _Alloc> & m)
    {
      return(ContainerWrite<std::unordered_set<_valueT,_Hash,_Pred,_Alloc> >(os, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Hash, 
              typename _Pred, typename _Alloc>
    static std::istream & 
    Read(std::istream & is,
         std::unordered_multiset<_valueT, _Hash, _Pred, _Alloc> & m)
    {
      return(ContainerRead<std::unordered_multiset<_valueT, _Hash, _Pred, _Alloc> >(is, m));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _valueT, typename _Hash,
              typename _Pred, typename _Alloc>
    static std::ostream & 
    Write(std::ostream & os,
          const std::unordered_multiset<_valueT, _Hash, _Pred, _Alloc> & m)
    {
      return(ContainerWrite<std::unordered_multiset<_valueT,_Hash,_Pred,_Alloc> >(os, m));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Ts>
    static std::istream & Read(std::istream & is,
                               std::variant<Ts...> & v)
    {
      uint64_t  index = 0;
      if (Read(is, index)) {
        if (index < std::variant_size_v<std::variant<Ts...>>) {
          v = VariantFromIndex<Ts...>(index);
          std::visit([&] (auto && arg) { Read(is, arg); }, v);
        }
        else {
          is.setstate(std::ios_base::failbit);
        }
      }
      return is;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Ts>
    static std::ostream & Write(std::ostream & os,
                                const std::variant<Ts...> & v)
    {
      uint64_t  index = v.index();
      if (Write(os, index)) {
        std::visit([&os] (const auto & arg) { Write(os, arg); }, v);
      }
      return os;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::istream & Read(std::istream & is, std::monostate & sm)
    {
      return is;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Write(std::ostream & os, const std::monostate & sm)
    {
      return os;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Args>
    static std::istream & ReadV(std::istream & is, Args & ...args)
    {
      (Read(is,args) &&...);
      return is;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename... Args>
    static std::ostream & WriteV(std::ostream & os, const Args & ...args)
    {
      (Write(os,args) &&...);
      return os;
    }
    
  private:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _inputIteratorT>
    static std::ostream & Write(std::ostream & os,
                                _inputIteratorT f, _inputIteratorT l)
    {
      if (os) {
        for ( ; f != l; ++f) {
          if (! Write(os, *f)) {
            break;
          }
        }
      }
      return(os);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _containerT>
    static std::istream & ContainerRead(std::istream & is,
                                        _containerT & c)
    {
      if (! c.empty())
        c.clear();
      if (is) {
        uint64_t  numEntries;
        if (Read(is, numEntries)) {
          for (uint64_t i = 0; i < numEntries; ++i) {
            typename _containerT::value_type  val;
            if (! Read(is, val))
              break;
            c.insert(c.end(), std::move(val));
          }
        }
      }
      return(is);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _containerT>
    static std::ostream & ContainerWrite(std::ostream & os, 
                                         const _containerT & c)
    {
      if (os) {
        uint64_t  numEntries = c.size();
        if (Write(os, numEntries)) {
          if (numEntries) {
            Write<typename _containerT::const_iterator>(os, 
                                                        c.begin(), 
                                                        c.end());
          }
        }
      }
      return(os);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename _containerT>
    static std::istream & 
    PairAssocContRead(std::istream & is, _containerT & m)
    {
      if (! m.empty())
        m.clear();
      if (is) {
        uint64_t  numEntries;
        if (Read(is, numEntries)) {
          for (uint64_t i = 0; i < numEntries; ++i) {
            typename _containerT::key_type  key;
            if (Read(is, key)) {
              typename _containerT::mapped_type  val;
              if (Read(is, val))
                m.insert(typename _containerT::value_type(std::move(key), std::move(val)));
              else
                break;
            }
            else
              break;
          }
        }
      }
      return(is);
    }
    
  };
 
 
}  // namespace Dwm
 
#endif  // _DWMSTREAMIO_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------