vtkOStreamWrapper.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkOStreamWrapper_h
#define vtkOStreamWrapper_h
 
#include "vtkCommonCoreModule.h"
 
#include <type_traits>
 
#ifndef VTK_SYSTEM_INCLUDES_INSIDE
Do_not_include_vtkOStreamWrapper_directly_vtkSystemIncludes_includes_it;
#endif
 
VTK_ABI_NAMESPACE_BEGIN
class vtkIndent;
class vtkObjectBase;
class vtkLargeInteger;
template <typename T>
class vtkSmartPointer;
class vtkSmartPointerBase;
class vtkStdString;
 
class VTKCOMMONCORE_EXPORT VTK_WRAPEXCLUDE vtkOStreamWrapper
{
  class std_string;
  class std_string_view;
 
public:

  vtkOStreamWrapper(ostream& os);
  vtkOStreamWrapper(vtkOStreamWrapper& r);
 
  virtual ~vtkOStreamWrapper();

  struct EndlType
  {
  };


  vtkOStreamWrapper& operator<<(const EndlType&);
  vtkOStreamWrapper& operator<<(const vtkIndent&);
  vtkOStreamWrapper& operator<<(vtkObjectBase&);
  vtkOStreamWrapper& operator<<(const vtkLargeInteger&);
  vtkOStreamWrapper& operator<<(const vtkSmartPointerBase&);
  vtkOStreamWrapper& operator<<(const vtkStdString&);
  vtkOStreamWrapper& operator<<(const char*);
  vtkOStreamWrapper& operator<<(void*);
  vtkOStreamWrapper& operator<<(char);
  vtkOStreamWrapper& operator<<(short);
  vtkOStreamWrapper& operator<<(int);
  vtkOStreamWrapper& operator<<(long);
  vtkOStreamWrapper& operator<<(long long);
  vtkOStreamWrapper& operator<<(unsigned char);
  vtkOStreamWrapper& operator<<(unsigned short);
  vtkOStreamWrapper& operator<<(unsigned int);
  vtkOStreamWrapper& operator<<(unsigned long);
  vtkOStreamWrapper& operator<<(unsigned long long);
  vtkOStreamWrapper& operator<<(float);
  vtkOStreamWrapper& operator<<(double);
  vtkOStreamWrapper& operator<<(bool);
 
  // Work-around for IBM Visual Age bug in overload resolution.
#if defined(__IBMCPP__)
  vtkOStreamWrapper& WriteInternal(const char*);
  vtkOStreamWrapper& WriteInternal(void*);
  template <typename T>
  vtkOStreamWrapper& operator<<(T* p)
  {
    return this->WriteInternal(p);
  }
#endif
 
  vtkOStreamWrapper& operator<<(void (*)(void*));
  vtkOStreamWrapper& operator<<(void* (*)(void*));
  vtkOStreamWrapper& operator<<(int (*)(void*));
  vtkOStreamWrapper& operator<<(int* (*)(void*));
  vtkOStreamWrapper& operator<<(float* (*)(void*));
  vtkOStreamWrapper& operator<<(const char* (*)(void*));
  vtkOStreamWrapper& operator<<(void (*)(void*, int*));
 
  // Accept std::string without a declaration.
  template <template <typename, typename, typename> class S>
  vtkOStreamWrapper& operator<<(const S<char, std::char_traits<char>, std::allocator<char>>& s)
  {
    return *this << reinterpret_cast<std_string const&>(s);
  }
 
  // Accept std::string_view without a declaration. The trivially-copyable
  // constraint keeps this from also matching std::basic_string (whose
  // allocator parameter is defaulted and would otherwise be deduced too).
  template <template <typename, typename> class S,
    typename = std::enable_if_t<std::is_trivially_copyable<S<char, std::char_traits<char>>>::value>>
  vtkOStreamWrapper& operator<<(const S<char, std::char_traits<char>>& s)
  {
    return *this << reinterpret_cast<std_string_view const&>(s);
  }
 
  // Accept vtkSmartPointer for output.
  template <typename T>
  vtkOStreamWrapper& operator<<(const vtkSmartPointer<T>& ptr)
  {
    this->ostr << (static_cast<T*>(ptr));
    return *this;
  }

  vtkOStreamWrapper& write(const char*, unsigned long);

  ostream& GetOStream();

  operator ostream&();

  operator int();

  void flush();


  static void UseEndl(const EndlType&) {}
protected:
  // Reference to the real ostream.
  ostream& ostr;
 
private:
  vtkOStreamWrapper& operator=(const vtkOStreamWrapper& r) = delete;
  vtkOStreamWrapper& operator<<(std_string const&);
  vtkOStreamWrapper& operator<<(std_string_view const&);
};
 
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkOStreamWrapper.h