Chris@16: //  (C) Copyright Howard Hinnant
Chris@16: //  (C) Copyright 2011 Vicente J. Botet Escriba
Chris@16: //  Use, modification and distribution are subject to the Boost Software License,
Chris@16: //  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@16: //  http://www.boost.org/LICENSE_1_0.txt).
Chris@16: //
Chris@16: 
Chris@16: /**
Chris@16:  * Duration formatting facet for output.
Chris@16:  */
Chris@16: #ifndef BOOST_CHRONO_IO_DURATION_PUT_HPP
Chris@16: #define BOOST_CHRONO_IO_DURATION_PUT_HPP
Chris@16: 
Chris@16: #include <boost/chrono/config.hpp>
Chris@16: #include <boost/chrono/io/duration_units.hpp>
Chris@101: #include <boost/chrono/process_cpu_clocks.hpp>
Chris@16: #include <boost/assert.hpp>
Chris@16: #include <locale>
Chris@16: 
Chris@16: namespace boost
Chris@16: {
Chris@16:   namespace chrono
Chris@16:   {
Chris@16: 
Chris@101:     namespace detail
Chris@101:     {
Chris@101:       template <class T>
Chris@101:       struct propagate {
Chris@101:         typedef T type;
Chris@101:       };
Chris@101:       template <>
Chris@101:       struct propagate<boost::int_least32_t> {
Chris@101:         typedef boost::int_least64_t type;
Chris@101:       };
Chris@101:     }
Chris@16:     /**
Chris@16:      * @tparam ChatT a character type
Chris@16:      * @tparam OutputIterator a model of @c OutputIterator
Chris@16:      *
Chris@16:      * The @c duration_put facet provides facilities for formatted output of duration values.
Chris@16:      * The member function of @c duration_put take a duration and format it into character string representation.
Chris@16:      *
Chris@16:      */
Chris@16:     template <class CharT, class OutputIterator = std::ostreambuf_iterator<CharT> >
Chris@16:     class duration_put: public std::locale::facet
Chris@16:     {
Chris@16:     public:
Chris@16:       /**
Chris@16:        * Type of character the facet is instantiated on.
Chris@16:        */
Chris@16:       typedef CharT char_type;
Chris@16:       /**
Chris@16:        * Type of character string passed to member functions.
Chris@16:        */
Chris@16:       typedef std::basic_string<CharT> string_type;
Chris@16:       /**
Chris@16:        * Type of iterator used to write in the character buffer.
Chris@16:        */
Chris@16:       typedef OutputIterator iter_type;
Chris@16: 
Chris@16:       /**
Chris@16:        * Construct a duration_put facet.
Chris@16:        * @param refs
Chris@16:        * @Effects Construct a duration_put facet.
Chris@16:        * If the @c refs argument is @c 0 then destruction of the object is
Chris@16:        * delegated to the @c locale, or locales, containing it. This allows
Chris@16:        * the user to ignore lifetime management issues. On the other had,
Chris@16:        * if @c refs is @c 1 then the object must be explicitly deleted;
Chris@16:        * the @c locale will not do so. In this case, the object can be
Chris@16:        * maintained across the lifetime of multiple locales.
Chris@16:        */
Chris@16:       explicit duration_put(size_t refs = 0) :
Chris@16:         std::locale::facet(refs)
Chris@16:       {
Chris@16:       }
Chris@16: 
Chris@16:       /**
Chris@16:        *
Chris@16:        * @param s an output stream iterator
Chris@16:        * @param ios a reference to a ios_base
Chris@16:        * @param fill the character used as filler
Chris@16:        * @param d the duration
Chris@16:        * @param pattern begin of the formatting pattern
Chris@16:        * @param pat_end end of the formatting pattern
Chris@16:        *
Chris@16:        * @Effects Steps through the sequence from @c pattern to @c pat_end,
Chris@16:        * identifying characters that are part of a pattern sequence. Each character
Chris@16:        * that is not part of a pattern sequence is written to @c s immediately, and
Chris@16:        * each pattern sequence, as it is identified, results in a call to
Chris@16:        * @c put_value or @c put_unit;
Chris@16:        * thus, pattern elements and other characters are interleaved in the output
Chris@16:        * in the order in which they appear in the pattern. Pattern sequences are
Chris@16:        * identified by converting each character @c c to a @c char value as if by
Chris@16:        * @c ct.narrow(c,0), where @c ct is a reference to @c ctype<charT> obtained from
Chris@16:        * @c ios.getloc(). The first character of each sequence is equal to @c '%',
Chris@16:        * followed by a pattern specifier character @c spec, which can be @c 'v' for
Chris@16:        * the duration value or @c 'u' for the duration unit. .
Chris@16:        * For each valid pattern sequence identified, calls
Chris@16:        * <c>put_value(s, ios, fill, d)</c> or <c>put_unit(s, ios, fill, d)</c>.
Chris@16:        *
Chris@16:        * @Returns An iterator pointing immediately after the last character produced.
Chris@16:        */
Chris@16:       template <typename Rep, typename Period>
Chris@16:       iter_type put(iter_type s, std::ios_base& ios, char_type fill, duration<Rep, Period> const& d, const CharT* pattern,
Chris@101:           const CharT* pat_end, const char_type* val = 0) const
Chris@16:       {
Chris@16:         if (std::has_facet<duration_units<CharT> >(ios.getloc()))
Chris@16:         {
Chris@16:           duration_units<CharT> const&facet = std::use_facet<duration_units<CharT> >(
Chris@16:               ios.getloc());
Chris@101:           return put(facet, s, ios, fill, d, pattern, pat_end, val);
Chris@16:         }
Chris@16:         else
Chris@16:         {
Chris@16:           duration_units_default<CharT> facet;
Chris@101:           return put(facet, s, ios, fill, d, pattern, pat_end, val);
Chris@16:         }
Chris@16:       }
Chris@16: 
Chris@16:       template <typename Rep, typename Period>
Chris@16:       iter_type put(duration_units<CharT> const& units_facet, iter_type s, std::ios_base& ios, char_type fill,
Chris@101:           duration<Rep, Period> const& d, const CharT* pattern, const CharT* pat_end, const char_type* val = 0) const
Chris@16:       {
Chris@16: 
Chris@16:         const std::ctype<char_type>& ct = std::use_facet<std::ctype<char_type> >(ios.getloc());
Chris@16:         for (; pattern != pat_end; ++pattern)
Chris@16:         {
Chris@16:           if (ct.narrow(*pattern, 0) == '%')
Chris@16:           {
Chris@16:             if (++pattern == pat_end)
Chris@16:             {
Chris@16:               *s++ = pattern[-1];
Chris@16:               break;
Chris@16:             }
Chris@16:             char fmt = ct.narrow(*pattern, 0);
Chris@16:             switch (fmt)
Chris@16:             {
Chris@16:             case 'v':
Chris@16:             {
Chris@101:               s = put_value(s, ios, fill, d, val);
Chris@16:               break;
Chris@16:             }
Chris@16:             case 'u':
Chris@16:             {
Chris@16:               s = put_unit(units_facet, s, ios, fill, d);
Chris@16:               break;
Chris@16:             }
Chris@16:             default:
Chris@16:               BOOST_ASSERT(false && "Boost::Chrono internal error.");
Chris@16:               break;
Chris@16:             }
Chris@16:           }
Chris@16:           else
Chris@16:             *s++ = *pattern;
Chris@16:         }
Chris@16:         return s;
Chris@16:       }
Chris@16: 
Chris@16:       /**
Chris@16:        *
Chris@16:        * @param s an output stream iterator
Chris@16:        * @param ios a reference to a ios_base
Chris@16:        * @param fill the character used as filler
Chris@16:        * @param d the duration
Chris@16:        * @Effects imbue in @c ios the @c duration_units_default facet if not already present.
Chris@16:        * Retrieves Stores the duration pattern from the @c duration_unit facet in let say @c str. Last as if
Chris@16:        * @code
Chris@16:        *   return put(s, ios, d, str.data(), str.data() + str.size());
Chris@16:        * @endcode
Chris@16:        * @Returns An iterator pointing immediately after the last character produced.
Chris@16:        */
Chris@16:       template <typename Rep, typename Period>
Chris@101:       iter_type put(iter_type s, std::ios_base& ios, char_type fill, duration<Rep, Period> const& d, const char_type* val = 0) const
Chris@16:       {
Chris@16:         if (std::has_facet<duration_units<CharT> >(ios.getloc()))
Chris@16:         {
Chris@16:           duration_units<CharT> const&facet = std::use_facet<duration_units<CharT> >(
Chris@16:               ios.getloc());
Chris@16:           std::basic_string<CharT> str = facet.get_pattern();
Chris@101:           return put(facet, s, ios, fill, d, str.data(), str.data() + str.size(), val);
Chris@16:         }
Chris@16:         else
Chris@16:         {
Chris@16:           duration_units_default<CharT> facet;
Chris@16:           std::basic_string<CharT> str = facet.get_pattern();
Chris@101: 
Chris@101:           return put(facet, s, ios, fill, d, str.data(), str.data() + str.size(), val);
Chris@16:         }
Chris@16:       }
Chris@16: 
Chris@16:       /**
Chris@16:        *
Chris@16:        * @param s an output stream iterator
Chris@16:        * @param ios a reference to a ios_base
Chris@16:        * @param fill the character used as filler
Chris@16:        * @param d the duration
Chris@16:        * @Effects As if s=std::use_facet<std::num_put<CharT, iter_type> >(ios.getloc()).put(s, ios, fill, static_cast<long int> (d.count())).
Chris@16:        * @Returns s, iterator pointing immediately after the last character produced.
Chris@16:        */
Chris@16:       template <typename Rep, typename Period>
Chris@101:       iter_type put_value(iter_type s, std::ios_base& ios, char_type fill, duration<Rep, Period> const& d, const char_type* val = 0) const
Chris@16:       {
Chris@101:         if (val)
Chris@101:         {
Chris@101:           while (*val) {
Chris@101:             *s = *val;
Chris@101:             s++; val++;
Chris@101:           }
Chris@101:           return s;
Chris@101:         }
Chris@16:         return std::use_facet<std::num_put<CharT, iter_type> >(ios.getloc()).put(s, ios, fill,
Chris@101:             static_cast<typename detail::propagate<Rep>::type> (d.count()));
Chris@101:       }
Chris@101: 
Chris@101:       template <typename Rep, typename Period>
Chris@101:       iter_type put_value(iter_type s, std::ios_base& ios, char_type fill, duration<process_times<Rep>, Period> const& d, const char_type* = 0) const
Chris@101:       {
Chris@101:         *s++ = CharT('{');
Chris@101:         s = put_value(s, ios, fill, process_real_cpu_clock::duration(d.count().real));
Chris@101:         *s++ = CharT(';');
Chris@101:         s = put_value(s, ios, fill, process_user_cpu_clock::duration(d.count().user));
Chris@101:         *s++ = CharT(';');
Chris@101:         s = put_value(s, ios, fill, process_system_cpu_clock::duration(d.count().system));
Chris@101:         *s++ = CharT('}');
Chris@101:         return s;
Chris@16:       }
Chris@16: 
Chris@16:       /**
Chris@16:        *
Chris@16:        * @param s an output stream iterator
Chris@16:        * @param ios a reference to a ios_base
Chris@16:        * @param fill the character used as filler
Chris@16:        * @param d the duration
Chris@16:        * @Effects Let facet be the duration_units<CharT> facet associated to ios. If the associated unit is named,
Chris@16:        * as if
Chris@16:        * @code
Chris@16:           string_type str = facet.get_unit(get_duration_style(ios), d);
Chris@16:           s=std::copy(str.begin(), str.end(), s);
Chris@16:        * @endcode
Chris@16:        * Otherwise, format the unit as "[Period::num/Period::den]" followed by the unit associated to [N/D] obtained using facet.get_n_d_unit(get_duration_style(ios), d)
Chris@16:        * @Returns s, iterator pointing immediately after the last character produced.
Chris@16:        */
Chris@16:       template <typename Rep, typename Period>
Chris@16:       iter_type put_unit(iter_type s, std::ios_base& ios, char_type fill, duration<Rep, Period> const& d) const
Chris@16:       {
Chris@16:         if (std::has_facet<duration_units<CharT> >(ios.getloc()))
Chris@16:         {
Chris@16:           duration_units<CharT> const&facet = std::use_facet<duration_units<CharT> >(
Chris@16:               ios.getloc());
Chris@16:           return put_unit(facet, s, ios, fill, d);
Chris@16:         }
Chris@16:         else
Chris@16:         {
Chris@16:           duration_units_default<CharT> facet;
Chris@16:           return put_unit(facet, s, ios, fill, d);
Chris@16:         }
Chris@16:       }
Chris@16: 
Chris@16:       template <typename Rep, typename Period>
Chris@16:       iter_type put_unit(duration_units<CharT> const& facet, iter_type s, std::ios_base& ios, char_type fill,
Chris@16:           duration<Rep, Period> const& d) const
Chris@16:       {
Chris@16:         if (facet.template is_named_unit<Period>()) {
Chris@16:           string_type str = facet.get_unit(get_duration_style(ios), d);
Chris@16:           s=std::copy(str.begin(), str.end(), s);
Chris@16:         } else {
Chris@16:           *s++ = CharT('[');
Chris@16:           std::use_facet<std::num_put<CharT, iter_type> >(ios.getloc()).put(s, ios, fill, Period::num);
Chris@16:           *s++ = CharT('/');
Chris@16:           std::use_facet<std::num_put<CharT, iter_type> >(ios.getloc()).put(s, ios, fill, Period::den);
Chris@16:           *s++ = CharT(']');
Chris@16:           string_type str = facet.get_n_d_unit(get_duration_style(ios), d);
Chris@16:           s=std::copy(str.begin(), str.end(), s);
Chris@16:         }
Chris@16:         return s;
Chris@16:       }
Chris@101:       template <typename Rep, typename Period>
Chris@101:       iter_type put_unit(duration_units<CharT> const& facet, iter_type s, std::ios_base& ios, char_type fill,
Chris@101:           duration<process_times<Rep>, Period> const& d) const
Chris@101:       {
Chris@101:         duration<Rep,Period> real(d.count().real);
Chris@101:         if (facet.template is_named_unit<Period>()) {
Chris@101:           string_type str = facet.get_unit(get_duration_style(ios), real);
Chris@101:           s=std::copy(str.begin(), str.end(), s);
Chris@101:         } else {
Chris@101:           *s++ = CharT('[');
Chris@101:           std::use_facet<std::num_put<CharT, iter_type> >(ios.getloc()).put(s, ios, fill, Period::num);
Chris@101:           *s++ = CharT('/');
Chris@101:           std::use_facet<std::num_put<CharT, iter_type> >(ios.getloc()).put(s, ios, fill, Period::den);
Chris@101:           *s++ = CharT(']');
Chris@101:           string_type str = facet.get_n_d_unit(get_duration_style(ios), real);
Chris@101:           s=std::copy(str.begin(), str.end(), s);
Chris@101:         }
Chris@101:         return s;
Chris@101:       }
Chris@16: 
Chris@16:       /**
Chris@16:        * Unique identifier for this type of facet.
Chris@16:        */
Chris@16:       static std::locale::id id;
Chris@16: 
Chris@16:       /**
Chris@16:        * @Effects Destroy the facet
Chris@16:        */
Chris@16:       ~duration_put()
Chris@16:       {
Chris@16:       }
Chris@16: 
Chris@16:     };
Chris@16: 
Chris@16:     template <class CharT, class OutputIterator>
Chris@16:     std::locale::id duration_put<CharT, OutputIterator>::id;
Chris@16: 
Chris@16:   } // chrono
Chris@16: } // boost
Chris@16: 
Chris@16: #endif  // header