Home | History | Annotate | Download | only in web
      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 "../platform/Platform.h"
     35 
     36 namespace WebKit {
     37 
     38 // Must be called on the thread that will be the main WebKit thread before
     39 // using any other WebKit APIs. The provided Platform; must be
     40 // non-null and must remain valid until the current thread calls shutdown.
     41 WEBKIT_EXPORT void initialize(Platform*);
     42 
     43 // Must be called on the thread that will be the main WebKit thread before
     44 // using any other WebKit APIs. The provided Platform must be
     45 // non-null and must remain valid until the current thread calls shutdown.
     46 //
     47 // This is a special variant of initialize that does not intitialize V8.
     48 WEBKIT_EXPORT void initializeWithoutV8(Platform*);
     49 
     50 // Once shutdown, the Platform passed to initialize will no longer
     51 // be accessed. No other WebKit objects should be in use when this function is
     52 // called. Any background threads created by WebKit are promised to be
     53 // terminated by the time this function returns.
     54 WEBKIT_EXPORT void shutdown();
     55 
     56 // Once shutdown, the Platform passed to initializeWithoutV8 will no longer
     57 // be accessed. No other WebKit objects should be in use when this function is
     58 // called. Any background threads created by WebKit are promised to be
     59 // terminated by the time this function returns.
     60 //
     61 // If initializeWithoutV8() was used to initialize WebKit, shutdownWithoutV8
     62 // must be called to shut it down again.
     63 WEBKIT_EXPORT void shutdownWithoutV8();
     64 
     65 // Alters the rendering of content to conform to a fixed set of rules.
     66 WEBKIT_EXPORT void setLayoutTestMode(bool);
     67 WEBKIT_EXPORT bool layoutTestMode();
     68 
     69 // Enables the named log channel. See WebCore/platform/Logging.h for details.
     70 WEBKIT_EXPORT void enableLogChannel(const char*);
     71 
     72 // Purge the plugin list cache. If |reloadPages| is true, any pages
     73 // containing plugins will be reloaded after refreshing the plugin list.
     74 WEBKIT_EXPORT void resetPluginCache(bool reloadPages);
     75 
     76 } // namespace WebKit
     77 
     78 #endif
     79