src/CommonsJavaScript/JSCallbackManager.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /*
  17  * @file        JSCallbackManager.h
  18  * @author      Lukasz Marek (l.marel@samsung.com)
  19  * @version     0.1
  20  */
  21
  22 #ifndef WRTDEVICEAPIS_COMMONSJAVASCRIPT_JS_CALLBACK_MANAGER_H_
  23 #define WRTDEVICEAPIS_COMMONSJAVASCRIPT_JS_CALLBACK_MANAGER_H_
  24
  25 #include <dpl/shared_ptr.h>
  26 #include <Commons/IEvent.h>
  27 #include <JavaScriptCore/JavaScript.h>
  28
  29 namespace WrtDeviceApis {
  30 namespace CommonsJavaScript {
  31
  32 class JSCallbackManager;
  33 typedef DPL::SharedPtr<JSCallbackManager> JSCallbackManagerPtr;
  34
  35 class JSCallbackManager : public WrtDeviceApis::Commons::IEventPrivateData
  36 {
  37   private:
  38     JSCallbackManager()
  39     {
  40     }
  41
  42     /**
  43      *  Used to create JSCallbackManagerPtr object by factory method createObject
  44      */
  45     JSCallbackManager(JSContextRef context,
  46             JSObjectRef onSuccess,
  47             JSObjectRef onError);
  48
  49   public:
  50
  51     //JSCallbackManager( JSContextRef context, JSValueRef onSuccess, JSValueRef onError );
  52
  53     /**
  54      * Create JSCallbackManagerPtr object witch checking callback parameters
  55      * if callbacks are NULL it was programmer intention to not use callback and no exception will be rised
  56      * if callbacks are some object but not a function it will rise exception
  57      * @param[in] context - global context
  58      * @param[in] onSuccess - success callback (may be NULL if not needed)
  59      * @param[in] onError   - error callback (may be NULL if not needed)
  60      * @param[in] acceptJSNullAsOnSuccess - converts JSNull on onSuccess to NULL when true
  61      * @param[in] acceptJSNullAsOnError   - converts JSNull on onError to NULL when true
  62      * @throw Commons::InvalidArgumentException - if callback is not null and is not a js function
  63      */
  64     static JSCallbackManagerPtr createObject(
  65             JSContextRef context,
  66             JSValueRef onSuccess = NULL,
  67             JSValueRef onError = NULL,
  68             bool acceptJSNullAsOnSuccess = false,
  69             bool acceptJSNullAsOnError = false);
  70
  71     virtual ~JSCallbackManager();
  72
  73     void setContext(JSContextRef context);
  74
  75     JSContextRef getContext() const
  76     {
  77         return m_context;
  78     }
  79
  80     void setOnSuccess(JSValueRef onSuccess);
  81     JSValueRef getOnSuccess() const;
  82     void setOnError(JSValueRef onError);
  83     JSValueRef getOnError() const;
  84
  85     void callOnSuccess();
  86     void callOnSuccess(JSValueRef obj);
  87     void callOnSuccess(JSValueRef obj[], int paramCount);
  88
  89     void callOnError();
  90     void callOnError(JSValueRef obj);
  91     void callOnError(JSValueRef obj[], int paramCount);
  92
  93   private:
  94     void makeCallback(JSContextRef context,
  95                       JSObjectRef object,
  96                       JSObjectRef callback,
  97                       JSValueRef argv[],
  98                       unsigned argc);
  99
 100     JSObjectRef m_onSuccess;
 101     JSObjectRef m_onError;
 102     JSContextRef m_context;
 103     JSObjectRef m_object;
 104 };
 105
 106 bool isCallback(JSContextRef ctx,
 107                 JSValueRef value,
 108                 JSValueRef* exception);
 109 }
 110 }
 111
 112 #endif // WRTDEVICEAPIS_COMMONSJAVASCRIPT_JS_CALLBACK_MANAGER_H_