pretty-print.h (1923B)
1 // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors 2 // Licensed under the MIT License: 3 // 4 // Permission is hereby granted, free of charge, to any person obtaining a copy 5 // of this software and associated documentation files (the "Software"), to deal 6 // in the Software without restriction, including without limitation the rights 7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 // copies of the Software, and to permit persons to whom the Software is 9 // furnished to do so, subject to the following conditions: 10 // 11 // The above copyright notice and this permission notice shall be included in 12 // all copies or substantial portions of the Software. 13 // 14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 20 // THE SOFTWARE. 21 22 #pragma once 23 24 #include "dynamic.h" 25 #include <kj/string-tree.h> 26 27 CAPNP_BEGIN_HEADER 28 29 namespace capnp { 30 31 kj::StringTree prettyPrint(DynamicStruct::Reader value); 32 kj::StringTree prettyPrint(DynamicStruct::Builder value); 33 kj::StringTree prettyPrint(DynamicList::Reader value); 34 kj::StringTree prettyPrint(DynamicList::Builder value); 35 // Print the given Cap'n Proto struct or list with nice indentation. Note that you can pass any 36 // struct or list reader or builder type to this method, since they can be implicitly converted 37 // to one of the dynamic types. 38 // 39 // If you don't want indentation, just use the value's KJ stringifier (e.g. pass it to kj::str(), 40 // any of the KJ debug macros, etc.). 41 42 } // namespace capnp 43 44 CAPNP_END_HEADER