pkg.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: Tue Jun 15 12:33:59 1999
// commit: $Id: pkg.h 10065 2007-04-12 05:54:56Z rjpeters $
// $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/tcl/pkg.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_PKG_H_UTC20050628162421_DEFINED
#define GROOVX_TCL_PKG_H_UTC20050628162421_DEFINED

#include "tcl/makecmd.h"

#include "rutz/fileposition.h"

struct Tcl_Interp;

namespace rutz
{
  struct file_pos;
}

namespace tcl
{
  class command;
  class interpreter;
  class pkg;

  const int NO_EXPORT = 1 << 0;
}

//
// tcl::pkg class definition
//




class tcl::pkg
{
private:

  pkg(Tcl_Interp* interp, const char* name, const char* version);

  ~pkg() throw();

public:
  static const int STATUS_OK;
  static const int STATUS_ERR;

  static pkg* create_in_macro(Tcl_Interp* interp,
                              const char* name, const char* version)
  {
    return new pkg(interp, name, version);
  }

  typedef void (exit_callback)();


  void on_exit(exit_callback* callback);


  static int destroy_on_unload(Tcl_Interp* interp, const char* pkgname);


  static pkg* lookup(tcl::interpreter& interp,
                     const char* name, const char* version = 0) throw();

  int init_status() const throw();

  void set_init_status_error() throw();

  tcl::interpreter& interp() throw();

  void handle_live_exception(const rutz::file_pos& pos) throw();


  const char* namesp_name() throw();


  const char* pkg_name() const throw();

  const char* version() const throw();


  void namesp_alias(const char* namesp, const char* pattern = "*");


  void inherit_namesp(const char* namesp, const char* pattern = "*");


  void inherit_pkg(const char* name, const char* version = 0);

  void eval(const char* script);

  void link_var(const char* var_name, int& var);

  void link_var(const char* var_name, double& var);


  void link_var_copy(const char* var_name, int var);


  void link_var_copy(const char* var_name, double var);


  void link_var_const(const char* var_name, int& var);


  void link_var_const(const char* var_name, double& var);


  template <class Func>
  inline void def(const char* cmd_name, const char* usage, Func f,
                  const rutz::file_pos& src_pos, int flags = 0)
  {
    make_command(interp(), f, make_pkg_cmd_name(cmd_name, flags),
                 usage, src_pos);
  }

  template <class Func>
  inline void def_vec(const char* cmd_name, const char* usage, Func f,
                      unsigned int keyarg /*default is 1*/,
                      const rutz::file_pos& src_pos, int flags = 0)
  {
    make_vec_command(interp(), f, make_pkg_cmd_name(cmd_name, flags),
                     usage, keyarg, src_pos);
  }

  template <class Func>
  inline void def_raw(const char* cmd_name, const arg_spec& spec,
                      const char* usage, Func f,
                      const rutz::file_pos& src_pos, int flags = 0)
  {
    make_generic_command(interp(), f, make_pkg_cmd_name(cmd_name, flags),
                         usage, spec, src_pos);
  }

  template <class Func>
  inline void def_vec_raw(const char* cmd_name, const arg_spec& spec,
                          const char* usage, Func f,
                          unsigned int keyarg /*default is 1*/,
                          const rutz::file_pos& src_pos, int flags = 0)
  {
    make_generic_vec_command(interp(), f, make_pkg_cmd_name(cmd_name, flags),
                             usage, spec, keyarg, src_pos);
  }

  template <class C>
  void def_action(const char* cmd_name, void (C::* action_func) (),
                  const rutz::file_pos& src_pos, int flags = 0)
  {
    def_vec( cmd_name, action_usage, action_func, 1, src_pos, flags );
  }

  template <class C>
  void def_action(const char* cmd_name, void (C::* action_func) () const,
                  const rutz::file_pos& src_pos, int flags = 0)
  {
    def_vec( cmd_name, action_usage, action_func, 1, src_pos, flags );
  }

  template <class C, class T>
  void def_getter(const char* cmd_name, T (C::* getter_func) () const,
                  const rutz::file_pos& src_pos, int flags = 0)
  {
    def_vec( cmd_name, getter_usage, getter_func, 1, src_pos, flags );
  }

  template <class C, class T>
  void def_setter(const char* cmd_name, void (C::* setter_func) (T),
                  const rutz::file_pos& src_pos, int flags = 0)
  {
    def_vec( cmd_name, setter_usage, setter_func, 1, src_pos, flags );
  }

  template <class C, class T>
  void def_get_set(const char* cmd_name,
                   T (C::* getter_func) () const,
                   void (C::* setter_func) (T),
                   const rutz::file_pos& src_pos, int flags = 0)
  {
    def_getter( cmd_name, getter_func, src_pos, flags );
    def_setter( cmd_name, setter_func, src_pos, flags );
  }

  static void verbose_init(bool verbose) throw();


  int finish_init() throw();

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

  const char* make_pkg_cmd_name(const char* cmd_name, int flags);

  static const char* const action_usage;
  static const char* const getter_usage;
  static const char* const setter_usage;

  struct impl;
  friend struct impl;
  impl* rep;
};

#include "rutz/debug.h"
GVX_DBG_REGISTER

/*
  These macros make it slightly more convenient to make sure that
  *_Init() package initialization functions don't leak any exceptions
  (as they are called directly from C code within the Tcl core).
 */


#define GVX_PKG_CREATE(pkg, interp, pkgname, pkgversion)              \
                                                                      \
int GVX_PKG_STATUS = tcl::pkg::STATUS_ERR;                            \
{                                                                     \
  tcl::pkg* pkg = 0;                                                  \
                                                                      \
  try                                                                 \
    { pkg = tcl::pkg::create_in_macro(interp, pkgname, pkgversion); } \
  catch (...)                                                         \
    { return 1; }                                                     \
                                                                      \
  static bool recursive_initialization = false;                       \
  GVX_ASSERT(!recursive_initialization);                              \
  recursive_initialization = true;                                    \
                                                                      \
  try                                                                 \
  {


#define GVX_PKG_RETURN(pkg)                     \
  }                                             \
  catch(...)                                    \
  {                                             \
    pkg->handle_live_exception(SRC_POS);        \
  }                                             \
  recursive_initialization = false;             \
  GVX_PKG_STATUS = pkg->finish_init();          \
}                                               \
return GVX_PKG_STATUS;

#define GVX_PKG_FINISH(pkg)                     \
  }                                             \
  catch(...)                                    \
  {                                             \
    pkg->handle_live_exception(SRC_POS);        \
  }                                             \
  recursive_initialization = false;             \
  GVX_PKG_STATUS = pkg->finish_init();          \
}


static const char __attribute__((used)) vcid_groovx_tcl_pkg_h_utc20050628162421[] = "$Id: pkg.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
#endif // !GROOVX_TCL_PKG_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.