#ifndef _DATE_TIME_DATE_GENERATOR_FORMATTER__HPP___

#define _DATE_TIME_DATE_GENERATOR_FORMATTER__HPP___

/* Copyright (c) 2004 CrystalClear Software, Inc.

 * Use, modification and distribution is subject to the 

 * Boost Software License, Version 1.0. (See accompanying

 * file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)

 * Author: Jeff Garland, Bart Garst

 * $Date: 2008-11-13 14:05:31 -0500 (Thu, 13 Nov 2008) $

 */

#include <iostream>

#include <string>

#include <vector>

#include <algorithm>

#include "boost/date_time/date_generators.hpp"

namespace boost {

namespace date_time {

  //! Formats date_generators for output

  /*! Formatting of date_generators follows specific orders for the 

   * various types of date_generators.

   * - partial_date                     => "dd Month"

   * - nth_day_of_the_week_in_month     => "nth weekday of month"

   * - first_day_of_the_week_in_month   => "first weekday of month"

   * - last_day_of_the_week_in_month    => "last weekday of month"

   * - first_day_of_the_week_after      => "weekday after"

   * - first_day_of_the_week_before     => "weekday before"

   * While the order of the elements in these phrases cannot be changed, 

   * the elements themselves can be. Weekday and Month get their formats

   * and names from the date_facet. The remaining elements are stored in 

   * the date_generator_formatter and can be customized upon construction

   * or via a member function. The default elements are those shown in the 

   * examples above.

   */

  template <class date_type, class CharT, class OutItrT = std::ostreambuf_iterator<CharT, std::char_traits<CharT> > >

  class date_generator_formatter {

    public:

      typedef partial_date<date_type>          partial_date_type;

      typedef nth_kday_of_month<date_type>     nth_kday_type;

      typedef first_kday_of_month<date_type>   first_kday_type;

      typedef last_kday_of_month<date_type>    last_kday_type;

      typedef first_kday_after<date_type>      kday_after_type;

      typedef first_kday_before<date_type>     kday_before_type;

      typedef CharT char_type;

      typedef std::basic_string<char_type> string_type;

      typedef std::vector<string_type> collection_type;

      static const char_type first_string[6];

      static const char_type second_string[7];

      static const char_type third_string[6];

      static const char_type fourth_string[7];

      static const char_type fifth_string[6];

      static const char_type last_string[5];

      static const char_type before_string[8];

      static const char_type after_string[6];

      static const char_type of_string[3];

      enum phrase_elements {first=0, second, third, fourth, fifth, last,

                         before, after, of, number_of_phrase_elements};

      //! Default format elements used

      date_generator_formatter()

      {

        phrase_strings.reserve(number_of_phrase_elements);

        phrase_strings.push_back(string_type(first_string));

        phrase_strings.push_back(string_type(second_string));

        phrase_strings.push_back(string_type(third_string));

        phrase_strings.push_back(string_type(fourth_string));

        phrase_strings.push_back(string_type(fifth_string));

        phrase_strings.push_back(string_type(last_string));

        phrase_strings.push_back(string_type(before_string));

        phrase_strings.push_back(string_type(after_string));

        phrase_strings.push_back(string_type(of_string));

      }

      //! Constructor that allows for a custom set of phrase elements

      date_generator_formatter(const string_type& first_str,

                               const string_type& second_str,

                               const string_type& third_str,

                               const string_type& fourth_str,

                               const string_type& fifth_str,

                               const string_type& last_str,

                               const string_type& before_str,

                               const string_type& after_str,

                               const string_type& of_str)

      {

        phrase_strings.reserve(number_of_phrase_elements);

        phrase_strings.push_back(first_str);

        phrase_strings.push_back(second_str);

        phrase_strings.push_back(third_str);

        phrase_strings.push_back(fourth_str);

        phrase_strings.push_back(fifth_str);

        phrase_strings.push_back(last_str);

        phrase_strings.push_back(before_str);

        phrase_strings.push_back(after_str);

        phrase_strings.push_back(of_str);

      }

      //! Replace the set of phrase elements with those contained in new_strings

      /*! The order of the strings in the given collection is important.

       * They must follow: 

       *  - first, second, third, fourth, fifth, last, before, after, of. 

       *

       * It is not necessary to send in a complete set if only a few 

       * elements are to be replaced as long as the correct beg_pos is used.

       *

       * Ex: To keep the default first through fifth elements, but replace 

       * the rest with a collection of: 

       *  - "final", "prior", "following", "in". 

       * The beg_pos of date_generator_formatter::last would be used.

       */

      void elements(const collection_type& new_strings,

                    phrase_elements beg_pos=first)

      {

        if(beg_pos < number_of_phrase_elements) {

          typename collection_type::iterator itr = phrase_strings.begin();

          itr += beg_pos;

          std::copy(new_strings.begin(), new_strings.end(),

                    itr);

                    //phrase_strings.begin());

        }

      }

      //!Put a partial_date => "dd Month"

      template<class facet_type>

      OutItrT put_partial_date(OutItrT next, std::ios_base& a_ios,

                               CharT a_fill, const partial_date_type& pd,

                               const facet_type& facet) const

      {

        facet.put(next, a_ios, a_fill, pd.day());

        next = a_fill; //TODO change this ???

        facet.put(next, a_ios, a_fill, pd.month());

        return next;

      }

      //! Put an nth_day_of_the_week_in_month => "nth weekday of month"

      template<class facet_type>

      OutItrT put_nth_kday(OutItrT next, std::ios_base& a_ios,

                           CharT a_fill, const nth_kday_type& nkd,

                           const facet_type& facet) const

      {

        put_string(next, phrase_strings[nkd.nth_week() -1]);

        next = a_fill; //TODO change this ???

        facet.put(next, a_ios, a_fill, nkd.day_of_week());

        next = a_fill; //TODO change this ???

        put_string(next, string_type(of_string));

        next = a_fill; //TODO change this ???

        facet.put(next, a_ios, a_fill, nkd.month());

        return next;

      }

      //! Put a first_day_of_the_week_in_month => "first weekday of month"

      template<class facet_type>

      OutItrT put_first_kday(OutItrT next, std::ios_base& a_ios,

                             CharT a_fill, const first_kday_type& fkd,

                             const facet_type& facet) const

      {

        put_string(next, phrase_strings[first]);

        next = a_fill; //TODO change this ???

        facet.put(next, a_ios, a_fill, fkd.day_of_week());

        next = a_fill; //TODO change this ???

        put_string(next, string_type(of_string));

        next = a_fill; //TODO change this ???

        facet.put(next, a_ios, a_fill, fkd.month());

        return next;

      }

      //! Put a last_day_of_the_week_in_month => "last weekday of month"

      template<class facet_type>

      OutItrT put_last_kday(OutItrT next, std::ios_base& a_ios,

                           CharT a_fill, const last_kday_type& lkd,

                           const facet_type& facet) const

      {

        put_string(next, phrase_strings[last]);

        next = a_fill; //TODO change this ???

        facet.put(next, a_ios, a_fill, lkd.day_of_week());

        next = a_fill; //TODO change this ???

        put_string(next, string_type(of_string));

        next = a_fill; //TODO change this ???

        facet.put(next, a_ios, a_fill, lkd.month());

        return next;

      }

      //! Put a first_day_of_the_week_before => "weekday before"

      template<class facet_type>

      OutItrT put_kday_before(OutItrT next, std::ios_base& a_ios,

                              CharT a_fill, const kday_before_type& fkb,

                              const facet_type& facet) const

      {

        facet.put(next, a_ios, a_fill, fkb.day_of_week());

        next = a_fill; //TODO change this ???

        put_string(next, phrase_strings[before]);

        return next;

      }

      //! Put a first_day_of_the_week_after => "weekday after"

      template<class facet_type>

      OutItrT put_kday_after(OutItrT next, std::ios_base& a_ios,

                             CharT a_fill, const kday_after_type& fka,

                             const facet_type& facet) const

      {

        facet.put(next, a_ios, a_fill, fka.day_of_week());

        next = a_fill; //TODO change this ???

        put_string(next, phrase_strings[after]);

        return next;

      }

    private:

      collection_type phrase_strings;

      //! helper function to put the various member string into stream

      OutItrT put_string(OutItrT next, const string_type& str) const

      {

        typename string_type::const_iterator itr = str.begin();

        while(itr != str.end()) {

          *next = *itr;

          ++itr;

          ++next;

        }

        return next;

      }

  };

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::first_string[6] = 

    {'f','i','r','s','t'};

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::second_string[7] = 

    {'s','e','c','o','n','d'};

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::third_string[6] = 

    {'t','h','i','r','d'};

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::fourth_string[7] = 

    {'f','o','u','r','t','h'};

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::fifth_string[6] = 

    {'f','i','f','t','h'};

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::last_string[5] = 

    {'l','a','s','t'};

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::before_string[8] = 

    {'b','e','f','o','r','e'};

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::after_string[6] = 

    {'a','f','t','e','r'};

  template<class date_type, class CharT, class OutItrT>

  const typename date_generator_formatter<date_type, CharT, OutItrT>::char_type

  date_generator_formatter<date_type, CharT, OutItrT>::of_string[3] = 

    {'o','f'};

} } // namespaces

#endif // _DATE_TIME_DATE_GENERATOR_FORMATTER__HPP___