// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_TEST_WEBDRIVER_COMMANDS_WEBDRIVER_COMMAND_H_
#define CHROME_TEST_WEBDRIVER_COMMANDS_WEBDRIVER_COMMAND_H_

#include <string>
#include <vector>

#include "chrome/test/webdriver/session_manager.h"
#include "chrome/test/webdriver/commands/command.h"

namespace webdriver {

// All URLs that are found in the document:
// http://code.google.com/p/selenium/wiki/JsonWireProtocol
// and are to be supported for all browsers and platforms should inhert
// this class.  For cases which do not invlove interaction with the
// browser, such a transfering a file, inhert from the Command class
// directly.
class WebDriverCommand : public Command {
 public:
  inline WebDriverCommand(const std::vector<std::string> path_segments,
                          const DictionaryValue* const parameters)
      : Command(path_segments, parameters), session_(NULL) {}
  virtual ~WebDriverCommand() {}

  // Initializes this webdriver command by fetching the command session and,
  // if necessary, verifying the session has a valid TabProxy.
  virtual bool Init(Response* const response);

 protected:
  static const std::string kElementDictionaryKey;

  // Tests if |dictionary| contains the kElementDictionaryKey, which
  // indicates that it represents an element.
  static bool IsElementIdDictionary(const DictionaryValue* const dictionary);

  // Returns the |element_id| as a DictionaryValue that conforms with
  // WebDriver's wire protocol. On success, returns a dynamically allocated
  // object that the caller is responsible for deleting. Returns NULL on
  // failure.
  DictionaryValue* GetElementIdAsDictionaryValue(const std::string& element_id);

  // Returns whether this command requires a valid TabProxy upon
  // initialization.
  virtual bool RequiresValidTab() { return true; }

  // Returns whether this command has a valid TabProxy. Returns true on
  // success. Otherwise, returns false and populates the |resposne| with the
  // necessary information to return to the client.
  bool VerifyTabIsValid(Response* response);

  Session* session_;
  scoped_refptr<TabProxy> tab_;

  DISALLOW_COPY_AND_ASSIGN(WebDriverCommand);
};

}  // namespace webdriver

#endif  // CHROME_TEST_WEBDRIVER_COMMANDS_WEBDRIVER_COMMAND_H_