1/*
2 * Copyright (C) 2009 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef WebKit_h
32#define WebKit_h
33
34#include "WebCommon.h"
35
36namespace WebKit {
37
38class WebKitClient;
39
40// Must be called on the thread that will be the main WebKit thread before
41// using any other WebKit APIs.  The provided WebKitClient must be non-null
42// and must remain valid until the current thread calls shutdown.
43WEBKIT_API void initialize(WebKitClient*);
44
45// Once shutdown, the WebKitClient passed to initialize will no longer be
46// accessed.  No other WebKit objects should be in use when this function
47// is called.  Any background threads created by WebKit are promised to be
48// terminated by the time this function returns.
49WEBKIT_API void shutdown();
50
51// Returns the WebKitClient instance passed to initialize.
52WEBKIT_API WebKitClient* webKitClient();
53
54// Alters the rendering of content to conform to a fixed set of rules.
55WEBKIT_API void setLayoutTestMode(bool);
56WEBKIT_API bool layoutTestMode();
57
58// Enables the named log channel.  See WebCore/platform/Logging.h for details.
59WEBKIT_API void enableLogChannel(const char*);
60
61// Purge the plugin list cache. If |reloadPages| is true, any pages
62// containing plugins will be reloaded after refreshing the plugin list.
63WEBKIT_API void resetPluginCache(bool reloadPages);
64
65} // namespace WebKit
66
67#endif
68