cpp/IEDriver/Script.h

// Copyright 2011 Software Freedom Conservancy
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef WEBDRIVER_IE_SCRIPT_H_
#define WEBDRIVER_IE_SCRIPT_H_

#include <string>
#include "json.h"
#include "Element.h"

using namespace std;

namespace webdriver {

// Forward declaration of classes to avoid
// circular include files.
class Browser;
class IECommandExecutor;

class Script {
 public:
  Script(IHTMLDocument2* document,
         std::string script_source,
         unsigned long argument_count);
  Script(IHTMLDocument2* document,
         std::wstring script_source,
         unsigned long argument_count);
  ~Script(void);

  std::wstring source_code() const { return this->source_code_; }
  unsigned long argument_count() const { return this->argument_count_; }
  SAFEARRAY* arguments() { return this->argument_array_; }
  VARIANT result() { return this->result_; }
  void set_result(VARIANT value) {
    HRESULT hr = ::VariantCopy(&this->result_, &value);
  }

  void AddArgument(const std::string& argument);
  void AddArgument(const std::wstring& argument);
  void AddArgument(const int argument);
  void AddArgument(const double argument);
  void AddArgument(const bool argument);
  void AddArgument(ElementHandle argument);
  void AddArgument(IHTMLElement* argument);
  void AddArgument(VARIANT argument);
  void AddNullArgument(void);

  bool ResultIsEmpty(void);
  bool ResultIsString(void);
  bool ResultIsInteger(void);
  bool ResultIsBoolean(void);
  bool ResultIsDouble(void);
  bool ResultIsArray(void);
  bool ResultIsObject(void);
  bool ResultIsElement(void);
  bool ResultIsElementCollection(void);
  bool ResultIsIDispatch(void);

  int Execute(void);
  int ConvertResultToJsonValue(const IECommandExecutor& executor,
                               Json::Value* value);
  bool ConvertResultToString(std::string* value);

 private:
  int GetArrayLength(long* length);
  int GetArrayItem(const IECommandExecutor& executor,
                   long index,
                   Json::Value* item);
  int GetPropertyNameList(std::wstring* property_names);
  int GetPropertyValue(const IECommandExecutor& executor,
                       const std::wstring& property_name,
                       Json::Value* property_value);
  std::wstring GetResultObjectTypeName(void);
  bool CreateAnonymousFunction(VARIANT* result);
  void Initialize(IHTMLDocument2* document,
                  const std::wstring& script_source,
                  const unsigned long argument_count);

  CComPtr<IHTMLDocument2> script_engine_host_;
  unsigned long argument_count_;
  std::wstring source_code_;
  long current_arg_index_;
  SAFEARRAY* argument_array_;
  VARIANT result_;
};

} // namespace webdriver

#endif // WEBDRIVER_IE_SCRIPT_H_