// $Id$
//
// Copyright (C) 2008 
// Fraunhofer Institute for Open Communication Systems (FOKUS)
// Competence Center NETwork research (NET), St. Augustin, GERMANY
//     Stefan Bund <g0dil@berlios.de>
//
// 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.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the
// Free Software Foundation, Inc.,
// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

/** \file
    \brief ParsedCommand internal header */

#ifndef IH_SENF_Scheduler_Console_ParsedCommand_
#define IH_SENF_Scheduler_Console_ParsedCommand_ 1

// Custom includes
#include <boost/function.hpp>
#include <boost/intrusive_ptr.hpp>
#include "Parse.hh"

///////////////////////////////ih.p////////////////////////////////////////

namespace senf {
namespace console {

    template < class FunctionTraits, 
               class ReturnType=typename FunctionTraits::result_type, 
               unsigned arity=FunctionTraits::arity >
    class ParsedCommandOverload;

    template < class Overload, 
               unsigned index=0, 
               bool flag=(index < unsigned(Overload::traits::arity)) >
    class ParsedArgumentAttributor;

namespace detail {

    /** \brief Internal: Argument information structure
        
        This class is used to hold argument information for automatically parsed commands. 

        \see ParsedCommandOverloadBase
     */
    struct ArgumentInfoBase
        : public intrusive_refcount
    {
        typedef boost::intrusive_ptr<ArgumentInfoBase> ptr;
        
        std::string type;
        std::string name;
        std::string defaultDoc;
        bool hasDefault;
        std::string doc;
        bool singleToken;
        
        explicit ArgumentInfoBase(std::string const & type, bool singleToken=false);
        virtual ~ArgumentInfoBase();

        virtual std::string defaultValueStr() const = 0;
    };
    
    /** \brief Internal: Argument information structure
        
        This class is used to hold argument information for automatically parsed commands. 

        \see ParsedCommandOverloadBase
     */
    template <class ParameterType>
    struct ArgumentInfo 
        : public ArgumentInfoBase
    {
        typedef boost::intrusive_ptr<ArgumentInfo> ptr;
        typedef boost::function<void (ParseCommandInfo::TokensRange const &, 
                                      ParameterType &)> Parser;

        static ptr create();
        ArgumentInfo();

        ParameterType defaultValue;
        Parser parser;

        virtual std::string defaultValueStr() const;
    };
    
#ifndef DOXYGEN

    // FirstArgType returns void, if the function has no arguments, otherwise it returns arg1_type

    template <class Traits, bool flag=(Traits::arity>0)>
    struct FirstArgType
    {
        typedef void type;
    };

    template <class Traits>
    struct FirstArgType<Traits,true>
    {
        typedef typename Traits::arg1_type type;
    };

    template <class FnunctionP, class Function, bool isFN=boost::is_function<Function>::value>
    struct ParsedCommandTraits_i
    {
        static const bool is_callable = false;
        static const bool is_member = false;
    };

    template <class FunctionP, class Function>
    struct ParsedCommandTraits_i<FunctionP, Function, true>
    {
        typedef FunctionP base_type;
        typedef typename senf::remove_any_pointer<base_type>::type function_type;
        typedef boost::function_traits<function_type> base_traits;
        typedef typename FirstArgType<base_traits>::type first_arg_type;

        static const bool has_ostream_arg = boost::is_same<first_arg_type, std::ostream &>::value;

        typedef typename boost::mpl::if_c<
            has_ostream_arg, 
            typename function_traits_remove_arg<base_traits>::type, 
            base_traits>
        ::type traits;

        typedef typename senf::remove_cvref<typename base_traits::result_type>::type result_type;

        static const bool is_callable = true;
        static const bool is_member = boost::is_member_pointer<base_type>::value;
        
        typedef typename senf::member_class<base_type>::type class_type;

        typedef ParsedCommandOverload<traits> Overload;
        typedef ParsedArgumentAttributor<Overload> Attributor;
    };

    // Disable auto-parsing for ParseCommandInfo arg -> register manually parsed command
    template <class FunctionP>
    struct ParsedCommandTraits_i<FunctionP, void (std::ostream &, ParseCommandInfo const &), true>
    {};

    template <class FunctionP>
    struct ParsedCommandTraits
        : public ParsedCommandTraits_i< FunctionP, 
                                        typename senf::remove_any_pointer<FunctionP>::type >
    {};

    struct ParsedCommandAddNodeAccess;

#endif

}}}

///////////////////////////////ih.e////////////////////////////////////////
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: