fieldpkg.cc

Go to the documentation of this file.

//
// Copyright (c) 2000-2004 California Institute of Technology
// Copyright (c) 2004-2007 University of Southern California
// Rob Peters <rjpeters at usc dot edu>
//
// created: Mon Nov 13 09:58:16 2000
// commit: $Id: fieldpkg.cc 10065 2007-04-12 05:54:56Z rjpeters $
// $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/tcl-io/fieldpkg.cc $
//
// --------------------------------------------------------------------
//
// 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_IO_FIELDPKG_CC_UTC20050712162004_DEFINED
#define GROOVX_TCL_IO_FIELDPKG_CC_UTC20050712162004_DEFINED

#include "tcl-io/fieldpkg.h"

#include "io/fields.h"

#include "nub/ref.h"

#include "tcl/list.h"

#include "tcl-io/objreader.h"
#include "tcl-io/objwriter.h"

#include "rutz/iter.h"

#include "rutz/trace.h"
#include "rutz/debug.h"
GVX_DBG_REGISTER

namespace tcl
{
  tcl::obj getField(const Field& field,
                    nub::ref<FieldContainer> item)
  {
    tcl::obj_writer w;
    field.writeValueTo(item.get(), w);
    return w.get_obj();
  }

  void setField(const Field& field, nub::ref<FieldContainer> item,
                const tcl::obj& newValue)
  {
    tcl::obj_reader r(newValue);
    field.readValueFrom(item.get(), r);
    item->touch(); // emit a signal saying that the object has changed
  }

  struct FieldsLister
  {
    const FieldMap& itsFields;
    tcl::list itsFieldList;
    bool isItRecursive;
    bool isItInited;

    FieldsLister(const FieldMap& fields, bool recurse) :
      itsFields(fields),
      itsFieldList(),
      isItRecursive(recurse),
      isItInited(false)
    {}

    ~FieldsLister() throw() {}

    typedef void retn_t;

    void operator()(tcl::call_context& ctx);
  };
}


void tcl::FieldsLister::operator()(tcl::call_context& ctx)
{
GVX_TRACE("tcl::FieldsLister::operator()");
  if (!isItInited)
    {
      for (const FieldMap* fmap = &itsFields;
           fmap != 0;
           fmap = isItRecursive ? fmap->parent() : 0)
        {
          for (FieldMap::Iterator itr(fmap->ioFields()); itr.is_valid(); ++itr)
            {
              const Field& field = *itr;

              tcl::list sub_list;

              sub_list.append(field.name());           // property name
              sub_list.append(field.min());            // min value
              sub_list.append(field.max());            // max value
              sub_list.append(field.res());            // resolution value

              tcl::list flags;
              if (field.startsNewGroup()) flags.append("NEW_GROUP");
              if (field.isTransient())    flags.append("TRANSIENT");
              if (field.isString())       flags.append("STRING");
              if (field.isMultiValued())  flags.append("MULTI");
              if (field.isChecked())      flags.append("CHECKED");
              if (!field.allowGet())      flags.append("NO_GET");
              if (!field.allowSet())      flags.append("NO_SET");
              if (field.isPrivate())      flags.append("PRIVATE");
              if (field.isBoolean())      flags.append("BOOLEAN");

              sub_list.append(flags);

              itsFieldList.append(sub_list);
            }
        }

      isItInited = true;
    }

  ctx.set_result(itsFieldList);
}

//
// Free function definitions
//

void tcl::defField(tcl::pkg* pkg, const Field& field,
                   const rutz::file_pos& src_pos)
{
GVX_TRACE("tcl::defField");

  const unsigned int keyarg = 1;

  pkg->def_vec( field.name().c_str(), "objref(s)",
                rutz::bind_first(getField, field), keyarg, src_pos );
  pkg->def_vec( field.name().c_str(), "objref(s) new_val(s)",
                rutz::bind_first(setField, field), keyarg, src_pos );
}

void tcl::defAllFields(tcl::pkg* pkg, const FieldMap& fieldmap,
                       const rutz::file_pos& src_pos)
{
GVX_TRACE("tcl::defAllFields");

  for (const FieldMap* fmap = &fieldmap; fmap != 0; fmap = fmap->parent())
    {
      for (FieldMap::Iterator itr(fmap->ioFields()); itr.is_valid(); ++itr)
        {
          defField(pkg, *itr, src_pos);
        }
    }

  pkg->def_raw("fields", tcl::arg_spec(1), "",
               FieldsLister(fieldmap, false), src_pos);

  pkg->def_raw("allFields", tcl::arg_spec(1), "",
               FieldsLister(fieldmap, true), src_pos);
}

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