bslCps.js

/*
    Copyright © 2011 MLstate

    This file is part of OPA.

    OPA is free software: you can redistribute it and/or modify it under the
    terms of the GNU Affero General Public License, version 3, as published by
    the Free Software Foundation.

    OPA 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 Affero General Public License for
    more details.

    You should have received a copy of the GNU Affero General Public License
    along with OPA.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
   Bypasses for CPS

   @author Maxime Audouin <maxime.audouin@mlstate.com>
   @author Rudy Sicard
   @review David Rajchenbach-Teller (started Aug 20th, 2010)
*/

##extern-type Cps.future('a)
##extern-type continuation('a)
##extern-type [normalize] func('a, 'b)
##extern-type [normalize] black_future

##extern-type [normalize] _unit_continuation
##extern-type [normalize] _unit
    /* the type unit that doesn't get projected */

/**
 * Defined in [qmlCpsClientLib.js]
 * it use js_debug, with a prefix identifying 'CPS'
**/
##register debug \ cps_debug : int, string -> void

##register [no-projection, restricted : cps] wait \ wait_barrier : Cps.future('a), continuation('a) -> void

/**
 * @param {(number|string)=} name An optional name, used for debugging purposes
 * @return {!Barrier}
 */
function make_barrier(name)
{
    return new Barrier(name);
}

/**
 * Non-blocking wait for a barrier to be [release]d
 *
 * @param {!Barrier} barrier
 * @param {!Continuation} k
 * @return {!*}
 */
function wait_barrier(barrier, k){
    barrier.wait(k);
}

/**
 * Release a [Barrier]
 *
 * @param {!Barrier} barrier
 * @param {!*} x The value to release
 * @return {!*}
 */
function release_barrier(barrier, x){
    barrier.release(x);
}

/**
 * Defined in [qmlCpsClientLib.js]
**/
##register [no-projection : cps, restricted : cps] spawn \ spawn : (_unit, continuation('a) -> _unit) -> Cps.future('a)

/**
 * A bogus empty continuation,used by [uncps_directive]
 */
var empty_continuation = new Continuation(function() {return js_void});

/**
 * @param f A function with OPA type [continuation('a) -> void],
 * converted by CPS into [('a -> unit continuation -> unit) -> unit continuation -> unit)]
 * @param {{apply1}} k A [continuation('a)], which must be called by [f] to return any result
 *
 * This implementation mirrors [QmlCpsServerLib.uncps_directive]
 */
##register [no-projection : cps, restricted : cps] uncps_directive : (('a, _unit_continuation -> _unit), _unit_continuation -> _unit), continuation('a) -> _unit
##args(f, k)
{
    var g = function(a, k2) {
        k.apply1(a);
        k2.apply1();
    };
    return f(g, empty_continuation)//[empty_continuation] is defined in [qmlCpsClientLib.js]
}

/**
 * Thread_context does not really makes sens on the client side.
 * Not clear what this function should return.
 * Currently, the cps mode on the client is not used.
**/
##register [no-projection : cps] thread_context: continuation('a) -> option(opa['thread_context])
##args(b)
{
    cps_assert(false, "[thread_context] client-side thread context not implemented yet");
}

/**
 * Fake implementation of [with_thread_context].
 * Currently implemented as [snd]
**/
##register [no-projection, restricted : cps] with_thread_context : opa['b], continuation('a) -> continuation('a)
##args(tc, b)
{
  //TODO restore options
  //return new Continuation(b.options, b._payload, tc);
  return b;
}


##register [no-projection:cps, restricted:cps] cont_native \ `cont` : ('a -> _unit) -> continuation('a)
function cont(f){
  //return new Continuation(default_options, f, default_thread_context);
    //TODO restore options
    return new Continuation(f);
}

##register [no-projection:cps, restricted:cps] ccont_native \ `ccont` : continuation('b), ('a -> _unit) -> continuation('a)
function ccont(b, f){
  //return b.with_payload(f);
    //TODO restore options
    return new Continuation(f);
}

##register [no-projection, restricted : cps] return \ return_ : continuation('a), 'a -> void
##register [no-projection : cps, restricted : cps] apply\ cps_apply : ('a, continuation('c) -> _unit), 'a, continuation('c) -> _unit

