JsValue.h

/*
 * This file is part of Adblock Plus <https://adblockplus.org/>,
 * Copyright (C) 2006-present eyeo GmbH
 *
 * Adblock Plus is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * Adblock Plus 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ADBLOCK_PLUS_JS_VALUE_H
#define ADBLOCK_PLUS_JS_VALUE_H

#include <stdint.h>
#include <string>
#include <vector>
#include <memory>

#include <AdblockPlus/IFileSystem.h>

namespace v8
{
  class Value;
  class Object;
  template<class T> class Local;
  template<class T> class Global;
}

namespace AdblockPlus
{
  class JsValue;
  class JsEngine;

  typedef std::shared_ptr<JsEngine> JsEnginePtr;

  typedef IFileSystem::IOBuffer StringBuffer;

  typedef std::vector<AdblockPlus::JsValue> JsValueList;

  class JsValue
  {
    friend class JsEngine;
  public:
    JsValue(JsValue&& src);
    JsValue(const JsValue& src);
    virtual ~JsValue();

    JsValue& operator=(const JsValue& src);
    JsValue& operator=(JsValue&& src);

    bool IsUndefined() const;
    bool IsNull() const;
    bool IsString() const;
    bool IsNumber() const;
    bool IsBool() const;
    bool IsObject() const;
    bool IsArray() const;
    bool IsFunction() const;
    std::string AsString() const;
    StringBuffer AsStringBuffer() const;
    int64_t AsInt() const;
    bool AsBool() const;
    JsValueList AsList() const;

    std::vector<std::string> GetOwnPropertyNames() const;

    JsValue GetProperty(const std::string& name) const;


    void SetProperty(const std::string& name, const std::string& val);
    void SetProperty(const std::string& name, const StringBuffer& val);
    void SetProperty(const std::string& name, int64_t val);
    void SetProperty(const std::string& name, bool val);
    void SetProperty(const std::string& name, const JsValue& value);
    inline void SetProperty(const std::string& name, const char* val)
    {
      SetProperty(name, std::string(val));
    }
    inline void SetProperty(const std::string& name, int val)
    {
      SetProperty(name, static_cast<int64_t>(val));
    }

    void SetStringBufferProperty(const std::string& name, const StringBuffer& val);

    std::string GetClass() const;

    JsValue Call(const JsValueList& params = JsValueList()) const;

    JsValue Call(const JsValueList& params, const AdblockPlus::JsValue& thisValue) const;

    JsValue Call(const JsValue& arg) const;

    v8::Local<v8::Value> UnwrapValue() const;

  protected:
    JsEnginePtr jsEngine;
  private:
    JsValue(JsEnginePtr jsEngine, v8::Local<v8::Value> value);
    void SetProperty(const std::string& name, v8::Local<v8::Value> val);

    // Parameter args is not const because a pointer to its internal arrays is
    // passed to v8::Function::Call but the latter does not expect a const pointer.
    JsValue Call(std::vector<v8::Local<v8::Value>>& args, v8::Local<v8::Object> thisObj) const;

    std::unique_ptr<v8::Global<v8::Value>> value;
  };
}

#endif