cos-cpp-sdk-v5/include/util/string_util.h

#ifndef COS_CPP_SDK_V5_INCLUDE_UTIL_STRING_UTIL_H_
#define COS_CPP_SDK_V5_INCLUDE_UTIL_STRING_UTIL_H_

#include <stdint.h>

#include <string>

#include "cos_defines.h"
#include "rapidxml/1.13/rapidxml.hpp"
#include "rapidxml/1.13/rapidxml_print.hpp"
#include "rapidxml/1.13/rapidxml_utils.hpp"

namespace qcloud_cos {

class StringUtil {
 public:
  /**
   * @brief 去除string两端的空格
   *
   * @param s: 待去除空格的字符串，是入参也是出参
   *
   * @return 返回去除空格后的字符串,即s
   */
  static std::string& Trim(std::string& s);

  /**
   * @brief 去除string两端指定的字符串
   *
   * @param s: 待去除的字符串，入参
   * @param trim_value: 删除的字符串
   *
   * @return 返回Trim后的字符串
   */
  static std::string Trim(const std::string& s, const std::string& trim_value);

  /**
   * @brief 将xml转为string
   *
   * @param xmlObject 需要转换xml对象
   *
   * @return 返回转换后的string
   */
  static std::string XmlToString(const rapidxml::xml_document<>& xml_doc);

  /**
   * @brief 将string转换为xml
   *
   * @param xmlStr 待转换的string对象
   * @param doc    待返回的xml对象[out]
   *
   * @return 转换成功返回true,否则返回false
   */
  static bool StringToXml(char* xml_str, rapidxml::xml_document<>* doc);

  /**
   * @brief 把uint64_t类型的num转换成std::string,长度为8个字节
   *
   * @param num uint64_t类型
   *
   * @return 转换后的string
   */
  static std::string Uint64ToString(uint64_t num);

  /**
   * @brief 将int转为string
   *
   * @param num int类型
   *
   * @return 转换后的string
   */
  static std::string IntToString(int num);

  /**
   * @brief 将float转为string
   *
   * @param num float类型
   *
   * @return 转换后的string
   */
  static std::string FloatToString(float num);

  /**
   * @brief 字符串就地转成全大写
   *
   * @param s 指向string类型的指针
   *
   * @return void
   */
  static void StringToUpper(std::string* s);

  /**
   * @brief 字符串转成全大写
   *
   * @param s string类型的常引用
   *
   * @return 全大写字符串
   */
  static std::string StringToUpper(const std::string& s);

  /**
   * @brief 字符串就地转成全小写
   *
   * @param s 指向string类型的指针
   *
   * @return void
   */
  static void StringToLower(std::string* s);

  /**
   * @brief 字符串转成全小写
   *
   * @param s string类型的常引用
   *
   * @return 全大写字符串
   */
  static std::string StringToLower(const std::string& s);

  /**
   * @brief 字符串连接
   *
   * @param str_vec 字符串vector
   * @param delimiter 分隔符
   *
   * @return 字符串
   */
  static std::string JoinStrings(const std::vector<std::string>& str_vec,
                                 const std::string& delimiter);

  /**
   * @brief 将string转为uint64_t
   *
   * @param str string类型
   *
   * @return 转换后的uint64_t
   */
  static uint64_t StringToUint64(const std::string& str);

  static unsigned StringToUint32(const std::string& str);

  /**
   * @brief 将string转为int
   *
   * @param str string类型
   *
   * @return 转换后的int
   */
  static int StringToInt(const std::string& str);

  /**
   * @brief 将string转为float
   *
   * @param str string类型
   *
   * @return 转换后的float
   */
  static float StringToFloat(const std::string& str);
  /**
   * @brief 判断字符串是否以指定前缀开头
   *
   * @param str string类型
   * @param prefix string类型
   *
   * @return str的前缀为prefix,则返回true;反之,返回false
   */
  static bool StringStartsWith(const std::string& str,
                               const std::string& prefix);

  /**
   * @brief 判断字符串是否以指定前缀开头(忽略大小写)
   *
   * @param str string类型
   * @param prefix string类型
   *
   * @return str的前缀为prefix,则返回true;反之,返回false
   */
  static bool StringStartsWithIgnoreCase(const std::string& str,
                                         const std::string& prefix);

  /**
   * @brief 移除前缀
   *
   * @param str string类型
   * @param prefix string类型
   *
   * @return 返回移除了prefix前缀的字符串
   */
  static std::string StringRemovePrefix(const std::string& str,
                                        const std::string& prefix);

  /**
   * @brief 判断字符串是否以指定后缀结尾
   *
   * @param str string类型
   * @param suffix string类型
   *
   * @return str的后缀为suffix,则返回true;反之,返回false
   */
  static bool StringEndsWith(const std::string& str, const std::string& suffix);

  /**
   * @brief 判断字符串是否以指定后缀结尾(忽略大小写)
   *
   * @param str string类型
   * @param suffix string类型
   *
   * @return str的后缀为suffix,则返回true;反之,返回false
   */
  static bool StringEndsWithIgnoreCase(const std::string& str,
                                       const std::string& suffix);

  /**
   * @brief 移除后缀
   *
   * @param str string类型
   * @param suffix string类型
   *
   * @return 返回移除了suffix前缀的字符串
   */
  static std::string StringRemoveSuffix(const std::string& str,
                                        const std::string& suffix);

  /**
   * @brief 分割字符串
   *
   * @param str string类型,待分割字符串
   * @param delim char类型,分割符
   * @param vec std::vector类型,分割结果
   *
   * @return void
   */
  static void SplitString(const std::string& str, char delim,
                          std::vector<std::string>* vec);

  /**
   * @brief 分割字符串
   *
   * @param str string类型,待分割字符串
   * @param sep string类型,分割字符串
   * @param vec std::vector类型,分割结果
   *
   * @return void
   */
  static void SplitString(const std::string& str, const std::string& sep,
                          std::vector<std::string>* vec);

  /**
   * @brief 将HTTP_METHOD转成对应的字符串格式
   *
   * @param method HTTP_METHOD
   *
   * @return string
   */
  static std::string HttpMethodToString(HTTP_METHOD method);

  static bool IsV4ETag(const std::string& etag);
  static bool IsMultipartUploadETag(const std::string& etag);

  /**
   * @brief 从字符串中获取uint32整型
   */
  static uint32_t GetUint32FromStrWithBigEndian(const char* str);

  /**
   * @brief 从字符串中获取uint16整型
   */
  static uint16_t GetUint16FromStrWithBigEndian(const char* str);

  static size_t GetLengthFromIStream(std::istream& is);
};
}  // namespace qcloud_cos

#endif  // COS_CPP_SDK_V5_INCLUDE_UTIL_STRING_UTIL_H_