ReactOS 0.4.15-dev-8241-g63935f8
jsstr.h
Go to the documentation of this file.
1/*
2 * Copyright 2012 Jacek Caban for CodeWeavers
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
17 */
18
19/*
20 * jsstr_t is a common header for all string representations. The exact layout of the string
21 * representation may be:
22 *
23 * - inline string - string bytes directly follow string headers.
24 * - heap string - a structure containing a pointer to buffer on the heap.
25 * - roper string - a product of concatenation of two strings. Instead of copying whole
26 * buffers, we may store just references to concatenated strings.
27 *
28 * String layout may change over life time of the string. Currently possible transformation
29 * is when a rope string becomes a heap stream. That happens when we need a real, linear
30 * zero-terminated buffer (a flat buffer). At this point the type of the string is changed
31 * and the new buffer is stored in the string, so that subsequent operations requiring
32 * a flat string won't need to flatten it again.
33 *
34 * In the future more layouts and transformations may be added.
35 */
36
37#pragma once
38
39struct _jsstr_t {
40 unsigned length_flags;
41 unsigned ref;
42};
43
44#define JSSTR_LENGTH_SHIFT 4
45#define JSSTR_MAX_LENGTH ((1 << (32-JSSTR_LENGTH_SHIFT))-1)
46#define JSSTR_FLAGS_MASK ((1 << JSSTR_LENGTH_SHIFT)-1)
47
48#define JSSTR_FLAG_LBIT 1
49#define JSSTR_FLAG_FLAT 2
50#define JSSTR_FLAG_TAG_MASK 3
51
52typedef enum {
57
58static inline unsigned jsstr_length(jsstr_t *str)
59{
60 return str->length_flags >> JSSTR_LENGTH_SHIFT;
61}
62
64{
65 return str->length_flags & JSSTR_FLAG_TAG_MASK;
66}
67
69{
70 return jsstr_tag(str) == JSSTR_INLINE;
71}
72
74{
75 return jsstr_tag(str) == JSSTR_HEAP;
76}
77
79{
80 return jsstr_tag(str) == JSSTR_ROPE;
81}
82
83typedef struct {
87
88typedef struct {
92
93typedef struct {
97 unsigned depth;
99
102
103static inline jsstr_t *jsstr_alloc(const WCHAR *str)
104{
106}
107
109
110static inline void jsstr_release(jsstr_t *str)
111{
112 if(!--str->ref)
114}
115
117{
118 str->ref++;
119 return str;
120}
121
123{
125}
126
128{
130}
131
133{
135}
136
138
139static inline const WCHAR *jsstr_flatten(jsstr_t *str)
140{
144}
145
146void jsstr_extract(jsstr_t*,unsigned,unsigned,WCHAR*) DECLSPEC_HIDDEN;
147
148static inline unsigned jsstr_flush(jsstr_t *str, WCHAR *buf)
149{
150 unsigned len = jsstr_length(str);
151 if(jsstr_is_inline(str)) {
153 }else if(jsstr_is_heap(str)) {
154 memcpy(buf, jsstr_as_heap(str)->buf, len*sizeof(WCHAR));
155 }else {
157 jsstr_flush(rope->left, buf);
158 jsstr_flush(rope->right, buf+jsstr_length(rope->left));
159 }
160 return len;
161}
162
163static inline jsstr_t *jsstr_substr(jsstr_t *str, unsigned off, unsigned len)
164{
165 jsstr_t *ret;
166 WCHAR *ptr;
167
169 if(ret)
170 jsstr_extract(str, off, len, ptr);
171 return ret;
172}
173
175
177{
179}
180
182
186
189
192
Definition: _rope.h:1087
#define DECLSPEC_HIDDEN
Definition: precomp.h:8
#define lstrlenW
Definition: compat.h:750
unsigned int BOOL
Definition: ntddk_ex.h:94
GLdouble GLdouble right
Definition: glext.h:10859
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition: glext.h:7751
GLint left
Definition: glext.h:7726
GLenum GLsizei len
Definition: glext.h:6722
jsstr_t * jsstr_alloc_len(const WCHAR *, unsigned) DECLSPEC_HIDDEN
Definition: jsstr.c:86
jsstr_t * jsstr_nan(void) DECLSPEC_HIDDEN
Definition: jsstr.c:283
jsstr_t * jsstr_empty(void) DECLSPEC_HIDDEN
Definition: jsstr.c:288
const WCHAR * jsstr_rope_flatten(jsstr_rope_t *) DECLSPEC_HIDDEN
Definition: jsstr.c:262
static jsstr_t * jsstr_substr(jsstr_t *str, unsigned off, unsigned len)
Definition: jsstr.h:163
jsstr_t * jsstr_alloc_buf(unsigned, WCHAR **) DECLSPEC_HIDDEN
Definition: jsstr.c:69
static jsstr_t * jsstr_addref(jsstr_t *str)
Definition: jsstr.h:116
static const WCHAR * jsstr_flatten(jsstr_t *str)
Definition: jsstr.h:139
#define JSSTR_FLAG_LBIT
Definition: jsstr.h:48
void jsstr_free(jsstr_t *) DECLSPEC_HIDDEN
Definition: jsstr.c:44
BOOL init_strings(void) DECLSPEC_HIDDEN
Definition: jsstr.c:308
static BOOL jsstr_eq(jsstr_t *left, jsstr_t *right)
Definition: jsstr.h:176
static void jsstr_release(jsstr_t *str)
Definition: jsstr.h:110
void jsstr_extract(jsstr_t *, unsigned, unsigned, WCHAR *) DECLSPEC_HIDDEN
Definition: jsstr.c:113
static jsstr_inline_t * jsstr_as_inline(jsstr_t *str)
Definition: jsstr.h:122
static unsigned jsstr_length(jsstr_t *str)
Definition: jsstr.h:58
#define JSSTR_LENGTH_SHIFT
Definition: jsstr.h:44
#define JSSTR_FLAG_FLAT
Definition: jsstr.h:49
#define JSSTR_FLAG_TAG_MASK
Definition: jsstr.h:50
static BOOL jsstr_is_rope(jsstr_t *str)
Definition: jsstr.h:78
static jsstr_tag_t jsstr_tag(jsstr_t *str)
Definition: jsstr.h:63
const char * debugstr_jsstr(jsstr_t *) DECLSPEC_HIDDEN
Definition: jsstr.c:37
static jsstr_heap_t * jsstr_as_heap(jsstr_t *str)
Definition: jsstr.h:127
jsstr_t * jsstr_undefined(void) DECLSPEC_HIDDEN
Definition: jsstr.c:293
static BOOL jsstr_is_heap(jsstr_t *str)
Definition: jsstr.h:73
static unsigned jsstr_flush(jsstr_t *str, WCHAR *buf)
Definition: jsstr.h:148
static jsstr_t * jsstr_alloc(const WCHAR *str)
Definition: jsstr.h:103
static BOOL jsstr_is_inline(jsstr_t *str)
Definition: jsstr.h:68
jsstr_t * jsstr_concat(jsstr_t *, jsstr_t *) DECLSPEC_HIDDEN
Definition: jsstr.c:211
jsstr_t * jsstr_null_bstr(void) DECLSPEC_HIDDEN
Definition: jsstr.c:298
static jsstr_rope_t * jsstr_as_rope(jsstr_t *str)
Definition: jsstr.h:132
jsstr_tag_t
Definition: jsstr.h:52
@ JSSTR_INLINE
Definition: jsstr.h:53
@ JSSTR_HEAP
Definition: jsstr.h:54
@ JSSTR_ROPE
Definition: jsstr.h:55
BOOL is_null_bstr(jsstr_t *) DECLSPEC_HIDDEN
Definition: jsstr.c:303
int jsstr_cmp(jsstr_t *, jsstr_t *) DECLSPEC_HIDDEN
Definition: jsstr.c:189
void free_strings(void) DECLSPEC_HIDDEN
Definition: jsstr.c:325
#define memcpy(s1, s2, n)
Definition: mkisofs.h:878
static PVOID ptr
Definition: dispmode.c:27
const WCHAR * str
Definition: jsstr.h:39
unsigned ref
Definition: jsstr.h:41
unsigned length_flags
Definition: jsstr.h:40
jsstr_t str
Definition: jsstr.h:89
WCHAR * buf
Definition: jsstr.h:90
jsstr_t str
Definition: jsstr.h:84
WCHAR buf[1]
Definition: jsstr.h:85
jsstr_t * left
Definition: jsstr.h:95
jsstr_t str
Definition: jsstr.h:94
jsstr_t * right
Definition: jsstr.h:96
unsigned depth
Definition: jsstr.h:97
#define CONTAINING_RECORD(address, type, field)
Definition: typedefs.h:260
int ret
__wchar_t WCHAR
Definition: xmlstorage.h:180