LLVM OpenMP* Runtime Library
kmp_str.h
1 /*
2  * kmp_str.h -- String manipulation routines.
3  */
4 
5 
6 //===----------------------------------------------------------------------===//
7 //
8 // The LLVM Compiler Infrastructure
9 //
10 // This file is dual licensed under the MIT and the University of Illinois Open
11 // Source Licenses. See LICENSE.txt for details.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 
16 #ifndef KMP_STR_H
17 #define KMP_STR_H
18 
19 #include <string.h>
20 #include <stdarg.h>
21 
22 #include "kmp_os.h"
23 
24 #ifdef __cplusplus
25  extern "C" {
26 #endif // __cplusplus
27 
28 #if KMP_OS_WINDOWS
29 # define strdup _strdup
30 #endif
31 
32 /* some macros to replace ctype.h functions */
33 #define TOLOWER(c) ((((c) >= 'A') && ((c) <= 'Z')) ? ((c) + 'a' - 'A') : (c))
34 
35 struct kmp_str_buf {
36  char * str; // Pointer to buffer content, read only.
37  unsigned int size; // Do not change this field!
38  int used; // Number of characters printed to buffer, read only.
39  char bulk[ 512 ]; // Do not use this field!
40 }; // struct kmp_str_buf
41 typedef struct kmp_str_buf kmp_str_buf_t;
42 
43 #define __kmp_str_buf_init( b ) { (b)->str = (b)->bulk; (b)->size = sizeof( (b)->bulk ); (b)->used = 0; (b)->bulk[ 0 ] = 0; }
44 
45 void __kmp_str_buf_clear( kmp_str_buf_t * buffer );
46 void __kmp_str_buf_reserve( kmp_str_buf_t * buffer, int size );
47 void __kmp_str_buf_detach( kmp_str_buf_t * buffer );
48 void __kmp_str_buf_free( kmp_str_buf_t * buffer );
49 void __kmp_str_buf_cat( kmp_str_buf_t * buffer, char const * str, int len );
50 void __kmp_str_buf_vprint( kmp_str_buf_t * buffer, char const * format, va_list args );
51 void __kmp_str_buf_print( kmp_str_buf_t * buffer, char const * format, ... );
52 void __kmp_str_buf_print_size( kmp_str_buf_t * buffer, size_t size );
53 
54 /*
55  File name parser. Usage:
56 
57  kmp_str_fname_t fname = __kmp_str_fname_init( path );
58  // Use fname.path (copy of original path ), fname.dir, fname.base.
59  // Note fname.dir concatenated with fname.base gives exact copy of path.
60  __kmp_str_fname_free( & fname );
61 
62 */
63 struct kmp_str_fname {
64  char * path;
65  char * dir;
66  char * base;
67 }; // struct kmp_str_fname
68 typedef struct kmp_str_fname kmp_str_fname_t;
69 void __kmp_str_fname_init( kmp_str_fname_t * fname, char const * path );
70 void __kmp_str_fname_free( kmp_str_fname_t * fname );
71 // Compares file name with specified patern. If pattern is NULL, any fname matched.
72 int __kmp_str_fname_match( kmp_str_fname_t const * fname, char const * pattern );
73 
74 /*
75  The compiler provides source locations in string form ";file;func;line;col;;". It not not
76  convenient for manupulation. These structure keeps source location in more convenient form.
77  Usage:
78 
79  kmp_str_loc_t loc = __kmp_str_loc_init( ident->psource, 0 );
80  // use loc.file, loc.func, loc.line, loc.col.
81  // loc.fname is available if the second argument of __kmp_str_loc_init is true.
82  __kmp_str_loc_free( & loc );
83 
84  If psource is NULL or does not follow format above, file and/or func may be NULL pointers.
85 */
86 struct kmp_str_loc {
87  char * _bulk; // Do not use thid field.
88  kmp_str_fname_t fname; // Will be initialized if init_fname is true.
89  char * file;
90  char * func;
91  int line;
92  int col;
93 }; // struct kmp_str_loc
94 typedef struct kmp_str_loc kmp_str_loc_t;
95 kmp_str_loc_t __kmp_str_loc_init( char const * psource, int init_fname );
96 void __kmp_str_loc_free( kmp_str_loc_t * loc );
97 
98 int __kmp_str_eqf( char const * lhs, char const * rhs );
99 char * __kmp_str_format( char const * format, ... );
100 void __kmp_str_free( char const * * str );
101 int __kmp_str_match( char const * target, int len, char const * data );
102 int __kmp_str_match_false( char const * data );
103 int __kmp_str_match_true( char const * data );
104 void __kmp_str_replace( char * str, char search_for, char replace_with );
105 void __kmp_str_split( char * str, char delim, char ** head, char ** tail );
106 char * __kmp_str_token( char * str, char const * delim, char ** buf );
107 int __kmp_str_to_int( char const * str, char sentinel );
108 
109 void __kmp_str_to_size( char const * str, size_t * out, size_t dfactor, char const * * error );
110 void __kmp_str_to_uint( char const * str, kmp_uint64 * out, char const * * error );
111 
112 #ifdef __cplusplus
113  } // extern "C"
114 #endif // __cplusplus
115 
116 #endif // KMP_STR_H
117 
118 // end of file //
119