##register [no-projection, restricted : cps] make_barrier    \ make_barrier    : string -> Cps.future('a)
##register [no-projection, restricted : cps] release_barrier \ release_barrier : Cps.future('a), 'a -> void


##register [no-projection, restricted : cps] magic_func : func('a, 'c) -> func('e, 'f)
##args(a)
{ return a; }

##register [no-projection, restricted : cps] black_make_barrier    \ make_barrier    : string -> black_future
##register [no-projection, restricted : cps] black_release_barrier \ release_barrier : black_future, 'a -> void

/**
 * Defined in [qmlCpsClientLib.js]
**/
##register [no-projection, restricted : cps] blocking_wait \ blocking_wait : Cps.future('a) -> 'a
##register [no-projection, restricted : cps] black_blocking_wait \ blocking_wait : black_future -> 'a
##register [no-projection, restricted : cps] loop_schedule \ loop_schedule : opa['d] -> void


/* User ByPass (see, cps.opa) - used by the user, need a projection */
##register user_return \ return_ : continuation('a), 'a -> void


##register user_cont : ('a -> void) -> continuation('a)
##args(f)
{
  // Note cps was not implemented on client side but user_cont it's
  // used it can't be an assert false.
  return cont(f);
}

##register execute : continuation('a), 'a -> void
##args(k, x)
{
  execute(k, x);
}

/**
 * The thread context for this VM
 */
var global_thread_context;
if (command_line_execution) {
  global_thread_context = js_none
} else {
  global_thread_context =
    js_some(normalize_obj(
    {
        key:{
            client:{
                client: getStableCookie(),
                page    : js_some(page_server)
            }},
        request: js_none,
        details:{
            some:{
                locale:  js2list([window.navigator.language]),
                browser: {
                    environment: { Unidentified: js_void },
                    renderer:    { Unidentified: js_void }
                }
            }
        }
    }
    ))
}

##module Notcps_compatibility
##register [opacapi] thread_context : opa['d] -> option(opa['b])
  ##args(a)
  {
      return global_thread_context;
  }

##register with_thread_context : opa['d], 'a -> 'a
  ##args(a, b)
  {
    return b;
  }

##register uncps_directive : (('a -> void) -> void) -> 'a
  ##args(f)
  {
    var cheat = null;
    f( function(x){ cheat = x} );
    return cheat;
  }
##endmodule


/*
function argspush(arg, oldargs){
    var length = arg.length;
    for (var i=0; i < length; i++) oldargs.push(arg[i]);
}


var uncps1 = function(f){
  return function(arg){
    var b = make_barrier();
    cps_apply(f, arg, new Continuation(b.release, b));
    var out = blocking_wait(b);//NOTE: This will fail if function [f] is asynchronous
    return out;
  }
}

var uncps = function(n, f){
  if (n == 1){
    return uncps1(f);
  }else{
    return function(){
      var args = [];
      argspush(arguments, args);
      var a = args.pop();
      var f1 = uncps(n - 1, f);
      var f2 = f1.apply(this, args);
      var out = uncps1(f2)(a);
      return out;
    }
  }
}


var cps1 = function(f){
  return function(arg, k){
    k._payload(f(arg));
    return js_void;
  }
}

var cps = function(n, f){
  if (n == 1){
    return cps1(f);
  }else{
    return function_wrapper(
    function(arg, k)
    {
      k._payload(cps(n - 1, f(arg)));
    }, 2, "cps ??")
  }
}
*/
//S2Hack - This dirty hack should be remove for S3. QmlJs compiler
//should be rewrite this, but it is so dirty and I do not want fix it
//proprely.

// Mathieu Thu Sep 30 20:05:45 CEST 2010
// This hack is deprecated, Maxime, please don't you WANT to remove this, properly ?

var _directive_thread_context_ = %%BslCps.Notcps_compatibility.thread_context%%;
var _directive_with_thread_context_ = function(context, expression){
    return expression
}

##register [no-projection : cps, restricted : cps] callcc_directive : (continuation('a), _unit_continuation -> _unit), continuation('a) -> _unit
##args(f, k)
{
  return f(k, empty_continuation);
}

##register print_trace : continuation(_) -> void
##args(_)
{
    return ;
}