Functions with no parameters in WebKit/Shared/API/c and WebKit/UIProcess/API/C are
[WebKit-https.git] / Source / WebKit / Shared / API / c / WKString.h
1 /*
2  * Copyright (C) 2010 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WKString_h
27 #define WKString_h
28
29 #include <WebKit/WKBase.h>
30 #include <stddef.h>
31
32 #ifndef __cplusplus
33 #include <stdbool.h>
34 #endif
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #if !defined(WIN32) && !defined(_WIN32) \
41     && !((defined(__CC_ARM) || defined(__ARMCC__)) && !defined(__linux__)) /* RVCT */
42     typedef unsigned short WKChar;
43 #else
44     typedef wchar_t WKChar;
45 #endif
46
47 WK_EXPORT WKTypeID WKStringGetTypeID(void);
48
49 WK_EXPORT WKStringRef WKStringCreateWithUTF8CString(const char* string);
50
51 WK_EXPORT bool WKStringIsEmpty(WKStringRef string);
52
53 WK_EXPORT size_t WKStringGetLength(WKStringRef string);
54 WK_EXPORT size_t WKStringGetCharacters(WKStringRef string, WKChar* buffer, size_t bufferLength);
55
56 WK_EXPORT size_t WKStringGetMaximumUTF8CStringSize(WKStringRef string);
57 WK_EXPORT size_t WKStringGetUTF8CString(WKStringRef string, char* buffer, size_t bufferSize);
58 WK_EXPORT size_t WKStringGetUTF8CStringNonStrict(WKStringRef string, char* buffer, size_t bufferSize);
59
60 WK_EXPORT bool WKStringIsEqual(WKStringRef a, WKStringRef b);
61 WK_EXPORT bool WKStringIsEqualToUTF8CString(WKStringRef a, const char* b);
62 WK_EXPORT bool WKStringIsEqualToUTF8CStringIgnoringCase(WKStringRef a, const char* b);
63
64 #ifdef __cplusplus
65 }
66 #endif
67
68 #endif /* WKString_h */