/libflusspferd/spidermonkey/native_object_base.cpp

// vim:ts=2:sw=2:expandtab:autoindent:filetype=cpp:
/*
The MIT License

Copyright (c) 2008, 2009 Flusspferd contributors (see "CONTRIBUTORS" or
                                       http://flusspferd.org/contributors.txt)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

#include "flusspferd/native_object_base.hpp"
#include "flusspferd/tracer.hpp"
#include "flusspferd/object.hpp"
#include "flusspferd/string.hpp"
#include "flusspferd/call_context.hpp"
#include "flusspferd/root.hpp"
#include "flusspferd/exception.hpp"
#include "flusspferd/current_context_scope.hpp"
#include "flusspferd/spidermonkey/init.hpp"
#include "flusspferd/spidermonkey/jsid.hpp"
#include <boost/unordered_map.hpp>
#include <boost/variant.hpp>

using namespace flusspferd;

class native_object_base::impl {
public:
  static void finalize(JSContext *ctx, JSObject *obj);
  static JSBool call_helper(JSContext *, JSObject *, uintN, jsval *, jsval *);

  static void trace_op(JSTracer *trc, JSObject *obj);

  template<property_mode>
#if defined(JSID_VOID) || defined(JS_USE_JSVAL_JSID_STRUCT_TYPES) // TODO add better check for new jsid/jsvalue API
  static JSBool property_op(JSContext *, JSObject *, jsid, jsval *);
#else
  static JSBool property_op(JSContext *, JSObject *, jsval, jsval *);
#endif

  static JSBool new_resolve(JSContext *, JSObject *, jsval, uintN, JSObject **);

  static JSBool new_enumerate(JSContext *cx, JSObject *obj,
    JSIterateOp enum_op, jsval *statep, jsid *idp);

public:
  static JSClass native_object_class;
  static JSClass native_enumerable_object_class;
};

static const unsigned int basic_flags =
  JSCLASS_HAS_PRIVATE
  | JSCLASS_NEW_RESOLVE
  | JSCLASS_MARK_IS_TRACE
  ;

#define MARK_TRACE_OP ((JSMarkOp) &native_object_base::impl::trace_op)

JSClass native_object_base::impl::native_object_class = {
  "NativeObject",
  basic_flags,
  &native_object_base::impl::property_op<native_object_base::property_add>,
  &native_object_base::impl::property_op<native_object_base::property_delete>,
  &native_object_base::impl::property_op<native_object_base::property_get>,
  &native_object_base::impl::property_op<native_object_base::property_set>,
  JS_EnumerateStub,
  (JSResolveOp) &native_object_base::impl::new_resolve,
  JS_ConvertStub,
  &native_object_base::impl::finalize,
  0,
  0,
  &native_object_base::impl::call_helper,
  0,
  0,
  0,
  MARK_TRACE_OP,
  0
};

JSClass native_object_base::impl::native_enumerable_object_class = {
  "NativeObject",
  basic_flags | JSCLASS_NEW_ENUMERATE,
  &native_object_base::impl::property_op<native_object_base::property_add>,
  &native_object_base::impl::property_op<native_object_base::property_delete>,
  &native_object_base::impl::property_op<native_object_base::property_get>,
  &native_object_base::impl::property_op<native_object_base::property_set>,
  (JSEnumerateOp) &native_object_base::impl::new_enumerate,
  (JSResolveOp) &native_object_base::impl::new_resolve,
  JS_ConvertStub,
  &native_object_base::impl::finalize,
  0,
  0,
  &native_object_base::impl::call_helper,
  0,
  0,
  0,
  MARK_TRACE_OP,
  0
};

native_object_base::native_object_base(object const &o) : p(new impl) {
  load_into(o);
}

native_object_base::~native_object_base() {
  if (!is_null()) {
    JS_SetPrivate(Impl::current_context(), get(), 0);
  }
}

void native_object_base::load_into(object const &o) {
  if (!is_null())
    throw exception("Cannot load native_object data into more than one object");

  object::operator=(o);

  if (!is_null()) {
    if (!JS_SetPrivate(Impl::current_context(), Impl::get_object(o), this))
      throw exception("Could not create native object (private data)");
  }
}

bool native_object_base::is_object_native(object const &o_) {
  object o = o_;

  if (o.is_null())
    return false;

  JSContext *ctx = Impl::current_context();
  JSObject *jso = Impl::get_object(o);
  JSClass *classp = JS_GET_CLASS(ctx, jso);

  if (!classp || classp->finalize != &native_object_base::impl::finalize)
    return false;

  void *priv = JS_GetPrivate(ctx, jso);
  if (!priv)
    return false;

  return true;
}

native_object_base &native_object_base::get_native(object const &o_) {
  object o = o_;

  if (o.is_null())
    throw exception("Can not interpret 'null' as native object");

  JSContext *ctx = Impl::current_context();
  JSObject *jso = Impl::get_object(o);
  JSClass *classp = JS_GET_CLASS(ctx, jso);

  if (!classp || classp->finalize != &native_object_base::impl::finalize)
    throw exception("Object is not native");

  void *priv = JS_GetPrivate(ctx, jso);
  if (!priv)
    throw exception("Object is not native");

  return *static_cast<native_object_base*>(priv);
}

object native_object_base::do_create_object(
  object const &prototype_, object const &parent)
{
  JSContext *ctx = Impl::current_context();

  object prototype = prototype_;

  JSObject *o = JS_NewObject(
      ctx,
      &impl::native_object_class,
      Impl::get_object(prototype),
      Impl::get_object(parent));

  if (!o)
    throw exception("Could not create native object");

  return Impl::wrap_object(o);
}

object native_object_base::do_create_enumerable_object(
  object const &prototype_, object const &parent)
{
  JSContext *ctx = Impl::current_context();

  object prototype = prototype_;

  JSObject *o = JS_NewObject(
      ctx,
      &impl::native_enumerable_object_class,
      Impl::get_object(prototype),
      Impl::get_object(parent));

  if (!o)
    throw exception("Could not create native object");

  return Impl::wrap_object(o);
}

void native_object_base::impl::finalize(JSContext *ctx, JSObject *obj) {
  void *p = JS_GetPrivate(ctx, obj);

  if (p) {
    current_context_scope scope(Impl::wrap_context(ctx));
    delete static_cast<native_object_base*>(p);
  }
}

JSBool native_object_base::impl::call_helper(
    JSContext *ctx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
  FLUSSPFERD_CALLBACK_BEGIN {
    current_context_scope scope(Impl::wrap_context(ctx));

    JSObject *function = JSVAL_TO_OBJECT(argv[-2]);

    native_object_base *self = 0;
    
    try {
      self = &native_object_base::get_native(Impl::wrap_object(obj));
    } catch (exception &) {
      self = &native_object_base::get_native(Impl::wrap_object(function));
    }

    call_context x;

    x.self = Impl::wrap_object(obj);
    x.self_native = self;
    x.arg = Impl::arguments_impl(argc, argv);
    x.result.bind(Impl::wrap_jsvalp(rval));
    x.function = Impl::wrap_object(function);

    self->self_call(x);
  } FLUSSPFERD_CALLBACK_END;
}
#if defined(JSID_VOID) || defined(JS_USE_JSVAL_JSID_STRUCT_TYPES) // TODO add better check for new jsid/jsvalue API
template<native_object_base::property_mode mode>
JSBool native_object_base::impl::property_op(
    JSContext *ctx, JSObject *obj, jsid id, jsval *vp)
#else
template<native_object_base::property_mode mode>
JSBool native_object_base::impl::property_op(
    JSContext *ctx, JSObject *obj, jsval id, jsval *vp)
#endif
{
  FLUSSPFERD_CALLBACK_BEGIN {
    current_context_scope scope(Impl::wrap_context(ctx));

    native_object_base &self =
      native_object_base::get_native(Impl::wrap_object(obj));

    value data(Impl::wrap_jsvalp(vp));
    self.property_op(mode, Impl::wrap_jsid(id), data);
  } FLUSSPFERD_CALLBACK_END;
}

JSBool native_object_base::impl::new_resolve(
    JSContext *ctx, JSObject *obj, jsval id, uintN sm_flags, JSObject **objp)
{
  FLUSSPFERD_CALLBACK_BEGIN {
    current_context_scope scope(Impl::wrap_context(ctx));

    native_object_base &self =
      native_object_base::get_native(Impl::wrap_object(obj));

    unsigned flags = 0;

    if (sm_flags & JSRESOLVE_QUALIFIED)
      flags |= property_qualified;
    if (sm_flags & JSRESOLVE_ASSIGNING)
      flags |= property_assigning;
    if (sm_flags & JSRESOLVE_DETECTING)
      flags |= property_detecting;
    if (sm_flags & JSRESOLVE_DECLARING)
      flags |= property_declaring;
    if (sm_flags & JSRESOLVE_CLASSNAME)
      flags |= property_classname;

    *objp = 0;
    if (self.property_resolve(Impl::wrap_jsval(id), flags))
      *objp = Impl::get_object(self);
  } FLUSSPFERD_CALLBACK_END;
}

JSBool native_object_base::impl::new_enumerate(
    JSContext *ctx, JSObject *obj, JSIterateOp enum_op, jsval *statep, jsid *idp)
{
  FLUSSPFERD_CALLBACK_BEGIN {
    current_context_scope scope(Impl::wrap_context(ctx));

    native_object_base &self =
      native_object_base::get_native(Impl::wrap_object(obj));

    
    boost::any *iter;
    switch (enum_op) {
    case JSENUMERATE_INIT:
      {
        iter = new boost::any;
        int num = 0;
        *iter = self.enumerate_start(num);
        *statep = PRIVATE_TO_JSVAL(iter);
        if (idp) {
#if defined(JSID_VOID) || defined(JS_USE_JSVAL_JSID_STRUCT_TYPES) // TODO add better check for new jsid/jsvalue API
          *idp = INT_TO_JSID(num);
#else
          *idp = INT_TO_JSVAL(num);
#endif
        }
        return JS_TRUE;
      }
    case JSENUMERATE_NEXT:
      {
        iter = (boost::any*)JSVAL_TO_PRIVATE(*statep);
        value id;
        if (iter->empty() || (id = self.enumerate_next(*iter)).is_undefined())
          *statep = JSVAL_NULL;
        else {
          JS_ValueToId(ctx, Impl::get_jsval(id), idp);
        }
        return JS_TRUE;
      }
    case JSENUMERATE_DESTROY:
      {
        iter = (boost::any*)JSVAL_TO_PRIVATE(*statep);
        delete iter;
        return JS_TRUE;
      }
    }
  } FLUSSPFERD_CALLBACK_END;
}

void native_object_base::impl::trace_op(
    JSTracer *trc, JSObject *obj)
{
  current_context_scope scope(Impl::wrap_context(trc->context));

  native_object_base &self =
    native_object_base::get_native(Impl::wrap_object(obj));

  tracer tracer_(trc);
  self.trace(tracer_);
}

void native_object_base::property_op(
    property_mode, value const &, value &)
{
}

bool native_object_base::property_resolve(value const &, unsigned) {
  return false;
}

boost::any native_object_base::enumerate_start(int &)
{
  return boost::any();
}

value native_object_base::enumerate_next(boost::any &)
{
  return value();
}

void native_object_base::self_call(call_context &) {
  throw exception("Object can not be called");
}

void native_object_base::trace(tracer&) {}