command.h

Go to the documentation of this file.

//
// Copyright (c) 1999-2004 California Institute of Technology
// Copyright (c) 2004-2007 University of Southern California
// Rob Peters <rjpeters at usc dot edu>
//
// created: Fri Jun 11 14:50:43 1999
// commit: $Id: command.h 10065 2007-04-12 05:54:56Z rjpeters $
// $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/tcl/command.h $
//
// --------------------------------------------------------------------
//
// This file is part of GroovX.
//   [http://ilab.usc.edu/rjpeters/groovx/]
//
// GroovX 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.
//
// GroovX 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 GroovX; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
//

#ifndef GROOVX_TCL_COMMAND_H_UTC20050628162421_DEFINED
#define GROOVX_TCL_COMMAND_H_UTC20050628162421_DEFINED

#include "tcl/argspec.h"
#include "tcl/conversions.h"
#include "tcl/obj.h"

#include "rutz/shared_ptr.h"

typedef struct Tcl_Obj Tcl_Obj;

namespace rutz
{
  class file_pos;
  class fstring;
  template <class T> class shared_ptr;
}

namespace tcl
{
  class arg_spec;
  class function;
  class command;
  class call_context;
  class arg_dispatcher;
  class interpreter;
}

class tcl::function
{
public:
  virtual ~function() throw();


  virtual void invoke(tcl::call_context& ctx) = 0;
};




class tcl::command
{
public:

  command(rutz::shared_ptr<tcl::function> callback,
          const char* usage, const arg_spec& spec);

  ~command() throw();

  rutz::fstring usage_string() const;

  bool allows_argc(unsigned int objc) const;

  bool rejects_argc(unsigned int objc) const;

  void call(tcl::interpreter& interp,
            unsigned int objc, Tcl_Obj* const objv[]);

  rutz::shared_ptr<arg_dispatcher> get_dispatcher() const;

  void set_dispatcher(rutz::shared_ptr<arg_dispatcher> dpx);

private:
  command(const command&); // not implemented
  command& operator=(const command&); // not implemented

  class impl;
  impl* const rep;
};




class tcl::arg_dispatcher
{
public:
  virtual ~arg_dispatcher() throw();

  virtual void dispatch(tcl::interpreter& interp,
                        unsigned int objc, Tcl_Obj* const objv[],
                        tcl::function& callback) = 0;
};




class tcl::call_context
{
public:
  friend class tcl::command;

  call_context(tcl::interpreter& interp,
               unsigned int objc, Tcl_Obj* const* objv);

  virtual ~call_context() throw();

  tcl::interpreter& interp() const throw() { return m_interp; }

  unsigned int objc() const throw() { return m_objc; }


  template <class T>
  typename returnable<T>::type get_arg(unsigned int argn)
    {
      return tcl::convert_to<T>(get_objv(argn));
    }


  template <class T>
  void set_result(T t)
    {
      set_obj_result(tcl::convert_from<T>(t));
    }

  Tcl_Obj* const* get_raw_args() const throw()
    {
      return m_objv;
    }

protected:
  virtual Tcl_Obj* get_objv(unsigned int n) throw() { return m_objv[n]; }

  virtual void set_obj_result(const tcl::obj& obj);

private:
  call_context(const call_context&);
  call_context& operator=(const call_context&);

  tcl::interpreter&        m_interp;
  unsigned int       const m_objc;
  Tcl_Obj* const*    const m_objv;
};

static const char __attribute__((used)) vcid_groovx_tcl_command_h_utc20050628162421[] = "$Id: command.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
#endif // !GROOVX_TCL_COMMAND_H_UTC20050628162421_DEFINED

---

The software described here is Copyright (c) 1998-2005, Rob Peters.
This page was generated Wed Dec 3 06:49:41 2008 by Doxygen version 1.5.5.