Home
Publications
Presentations
Support
Download
Examples
Developers
Class Docs
Namespaces
Classes
Files
Mailing Lists
Gallery
Wiki

o_string_stream.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2012 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library 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 2.1 of the License, or (at your option) any later version.

// This library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_OSTRINGSTREAM_H
#define LIBMESH_OSTRINGSTREAM_H



// Mesh configuration options
#include "libmesh/libmesh_config.h"



#ifdef LIBMESH_HAVE_SSTREAM

// C++ includes
#include <sstream>

// Local Includes
#include "libmesh/libmesh_common.h"


// Forward Declarations



/*
 * Some compilers, at least HP \p aCC do not even
 * accept empty classes derived from \p std::ostringstream.
 * Therefore, resort to preprocessor definitions.
 */

#ifndef LIBMESH_BROKEN_IOSTREAM
 /*
  * ---------------------------------------------------------------------------------
  * Everything for a clean iostream
  */

# include <iomanip>

 /*
  * Outputs \p std::string \p d with width
  * \p v left-formatted to stream \p o.
  */
# define OSSStringleft(o,v,d)       (o).width(v);  (o) << std::left << (d)

 /*
  * Outputs \p std::string \p d with width
  * \p v right-formatted to stream \p o.
  */
# define OSSStringright(o,v,d)      (o).width(v);  (o) << std::right << (d)

 /*
  * Outputs \p Real \p d with width \p v and
  * precision \p p to stream \p o (padded with
  * whitespaces).
  */
# define OSSRealleft(o,v,p,d)       (o).width(v);  (o).precision(p); (o).fill(' '); (o) << (d)

 /*
  * Outputs \p Real \p d with width \p v and
  * precision \p p to stream \p o (padded with
  * zeros).
  */
# define OSSRealzeroleft(o,v,p,d)   (o).width(v); (o).precision(p); (o).fill('0'); (o) << std::showpoint << std::left << (d)

 /*
  * Outputs \p Real \p d with width \p v and
  * precision \p p to stream \p o (padded with
  * whitespaces).
  */
# define OSSRealright(o,v,p,d)       (o).width(v);  (o).precision(p); (o).fill(' '); (o) << std::right << (d)

 /*
  * Outputs \p Real \p d with width \p v and
  * precision \p p to stream \p o (padded with
  * zeros).
  */
# define OSSRealzeroright(o,v,p,d)   (o).width(v);  (o).precision(p); (o).fill('0'); (o) << std::right << (d)

 /*
  * Outputs \p Real \p d with width \p v
  * in scientific format to stream \p o.
  */
# define OSSRealscientific(o,v,d)   (o) << std::setw(v) << std::scientific << (d)

 /*
  * Outputs \p int \p d with width
  * \p v to stream \p o.
  */
# define OSSInt(o,v,d)              (o).width(v);  (o) << (d)

 /*
  * class alias
  */
//# define OStringStream           std::ostringstream
typedef std::ostringstream OStringStream;




#else
 /*
  * ---------------------------------------------------------------------------------
  * Everything for broken iostream
  */

# include <cstdio>

 /*
  * Outputs \p std::string \p d with width
  * \p v left-formatted to stream \p o.
  */
# define OSSStringleft(o,v,d)       (o).left( (v), (d) )

 /*
  * Outputs \p std::string \p d with width
  * \p v right-formatted to stream \p o.
  */
# define OSSStringright(o,v,d)      (o).right( (v), (d) )

 /*
  * Outputs \p Real \p d with width \p v and
  * precision \p p to stream \p o (padded with
  * whitespaces).
  */
# define OSSRealleft(o,v,p,d)       (o).left( (v), (p), (d) , ' ')

 /*
  * Outputs \p Real \p d with width \p v and
  * precision \p p to stream \p o (padded with
  * zeros).
  */
# define OSSRealzeroleft(o,v,p,d)       (o).left( (v), (p), (d) , '0')

 /*
  * Outputs \p Real \p d with width \p v and
  * precision \p p to stream \p o (padded with
  * whitespaces).
  */
# define OSSRealright(o,v,p,d)      (o).right( (v), (p), (d) ,' ')

 /*
  * Outputs \p Real \p d with width \p v and
  * precision \p p to stream \p o (padded with
  * zeros).
  */
