OLD | NEW |
| (Empty) |
1 This directory contains the Chromium WebKit API. It will eventually be | |
2 upstreamed to WebKit/WebKit/chromium in svn.webkit.org. | |
3 | |
4 | |
5 OVERVIEW | |
6 | |
7 The Chromium WebKit API provides a stable interface to WebCore without | |
8 revealing any of the WebCore or WTF types to the consumer. | |
9 | |
10 The 'public' directory contains the API headers, and the 'src' directory | |
11 contains the API implementation. The API is intended to be used either as a | |
12 shared or static library. | |
13 | |
14 | |
15 COMPATIBILITY | |
16 | |
17 No attempt is made to support runtime compatibility in a shared library | |
18 build. Instead, the API is intended to support backwards compatibility at | |
19 build time. C++ symbols are allowed in other words. | |
20 | |
21 | |
22 CODING STYLE | |
23 | |
24 The code in this directory should adhere to the WebKit Coding Style | |
25 Guidelines: http://webkit.org/coding/coding-style.html | |
26 | |
27 | |
28 DEFINES | |
29 | |
30 WEBKIT_IMPLEMENTATION is defined when building the 'src' directory. | |
31 Consumers should not define this macro. | |
32 | |
33 WEBKIT_DLL is defined when building as a shared library. This should be | |
34 defined when building the 'src' directory, and it should also be defined by | |
35 the consumer to ensure proper linkage to the shared library. | |
36 | |
37 | |
38 BASIC TYPES | |
39 | |
40 Use of STL is prohibited except in cases where it would be allowed in | |
41 WebCore. This includes non-allocating uses: algorithms, numeric limits, etc. | |
42 WTF container classes should be used in the implementation of this API. | |
43 | |
44 The API includes some usage of WebCore types when WEBKIT_IMPLEMENTATION is | |
45 defined. This is only done for the convenience to the implementation, and | |
46 should not be considered part of the Chromium WebKit API. Similarly, STL | |
47 types are assumed when WEBKIT_IMPLEMENTATION is not defined, which is done | |
48 for the convenience of the consumer. | |
OLD | NEW |