WebKit/Source/JavaScriptCore/API/JSStringRef.h at main · WebKit/WebKit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
 * Copyright (C) 2006 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndefJSStringRef_h
#defineJSStringRef_h

#include<JavaScriptCore/JSValueRef.h>

#ifndef__cplusplus
#include<stdbool.h>
#endif
#include<stddef.h>/* for size_t */

#ifdef__cplusplus
extern"C" {
#endif

#if !defined(_NATIVE_WCHAR_T_DEFINED) /* MSVC */ \
&& (!defined(__WCHAR_MAX__) || (__WCHAR_MAX__>0xffffU)) /* ISO C/C++ */ \
&& (!defined(WCHAR_MAX) || (WCHAR_MAX>0xffffU)) /* RVCT */
/*!
@typedef JSChar
@abstract A UTF-16 code unit. One, or a sequence of two, can encode any Unicode
 character. As with all scalar types, endianness depends on the underlying
 architecture.
*/
typedefunsigned shortJSChar;
#else
typedefwchar_tJSChar;
#endif

/*!
@function
@abstract Creates a JavaScript string from a buffer of Unicode characters.
@param chars The buffer of Unicode characters to copy into the new JSString.
@param numChars The number of characters to copy from the buffer pointed to by chars.
@result A JSString containing chars. Ownership follows the Create Rule.
*/
JS_EXPORTJSStringRefJSStringCreateWithCharacters(constJSChar*chars, size_tnumChars);
/*!
@function
@abstract Creates a JavaScript string from a null-terminated UTF8 string.
@param string The null-terminated UTF8 string to copy into the new JSString.
@result A JSString containing string. Ownership follows the Create Rule.
*/
JS_EXPORTJSStringRefJSStringCreateWithUTF8CString(constchar*string);

/*!
@function
@abstract Retains a JavaScript string.
@param string The JSString to retain.
@result A JSString that is the same as string.
*/
JS_EXPORTJSStringRefJSStringRetain(JSStringRefstring);
/*!
@function
@abstract Releases a JavaScript string.
@param string The JSString to release.
*/
JS_EXPORTvoidJSStringRelease(JSStringRefstring);

/*!
@function
@abstract Returns the number of Unicode characters in a JavaScript string.
@param string The JSString whose length (in Unicode characters) you want to know.
@result The number of Unicode characters stored in string.
*/
JS_EXPORTsize_tJSStringGetLength(JSStringRefstring);
/*!
@function
@abstract Returns a pointer to the Unicode character buffer that
 serves as the backing store for a JavaScript string.
@param string The JSString whose backing store you want to access.
@result A pointer to the Unicode character buffer that serves as string's
 backing store, which will be deallocated when string is deallocated.
*/
JS_EXPORTconstJSChar*JSStringGetCharactersPtr(JSStringRefstring);

/*!
@function
@abstract Returns the maximum number of bytes a JavaScript string will
 take up if converted into a null-terminated UTF8 string.
@param string The JSString whose maximum converted size (in bytes) you
 want to know.
@result The maximum number of bytes that could be required to convert string into a
 null-terminated UTF8 string. The number of bytes that the conversion actually ends
 up requiring could be less than this, but never more.
*/
JS_EXPORTsize_tJSStringGetMaximumUTF8CStringSize(JSStringRefstring);
/*!
@function
@abstract Converts a JavaScript string into a null-terminated UTF8 string,
 and copies the result into an external byte buffer.
@param string The source JSString.
@param buffer The destination byte buffer into which to copy a null-terminated
 UTF8 representation of string. On return, buffer contains a UTF8 string
 representation of string. If bufferSize is too small, buffer will contain only
 partial results. If buffer is not at least bufferSize bytes in size,
 behavior is undefined.
@param bufferSize The size of the external buffer in bytes.
@result The number of bytes written into buffer (including the null-terminator byte).
*/
JS_EXPORTsize_tJSStringGetUTF8CString(JSStringRefstring, char*buffer, size_tbufferSize);

/*!
@function
@abstract Tests whether two JavaScript strings match.
@param a The first JSString to test.
@param b The second JSString to test.
@result true if the two strings match, otherwise false.
*/
JS_EXPORTboolJSStringIsEqual(JSStringRefa, JSStringRefb);
/*!
@function
@abstract Tests whether a JavaScript string matches a null-terminated UTF8 string.
@param a The JSString to test.
@param b The null-terminated UTF8 string to test.
@result true if the two strings match, otherwise false.
*/
JS_EXPORTboolJSStringIsEqualToUTF8CString(JSStringRefa, constchar*b);

#ifdef__cplusplus
}
#endif

#endif/* JSStringRef_h */