# define OSSRealzeroright(o,v,p,d)      (o).right( (v), (p), (d) ,'0')

 /*
  * Outputs \p Real \p d with width \p v
  * in scientific format to stream \p o.
  */
# define OSSRealscientific(o,v,d)   (o).scientific( (v), (d) )

 /*
  * Outputs \p int \p d with width
  * \p v to stream \p o.
  */
# define OSSInt(o,v,d)              (o).left( (v), (d) )

//  /*
//   * class alias
//   */
// # define OSSOStringStream           OStringStream


namespace libMesh
{


 // ------------------------------------------------------------
 // OStringStream class definition
 class OStringStream : public std::ostringstream
 {
 public:

  OStringStream () : std::ostringstream()
   {
     // [JWP] TODO: I will remove this class at the next libmesh
     // release or on on March 21, 2013, whichever comes first.
     libmesh_deprecated();
   }

  ~OStringStream () {};

  typedef std::string::size_type sizetype;

  void left (const sizetype w,
             const std::string& s);

  void left (const sizetype w,
             const sizetype prec,
             const Real r,
             const char c = ' ');

  void left (const sizetype w,
             const int n);

  void right (const sizetype w,
              const std::string& s);


  void right (const sizetype w,
              const sizetype prec,
              const Real r,
              const char c = ' ');

  void scientific (const sizetype w,
                   const Real r);

 protected:
  void print_ws (const sizetype n,
                 const char c = ' ');

 };



 // ------------------------------------------------------------
 // OStringStream inline methods
 inline
 void OStringStream::left (const sizetype w,
                           const std::string& s)
 {
   *this << s;
   // pad with whitespaces afterwards
   print_ws ((w-s.size()));
 }


 inline
 void OStringStream::left (const sizetype w,
                           const sizetype prec,
                           const Real r,
                           const char c)
 {
   libmesh_assert_less (w, 30);
   char buf[30];
   char format[8];
   // form the format for r
   // ALTERNATIVE: sprintf (format, "%%%d.%df", int((w-prec)/2), prec);
   sprintf (format, "%%.%df", prec);
   // form string as desired
   sprintf (buf, format, r);
   *this << buf;
   // pad with whitespaces afterwards
   print_ws (w-std::string(buf).size(), c);
   // ALTERNATIVE: print_ws (w-int((w-prec)/2));
 }


 inline
 void OStringStream::left (const sizetype w,
                           const int n)
 {
   libmesh_assert_less (w, 30);
   char buf[30];
   // form string as desired
   sprintf (buf, "%d", n);
   *this << buf;
   // pad with whitespaces afterwards
   print_ws (w-std::string(buf).size());
 }


 inline
 void OStringStream::right (const sizetype w,
                            const std::string& s)
 {
   // first pad with whitespaces
   print_ws ((w-s.size()));
   *this << s;
 }


 inline
 void OStringStream::right (const sizetype w,
                            const sizetype prec,
                            const Real r,
                            const char c)
 {
   libmesh_assert_less (w, 30);
   char buf[30];
   char format[8];
   // form the format for r
   sprintf (format, "%%.%df", prec);
   // form string as desired
   sprintf (buf, format, r);
   // first pad with the user-defined char
   print_ws (w-std::string(buf).size(), c);
   // then print the float
   *this << buf;
 }


 inline
 void OStringStream::scientific (const sizetype w,
                                 const Real r)
 {
   libmesh_assert_less (w, 30);
   char buf[30];
   char format[8];
   // form the format for r
   sprintf (format, "%%%de", w);
   // form string as desired
   sprintf (buf, format, r);
   *this << buf;
 }


 inline
 void OStringStream::print_ws (const sizetype n,
                               const char c)
 {
   for (sizetype i = 0; i < n; i++)
     *this << c;
 }


} // namespace libMesh

#endif // ifndef ... else ... LIBMESH_BROKEN_IOSTREAM




#endif // ifdef LIBMESH_HAVE_SSTREAM

#endif // LIBMESH_OSTRINGSTREAM_H

---

Site Created By: libMesh Developers
Last modified: February 05 2013 19:54:48 UTC

Hosted By: