first commit.

[gintenlib/gintenlib.git] / gintenlib / list_formatter.hpp

#ifndef GINTENLIB_INCLUDED_LIST_FORMATTER_HPP_
#define GINTENLIB_INCLUDED_LIST_FORMATTER_HPP_

/*

      <gintenlib/list_formatter.hpp>

  list_formatter ¡§ ¥Õ¥¡¥ó¥¯¥¿ÈÇ list_format¡Êconst char* ÈÇ¡Ë

  Àë¸À¡§
  template< typename Elem >
  struct basic_list_formatter
  {
    explicit basic_list_formatter
      ( 
        gintenlib_param_t(Elem) pre_ = "( ",
        gintenlib_param_t(Elem) delim_ = ", ",
        gintenlib_param_t(Elem) post_ = " )" 
      );

    typedef gintenlib_value_t(Elem) element_type;
    // ¥á¥ó¥Ð¡ÖÊÑ¿ô¡×¡¢¼«Í³¤Ë³°Éô¤«¤é¥¢¥¯¥»¥¹¤Ç¤­¤ë
    element_type pre, delim, post;

    // ½ÐÎÏÈϰϤò»ØÄꤷ¡¢¥¹¥È¥ê¡¼¥à¤Ëή¤»¤ë¤è¤¦¤Ë¤¹¤ë
    template< typename InIte >
      list_format_impl_< InIte, Elem, Elem, Elem >
    operator()( const InIte& begin, const InIte& end ) const;

    // ½ÐÎÏÈϰϤò range ¤Ç»ØÄê
    template< typename Range >
      list_format_impl_< gintenlib_const_ite_of(Range), Elem, Elem, Elem >
    operator()( const Range& src ) const;

    // ostream_iterator ¤Î¤è¤¦¤Ë¿¶Éñ¤¦¥¤¥Æ¥ì¡¼¥¿¤òÀ½ºî¡£
    // ¥¤¥Æ¥ì¡¼¥¿¤¬´û¤ËÀ½ºî¤µ¤ì¤Æ¤¤¤¿¾ì¹ç¤Ï¡¢¤¤¤Ã¤¿¤ó¥ê¥¹¥È¤¬ÊĤ¸¤é¤ì¤ë
    template< typename Stream >
    iterator<Stream> make_iterator( Stream& os ) const;

    template< typename Stream >
    struct iterator
      : std::iterator< std::output_iterator_tag, void, void, void, void >
    {
      iterator( const basic_list_formatter& formatter, Stream& os );
      iterator( const iterator& src );

      ~iterator();

      iterator& operator=( const iterator& src );
      iterator& swap( iterator& other );

      template< typename T >
      iterator& operator=( const T& val );

      iterator& close();

      iterator& operator*(){ return *this; }
      iterator& operator++(){ return *this; }
      iterator& operator++(int){ return *this; }

    };  // struct iterator

  };  // struct basic_list_formatter

  typedef basic_list_formatter<const char*> list_formatter;

  µ¡Ç½¡§
    list_format(v) ¤ä list_format( begin, end ) ¤È»È¤¦Éôʬ¤Ç¡¢Âå¤ï¤ê¤Ë»ÈÍѤǤ­¤ë¥Õ¥¡¥ó¥¯¥¿¡£

    list_formatter formatter( pre, delim, post );
    cout << formatter(v) << endl;

    ¤³¤Î¥³¡¼¥É¤Î¼Â¹Ô·ë²Ì¤Ï cout << list_format( v, pre, delim, post ) << endl; ¤ÈÅù²Á¡£
    ͽ¤á pre, delim, post ¤ÎÀßÄê¤ò¤·¤Æ¤ª¤¤¤Æ»È¤¤¤Þ¤ï¤·¤¿¤¤¾ì¹ç¤Ë»ÈÍѤǤ­¤ë¡£

    ¤â¤¦°ì¤Ä¤Îµ¡Ç½¤È¤·¤Æ¡¢make_iterator() ¥á¥ó¥Ð´Ø¿ô¤ò¸Æ¤Ö¤³¤È¤Ç½ÐÎÏ¥¤¥Æ¥ì¡¼¥¿¤ò¹½ÃۤǤ­¤ëµ¡Ç½¤â¤¢¤ê¡¢

    cout << formatter(v);
    cout << formatter( v.begin(), v.end() );
    copy( v.begin(), v.end(), formatter.make_iterator(cout) );

    ¤³¤Î»°¤Ä¤Îʸ¤Î¼Â¹Ô·ë²Ì¤Ï¡¢¤É¤ì¤âÅù¤·¤¤¡£

  »ÈÍÑÎ㡧
    // ¹½ÃÛ¤·¤Æ
    gintenlib::list_formatter formatter( "[ ", " | ", " ]\n" );

    // Ǥ°Õ¤Î¥³¥ó¥Æ¥Ê v ¤ËÂФ·¡¢Å¬ÍѤ¹¤ë
    cout << formatter(v);
    // µÕ½ç¤Ëɽ¼¨¤ò¤·¤Æ¤ß¤ë
    cout << formatter( v.rbegin(), v.rend() );
    // µÕ½ç¤Ëɽ¼¨¤¹¤ë¤Ë¤Ï¡¢¤³¤¦½ñ¤¤¤Æ¤â¤è¤¤
    reverse_copy( v.begin(), v.end(), formatter.ite(cout) );

  Êä­¡§
    ¡¦pre, delim, post ¤Ï const char* ¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
      Ǥ°ÕÍ×ÁǤò³ÊǼ¤·¤¿¤¤¾ì¹ç¤Ï¡¢list_formatter_ex ¤òÍѤ¤¤ë¡£
    ¡¦operator() ¤ÎŬÍÑ·ë²Ì¤Î¼è¤ê°·¤¤¤Ï¡¢ list_format ´Ø¿ô¤ÎÌá¤êÃͤÈƱ¤¸¤è¤¦¤Ë°·¤¦¡£
    ¡¦½ÐÎÏ¥¤¥Æ¥ì¡¼¥¿¤ò»ÈÍѤ¹¤ë¾ì¹ç¤ÎÃí°Õ»ö¹à¡§
      ¡¦pre Í×ÁǤϡֺǽé¤ÎÍ×ÁǤ¬¼ÂºÝ¤Ë½ÐÎϤµ¤ì¤ëľÁ°¡×¤Ë½ÐÎϤµ¤ì¤ë¡£
      ¡¦delim Í×ÁǤϡÖÆó²óÌܰʹߤÎÍ×ÁǤ¬½ÐÎϤµ¤ì¤ëľÁ°¡×¤Ë½ÐÎϤµ¤ì¤ë¡£
      ¡¦post Í×ÁǤϡ֥³¥Ô¡¼¤ò´Þ¤á¡¢Á´¤Æ¤Î¥¤¥Æ¥ì¡¼¥¿¤¬ÇË´þ¤µ¤ì¤¿¤È¤­¡×¤Ë½ÐÎϤµ¤ì¤ë¡£
        ¤¿¤À¤·¡¢Ì¤¤À pre ¤¬½ÐÎϤµ¤ì¤Æ¤¤¤Ê¤±¤ì¤Ð¡¢post ¤â½ÐÎϤµ¤ì¤Ê¤¤¡£
      ¡¦¤â¤·Á´¤Æ¤Î¥¤¥Æ¥ì¡¼¥¿¤¬ÇË´þ¤µ¤ì¤ëÁ°¤Ë¿·¤¿¤Ê¥¤¥Æ¥ì¡¼¥¿¤òÀ½ºî¤·¤¿¾ì¹ç¡¢
        ¤½¤Î»þÅÀ¤Ç post Í×ÁǤ¬½ÐÎϤµ¤ì¡¢¡Ö²¿¤â½ÐÎϤµ¤ì¤Æ¤¤¤Ê¤¤¡×¾õÂ֤ˤʤ롣

*/

#include <iterator>
#include <cassert>
#include <algorithm>  // for swap()

#include <boost/range.hpp>
#include <boost/call_traits.hpp>

#include "list_format.hpp"

namespace gintenlib
{
  template< typename Elem >
  class basic_list_formatter
  {
    typedef typename boost::call_traits<Elem>::param_type param_type;

   public:
    typedef typename boost::call_traits<Elem>::value_type element_type;

    basic_list_formatter()
      : pre("( "), delim(", "), post(" )"), iterator_count_(0) {}
    
    explicit basic_list_formatter
      ( param_type pre_, param_type delim_, param_type post_ )
       : pre(pre_), delim(delim_), post(post_), iterator_count_(0) {}

    // ¥á¥ó¥ÐÊÑ¿ô¤Ê¤Î¤Ç¡¢¼«Í³¤Ë¥¢¥¯¥»¥¹¤Ç¤­¤ë¡£
    element_type pre, delim, post;

    // ½ÐÎÏÈϰϤò¥¤¥Æ¥ì¡¼¥¿¤Ç»ØÄꤷ¤Æ¡¢¥¹¥È¥ê¡¼¥à¤Ëή¤»¤ë¤è¤¦¤Ë
    template< typename InIte >
      list_format_impl_< InIte, Elem, Elem, Elem >
    operator()( const InIte& begin, const InIte& end ) const
    {
      return list_format_impl_< InIte, Elem, Elem, Elem >( begin, end, pre, delim, post );
    }
    // ½ÐÎÏÈϰϤò range ¤Ç»ØÄꤷ¤Æ¡¢¥¹¥È¥ê¡¼¥à¤Ëή¤»¤ë¤è¤¦¤Ë
    template< typename Range >
      list_format_impl_< typename boost::range_iterator<const Range>::type, Elem, Elem, Elem >
    operator()( const Range& src ) const
    {
      return list_format_impl_< typename boost::range_iterator<const Range>::type, Elem, Elem, Elem >
          ( boost::begin(src), boost::end(src), pre, delim, post );
    }

