kernel/generic/include/str.h

   1 /*
   2  * Copyright (c) 2001-2004 Jakub Jermar
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup generic
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_STR_H_
  36 #define KERN_STR_H_
  37
  38 #include <typedefs.h>
  39
  40 /**< Common Unicode characters */
  41 #define U_SPECIAL      '?'
  42
  43 #define U_LEFT_ARROW   0x2190
  44 #define U_UP_ARROW     0x2191
  45 #define U_RIGHT_ARROW  0x2192
  46 #define U_DOWN_ARROW   0x2193
  47
  48 #define U_PAGE_UP      0x21de
  49 #define U_PAGE_DOWN    0x21df
  50
  51 #define U_HOME_ARROW   0x21f1
  52 #define U_END_ARROW    0x21f2
  53
  54 #define U_NULL         0x2400
  55 #define U_ESCAPE       0x241b
  56 #define U_DELETE       0x2421
  57
  58 #define U_CURSOR       0x2588
  59
  60 /**< No size limit constant */
  61 #define STR_NO_LIMIT  ((size_t) -1)
  62
  63 /**< Maximum size of a string containing cnt characters */
  64 #define STR_BOUNDS(cnt)  (cnt << 2)
  65
  66 extern wchar_t str_decode(const char *str, size_t *offset, size_t sz);
  67 extern int chr_encode(wchar_t ch, char *str, size_t *offset, size_t sz);
  68
  69 extern size_t str_size(const char *str);
  70 extern size_t wstr_size(const wchar_t *str);
  71
  72 extern size_t str_lsize(const char *str, size_t max_len);
  73 extern size_t wstr_lsize(const wchar_t *str, size_t max_len);
  74
  75 extern size_t str_length(const char *str);
  76 extern size_t wstr_length(const wchar_t *wstr);
  77
  78 extern size_t str_nlength(const char *str, size_t size);
  79 extern size_t wstr_nlength(const wchar_t *str, size_t size);
  80
  81 extern bool ascii_check(wchar_t ch);
  82 extern bool chr_check(wchar_t ch);
  83
  84 extern int str_cmp(const char *s1, const char *s2);
  85 extern int str_lcmp(const char *s1, const char *s2, size_t max_len);
  86
  87 extern void str_cpy(char *dest, size_t size, const char *src);
  88 extern void str_ncpy(char *dest, size_t size, const char *src, size_t n);
  89 extern void wstr_to_str(char *dest, size_t size, const wchar_t *src);
  90
  91 extern char *str_dup(const char *src);
  92 extern char *str_ndup(const char *src, size_t n);
  93
  94 extern char *str_chr(const char *str, wchar_t ch);
  95
  96 extern bool wstr_linsert(wchar_t *str, wchar_t ch, size_t pos, size_t max_pos);
  97 extern bool wstr_remove(wchar_t *str, size_t pos);
  98
  99 extern int str_uint64_t(const char *, char **, unsigned int, bool, uint64_t *);
 100
 101 extern void order_suffix(const uint64_t, uint64_t *, char *);
 102 extern void bin_order_suffix(const uint64_t, uint64_t *, const char **, bool);
 103
 104 #endif
 105
 106 /** @}
 107  */