cannam@135: // Copyright (c) 2015 Philip Quinn.
cannam@135: // Licensed under the MIT License:
cannam@135: //
cannam@135: // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@135: // of this software and associated documentation files (the "Software"), to deal
cannam@135: // in the Software without restriction, including without limitation the rights
cannam@135: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@135: // copies of the Software, and to permit persons to whom the Software is
cannam@135: // furnished to do so, subject to the following conditions:
cannam@135: //
cannam@135: // The above copyright notice and this permission notice shall be included in
cannam@135: // all copies or substantial portions of the Software.
cannam@135: //
cannam@135: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@135: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@135: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@135: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@135: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@135: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@135: // THE SOFTWARE.
cannam@135: 
cannam@135: #ifndef CAPNP_SERIALIZE_TEXT_H_
cannam@135: #define CAPNP_SERIALIZE_TEXT_H_
cannam@135: 
cannam@135: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
cannam@135: #pragma GCC system_header
cannam@135: #endif
cannam@135: 
cannam@135: #include <kj/string.h>
cannam@135: #include "dynamic.h"
cannam@135: #include "orphan.h"
cannam@135: #include "schema.h"
cannam@135: 
cannam@135: namespace capnp {
cannam@135: 
cannam@135: class TextCodec {
cannam@135:   // Reads and writes Cap'n Proto objects in a plain text format (as used in the schema
cannam@135:   // language for constants, and read/written by the 'decode' and 'encode' commands of
cannam@135:   // the capnp tool).
cannam@135:   //
cannam@135:   // This format is useful for debugging or human input, but it is not a robust alternative
cannam@135:   // to the binary format. Changes to a schema's types or names that are permitted in a
cannam@135:   // schema's binary evolution will likely break messages stored in this format.
cannam@135:   //
cannam@135:   // Note that definitions or references (to constants, other fields, or files) are not
cannam@135:   // permitted in this format. To evaluate declarations with the full expressiveness of the
cannam@135:   // schema language, see `capnp::SchemaParser`.
cannam@135:   //
cannam@135:   // Requires linking with the capnpc library.
cannam@135: 
cannam@135: public:
cannam@135:   TextCodec();
cannam@135:   ~TextCodec() noexcept(true);
cannam@135: 
cannam@135:   void setPrettyPrint(bool enabled);
cannam@135:   // If enabled, pads the output of `encode()` with spaces and newlines to make it more
cannam@135:   // human-readable.
cannam@135: 
cannam@135:   template <typename T>
cannam@135:   kj::String encode(T&& value) const;
cannam@135:   kj::String encode(DynamicValue::Reader value) const;
cannam@135:   // Encode any Cap'n Proto value.
cannam@135: 
cannam@135:   template <typename T>
cannam@135:   Orphan<T> decode(kj::StringPtr input, Orphanage orphanage) const;
cannam@135:   // Decode a text message into a Cap'n Proto object of type T, allocated in the given
cannam@135:   // orphanage. Any errors parsing the input or assigning the fields of T are thrown as
cannam@135:   // exceptions.
cannam@135: 
cannam@135:   void decode(kj::StringPtr input, DynamicStruct::Builder output) const;
cannam@135:   // Decode a text message for a struct into the given builder. Any errors parsing the
cannam@135:   // input or assigning the fields of the output are thrown as exceptions.
cannam@135: 
cannam@135:   // TODO(someday): expose some control over the error handling?
cannam@135: private:
cannam@135:   Orphan<DynamicValue> decode(kj::StringPtr input, Type type, Orphanage orphanage) const;
cannam@135: 
cannam@135:   bool prettyPrint;
cannam@135: };
cannam@135: 
cannam@135: // =======================================================================================
cannam@135: // inline stuff
cannam@135: 
cannam@135: template <typename T>
cannam@135: inline kj::String TextCodec::encode(T&& value) const {
cannam@135:   return encode(DynamicValue::Reader(ReaderFor<FromAny<T>>(kj::fwd<T>(value))));
cannam@135: }
cannam@135: 
cannam@135: template <typename T>
cannam@135: inline Orphan<T> TextCodec::decode(kj::StringPtr input, Orphanage orphanage) const {
cannam@135:   return decode(input, Type::from<T>(), orphanage).template releaseAs<T>();
cannam@135: }
cannam@135: 
cannam@135: }  // namespace capnp
cannam@135: 
cannam@135: #endif  // CAPNP_SERIALIZE_TEXT_H_