1 /* 2 * 3 * Copyright 2015 gRPC authors. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 */ 18 19 #ifndef GRPC_CORE_LIB_GPR_STRING_H 20 #define GRPC_CORE_LIB_GPR_STRING_H 21 22 #include <grpc/support/port_platform.h> 23 24 #include <grpc/impl/codegen/gpr_types.h> 25 26 #include <stdbool.h> 27 #include <stddef.h> 28 29 /* String utility functions */ 30 31 /* Flags for gpr_dump function. */ 32 #define GPR_DUMP_HEX 0x00000001 33 #define GPR_DUMP_ASCII 0x00000002 34 35 /* Converts array buf, of length len, into a C string according to the flags. 36 Result should be freed with gpr_free() */ 37 char* gpr_dump(const char* buf, size_t len, uint32_t flags); 38 39 /* Parses an array of bytes into an integer (base 10). Returns 1 on success, 40 0 on failure. */ 41 int gpr_parse_bytes_to_uint32(const char* data, size_t length, 42 uint32_t* result); 43 44 /* Minimum buffer size for calling ltoa */ 45 #define GPR_LTOA_MIN_BUFSIZE (3 * sizeof(long)) 46 47 /* Convert a long to a string in base 10; returns the length of the 48 output string (or 0 on failure). 49 output must be at least GPR_LTOA_MIN_BUFSIZE bytes long. */ 50 int gpr_ltoa(long value, char* output); 51 52 /* Minimum buffer size for calling int64toa */ 53 #define GPR_INT64TOA_MIN_BUFSIZE (3 * sizeof(int64_t)) 54 55 /* Convert an int64 to a string in base 10; returns the length of the 56 output string (or 0 on failure). 57 output must be at least GPR_INT64TOA_MIN_BUFSIZE bytes long. 58 NOTE: This function ensures sufficient bit width even on Win x64, 59 where long is 32bit is size.*/ 60 int int64_ttoa(int64_t value, char* output); 61 62 // Parses a non-negative number from a value string. Returns -1 on error. 63 int gpr_parse_nonnegative_int(const char* value); 64 65 /* Reverse a run of bytes */ 66 void gpr_reverse_bytes(char* str, int len); 67 68 /* Pad a string with flag characters. The given length specifies the minimum 69 field width. The input string is never truncated. */ 70 char* gpr_leftpad(const char* str, char flag, size_t length); 71 72 /* Join a set of strings, returning the resulting string. 73 Total combined length (excluding null terminator) is returned in total_length 74 if it is non-null. */ 75 char* gpr_strjoin(const char** strs, size_t nstrs, size_t* total_length); 76 77 /* Join a set of strings using a separator, returning the resulting string. 78 Total combined length (excluding null terminator) is returned in total_length 79 if it is non-null. */ 80 char* gpr_strjoin_sep(const char** strs, size_t nstrs, const char* sep, 81 size_t* total_length); 82 83 void gpr_string_split(const char* input, const char* sep, char*** strs, 84 size_t* nstrs); 85 86 /* Returns an allocated string that represents tm according to RFC-3339, and, 87 more specifically, follows: 88 https://developers.google.com/protocol-buffers/docs/proto3#json 89 90 Uses RFC 3339, where generated output will always be Z-normalized and uses 91 0, 3, 6 or 9 fractional digits. */ 92 char* gpr_format_timespec(gpr_timespec); 93 94 /* A vector of strings... for building up a final string one piece at a time */ 95 typedef struct { 96 char** strs; 97 size_t count; 98 size_t capacity; 99 } gpr_strvec; 100 101 /* Initialize/destroy */ 102 void gpr_strvec_init(gpr_strvec* strs); 103 void gpr_strvec_destroy(gpr_strvec* strs); 104 /* Add a string to a strvec, takes ownership of the string */ 105 void gpr_strvec_add(gpr_strvec* strs, char* add); 106 /* Return a joined string with all added substrings, optionally setting 107 total_length as per gpr_strjoin */ 108 char* gpr_strvec_flatten(gpr_strvec* strs, size_t* total_length); 109 110 /** Case insensitive string comparison... return <0 if lower(a)<lower(b), ==0 if 111 lower(a)==lower(b), >0 if lower(a)>lower(b) */ 112 int gpr_stricmp(const char* a, const char* b); 113 114 void* gpr_memrchr(const void* s, int c, size_t n); 115 116 /** Return true if lower(s) equals "true", "yes" or "1", otherwise false. */ 117 bool gpr_is_true(const char* s); 118 119 #endif /* GRPC_CORE_LIB_GPR_STRING_H */ 120