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 #include <string> 30 31 /* String utility functions */ 32 33 /* Flags for gpr_dump function. */ 34 #define GPR_DUMP_HEX 0x00000001 35 #define GPR_DUMP_ASCII 0x00000002 36 37 /* Converts array buf, of length len, into a C string according to the flags. 38 Result should be freed with gpr_free() */ 39 char* gpr_dump(const char* buf, size_t len, uint32_t flags); 40 /* Converts array buf, of length len, into a C string according to the flags. 41 The length of the returned buffer is stored in out_len. 42 Result should be freed with gpr_free() */ 43 char* gpr_dump_return_len(const char* buf, size_t len, uint32_t flags, 44 size_t* out_len); 45 46 /* Parses an array of bytes into an integer (base 10). Returns 1 on success, 47 0 on failure. */ 48 int gpr_parse_bytes_to_uint32(const char* data, size_t length, 49 uint32_t* result); 50 51 /* Minimum buffer size for calling ltoa */ 52 #define GPR_LTOA_MIN_BUFSIZE (3 * sizeof(long)) 53 54 /* Convert a long to a string in base 10; returns the length of the 55 output string (or 0 on failure). 56 output must be at least GPR_LTOA_MIN_BUFSIZE bytes long. */ 57 int gpr_ltoa(long value, char* output); 58 59 /* Minimum buffer size for calling int64toa */ 60 #define GPR_INT64TOA_MIN_BUFSIZE (3 * sizeof(int64_t)) 61 62 /* Convert an int64 to a string in base 10; returns the length of the 63 output string (or 0 on failure). 64 output must be at least GPR_INT64TOA_MIN_BUFSIZE bytes long. 65 NOTE: This function ensures sufficient bit width even on Win x64, 66 where long is 32bit is size.*/ 67 int int64_ttoa(int64_t value, char* output); 68 69 // Parses a non-negative number from a value string. Returns -1 on error. 70 int gpr_parse_nonnegative_int(const char* value); 71 72 /* Reverse a run of bytes */ 73 void gpr_reverse_bytes(char* str, int len); 74 75 /* Pad a string with flag characters. The given length specifies the minimum 76 field width. The input string is never truncated. */ 77 char* gpr_leftpad(const char* str, char flag, size_t length); 78 79 /* Join a set of strings, returning the resulting string. 80 Total combined length (excluding null terminator) is returned in total_length 81 if it is non-null. */ 82 char* gpr_strjoin(const char** strs, size_t nstrs, size_t* total_length); 83 84 /* Join a set of strings using a separator, returning the resulting string. 85 Total combined length (excluding null terminator) is returned in total_length 86 if it is non-null. */ 87 char* gpr_strjoin_sep(const char** strs, size_t nstrs, const char* sep, 88 size_t* total_length); 89 90 void gpr_string_split(const char* input, const char* sep, char*** strs, 91 size_t* nstrs); 92 93 /* Returns a string that represents tm according to RFC-3339, and, 94 more specifically, follows: 95 https://developers.google.com/protocol-buffers/docs/proto3#json 96 97 Uses RFC 3339, where generated output will always be Z-normalized and uses 98 0, 3, 6 or 9 fractional digits. */ 99 std::string gpr_format_timespec(gpr_timespec); 100 101 /** Case insensitive string comparison... return <0 if lower(a)<lower(b), ==0 if 102 lower(a)==lower(b), >0 if lower(a)>lower(b) */ 103 int gpr_stricmp(const char* a, const char* b); 104 int gpr_strincmp(const char* a, const char* b, size_t n); 105 106 void* gpr_memrchr(const void* s, int c, size_t n); 107 108 /* Try to parse given string into a boolean value. 109 When parsed successfully, dst will have the value and returns true. 110 Otherwise, it returns false. */ 111 bool gpr_parse_bool_value(const char* value, bool* dst); 112 113 #endif /* GRPC_CORE_LIB_GPR_STRING_H */ 114