third_party/ot-br-posix/repo/src/utils/strcpy_utils.hpp

   1 /*
   2  *  Copyright (c) 2017-2019, The OpenThread Authors.
   3  *  All rights reserved.
   4  *
   5  *  Redistribution and use in source and binary forms, with or without
   6  *  modification, are permitted provided that the following conditions are met:
   7  *  1. Redistributions of source code must retain the above copyright
   8  *     notice, this list of conditions and the following disclaimer.
   9  *  2. Redistributions in binary form must reproduce the above copyright
  10  *     notice, this list of conditions and the following disclaimer in the
  11  *     documentation and/or other materials provided with the distribution.
  12  *  3. Neither the name of the copyright holder nor the
  13  *     names of its contributors may be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  *  POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /**
  30  * @file
  31  * This file includes definition for strcpy_safe().
  32  */
  33
  34 #ifndef OTBR_UTILS_STRCPY_UTILS_HPP_
  35 #define OTBR_UTILS_STRCPY_UTILS_HPP_
  36
  37 #include "openthread-br/config.h"
  38
  39 #include <string.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  * This method is a safe version of strcpy always ensuring last byte to be 0
  47  * If strlen(aSrc) >= n, the string will be truncated
  48  *
  49  * @param[out] aDest      dest string
  50  * @param[in]  aDestSize  size of dest string buffer
  51  * @param[in]  aSrc       src string
  52  *
  53  * @returns 0 on success, -1 on error
  54  *
  55  */
  56 int strcpy_safe(char *aDest, size_t aDestSize, const char *aSrc);
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif
  61
  62 #endif // OTBR_UTILS_STRCPY_UTILS_HPP_