third_party/WebKit/public/web/WebKit.h

   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 v8 {
  37 class Isolate;
  38 }
  39
  40 namespace blink {
  41
  42 // Must be called on the thread that will be the main WebKit thread before
  43 // using any other WebKit APIs. The provided Platform; must be
  44 // non-null and must remain valid until the current thread calls shutdown.
  45 BLINK_EXPORT void initialize(Platform*);
  46
  47 // Must be called on the thread that will be the main WebKit thread before
  48 // using any other WebKit APIs. The provided Platform must be
  49 // non-null and must remain valid until the current thread calls shutdown.
  50 //
  51 // This is a special variant of initialize that does not intitialize V8.
  52 BLINK_EXPORT void initializeWithoutV8(Platform*);
  53
  54 // Get the V8 Isolate for the main thread.
  55 // initialize must have been called first.
  56 BLINK_EXPORT v8::Isolate* mainThreadIsolate();
  57
  58 // Once shutdown, the Platform passed to initialize will no longer
  59 // be accessed. No other WebKit objects should be in use when this function is
  60 // called. Any background threads created by WebKit are promised to be
  61 // terminated by the time this function returns.
  62 BLINK_EXPORT void shutdown();
  63
  64 // Once shutdown, the Platform passed to initializeWithoutV8 will no longer
  65 // be accessed. No other WebKit objects should be in use when this function is
  66 // called. Any background threads created by WebKit are promised to be
  67 // terminated by the time this function returns.
  68 //
  69 // If initializeWithoutV8() was used to initialize WebKit, shutdownWithoutV8
  70 // must be called to shut it down again.
  71 BLINK_EXPORT void shutdownWithoutV8();
  72
  73 // Alters the rendering of content to conform to a fixed set of rules.
  74 BLINK_EXPORT void setLayoutTestMode(bool);
  75 BLINK_EXPORT bool layoutTestMode();
  76
  77 // Alters the rendering of fonts for layout tests.
  78 BLINK_EXPORT void setFontAntialiasingEnabledForTest(bool);
  79 BLINK_EXPORT bool fontAntialiasingEnabledForTest();
  80
  81 // Enables the named log channel. See WebCore/platform/Logging.h for details.
  82 BLINK_EXPORT void enableLogChannel(const char*);
  83
  84 // Purge the plugin list cache. If |reloadPages| is true, any pages
  85 // containing plugins will be reloaded after refreshing the plugin list.
  86 BLINK_EXPORT void resetPluginCache(bool reloadPages = false);
  87
  88 // The embedder should call this periodically in an attempt to balance overall
  89 // performance and memory usage.
  90 BLINK_EXPORT void decommitFreeableMemory();
  91
  92 } // namespace blink
  93
  94 #endif