// Copyright 2008, Google Inc.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//  3. Neither the name of Google Inc. nor the names of its contributors may be
//     used to endorse or promote products derived from this software without
//     specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifdef USING_CCTESTS

#ifndef GEARS_CCTESTS_TEST_H__
#define GEARS_CCTESTS_TEST_H__

#ifdef WINCE
#include <windows.h>
#include <wininet.h>  // For INTERNET_CACHE_ENTRY_INFO
#endif
#include "gears/base/common/base_class.h"
#include "gears/base/common/common.h"
#include "gears/geolocation/geolocation.h"

class GearsTest : public ModuleImplBaseClassVirtual {
 public:
  GearsTest() : ModuleImplBaseClassVirtual("GearsTest") {}

  // IN: nothing
  // OUT: double time
  void GetSystemTime(JsCallContext *context);

  // IN: nothing
  // OUT: double ticks
  void GetTimingTicks(JsCallContext *context);

  // IN: int64 start, int64 end
  // OUT: double elapsed
  void GetTimingTickDeltaMicros(JsCallContext *context);

  // IN: nothing
  // OUT: nothing
  void RunTests(JsCallContext *context);


  // JsObject and JsArray tests

  // IN: object value
  // OUT: void
  // throws exception on failure
  void TestPassObject(JsCallContext *context);

  // IN: function test_function
  // OUT: object created_object
  // throws exception on failure
  void TestCreateObject(JsCallContext *context);

  // IN: void
  // OUT: object created_object
  // throws exception on failure
  void TestCreateError(JsCallContext *context);
  
  // IN: nothing
  // OUT: nothing
  // throws exception on failure
  void TestObjectProperties(JsCallContext *context);

  // Argument passing tests

  // IN: bool bool_value, int int_value, int64 int64_value, double double_value,
  //     string string_value
  // OUT: void
  void TestPassArguments(JsCallContext *context);

  // IN: function
  // OUT: bool bool_value, int int_value, int64 int64_value,
  //      double double_value, string string_value
  void TestPassArgumentsCallback(JsCallContext *context);

  // IN: int value1, optional int value2, optional int value3
  // OUT: void
  void TestPassArgumentsOptional(JsCallContext *context);

  // Coercion tests

  // IN: variant value, bool expected_value
  // OUT: bool
  void TestCoerceBool(JsCallContext *context);
  // IN: variant value, int expected_value
  // OUT: bool
  void TestCoerceInt(JsCallContext *context);
  // IN: variant value, double expected_value
  // OUT: bool
  void TestCoerceDouble(JsCallContext *context);
  // IN: variant value, string expected_value
  // OUT: bool
  void TestCoerceString(JsCallContext *context);
  // IN: string type, variant value
  // OUT: bool
  void TestGetType(JsCallContext *context);

#ifdef WINCE
  // These methods are used by the JavaScript testBrowserCache test.

  // IN: variant urls
  // OUT: bool
  void RemoveEntriesFromBrowserCache(JsCallContext *context);
  // IN: variant urls, bool should_be_present, bool should_be_bogus
  // OUT: bool
  void TestEntriesPresentInBrowserCache(JsCallContext *context);
#endif

#ifdef OFFICIAL_BUILD
  // The Geolocation API has not been finalized for official builds.
#else
  // Geolocation internal tests.

  // IN: object position_options
  // OUT: object parsed_options
  void TestParseGeolocationOptions(JsCallContext *context);

  // IN: nothing
  // OUT: string request_body
  void TestGeolocationFormRequestBody(JsCallContext *context);

  // IN: string response_body
  // OUT: object position
  void TestGeolocationGetLocationFromResponse(JsCallContext *context);
#endif

#ifndef OFFICIAL_BUILD
  // IN: string input
  // OUT: GearsBlob
  // The resultant Blob's contents will the input string in UTF-8 format.
  void CreateBlobFromString(JsCallContext *context);
#endif

 private:

  DISALLOW_EVIL_CONSTRUCTORS(GearsTest);
};

#ifdef WINCE
// These functions are declared in wince_compatibility.cc. They are wrappers
// around static functions defined there.
INTERNET_CACHE_ENTRY_INFO* GetEntryInfoTest(const char16 *url);
bool IsEntryBogusTest(INTERNET_CACHE_ENTRY_INFO *info);
#endif

#endif // GEARS_CCTESTS_TEST_H__

#endif // USING_CCTESTS