README

   1 String library.
   2
   3 Structs
   4 -------
   5 String (str.h)
   6 WString (wstr.h)
   7
   8 Functions
   9 ---------
  10 String* str_empty();
  11 String* str_init(unsigned initial_size);
  12 String* str_from_cstr(const char *src, unsigned n);
  13 void    str_reserve(String *str, unsigned n);
  14
  15 int  str_concat_cstr(String *str, const char *cat, unsigned n);
  16 int  str_concat_str(String *str, String *cat);
  17 int  str_push_char(String *str, char c);
  18 int  str_remove_at(String *str, unsigned index);
  19 int  str_remove_range(String *str, unsigned start, unsigned end);
  20 char str_get_at(String *str, unsigned index);
  21 int  str_set_at(String *str, unsigned index, char c);
  22 int  str_insert(String *str, const char *insert, unsigned n, unsigned index);
  23
  24 char*       str_to_cstr(String *str);
  25 char*       str_substring(String *str, unsigned start, unsigned end);
  26 String*     str_dup(String *str);
  27 const char* str_get_buffer(String *str);
  28
  29 size_t str_length(String *str);
  30 char*  str_tok(String *str, char *tokens);
  31 int    str_transform(String *str, char(*func)(char));
  32
  33 void str_shrink(String *str);
  34 void str_clear(String *str);
  35 void str_free(String *str);
  36
  37 Note:
  38 The same functions are available for wide strings.
  39 Replace "str" with "wstr", "String" with "WString", "cstr" with "cwstr" and "char" with "wchar_t"
  40
  41 Building
  42 --------
  43 make: build the library
  44 make install: install the library. Default path: /usr/local, can be modified changing INSTALL_PATH (make install INSTALL_PATH=/usr)
  45 make uninstall: uninstall the library. INSTALL_PATH must be the same as on instalation.
  46 make doxygen: Build doxygen documentation in the ./doxygen folder.
  47 make clean: Cleans binary files