// rTorrent - BitTorrent client
// Copyright (C) 2006, Jari Sundell
//
// 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
//
// In addition, as a special exception, the copyright holders give
// permission to link the code of portions of this program with the
// OpenSSL library under certain conditions as described in each
// individual source file, and distribute linked combinations
// including the two.
//
// You must obey the GNU General Public License in all respects for
// all of the code used other than OpenSSL.  If you modify file(s)
// with this exception, you may extend this exception to your version
// of the file(s), but you are not obligated to do so.  If you do not
// wish to do so, delete this exception statement from your version.
// If you delete this exception statement from all source files in the
// program, then also delete it here.
//
// Contact:  Jari Sundell <jaris@ifi.uio.no>
//
//           Skomakerveien 33
//           3185 Skoppum, NORWAY

#ifndef RTORRENT_UTILS_VARIABLE_H
#define RTORRENT_UTILS_VARIABLE_H

#include <torrent/object.h>

namespace core {
  class Download;
}

namespace utils {

class Variable {
public:
  typedef torrent::Object::value_type  value_type;
  typedef torrent::Object::string_type string_type;
  typedef torrent::Object::list_type   list_type;
  typedef torrent::Object::map_type    map_type;
  typedef torrent::Object::key_type    key_type;

  Variable() {}
  virtual ~Variable() {}

  virtual const torrent::Object& get();
  virtual void                   set(const torrent::Object& arg);

  // The default action is to throw away the 'download' argument.
  virtual const torrent::Object& get_d(core::Download* download);
  virtual void                   set_d(core::Download* download, const torrent::Object& arg);

  static const char*  string_to_value_unit(const char* pos, value_type* value, int base, int unit);
  static bool         string_to_value_unit_nothrow(const char* pos, value_type* value, int base, int unit);

protected:
  Variable(const Variable&);
  void operator = (const Variable&);

  // Temporary hack, until torrent::Object is extended to allow
  // references so we can return a copy, not a const reference.
  static const torrent::Object m_emptyObject;
};

}

#endif