freemonoid_base.hh

// freemonoid_base.hh: this file is part of the Vaucanson project.
//
// Vaucanson, a generic library for finite state machines.
//
// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2007, 2008 The
// Vaucanson Group.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// The complete GNU General Public Licence Notice can be found as the
// `COPYING' file in the root directory.
//
// The Vaucanson Group consists of people listed in the `AUTHORS' file.
//
#ifndef VCSN_ALGEBRA_CONCEPT_FREEMONOID_BASE_HH
# define VCSN_ALGEBRA_CONCEPT_FREEMONOID_BASE_HH

# include <vaucanson/algebra/concept/alphabets_base.hh>
# include <vaucanson/algebra/concept/monoid_base.hh>
# include <string>
# include <list>

namespace vcsn {

  namespace algebra {

    /*---------------------.
    | FreeMonoidBase<Self> |
    `---------------------*/

    template<class Self>
    struct FreeMonoidBase
      : MonoidBase<Self>
    {
      typedef typename virtual_types<Self>::alphabet_t  alphabet_t;

      typedef typename alphabet_t::letter_t                     letter_t;

      alphabet_t&       alphabet();

      const alphabet_t& alphabet() const;

    protected:
      FreeMonoidBase();

      FreeMonoidBase(const FreeMonoidBase& m);
    };

  } // algebra

  /*--------------------------------------.
  | dynamic_traits<FreeMonoidBase<Self> > |
  `--------------------------------------*/

  template<class Self>
  struct dynamic_traits<algebra::FreeMonoidBase<Self> >
    : dynamic_traits<algebra::MonoidBase<Self> >
  { };

  template<typename S>
  struct virtual_types<algebra::FreeMonoidBase<S> >
    : virtual_types<algebra::MonoidBase<S> >
  {
    typedef undefined_type alphabet_t;
  };

  /*-------------------------------------.
  | MetaElement<FreeMonoidBase<Self>, T> |
  `-------------------------------------*/

  template<class Self, typename T>
  struct MetaElement<algebra::FreeMonoidBase<Self>, T>
    : MetaElement<algebra::MonoidBase<Self>, T>
  {
    typedef typename op_begin_traits<Self, T>::ret_t    iterator;

    typedef typename
    op_begin_traits<Self, T>::const_ret_t               const_iterator;

    typedef typename op_rbegin_traits<Self, T>::ret_t   reverse_iterator;

    typedef typename
    op_rbegin_traits<Self, T>::const_ret_t              const_reverse_iterator;

    size_t                    length() const;

    void                      mirror();

    iterator                    begin();

    const_iterator              begin() const;

    reverse_iterator            rbegin();

    const_reverse_iterator      rbegin() const;

    iterator                    end();

    const_iterator              end() const;

    reverse_iterator            rend();

    const_reverse_iterator      rend() const;

  protected:
    MetaElement();

    MetaElement(const MetaElement& other);
  };

  template<typename S, typename T>
  Element<S, T>
  mirror(const Element<S, T>& e);

  template <typename S, typename T>
  std::pair<bool, int>
  parse_word(Element<S, T>& dest,
             const std::string& s);

  namespace algebra {

    template <typename S, typename T>
    std::pair<bool, int>
    op_parse(const algebra::FreeMonoidBase<S>& s, T& v,
             const std::string&);

    template<typename Self, typename T>
    void op_in_mirror(const algebra::FreeMonoidBase<Self>& s, T& v);

    template<typename Self, typename T>
    bool op_contains(const algebra::FreeMonoidBase<Self>& s, const T& v);

    template<typename Self, typename St, typename T>
    St& op_rout(const algebra::FreeMonoidBase<Self>& s, St& st, const T& v);

  } // ! algebra

} // ! vcsn

# if !defined VCSN_USE_INTERFACE_ONLY || defined VCSN_USE_LIB
#  include <vaucanson/algebra/concept/freemonoid_base.hxx>
# endif // ! VCSN_USE_INTERFACE_ONLY

#endif // ! VCSN_ALGEBRA_CONCEPT_FREEMONOID_BASE_HH