include/grpc/support/string_util.h

   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_SUPPORT_STRING_UTIL_H
  20 #define GRPC_SUPPORT_STRING_UTIL_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include <grpc/impl/codegen/gpr_types.h>
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /** String utility functions */
  31
  32 /** Returns a copy of src that can be passed to gpr_free().
  33    If allocation fails or if src is NULL, returns NULL. */
  34 GPRAPI char* gpr_strdup(const char* src);
  35
  36 /** printf to a newly-allocated string.  The set of supported formats may vary
  37    between platforms.
  38
  39    On success, returns the number of bytes printed (excluding the final '\0'),
  40    and *strp points to a string which must later be destroyed with gpr_free().
  41
  42    On error, returns -1 and sets *strp to NULL. If the format string is bad,
  43    the result is undefined. */
  44 GPRAPI int gpr_asprintf(char** strp, const char* format, ...)
  45     GPR_PRINT_FORMAT_CHECK(2, 3);
  46
  47 #ifdef __cplusplus
  48 }
  49 #endif
  50
  51 #endif /* GRPC_SUPPORT_STRING_UTIL_H */