string.h

00001 /*
00002 ** mruby/string.h - String class
00003 **
00004 ** See Copyright Notice in mruby.h
00005 */
00006 
00007 #ifndef MRUBY_STRING_H
00008 #define MRUBY_STRING_H
00009 
00010 #if defined(__cplusplus)
00011 extern "C" {
00012 #endif
00013 
00014 extern const char mrb_digitmap[];
00015 
00016 #define RSTRING_EMBED_LEN_MAX ((mrb_int)(sizeof(void*) * 3 - 1))
00017 
00018 struct RString {
00019   MRB_OBJECT_HEADER;
00020   union {
00021     struct {
00022       mrb_int len;
00023       union {
00024         mrb_int capa;
00025         struct mrb_shared_string *shared;
00026       } aux;
00027       char *ptr;
00028     } heap;
00029     char ary[RSTRING_EMBED_LEN_MAX + 1];
00030   } as;
00031 };
00032 
00033 #define RSTR_EMBED_P(s) ((s)->flags & MRB_STR_EMBED)
00034 #define RSTR_SET_EMBED_FLAG(s) ((s)->flags |= MRB_STR_EMBED)
00035 #define RSTR_UNSET_EMBED_FLAG(s) ((s)->flags &= ~(MRB_STR_EMBED|MRB_STR_EMBED_LEN_MASK))
00036 #define RSTR_SET_EMBED_LEN(s, n) do {\
00037   size_t tmp_n = (n);\
00038   s->flags &= ~MRB_STR_EMBED_LEN_MASK;\
00039   s->flags |= (tmp_n) << MRB_STR_EMBED_LEN_SHIFT;\
00040 } while (0)
00041 #define RSTR_SET_LEN(s, n) do {\
00042   if (RSTR_EMBED_P(s)) {\
00043     RSTR_SET_EMBED_LEN((s),(n));\
00044   } else {\
00045     s->as.heap.len = (mrb_int)(n);\
00046   }\
00047 } while (0)
00048 #define RSTR_EMBED_LEN(s)\
00049   (mrb_int)(((s)->flags & MRB_STR_EMBED_LEN_MASK) >> MRB_STR_EMBED_LEN_SHIFT)
00050 #define RSTR_PTR(s) ((RSTR_EMBED_P(s)) ? (s)->as.ary : (s)->as.heap.ptr)
00051 #define RSTR_LEN(s) ((RSTR_EMBED_P(s)) ? RSTR_EMBED_LEN(s) : (s)->as.heap.len)
00052 #define RSTR_CAPA(s) (RSTR_EMBED_P(s) ? RSTRING_EMBED_LEN_MAX : (s)->as.heap.aux.capa)
00053 
00054 #define RSTR_SHARED_P(s) ((s)->flags & MRB_STR_SHARED)
00055 #define RSTR_SET_SHARED_FLAG(s) ((s)->flags |= MRB_STR_SHARED)
00056 #define RSTR_UNSET_SHARED_FLAG(s) ((s)->flags &= ~MRB_STR_SHARED)
00057 
00058 #define RSTR_NOFREE_P(s) ((s)->flags & MRB_STR_NOFREE)
00059 #define RSTR_SET_NOFREE_FLAG(s) ((s)->flags |= MRB_STR_NOFREE)
00060 #define RSTR_UNSET_NOFREE_FLAG(s) ((s)->flags &= ~MRB_STR_NOFREE)
00061 
00062 #define mrb_str_ptr(s)       ((struct RString*)(mrb_ptr(s)))
00063 #define RSTRING(s)           mrb_str_ptr(s)
00064 #define RSTRING_PTR(s)       RSTR_PTR(RSTRING(s))
00065 #define RSTRING_EMBED_LEN(s) RSTR_ENBED_LEN(RSTRING(s))
00066 #define RSTRING_LEN(s)       RSTR_LEN(RSTRING(s))  
00067 #define RSTRING_CAPA(s)      RSTR_CAPA(RSTRING(s))
00068 #define RSTRING_END(s)       (RSTRING_PTR(s) + RSTRING_LEN(s))
00069 mrb_int mrb_str_strlen(mrb_state*, struct RString*);
00070 
00071 #define MRB_STR_SHARED    1
00072 #define MRB_STR_NOFREE    2
00073 #define MRB_STR_EMBED     4
00074 #define MRB_STR_EMBED_LEN_MASK 0xf8
00075 #define MRB_STR_EMBED_LEN_SHIFT 3
00076 
00077 void mrb_gc_free_str(mrb_state*, struct RString*);
00078 MRB_API void mrb_str_modify(mrb_state*, struct RString*);
00079 MRB_API void mrb_str_concat(mrb_state*, mrb_value, mrb_value);
00080 MRB_API mrb_value mrb_str_plus(mrb_state*, mrb_value, mrb_value);
00081 MRB_API mrb_value mrb_ptr_to_str(mrb_state *, void*);
00082 MRB_API mrb_value mrb_obj_as_string(mrb_state *mrb, mrb_value obj);
00083 MRB_API mrb_value mrb_str_resize(mrb_state *mrb, mrb_value str, mrb_int len);
00084 MRB_API mrb_value mrb_str_substr(mrb_state *mrb, mrb_value str, mrb_int beg, mrb_int len);
00085 MRB_API mrb_value mrb_string_type(mrb_state *mrb, mrb_value str);
00086 MRB_API mrb_value mrb_check_string_type(mrb_state *mrb, mrb_value str);
00087 MRB_API mrb_value mrb_str_buf_new(mrb_state *mrb, size_t capa);
00088 
00089 MRB_API const char *mrb_string_value_cstr(mrb_state *mrb, mrb_value *ptr);
00090 MRB_API const char *mrb_string_value_ptr(mrb_state *mrb, mrb_value ptr);
00091 MRB_API mrb_value mrb_str_dup(mrb_state *mrb, mrb_value str);
00092 MRB_API mrb_value mrb_str_intern(mrb_state *mrb, mrb_value self);
00093 MRB_API mrb_value mrb_str_to_inum(mrb_state *mrb, mrb_value str, mrb_int base, mrb_bool badcheck);
00094 MRB_API double mrb_str_to_dbl(mrb_state *mrb, mrb_value str, mrb_bool badcheck);
00095 MRB_API mrb_value mrb_str_to_str(mrb_state *mrb, mrb_value str);
00096 MRB_API mrb_bool mrb_str_equal(mrb_state *mrb, mrb_value str1, mrb_value str2);
00097 MRB_API mrb_value mrb_str_cat(mrb_state *mrb, mrb_value str, const char *ptr, size_t len);
00098 MRB_API mrb_value mrb_str_cat_cstr(mrb_state *mrb, mrb_value str, const char *ptr);
00099 MRB_API mrb_value mrb_str_cat_str(mrb_state *mrb, mrb_value str, mrb_value str2);
00100 #define mrb_str_cat_lit(mrb, str, lit) mrb_str_cat(mrb, str, lit, mrb_strlen_lit(lit))
00101 MRB_API mrb_value mrb_str_append(mrb_state *mrb, mrb_value str, mrb_value str2);
00102 
00103 MRB_API int mrb_str_cmp(mrb_state *mrb, mrb_value str1, mrb_value str2);
00104 MRB_API char *mrb_str_to_cstr(mrb_state *mrb, mrb_value str);
00105 mrb_value mrb_str_pool(mrb_state *mrb, mrb_value str);
00106 mrb_int mrb_str_hash(mrb_state *mrb, mrb_value str);
00107 mrb_value mrb_str_dump(mrb_state *mrb, mrb_value str);
00108 mrb_value mrb_str_inspect(mrb_state *mrb, mrb_value str);
00109 
00110 void mrb_noregexp(mrb_state *mrb, mrb_value self);
00111 void mrb_regexp_check(mrb_state *mrb, mrb_value obj);
00112 
00113 /* For backward compatibility */
00114 #define mrb_str_cat2(mrb, str, ptr) mrb_str_cat_cstr(mrb, str, ptr)
00115 #define mrb_str_buf_cat(mrb, str, ptr, len) mrb_str_cat(mrb, str, ptr, len)
00116 #define mrb_str_buf_append(mrb, str, str2) mrb_str_cat_str(mrb, str, str2)
00117 
00118 #if defined(__cplusplus)
00119 }  /* extern "C" { */
00120 #endif
00121 
00122 #endif  /* MRUBY_STRING_H */
00123