cannam@49: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
cannam@49: // Licensed under the MIT License:
cannam@49: //
cannam@49: // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@49: // of this software and associated documentation files (the "Software"), to deal
cannam@49: // in the Software without restriction, including without limitation the rights
cannam@49: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@49: // copies of the Software, and to permit persons to whom the Software is
cannam@49: // furnished to do so, subject to the following conditions:
cannam@49: //
cannam@49: // The above copyright notice and this permission notice shall be included in
cannam@49: // all copies or substantial portions of the Software.
cannam@49: //
cannam@49: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@49: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@49: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@49: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@49: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@49: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@49: // THE SOFTWARE.
cannam@49: 
cannam@49: #ifndef CAPNP_BLOB_H_
cannam@49: #define CAPNP_BLOB_H_
cannam@49: 
cannam@49: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
cannam@49: #pragma GCC system_header
cannam@49: #endif
cannam@49: 
cannam@49: #include <kj/common.h>
cannam@49: #include <kj/string.h>
cannam@49: #include "common.h"
cannam@49: #include <string.h>
cannam@49: 
cannam@49: namespace capnp {
cannam@49: 
cannam@49: struct Data {
cannam@49:   Data() = delete;
cannam@49:   class Reader;
cannam@49:   class Builder;
cannam@49:   class Pipeline {};
cannam@49: };
cannam@49: 
cannam@49: struct Text {
cannam@49:   Text() = delete;
cannam@49:   class Reader;
cannam@49:   class Builder;
cannam@49:   class Pipeline {};
cannam@49: };
cannam@49: 
cannam@49: class Data::Reader: public kj::ArrayPtr<const byte> {
cannam@49:   // Points to a blob of bytes.  The usual Reader rules apply -- Data::Reader behaves like a simple
cannam@49:   // pointer which does not own its target, can be passed by value, etc.
cannam@49: 
cannam@49: public:
cannam@49:   typedef Data Reads;
cannam@49: 
cannam@49:   Reader() = default;
cannam@49:   inline Reader(decltype(nullptr)): ArrayPtr<const byte>(nullptr) {}
cannam@49:   inline Reader(const byte* value, size_t size): ArrayPtr<const byte>(value, size) {}
cannam@49:   inline Reader(const kj::Array<const byte>& value): ArrayPtr<const byte>(value) {}
cannam@49:   inline Reader(const ArrayPtr<const byte>& value): ArrayPtr<const byte>(value) {}
cannam@49:   inline Reader(const kj::Array<byte>& value): ArrayPtr<const byte>(value) {}
cannam@49:   inline Reader(const ArrayPtr<byte>& value): ArrayPtr<const byte>(value) {}
cannam@49: };
cannam@49: 
cannam@49: class Text::Reader: public kj::StringPtr {
cannam@49:   // Like Data::Reader, but points at NUL-terminated UTF-8 text.  The NUL terminator is not counted
cannam@49:   // in the size but must be present immediately after the last byte.
cannam@49:   //
cannam@49:   // Text::Reader's interface contract is that its data MUST be NUL-terminated.  The producer of
cannam@49:   // the Text::Reader must guarantee this, so that the consumer need not check.  The data SHOULD
cannam@49:   // also be valid UTF-8, but this is NOT guaranteed -- the consumer must verify if it cares.
cannam@49: 
cannam@49: public:
cannam@49:   typedef Text Reads;
cannam@49: 
cannam@49:   Reader() = default;
cannam@49:   inline Reader(decltype(nullptr)): StringPtr(nullptr) {}
cannam@49:   inline Reader(const char* value): StringPtr(value) {}
cannam@49:   inline Reader(const char* value, size_t size): StringPtr(value, size) {}
cannam@49:   inline Reader(const kj::String& value): StringPtr(value) {}
cannam@49:   inline Reader(const StringPtr& value): StringPtr(value) {}
cannam@49: 
cannam@49: #if KJ_COMPILER_SUPPORTS_STL_STRING_INTEROP
cannam@49:   template <typename T, typename = decltype(kj::instance<T>().c_str())>
cannam@49:   inline Reader(const T& t): StringPtr(t) {}
cannam@49:   // Allow implicit conversion from any class that has a c_str() method (namely, std::string).
cannam@49:   // We use a template trick to detect std::string in order to avoid including the header for
cannam@49:   // those who don't want it.
cannam@49: #endif
cannam@49: };
cannam@49: 
cannam@49: class Data::Builder: public kj::ArrayPtr<byte> {
cannam@49:   // Like Data::Reader except the pointers aren't const.
cannam@49: 
cannam@49: public:
cannam@49:   typedef Data Builds;
cannam@49: 
cannam@49:   Builder() = default;
cannam@49:   inline Builder(decltype(nullptr)): ArrayPtr<byte>(nullptr) {}
cannam@49:   inline Builder(byte* value, size_t size): ArrayPtr<byte>(value, size) {}
cannam@49:   inline Builder(kj::Array<byte>& value): ArrayPtr<byte>(value) {}
cannam@49:   inline Builder(ArrayPtr<byte> value): ArrayPtr<byte>(value) {}
cannam@49: 
cannam@49:   inline Data::Reader asReader() const { return Data::Reader(*this); }
cannam@49:   inline operator Reader() const { return asReader(); }
cannam@49: };
cannam@49: 
cannam@49: class Text::Builder: public kj::DisallowConstCopy {
cannam@49:   // Basically identical to kj::StringPtr, except that the contents are non-const.
cannam@49: 
cannam@49: public:
cannam@49:   inline Builder(): content(nulstr, 1) {}
cannam@49:   inline Builder(decltype(nullptr)): content(nulstr, 1) {}
cannam@49:   inline Builder(char* value): content(value, strlen(value) + 1) {}
cannam@49:   inline Builder(char* value, size_t size): content(value, size + 1) {
cannam@49:     KJ_IREQUIRE(value[size] == '\0', "StringPtr must be NUL-terminated.");
cannam@49:   }
cannam@49: 
cannam@49:   inline Reader asReader() const { return Reader(content.begin(), content.size() - 1); }
cannam@49:   inline operator Reader() const { return asReader(); }
cannam@49: 
cannam@49:   inline operator kj::ArrayPtr<char>();
cannam@49:   inline kj::ArrayPtr<char> asArray();
cannam@49:   inline operator kj::ArrayPtr<const char>() const;
cannam@49:   inline kj::ArrayPtr<const char> asArray() const;
cannam@49:   inline kj::ArrayPtr<byte> asBytes() { return asArray().asBytes(); }
cannam@49:   inline kj::ArrayPtr<const byte> asBytes() const { return asArray().asBytes(); }
cannam@49:   // Result does not include NUL terminator.
cannam@49: 
cannam@49:   inline operator kj::StringPtr() const;
cannam@49:   inline kj::StringPtr asString() const;
cannam@49: 
cannam@49:   inline const char* cStr() const { return content.begin(); }
cannam@49:   // Returns NUL-terminated string.
cannam@49: 
cannam@49:   inline size_t size() const { return content.size() - 1; }
cannam@49:   // Result does not include NUL terminator.
cannam@49: 
cannam@49:   inline char operator[](size_t index) const { return content[index]; }
cannam@49:   inline char& operator[](size_t index) { return content[index]; }
cannam@49: 
cannam@49:   inline char* begin() { return content.begin(); }
cannam@49:   inline char* end() { return content.end() - 1; }
cannam@49:   inline const char* begin() const { return content.begin(); }
cannam@49:   inline const char* end() const { return content.end() - 1; }
cannam@49: 
cannam@49:   inline bool operator==(decltype(nullptr)) const { return content.size() <= 1; }
cannam@49:   inline bool operator!=(decltype(nullptr)) const { return content.size() > 1; }
cannam@49: 
cannam@49:   inline bool operator==(Builder other) const { return asString() == other.asString(); }
cannam@49:   inline bool operator!=(Builder other) const { return asString() != other.asString(); }
cannam@49:   inline bool operator< (Builder other) const { return asString() <  other.asString(); }
cannam@49:   inline bool operator> (Builder other) const { return asString() >  other.asString(); }
cannam@49:   inline bool operator<=(Builder other) const { return asString() <= other.asString(); }
cannam@49:   inline bool operator>=(Builder other) const { return asString() >= other.asString(); }
cannam@49: 
cannam@49:   inline kj::StringPtr slice(size_t start) const;
cannam@49:   inline kj::ArrayPtr<const char> slice(size_t start, size_t end) const;
cannam@49:   inline Builder slice(size_t start);
cannam@49:   inline kj::ArrayPtr<char> slice(size_t start, size_t end);
cannam@49:   // A string slice is only NUL-terminated if it is a suffix, so slice() has a one-parameter
cannam@49:   // version that assumes end = size().
cannam@49: 
cannam@49: private:
cannam@49:   inline explicit Builder(kj::ArrayPtr<char> content): content(content) {}
cannam@49: 
cannam@49:   kj::ArrayPtr<char> content;
cannam@49: 
cannam@49:   static char nulstr[1];
cannam@49: };
cannam@49: 
cannam@49: inline kj::StringPtr KJ_STRINGIFY(Text::Builder builder) {
cannam@49:   return builder.asString();
cannam@49: }
cannam@49: 
cannam@49: inline bool operator==(const char* a, const Text::Builder& b) { return a == b.asString(); }
cannam@49: inline bool operator!=(const char* a, const Text::Builder& b) { return a != b.asString(); }
cannam@49: 
cannam@49: inline Text::Builder::operator kj::StringPtr() const {
cannam@49:   return kj::StringPtr(content.begin(), content.size() - 1);
cannam@49: }
cannam@49: 
cannam@49: inline kj::StringPtr Text::Builder::asString() const {
cannam@49:   return kj::StringPtr(content.begin(), content.size() - 1);
cannam@49: }
cannam@49: 
cannam@49: inline Text::Builder::operator kj::ArrayPtr<char>() {
cannam@49:   return content.slice(0, content.size() - 1);
cannam@49: }
cannam@49: 
cannam@49: inline kj::ArrayPtr<char> Text::Builder::asArray() {
cannam@49:   return content.slice(0, content.size() - 1);
cannam@49: }
cannam@49: 
cannam@49: inline Text::Builder::operator kj::ArrayPtr<const char>() const {
cannam@49:   return content.slice(0, content.size() - 1);
cannam@49: }
cannam@49: 
cannam@49: inline kj::ArrayPtr<const char> Text::Builder::asArray() const {
cannam@49:   return content.slice(0, content.size() - 1);
cannam@49: }
cannam@49: 
cannam@49: inline kj::StringPtr Text::Builder::slice(size_t start) const {
cannam@49:   return asReader().slice(start);
cannam@49: }
cannam@49: inline kj::ArrayPtr<const char> Text::Builder::slice(size_t start, size_t end) const {
cannam@49:   return content.slice(start, end);
cannam@49: }
cannam@49: 
cannam@49: inline Text::Builder Text::Builder::slice(size_t start) {
cannam@49:   return Text::Builder(content.slice(start, content.size()));
cannam@49: }
cannam@49: inline kj::ArrayPtr<char> Text::Builder::slice(size_t start, size_t end) {
cannam@49:   return content.slice(start, end);
cannam@49: }
cannam@49: 
cannam@49: }  // namespace capnp
cannam@49: 
cannam@49: #endif  // CAPNP_BLOB_H_