muduo::StringPiece

muduo::StringPiece

为什么要有这个StringPiece类?
C++里面有string和char*，如果你用const string &s 做函数形参，可以同时兼容两种字符串。但当你传入一个很长的char * 时，char*转string，创建一个临时string对象,同时开辟一个内存空间，拷贝字符串, 开销比较大。如果你的目的仅仅是读取字符串的值，用这个StringPiece的话，仅仅是4+一个指针的内存开销，而且也保证了兼容性。所以这个类的目的是传入字符串的字面值，它内部的ptr_ 这块内存不归他所有。所以不能做任何改动。归根结底，是处于性能的考虑，用以实现高效的字符串传递，这里既可以用const char*，也可以用std::string类型作为参数，并且不涉及内存拷贝。
实际上，这个类是google提供的一个类。

// For passing C-style string argument to a function.
class StringArg // copyable
{
 public:
  StringArg(const char* str)
    : str_(str)
  { }

  StringArg(const string& str)
    : str_(str.c_str())
  { }

#ifndef MUDUO_STD_STRING
  StringArg(const std::string& str)
    : str_(str.c_str())
  { }
#endif

  const char* c_str() const { return str_; }

 private:
  const char* str_;
};

class StringPiece {
 private:
  const char*   ptr_;
  int           length_;

 public:
  // We provide non-explicit singleton constructors so users can pass
  // in a "const char*" or a "string" wherever a "StringPiece" is
  // expected.
  StringPiece()
    : ptr_(NULL), length_(0) { }
  StringPiece(const char* str)
    : ptr_(str), length_(static_cast<int>(strlen(ptr_))) { }
  StringPiece(const unsigned char* str)
    : ptr_(reinterpret_cast<const char*>(str)),
      length_(static_cast<int>(strlen(ptr_))) { }
  StringPiece(const string& str)
    : ptr_(str.data()), length_(static_cast<int>(str.size())) { }
#ifndef MUDUO_STD_STRING
  StringPiece(const std::string& str)
    : ptr_(str.data()), length_(static_cast<int>(str.size())) { }
#endif
  StringPiece(const char* offset, int len)
    : ptr_(offset), length_(len) { }

  // data() may return a pointer to a buffer with embedded NULs, and the
  // returned buffer may or may not be null terminated.  Therefore it is
  // typically a mistake to pass data() to a routine that expects a NUL
  // terminated string.  Use "as_string().c_str()" if you really need to do
  // this.  Or better yet, change your routine so it does not rely on NUL
  // termination.
  const char* data() const { return ptr_; }
  int size() const { return length_; }
  bool empty() const { return length_ == 0; }
  const char* begin() const { return ptr_; }
  const char* end() const { return ptr_ + length_; }

  void clear() { ptr_ = NULL; length_ = 0; }
  void set(const char* buffer, int len) { ptr_ = buffer; length_ = len; }
  void set(const char* str) {
    ptr_ = str;
    length_ = static_cast<int>(strlen(str));
  }
  void set(const void* buffer, int len) {
    ptr_ = reinterpret_cast<const char*>(buffer);
    length_ = len;
  }

  char operator[](int i) const { return ptr_[i]; }

  void remove_prefix(int n) {
    ptr_ += n;
    length_ -= n;
  }

  void remove_suffix(int n) {
    length_ -= n;
  }

  bool operator==(const StringPiece& x) const {
    return ((length_ == x.length_) &&
            (memcmp(ptr_, x.ptr_, length_) == 0));
  }
  bool operator!=(const StringPiece& x) const {
    return !(*this == x);
  }

#define STRINGPIECE_BINARY_PREDICATE(cmp,auxcmp)                             \
  bool operator cmp (const StringPiece& x) const {                           \
    int r = memcmp(ptr_, x.ptr_, length_ < x.length_ ? length_ : x.length_); \
    return ((r auxcmp 0) || ((r == 0) && (length_ cmp x.length_)));          \
  }
  STRINGPIECE_BINARY_PREDICATE(<,  <);
  STRINGPIECE_BINARY_PREDICATE(<=, <);
  STRINGPIECE_BINARY_PREDICATE(>=, >);
  STRINGPIECE_BINARY_PREDICATE(>,  >);
#undef STRINGPIECE_BINARY_PREDICATE

  int compare(const StringPiece& x) const {
    int r = memcmp(ptr_, x.ptr_, length_ < x.length_ ? length_ : x.length_);
    if (r == 0) {
      if (length_ < x.length_) r = -1;
      else if (length_ > x.length_) r = +1;
    }
    return r;
  }

  string as_string() const {
    return string(data(), size());
  }

  void CopyToString(string* target) const {
    target->assign(ptr_, length_);
  }

#ifndef MUDUO_STD_STRING
  void CopyToStdString(std::string* target) const {
    target->assign(ptr_, length_);
  }
#endif

