/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2008 INRIA

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation;

 *

 * 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

 *

 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#ifndef COMMAND_LINE_H

#define COMMAND_LINE_H

#include <string>

#include <sstream>

#include <list>

#include "ns3/callback.h"

namespace ns3 {

/**

 * \brief parse command-line arguments

 * \ingroup core

 *

 * Instances of this class can be used to parse command-line 

 * arguments: users can register new arguments with

 * CommandLine::AddValue but the most important functionality

 * provided by this class is that it can be used to set the

 * 'initial value' of every attribute in the system with the

 * --TypeIdName::AttributeName=value syntax and it can be used

 * to set the value of every GlobalValue in the system with

 * the --GlobalValueName=value syntax.

 */

class CommandLine

{

public:

  CommandLine ();

  CommandLine (const CommandLine &cmd);

  CommandLine &operator = (const CommandLine &cmd);

  ~CommandLine ();

  /**

   * \param name the name of the user-supplied argument

   * \param help some help text used by --PrintHelp

   * \param value a reference to the variable where the

   *        value parsed will be stored (if no value

   *        is parsed, this variable is not modified).

   */

  template <typename T>

  void AddValue (const std::string &name,

		 const std::string &help,

		 T &value);

  /**

   * \param name the name of the user-supplied argument

   * \param help some help text used by --PrintHelp

   * \param callback a callback function that will be invoked to parse

   * and collect the value.  This normally used by language bindings.

   */

  void AddValue (const std::string &name,

		 const std::string &help,

                 Callback<bool, std::string> callback);

  /**

   * \param argc the 'argc' variable: number of arguments (including the

   *        main program name as first element).

   * \param argv the 'argv' variable: a null-terminated array of strings,

   *        each of which identifies a command-line argument.

   * 

   * Obviously, this method will parse the input command-line arguments and

   * will attempt to handle them all.

   */

  void Parse (int argc, char *argv[]) const;

private:

  class Item 

  {

  public:

    std::string m_name;

    std::string m_help;

    virtual ~Item ();

    virtual bool Parse (std::string value) = 0;

  };

  template <typename T>

  class UserItem : public Item

  {

  public:

    virtual bool Parse (std::string value);

    T *m_valuePtr;

  };

  class CallbackItem : public Item

  {

  public:

    virtual bool Parse (std::string value);

    Callback<bool, std::string> m_callback;

  };

  void HandleArgument (std::string name, std::string value) const;

  void PrintHelp (void) const;

  void PrintGlobals (void) const;

  void PrintAttributes (std::string type) const;

  void PrintGroup (std::string group) const;

  void PrintTypeIds (void) const;

  void PrintGroups (void) const;

  void Copy (const CommandLine &cmd);

  void Clear (void);

  typedef std::list<Item *> Items;

  Items m_items;

};

} // namespace ns3

namespace ns3 {

template <typename T>

void 

CommandLine::AddValue (const std::string &name,

		   const std::string &help,

		   T &value)

{

  UserItem<T> *item = new UserItem<T> ();

  item->m_name = name;

  item->m_help = help;

  item->m_valuePtr = &value;

  m_items.push_back (item);

}

template <typename T>

bool 

CommandLine::UserItem<T>::Parse (std::string value)

{

  std::istringstream iss;

  iss.str (value);

  iss >> (*m_valuePtr);

  return !iss.bad () && !iss.fail ();

}

} // namespace ns3

#endif /* COMMAND_LINE_H */