    // ¥¤¥Æ¥ì¡¼¥¿
    template< typename Stream >
    struct iterator
      : std::iterator< std::output_iterator_tag, void, void, void, void >
    {
      iterator( const basic_list_formatter& formatter, Stream& os )
        : formatter_(&formatter), os_(&os)
      {
        // ½ÐÎϤ¬¡ÖÊĤ¸¤Æ¡×¤Ê¤¤¤Ê¤é¡¢ÊĤ¸¤ë
        close();

        // ¤³¤Î»þÅÀ¤Ç¥«¥¦¥ó¥È¤ÏÉé
        --formatter_->iterator_count_;
      }

      iterator( const iterator& src )
        : formatter_(src.formatter_), os_(src.os_)
      {
        if( formatter_->iterator_count_ > 0 )
        {
          ++formatter_->iterator_count_;
        }
        else if( formatter_->iterator_count_ < 0 )
        {
          --formatter_->iterator_count_;
        }
        else
        {
          assert( !"basic_list_formatter::iterator::iterator(const iterator&) : sould not get here." );
        }
      }

      ~iterator()
      {
        if( formatter_->iterator_count_ > 0 )
        {
          // count ¤¬Àµ <==> ´û¤Ë²¿¤«½ÐÎϤµ¤ì¤Æ¤¤¤ë
          if( --formatter_->iterator_count_ == 0 )
          {
            // count ¤¬ 0 ¤Ë¤Ê¤Ã¤¿ <==> ¤â¤¦Â¾¤Î¥¤¥Æ¥ì¡¼¥¿¤Ï̵¤¤
            *os_ << formatter_->post;
          }
        }
        else if( formatter_->iterator_count_ < 0 )
        {
          ++formatter_->iterator_count_;
        }
        else
        {
          assert( !"basic_list_formatter::iterator::~iterator() : sould not get here." );
        }
      }

      iterator& operator=( const iterator& src )
      {
        iterator temp(src);
        swap(temp);
        return *this;
      }
      void swap( iterator& other )
      {
        using std::swap;
        swap( formatter_, other.formatter_ );
        swap( os_, other.os_ );
      }
      friend void swap( iterator& one, iterator& other )
      {
        one.swap(other);
      }

      // ¼ÂºÝ¤Î½ÐÎÏ
      template< typename T >
      iterator& operator=( const T& val )
      {
        if( formatter_->iterator_count_ > 0 )
        {
          *os_ << formatter_->delim << val;
        }
        else if( formatter_->iterator_count_ < 0 )
        {
          *os_ << formatter_->pre << val;
          formatter_->iterator_count_ = -formatter_->iterator_count_;
        }
        else
        {
          assert( !"basic_list_formatter::iterator::operator=(const T&) : sould not get here." );
        }
        return *this;
      }

      // ¡Ö½ÐÎϤòÊĤ¸¤ë¡×
      iterator& close()
      {
        // ¥«¥¦¥ó¥È¤¬Àµ <==> ½ÐÎϤ¬¡ÖÊĤ¸¤Æ¡×¤Ê¤¤
        if( formatter_->iterator_count_ > 0 )
        {
          // ÊĤ¸¤ë
          *os_ << formatter_->post;
          // ¡Ö̤½ÐÎϡפؤÈÀßÄê
          formatter_->iterator_count_ = -formatter_->iterator_count_;
        }
        return *this;
      }

      // »²¾È³°¤·¤â¡¢Á°ÃÖ¡¿¸åÃÖ¥¤¥ó¥¯¥ê¥á¥ó¥È¤â¡¢²¿¤â¤·¤Ê¤¤
      iterator& operator*(){ return *this; }
      iterator& operator++(){ return *this; }
      iterator& operator++(int){ return *this; }

    private:
      const basic_list_formatter* formatter_;
      Stream* os_;

    };  // struct iterator

    template< typename Stream >
    friend struct iterator;

    // ½ÐÎÏ¥¤¥Æ¥ì¡¼¥¿¤òºî¤ë
    template< typename Stream >
    iterator<Stream> make_iterator( Stream& os ) const
    {
      return iterator<Stream>( *this, os );
    }

  private:
    mutable int iterator_count_;

  };  // struct basic_list_formatter

  typedef basic_list_formatter<const char*> list_formatter;

}   // namespace gintenlib


#endif  // #ifndef GINTENLIB_INCLUDED_LIST_FORMATTER_HPP_