  // Does "this" start with "x"
  bool starts_with(const StringPiece& x) const {
    return ((length_ >= x.length_) && (memcmp(ptr_, x.ptr_, x.length_) == 0));
  }
};

}   // namespace muduo

// ------------------------------------------------------------------
// Functions used to create STL containers that use StringPiece
//  Remember that a StringPiece's lifetime had better be less than
//  that of the underlying string or char*.  If it is not, then you
//  cannot safely store a StringPiece into an STL container
// ------------------------------------------------------------------

#ifdef HAVE_TYPE_TRAITS
// This makes vector<StringPiece> really fast for some STL implementations
template<> struct __type_traits<muduo::StringPiece> {
  typedef __true_type    has_trivial_default_constructor;
  typedef __true_type    has_trivial_copy_constructor;
  typedef __true_type    has_trivial_assignment_operator;
  typedef __true_type    has_trivial_destructor;
  typedef __true_type    is_POD_type;
};
#endif

// allow StringPiece to be logged
std::ostream& operator<<(std::ostream& o, const muduo::StringPiece& piece);

另外看看这两个函数。
void remove_prefix(int n) {
ptr_ += n;
length_ -= n;
}
void remove_suffix(int n) {
length_ -= n;
}
StringPiece
这个类实际上只是对字符串的一个proxy类而已（即设计模式中的代理模式），看这个类的构造函数都是const类型，应该是该类只用于提取，而不用于修改，相当于C++17的string_view，C++17的string_view的介绍可以看这篇文章: http://purecpp.org/?p=1315，它提供了一个窗口，外部仅可以观察到这个窗口中字符串的内容，在调整窗口大小时不需要修改原字符串，仅移动开始指针和调整长度即可。另外这个类自身并不存储这个字符串，所以它的有效生存期取决于源字符串指针的生存期。该类不作验证工作，将验证工作交由调用者处理。
remove_suffix为什么仅仅只是改变了长度，没有将末尾填写成’\0’。因为将末尾填写成’\0’，那就是修改了字符串，违背了该类的设计初衷。
现在假设我们有这样一个初始字符串”abcde”，它的窗口为[0, length)，其中length = 5。
那么如果我们想去掉”ab”这两个前置字符怎么办呢？注意我们是一个代理类，不需要去操作源串，只需要修改ptr_指针，让它前进两格就可以了。
但是前进之后，长度变短了，这时需要把length_减去n;这时的窗口为[2, length)
那如果是想去掉”de”呢？只需要把length_减去n就好了。这时的窗口为[0, length - 2)
void remove_prefix(int n) { ptr_ += n; length_ -= n; }
void remove_suffix(int n) { length_ -= n; }
它有独立的length_来保证长度，同时，operator ==等函数的行为也保证了它只以length_作为终止的判断。

StringPiece类重载了< 、<=、 >= 、>这些运算符。这些运算符实现起来大同小异，所以通过一个宏STRINGPIECE_BINARY_PREDICATE来实现。

#define STRINGPIECE_BINARY_PREDICATE(cmp,auxcmp)                             \
  bool operator cmp (const StringPiece& x) const {                           \
    int r = memcmp(ptr_, x.ptr_, length_ < x.length_ ? length_ : x.length_); \
    return ((r auxcmp 0) || ((r == 0) && (length_ cmp x.length_)));          \
  }
  STRINGPIECE_BINARY_PREDICATE(<,  <);
  STRINGPIECE_BINARY_PREDICATE(<=, <);
  STRINGPIECE_BINARY_PREDICATE(>=, >);
  STRINGPIECE_BINARY_PREDICATE(>,  >);
#undef STRINGPIECE_BINARY_PREDICATE

注意看，STRINGPIECE_BINARY_PREDICATE有两个参数，第二个是辅助比较运算符，为什么还需要这个辅助比较运算符呢？
以小于号为栗子，宏展开后代码如下

bool operator < (const StringPiece& x) const {                           \
    int r = memcmp(ptr_, x.ptr_, length_ < x.length_ ? length_ : x.length_); \
    return ((r < 0) || ((r == 0) && (length_ < x.length_)));          \
  }

比如”abcd” < “abcdefg”, memcp比较它们的前四个字节，得到的r的值是0，很明显”adbcd”是小于”abcdefg”但由return后面的运算返回的结果为true。
又比如”abcdx” < “abcdefg”, memcp比较它们的前5个字节，r的值为大于0，显然，((r < 0) || ((r == 0) && (length_ < x.length_)))得到的结果为false.

参考资料：
http://blog.csdn.net/huntinux/article/details/51969326
https://www.zhihu.com/question/34499426/answer/58891014