lib/strutil.h

   1 #ifndef MC_STRUTIL_H
   2 #define MC_STRUTIL_H
   3
   4 #include "lib/global.h"         /* include glib.h */
   5
   6 #include <sys/types.h>
   7 #include <inttypes.h>
   8 #include <string.h>
   9
  10 /* Header file for strutil.c, strutilascii.c, strutil8bit.c, strutilutf8.c.
  11  * There are two sort of functions:
  12  * 1. functions for working with growing strings and conversion strings between
  13  *    different encodings.
  14  *    (implemented directly in strutil.c)
  15  * 2. functions, that hide differences between encodings derived from ASCII.
  16  *    (implemented separately in strutilascii.c, strutil8bit.c, strutilutf8.c)
  17  * documentation is made for UTF-8 version of functions.
  18  */
  19
  20 /* invalid strings
  21  * function, that works with invalid strings are marked with "I"
  22  * in documentation
  23  * invalid bytes of string are handled as one byte characters with width 1, they
  24  * are displayed as questionmarks, I-maked comparing functions try to keep
  25  * the original value of these bytes.
  26  */
  27
  28 /* combining characters
  29  * displaynig: all handled as zero with characters, expect combing character
  30  * at the begin of string, this character has with one (space add before),
  31  * so str_term_width is not good for computing width of singles characters
  32  * (never return zero, expect emtpy string)
  33  * for compatibility are strings composed before displaynig
  34  * comparing: comparing decompose all string before comparing, n-compare
  35  * functions do not work as is usual, because same strings do not have to be
  36  * same length in UTF-8. So they return 0 if one string is prefix of the other
  37  * one.
  38  * str_prefix is used to determine, how many characters from one string are
  39  * prefix in second string. However, str_prefix return number of characters in
  40  * decompose form. (used in do_search (screen.c))
  41  */
  42
  43 /*** typedefs(not structures) and defined constants **********************************************/
  44
  45 #define IS_FIT(x) ((x) & 0x0010)
  46 #define MAKE_FIT(x) ((x) | 0x0010)
  47 #define HIDE_FIT(x) ((x) & 0x000f)
  48
  49 #define INVALID_CONV ((GIConv) (-1))
  50
  51 /*** enums ***************************************************************************************/
  52
  53 /* results of conversion function
  54  */
  55 typedef enum
  56 {
  57     /* success means, that convertion has been finished successully
  58      */
  59     ESTR_SUCCESS = 0,
  60     /* problem means, that not every characters was successfully converted (They are
  61      * replaced with questionmark). So is impossible convert string back.
  62      */
  63     ESTR_PROBLEM = 1,
  64     /* failure means, that conversion is not possible (example: wrong encoding
  65      * of input string)
  66      */
  67     ESTR_FAILURE = 2
  68 } estr_t;
  69
  70 /* alignment strings on terminal
  71  */
  72 typedef enum
  73 {
  74     J_LEFT = 0x01,
  75     J_RIGHT = 0x02,
  76     J_CENTER = 0x03,
  77     /* if there is enough space for string on terminal,
  78      * string is centered otherwise is aligned to left */
  79     J_CENTER_LEFT = 0x04,
  80     /* fit alignment, if string is to long, is truncated with '~' */
  81     J_LEFT_FIT = 0x11,
  82     J_RIGHT_FIT = 0x12,
  83     J_CENTER_FIT = 0x13,
  84     J_CENTER_LEFT_FIT = 0x14
  85 } align_crt_t;
  86
  87 /* string-to-integer parsing results
  88  */
  89 typedef enum
  90 {
  91     LONGINT_OK = 0,
  92
  93     /* These two values can be ORed together, to indicate that both errors occurred. */
  94     LONGINT_OVERFLOW = 1,
  95     LONGINT_INVALID_SUFFIX_CHAR = 2,
  96
  97     LONGINT_INVALID_SUFFIX_CHAR_WITH_OVERFLOW = (LONGINT_INVALID_SUFFIX_CHAR | LONGINT_OVERFLOW),
  98     LONGINT_INVALID = 4
  99 } strtol_error_t;
 100
 101 /*** structures declarations (and typedefs of structures)*****************************************/
 102
 103 /* all functions in str_class must be defined for every encoding */
 104 struct str_class
 105 {
 106     gchar *(*conv_gerror_message) (GError * error, const char *def_msg);
 107       /*I*/ estr_t (*vfs_convert_to) (GIConv coder, const char *string, int size, GString * buffer);
 108       /*I*/ void (*insert_replace_char) (GString * buffer);
 109     int (*is_valid_string) (const char *);
 110       /*I*/ int (*is_valid_char) (const char *, size_t);
 111       /*I*/ void (*cnext_char) (const char **);
 112     void (*cprev_char) (const char **);
 113     void (*cnext_char_safe) (const char **);
 114       /*I*/ void (*cprev_char_safe) (const char **);
 115       /*I*/ int (*cnext_noncomb_char) (const char **text);
 116       /*I*/ int (*cprev_noncomb_char) (const char **text, const char *begin);
 117       /*I*/ int (*char_isspace) (const char *);
 118       /*I*/ int (*char_ispunct) (const char *);
 119       /*I*/ int (*char_isalnum) (const char *);
 120       /*I*/ int (*char_isdigit) (const char *);
 121       /*I*/ int (*char_isprint) (const char *);
 122       /*I*/ gboolean (*char_iscombiningmark) (const char *);
 123       /*I*/ int (*length) (const char *);
 124       /*I*/ int (*length2) (const char *, int);
 125       /*I*/ int (*length_noncomb) (const char *);
 126       /*I*/ int (*char_toupper) (const char *, char **, size_t *);
 127     int (*char_tolower) (const char *, char **, size_t *);
 128     void (*fix_string) (char *);
 129       /*I*/ const char *(*term_form) (const char *);
 130       /*I*/ const char *(*fit_to_term) (const char *, int, align_crt_t);
 131       /*I*/ const char *(*term_trim) (const char *text, int width);
 132       /*I*/ const char *(*term_substring) (const char *, int, int);
 133       /*I*/ int (*term_width1) (const char *);
 134       /*I*/ int (*term_width2) (const char *, size_t);
 135       /*I*/ int (*term_char_width) (const char *);
 136       /*I*/ const char *(*trunc) (const char *, int);
 137       /*I*/ int (*offset_to_pos) (const char *, size_t);
 138       /*I*/ int (*column_to_pos) (const char *, size_t);
 139       /*I*/ char *(*create_search_needle) (const char *, int);
 140     void (*release_search_needle) (char *, int);
 141     const char *(*search_first) (const char *, const char *, int);
 142     const char *(*search_last) (const char *, const char *, int);
 143     int (*compare) (const char *, const char *);
 144       /*I*/ int (*ncompare) (const char *, const char *);
 145       /*I*/ int (*casecmp) (const char *, const char *);
 146       /*I*/ int (*ncasecmp) (const char *, const char *);
 147       /*I*/ int (*prefix) (const char *, const char *);
 148       /*I*/ int (*caseprefix) (const char *, const char *);
 149       /*I*/ char *(*create_key) (const char *text, int case_sen);
 150       /*I*/ char *(*create_key_for_filename) (const char *text, int case_sen);
 151       /*I*/ int (*key_collate) (const char *t1, const char *t2, int case_sen);
 152       /*I*/ void (*release_key) (char *key, int case_sen);
 153   /*I*/};
 154
 155 /*** global variables defined in .c file *********************************************************/
 156
 157 /* standard convertors */
 158 extern GIConv str_cnv_to_term;
 159 extern GIConv str_cnv_from_term;
 160 /* from terminal encoding to terminal encoding */
 161 extern GIConv str_cnv_not_convert;
 162
 163 /*** declarations of public functions ************************************************************/
 164
 165 struct str_class str_utf8_init (void);
 166 struct str_class str_8bit_init (void);
 167 struct str_class str_ascii_init (void);
 168
 169 /* create convertor from "from_enc" to terminal encoding
 170  * if "from_enc" is not supported return INVALID_CONV
 171  */
 172 GIConv str_crt_conv_from (const char *);
 173
 174 /* create convertor from terminal encoding to "to_enc"
 175  * if "to_enc" is not supported return INVALID_CONV
 176  */
 177 GIConv str_crt_conv_to (const char *);
 178
 179 /* close convertor, do not close str_cnv_to_term, str_cnv_from_term,
 180  * str_cnv_not_convert
 181  */
 182 void str_close_conv (GIConv);
 183
 184 /* return on of not used buffers (.used == 0) or create new
 185  * returned buffer has set .used to 1
 186  */
 187
 188 /* convert string using coder, result of conversion is appended at end of buffer
 189  * return ESTR_SUCCESS if there was no problem.
 190  * otherwise return  ESTR_PROBLEM or ESTR_FAILURE
 191  */
 192 estr_t str_convert (GIConv, const char *, GString *);
 193 estr_t str_nconvert (GIConv, const char *, int, GString *);
 194
 195 /* convert GError message (which in UTF-8) to terminal charset
 196  * def_char is used if result of error->str conversion if ESTR_FAILURE
 197  * return new allocated null-terminated string, which is need to be freed
 198  * I
 199  */
 200 gchar *str_conv_gerror_message (GError * error, const char *def_msg);
 201
 202 /* return only ESTR_SUCCESS or ESTR_FAILURE, because vfs must be able to convert
 203  * result to original string. (so no replace with questionmark)
 204  * if coder is str_cnv_from_term or str_cnv_not_convert, string is only copied,
 205  * so is possible to show file, that is not valid in terminal encoding
 206  */
 207 estr_t str_vfs_convert_from (GIConv, const char *, GString *);
 208
 209 /* if coder is str_cnv_to_term or str_cnv_not_convert, string is only copied,
 210  * does replace with questionmark
 211  * I
 212  */
 213 estr_t str_vfs_convert_to (GIConv, const char *, int, GString *);
 214
 215 /* printf function for str_buffer, append result of printf at the end of buffer
 216  */
 217 /* *INDENT-OFF* */
 218 void str_printf (GString * buffer, const char *format, ...) G_GNUC_PRINTF (2, 3);
 219 /* *INDENT-ON* */
 220
 221 /* add standard replacement character in terminal encoding
 222  */
 223 void str_insert_replace_char (GString *);
 224
 225 /* init strings and set terminal encoding,
 226  * if is termenc NULL, detect terminal encoding
 227  * create all str_cnv_* and set functions for terminal encoding
 228  */
 229 void str_init_strings (const char *termenc);
 230
 231 /* free all str_buffer and all str_cnv_*
 232  */
 233 void str_uninit_strings (void);
 234
 235 /* try convert characters in ch to output using conv
 236  * ch_size is size of ch, can by (size_t)(-1) (-1 only for ASCII
 237  *     compatible encoding, for other must be set)
 238  * return ESTR_SUCCESS if conversion was successfully,
 239  * ESTR_PROBLEM if ch contains only part of characters,
 240  * ESTR_FAILURE if conversion is not possible
 241  */
 242 estr_t str_translate_char (GIConv conv, const char *ch, size_t ch_size,
 243                            char *output, size_t out_size);
 244
 245 /* test, if text is valid in terminal encoding
 246  * I
 247  */
 248 int str_is_valid_string (const char *text);
 249
 250 /* test, if first char of ch is valid
 251  * size, how many bytes characters occupied, could be (size_t)(-1)
 252  * return 1 if it is valid, -1 if it is invalid or -2 if it is only part of
 253  * multibyte character
 254  * I
 255  */
 256 int str_is_valid_char (const char *ch, size_t size);
 257
 258 /* return next characters after text, do not call on the end of string
 259  */
 260 char *str_get_next_char (char *text);
 261 const char *str_cget_next_char (const char *text);
 262
 263 /* return previous characters before text, do not call on the start of strings
 264  */
 265 char *str_get_prev_char (char *text);
 266 const char *str_cget_prev_char (const char *text);
 267
 268 /* set text to next characters, do not call on the end of string
 269  */
 270 void str_next_char (char **text);
 271 void str_cnext_char (const char **text);
 272
 273 /* set text to previous characters, do not call on the start of strings
 274  */
 275 void str_prev_char (char **text);
 276 void str_cprev_char (const char **text);
 277
 278 /* return next characters after text, do not call on the end of string
 279  * works with invalid string
 280  * I
 281  */
 282 char *str_get_next_char_safe (char *text);
 283 const char *str_cget_next_char_safe (const char *text);
 284
 285 /* return previous characters before text, do not call on the start of strings
 286  * works with invalid string
 287  * I
 288  */
 289 char *str_get_prev_char_safe (char *text);
 290 const char *str_cget_prev_char_safe (const char *text);
 291
 292 /* set text to next characters, do not call on the end of string
 293  * works with invalid string
 294  * I
 295  */
 296 void str_next_char_safe (char **text);
 297 void str_cnext_char_safe (const char **text);
 298
 299 /* set text to previous characters, do not call on the start of strings
 300  * works with invalid string
 301  * I
 302  */
 303 void str_prev_char_safe (char **text);
 304 void str_cprev_char_safe (const char **text);
 305
 306 /* set text to next noncombining characters, check the end of text
 307  * return how many characters was skipped
 308  * works with invalid string
 309  * I
 310  */
 311 int str_next_noncomb_char (char **text);
 312 int str_cnext_noncomb_char (const char **text);
 313
 314 /* set text to previous noncombining characters, search stop at begin
 315  * return how many characters was skipped
 316  * works with invalid string
 317  * I
 318  */
 319 int str_prev_noncomb_char (char **text, const char *begin);
 320 int str_cprev_noncomb_char (const char **text, const char *begin);
 321
 322 /* if first characters in ch is space, tabulator  or new lines
 323  * I
 324  */
 325 int str_isspace (const char *ch);
 326
 327 /* if first characters in ch is punctuation or symbol
 328  * I
 329  */
 330 int str_ispunct (const char *ch);
 331
 332 /* if first characters in ch is alphanum
 333  * I
 334  */
 335 int str_isalnum (const char *ch);
 336
 337 /* if first characters in ch is digit
 338  * I
 339  */
 340 int str_isdigit (const char *ch);
 341
 342 /* if first characters in ch is printable
 343  * I
 344  */
 345 int str_isprint (const char *ch);
 346
 347 /* if first characters in ch is a combining mark (only in utf-8)
 348  * combining makrs are assumed to be zero width
 349  * I
 350  */
 351 gboolean str_iscombiningmark (const char *ch);
 352
 353 /* write lower from of fisrt characters in ch into out
 354  * decrase remain by size of returned characters
 355  * if out is not big enough, do nothing
 356  */
 357 int str_toupper (const char *ch, char **out, size_t * remain);
 358
 359 /* write upper from of fisrt characters in ch into out
 360  * decrase remain by size of returned characters
 361  * if out is not big enough, do nothing
 362  */
 363 int str_tolower (const char *ch, char **out, size_t * remain);
 364
 365 /* return length of text in characters
 366  * I
 367  */
 368 int str_length (const char *text);
 369
 370 /* return length of text in characters, limit to size
 371  * I
 372  */
 373 int str_length2 (const char *text, int size);
 374
 375 /* return length of one char
 376  * I
 377  */
 378 int str_length_char (const char *);
 379
 380 /* return length of text in characters, count only noncombining characters
 381  * I
 382  */
 383 int str_length_noncomb (const char *text);
 384
 385 /* replace all invalid characters in text with questionmark
 386  * after return, text is valid string in terminal encoding
 387  * I
 388  */
 389 void str_fix_string (char *text);
 390
 391 /* replace all invalid characters in text with questionmark
 392  * replace all unprintable characters with '.'
 393  * return static allocated string, "text" is not changed
 394  * returned string do not need to be freed
 395  * I
 396  */
 397 const char *str_term_form (const char *text);
 398
 399 /* like str_term_form, but text can be alignment to width
 400  * alignment is specified in just_mode (J_LEFT, J_LEFT_FIT, ...)
 401  * result is completed with spaces to width
 402  * I
 403  */
 404 const char *str_fit_to_term (const char *text, int width, align_crt_t just_mode);
 405
 406 /* like str_term_form, but when text is wider than width, three dots are
 407  * inserted at begin and result is completed with suffix of text
 408  * no additional spaces are inserted
 409  * I
 410  */
 411 const char *str_term_trim (const char *text, int width);
 412
 413
 414 /* like str_term_form, but return only specified substring
 415  * start - column (position) on terminal, where substring begin
 416  * result is completed with spaces to width
 417  * I
 418  */
 419 const char *str_term_substring (const char *text, int start, int width);
 420
 421 /* return width, that will be text occupied on terminal
 422  * I
 423  */
 424 int str_term_width1 (const char *text);
 425
 426 /* return width, that will be text occupied on terminal
 427  * text is limited by length in characters
 428  * I
 429  */
 430 int str_term_width2 (const char *text, size_t length);
 431
 432 /* return width, that will be character occupied on terminal
 433  * combining characters are always zero width
 434  * I
 435  */
 436 int str_term_char_width (const char *text);
 437
 438 /* convert position in characters to position in bytes
 439  * I
 440  */
 441 int str_offset_to_pos (const char *text, size_t length);
 442
 443 /* convert position on terminal to position in characters
 444  * I
 445  */
 446 int str_column_to_pos (const char *text, size_t pos);
 447
 448 /* like str_fit_to_term width just_mode = J_LEFT_FIT,
 449  * but do not insert additional spaces
 450  * I
 451  */
 452 const char *str_trunc (const char *text, int width);
 453
 454 /* create needle, that will be searched in str_search_fist/last,
 455  * so needle can be reused
 456  * in UTF-8 return normalized form of needle
 457  */
 458 char *str_create_search_needle (const char *needle, int case_sen);
 459
 460 /* free needle returned by str_create_search_needle
 461  */
 462 void str_release_search_needle (char *needle, int case_sen);
 463
 464 /* search for first occurrence of search in text
 465  */
 466 const char *str_search_first (const char *text, const char *needle, int case_sen);
 467
 468 /* search for last occurrence of search in text
 469  */
 470 const char *str_search_last (const char *text, const char *needle, int case_sen);
 471
 472 /* case sensitive compare two strings
 473  * I
 474  */
 475 int str_compare (const char *t1, const char *t2);
 476
 477 /* case sensitive compare two strings
 478  * if one string is prefix of the other string, return 0
 479  * I
 480  */
 481 int str_ncompare (const char *t1, const char *t2);
 482
 483 /* case insensitive compare two strings
 484  * I
 485  */
 486 int str_casecmp (const char *t1, const char *t2);
 487
 488 /* case insensitive compare two strings
 489  * if one string is prefix of the other string, return 0
 490  * I
 491  */
 492 int str_ncasecmp (const char *t1, const char *t2);
 493
 494 /* return, how many bytes are are same from start in text and prefix
 495  * both strings are decomposed before comparing and return value is counted
 496  * in decomposed form, too. calling with prefix, prefix, you get size in bytes
 497  * of prefix in decomposed form,
 498  * I
 499  */
 500 int str_prefix (const char *text, const char *prefix);
 501
 502 /* case insensitive version of str_prefix
 503  * I
 504  */
 505 int str_caseprefix (const char *text, const char *prefix);
 506
 507 /* create a key that is used by str_key_collate
 508  * I
 509  */
 510 char *str_create_key (const char *text, int case_sen);
 511
 512 /* create a key that is used by str_key_collate
 513  * should aware dot '.' in text
 514  * I
 515  */
 516 char *str_create_key_for_filename (const char *text, int case_sen);
 517
 518 /* compare two string using LC_COLLATE, if is possible
 519  * if case_sen is set, comparing is case sensitive,
 520  * case_sen must be same for str_create_key, str_key_collate and str_release_key
 521  * I
 522  */
 523 int str_key_collate (const char *t1, const char *t2, int case_sen);
 524
 525 /* release_key created by str_create_key, only rigth way to release key
 526  * I
 527  */
 528 void str_release_key (char *key, int case_sen);
 529
 530 /* return TRUE if codeset_name is utf8 or utf-8
 531  * I
 532  */
 533 gboolean str_isutf8 (const char *codeset_name);
 534
 535 const char *str_detect_termencoding (void);
 536
 537 int str_verscmp (const char *s1, const char *s2);
 538
 539 /* return how many lines and columns will text occupy on terminal
 540  */
 541 void str_msg_term_size (const char *text, int *lines, int *columns);
 542
 543 /**
 544  * skip first needle's in haystack
 545  *
 546  * @param haystack pointer to string
 547  * @param needle pointer to string
 548  * @param skip_count skip first bytes
 549  *
 550  * @return pointer to skip_count+1 needle (or NULL if not found).
 551  */
 552
 553 char *strrstr_skip_count (const char *haystack, const char *needle, size_t skip_count);
 554
 555 char *str_replace_all (const char *haystack, const char *needle, const char *replacement);
 556
 557 strtol_error_t xstrtoumax (const char *s, char **ptr, int base, uintmax_t * val,
 558                            const char *valid_suffixes);
 559 uintmax_t parse_integer (const char *str, gboolean * invalid);
 560
 561 /* --------------------------------------------------------------------------------------------- */
 562 /*** inline functions ****************************************************************************/
 563 /* --------------------------------------------------------------------------------------------- */
 564
 565 static inline void
 566 str_replace (char *s, char from, char to)
 567 {
 568     for (; *s != '\0'; s++)
 569     {
 570         if (*s == from)
 571             *s = to;
 572     }
 573 }
 574
 575 /* --------------------------------------------------------------------------------------------- */
 576 /*
 577  * strcpy is unsafe on overlapping memory areas, so define memmove-alike
 578  * string function.
 579  * Have sense only when:
 580  *  * dest <= src
 581  *   AND
 582  *  * dest and str are pointers to one object (as Roland Illig pointed).
 583  *
 584  * We can't use str*cpy funs here:
 585  * http://kerneltrap.org/mailarchive/openbsd-misc/2008/5/27/1951294
 586  *
 587  * @param dest pointer to string
 588  * @param src pointer to string
 589  *
 590  * @return newly allocated string
 591  *
 592  */
 593
 594 static inline char *
 595 str_move (char *dest, const char *src)
 596 {
 597     size_t n;
 598
 599     g_assert (dest <= src);
 600
 601     n = strlen (src) + 1;       /* + '\0' */
 602
 603     return (char *) memmove (dest, src, n);
 604 }
 605
 606 /* --------------------------------------------------------------------------------------------- */
 607
 608 #endif /* MC_STRUTIL_H */