Source/WebKit/chromium/README

   1 This directory contains the Chromium WebKit API.
   2
   3
   4 OVERVIEW
   5
   6   The Chromium WebKit API provides a stable interface to WebCore without
   7   revealing any of the WebCore or WTF types to the consumer.
   8
   9   The 'public' directory contains the API headers, and the 'src' directory
  10   contains the API implementation.  The API is intended to be used either as a
  11   shared or static library.
  12
  13
  14 COMPATIBILITY
  15
  16   No attempt is made to support runtime compatibility in a shared library
  17   build.  Instead, the API is intended to support backwards compatibility at
  18   build time.  C++ symbols are allowed in other words.
  19
  20
  21 DEFINES
  22
  23   WEBKIT_IMPLEMENTATION is defined when building the 'src' directory.
  24   Consumers should not define this macro.
  25
  26   WEBKIT_DLL is defined when building as a shared library.  This should be
  27   defined when building the 'src' directory, and it should also be defined by
  28   the consumer to ensure proper linkage to the shared library.
  29
  30   WEBKIT_EXPORT is defined for platforms (e.g., Windows) that require
  31   additional annotations on functions and methods, which should be exported
  32   from WebKit when it is built as a DLL.  In general, this includes all public
  33   methods unless the methods are defined inline, marked pure virtual, or
  34   contained within a WEBKIT_IMPLEMENTATION section.  Also, any private method
  35   called by a public inline-defined method should be annotated with
  36   WEBKIT_EXPORT.  WEBKIT_EXPORT is not used to export whole classes.
  37
  38   WEBKIT_USING_V8 is defined when using V8 as the JavaScript library.
  39
  40   WEBKIT_USING_JSC is defined when using JSC as the JavaScript library.
  41
  42
  43 BASIC TYPES
  44
  45   Use of STL is prohibited except in cases where it would be allowed in
  46   WebCore.  This includes non-allocating uses: algorithms, numeric limits, etc.
  47   WTF container classes should be used in the implementation of this API.
  48
  49   The API includes some usage of WebCore types when WEBKIT_IMPLEMENTATION is
  50   defined.  This is only done for the convenience to the implementation, and
  51   should not be considered part of the Chromium WebKit API.  Similarly, STL
  52   types are assumed when WEBKIT_IMPLEMENTATION is not defined, which is done
  53   for the convenience of the consumer.