git.oblomov.eu Git - wine/blob - dlls/jscript/jsstr.h

   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  * This 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 struct _jsstr_t {
  37     unsigned length_flags;
  38     unsigned ref;
  39 };
  40
  41 #define JSSTR_LENGTH_SHIFT 4
  42 #define JSSTR_MAX_LENGTH (1 << (32-JSSTR_LENGTH_SHIFT))
  43 #define JSSTR_FLAGS_MASK ((1 << JSSTR_LENGTH_SHIFT)-1)
  44
  45 #define JSSTR_FLAG_NULLBSTR 4
  46
  47 #define JSSTR_FLAG_LBIT     1
  48 #define JSSTR_FLAG_FLAT     2
  49 #define JSSTR_FLAG_TAG_MASK 3
  50
  51 typedef enum {
  52     JSSTR_INLINE = JSSTR_FLAG_FLAT,
  53     JSSTR_HEAP   = JSSTR_FLAG_FLAT|JSSTR_FLAG_LBIT,
  54     JSSTR_ROPE   = JSSTR_FLAG_LBIT
  55 } jsstr_tag_t;
  56
  57 static inline unsigned jsstr_length(jsstr_t *str)
  58 {
  59     return str->length_flags >> JSSTR_LENGTH_SHIFT;
  60 }
  61
  62 static inline jsstr_tag_t jsstr_tag(jsstr_t *str)
  63 {
  64     return str->length_flags & JSSTR_FLAG_TAG_MASK;
  65 }
  66
  67 static inline BOOL jsstr_is_inline(jsstr_t *str)
  68 {
  69     return jsstr_tag(str) == JSSTR_INLINE;
  70 }
  71
  72 static inline BOOL jsstr_is_heap(jsstr_t *str)
  73 {
  74     return jsstr_tag(str) == JSSTR_HEAP;
  75 }
  76
  77 static inline BOOL jsstr_is_rope(jsstr_t *str)
  78 {
  79     return jsstr_tag(str) == JSSTR_ROPE;
  80 }
  81
  82 typedef struct {
  83     jsstr_t str;
  84     WCHAR buf[1];
  85 } jsstr_inline_t;
  86
  87 typedef struct {
  88     jsstr_t str;
  89     WCHAR *buf;
  90 } jsstr_heap_t;
  91
  92 typedef struct {
  93     jsstr_t str;
  94     jsstr_t *left;
  95     jsstr_t *right;
  96     unsigned depth;
  97 } jsstr_rope_t;
  98
  99 jsstr_t *jsstr_alloc_len(const WCHAR*,unsigned) DECLSPEC_HIDDEN;
 100 WCHAR *jsstr_alloc_buf(unsigned,jsstr_t**) DECLSPEC_HIDDEN;
 101
 102 static inline jsstr_t *jsstr_alloc(const WCHAR *str)
 103 {
 104     return jsstr_alloc_len(str, strlenW(str));
 105 }
 106
 107 void jsstr_free(jsstr_t*) DECLSPEC_HIDDEN;
 108
 109 static inline void jsstr_release(jsstr_t *str)
 110 {
 111     if(!--str->ref) {
 112         if(jsstr_is_inline(str))
 113             heap_free(str);
 114         else
 115             jsstr_free(str);
 116     }
 117 }
 118
 119 static inline jsstr_t *jsstr_addref(jsstr_t *str)
 120 {
 121     str->ref++;
 122     return str;
 123 }
 124
 125 static inline jsstr_inline_t *jsstr_as_inline(jsstr_t *str)
 126 {
 127     return CONTAINING_RECORD(str, jsstr_inline_t, str);
 128 }
 129
 130 static inline jsstr_heap_t *jsstr_as_heap(jsstr_t *str)
 131 {
 132     return CONTAINING_RECORD(str, jsstr_heap_t, str);
 133 }
 134
 135 static inline jsstr_rope_t *jsstr_as_rope(jsstr_t *str)
 136 {
 137     return CONTAINING_RECORD(str, jsstr_rope_t, str);
 138 }
 139
 140 const WCHAR *jsstr_rope_flatten(jsstr_rope_t*) DECLSPEC_HIDDEN;
 141
 142 static inline const WCHAR *jsstr_flatten(jsstr_t *str)
 143 {
 144     return jsstr_is_inline(str) ? jsstr_as_inline(str)->buf
 145         : jsstr_is_heap(str) ? jsstr_as_heap(str)->buf
 146         : jsstr_rope_flatten(jsstr_as_rope(str));
 147 }
 148
 149 void jsstr_extract(jsstr_t*,unsigned,unsigned,WCHAR*) DECLSPEC_HIDDEN;
 150
 151 static inline unsigned jsstr_flush(jsstr_t *str, WCHAR *buf)
 152 {
 153     unsigned len = jsstr_length(str);
 154     if(jsstr_is_inline(str)) {
 155         memcpy(buf, jsstr_as_inline(str)->buf, len*sizeof(WCHAR));
 156     }else if(jsstr_is_heap(str)) {
 157         memcpy(buf, jsstr_as_heap(str)->buf, len*sizeof(WCHAR));
 158     }else {
 159         jsstr_rope_t *rope = jsstr_as_rope(str);
 160         jsstr_flush(rope->left, buf);
 161         jsstr_flush(rope->right, buf+jsstr_length(rope->left));
 162     }
 163     return len;
 164 }
 165
 166 static inline jsstr_t *jsstr_substr(jsstr_t *str, unsigned off, unsigned len)
 167 {
 168     jsstr_t *ret;
 169     WCHAR *ptr;
 170
 171     ptr = jsstr_alloc_buf(len, &ret);
 172     if(ptr)
 173         jsstr_extract(str, off, len, ptr);
 174     return ret;
 175 }
 176
 177 int jsstr_cmp(jsstr_t*,jsstr_t*) DECLSPEC_HIDDEN;
 178
 179 static inline BOOL jsstr_eq(jsstr_t *left, jsstr_t *right)
 180 {
 181     return jsstr_length(left) == jsstr_length(right) && !jsstr_cmp(left, right);
 182 }
 183
 184 jsstr_t *jsstr_concat(jsstr_t*,jsstr_t*) DECLSPEC_HIDDEN;
 185
 186 jsstr_t *jsstr_nan(void) DECLSPEC_HIDDEN;
 187 jsstr_t *jsstr_empty(void) DECLSPEC_HIDDEN;
 188 jsstr_t *jsstr_undefined(void) DECLSPEC_HIDDEN;
 189
 190 BOOL init_strings(void) DECLSPEC_HIDDEN;
 191 void free_strings(void) DECLSPEC_HIDDEN;
 192
 193 const char *debugstr_jsstr(jsstr_t*) DECLSPEC_HIDDEN;