blob: c407cf86954a53f39143f81f5032c2f4a1d10585 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TinyCBOR 0.5.2 API: cborjson.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">TinyCBOR 0.5.2 API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">cborjson.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00017.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/****************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">** Copyright (C) 2015 Intel Corporation</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">** Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">** of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">** in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">** copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">** furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">** The above copyright notice and this permission notice shall be included in</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">** all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">** THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">** OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">** THE SOFTWARE.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">****************************************************************************/</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#ifndef CBORJSON_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define CBORJSON_H</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00005.html">cbor.h</a>&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">/* Conversion to JSON */</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="a00049.html#ga2f7386ebce337e0de69cae456bda78f7"> 35</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="a00049.html#ga2f7386ebce337e0de69cae456bda78f7">CborToJsonFlags</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; CborConvertAddMetadata = 1,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; CborConvertTagsToObjects = 2,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; CborConvertIgnoreTags = 0,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; CborConvertObeyByteStringTags = 0,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; CborConvertByteStringsToBase64Url = 4,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; CborConvertRequireMapStringKeys = 0,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; CborConvertStringifyMapKeys = 8,</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; CborConvertDefaultFlags = 0</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;};</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;CBOR_API <a class="code" href="a00045.html#ga76e9c9acc63dd940da4ab7e91309f7b5">CborError</a> <a class="code" href="a00049.html#ga558485bab0ebcb2646e7669d13861d79">cbor_value_to_json_advance</a>(FILE *out, <a class="code" href="a00065.html">CborValue</a> *value, <span class="keywordtype">int</span> flags);</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="a00049.html#ga3f2ce7eadf9a355654186166d24e69cf"> 51</a></span>&#160;CBOR_INLINE_API <a class="code" href="a00045.html#ga76e9c9acc63dd940da4ab7e91309f7b5">CborError</a> <a class="code" href="a00049.html#ga3f2ce7eadf9a355654186166d24e69cf">cbor_value_to_json</a>(FILE *out, <span class="keyword">const</span> <a class="code" href="a00065.html">CborValue</a> *value, <span class="keywordtype">int</span> flags)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;{</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="a00065.html">CborValue</a> copy = *value;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> <a class="code" href="a00049.html#ga558485bab0ebcb2646e7669d13861d79">cbor_value_to_json_advance</a>(out, &amp;copy, flags);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CBORJSON_H */</span><span class="preprocessor"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="ttc" id="a00045_html_ga76e9c9acc63dd940da4ab7e91309f7b5"><div class="ttname"><a href="a00045.html#ga76e9c9acc63dd940da4ab7e91309f7b5">CborError</a></div><div class="ttdeci">CborError</div><div class="ttdoc">The CborError enum contains the possible error values used by the CBOR encoder and decoder...</div><div class="ttdef"><b>Definition:</b> cbor.h:152</div></div>
<div class="ttc" id="a00049_html_ga3f2ce7eadf9a355654186166d24e69cf"><div class="ttname"><a href="a00049.html#ga3f2ce7eadf9a355654186166d24e69cf">cbor_value_to_json</a></div><div class="ttdeci">CborError cbor_value_to_json(FILE *out, const CborValue *value, int flags)</div><div class="ttdoc">Converts the current CBOR type pointed to by value to JSON and writes that to the out stream...</div><div class="ttdef"><b>Definition:</b> cborjson.h:51</div></div>
<div class="ttc" id="a00049_html_ga558485bab0ebcb2646e7669d13861d79"><div class="ttname"><a href="a00049.html#ga558485bab0ebcb2646e7669d13861d79">cbor_value_to_json_advance</a></div><div class="ttdeci">CborError cbor_value_to_json_advance(FILE *out, CborValue *value, int flags)</div><div class="ttdoc">Converts the current CBOR type pointed to by value to JSON and writes that to the out stream...</div><div class="ttdef"><b>Definition:</b> cbortojson.c:680</div></div>
<div class="ttc" id="a00005_html"><div class="ttname"><a href="a00005.html">cbor.h</a></div><div class="ttdoc">The &lt;cbor.h&gt; is the main header in TinyCBOR and defines the constants used by most functions as well ...</div></div>
<div class="ttc" id="a00065_html"><div class="ttname"><a href="a00065.html">CborValue</a></div><div class="ttdoc">This type contains one value parsed from the CBOR stream. </div><div class="ttdef"><b>Definition:</b> cbor.h:283</div></div>
<div class="ttc" id="a00049_html_ga2f7386ebce337e0de69cae456bda78f7"><div class="ttname"><a href="a00049.html#ga2f7386ebce337e0de69cae456bda78f7">CborToJsonFlags</a></div><div class="ttdeci">CborToJsonFlags</div><div class="ttdoc">The CborToJsonFlags enum contains flags that control the conversion of CBOR to JSON. </div><div class="ttdef"><b>Definition:</b> cborjson.h:35</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>