web/docs/printf_8h_source.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: include/pico/printf.h Source File</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('printf_8h_source.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="headertitle"><div class="title">printf.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="printf_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span> </div>
 109 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// \author (c) Marco Paland ([email protected])</span></div>
 110 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">//             2014-2019, PALANDesign Hannover, Germany</span></div>
 111 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">//</span></div>
 112 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// \license The MIT License (MIT)</span></div>
 113 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">//</span></div>
 114 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment">// of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
 116 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment">// in the Software without restriction, including without limitation the rights</span></div>
 117 <div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
 118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">// copies of the Software, and to permit persons to whom the Software is</span></div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">// furnished to do so, subject to the following conditions:</span></div>
 120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// </span></div>
 121 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment">// The above copyright notice and this permission notice shall be included in</span></div>
 122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// all copies or substantial portions of the Software.</span></div>
 123 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment">// </span></div>
 124 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">// THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
 125 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
 126 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
 127 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
 128 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
 129 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment">// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
 130 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment">// THE SOFTWARE.</span></div>
 131 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment">//</span></div>
 132 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">// \brief Tiny printf, sprintf and snprintf implementation, optimized for speed on</span></div>
 133 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment">//        embedded systems with a very limited resources.</span></div>
 134 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">//        Use this instead of bloated standard/newlib printf.</span></div>
 135 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment">//        These routines are thread safe and reentrant.</span></div>
 136 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">//</span></div>
 137 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"></span> </div>
 138 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#ifndef _PICO_PRINTF_H</span></div>
 139 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define _PICO_PRINTF_H</span></div>
 140 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
 141 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 142 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 143 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#endif</span></div>
 144 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
 145 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">#include &quot;<a class="code" href="pico_8h.html">pico.h</a>&quot;</span></div>
 146 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">#include &lt;<a class="code" href="stdio_8h.html">stdio.h</a>&gt;</span></div>
 147 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#include &lt;stdarg.h&gt;</span></div>
 148 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
 149 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment">// PICO_CONFIG: PICO_PRINTF_ALWAYS_INCLUDED, Whether to always include printf code even if only called weakly (by panic), type=bool, default=1 in debug build 0 otherwise, group=pico_printf</span></div>
 150 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="preprocessor">#ifndef PICO_PRINTF_ALWAYS_INCLUDED</span></div>
 151 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor">#ifndef NDEBUG</span></div>
 152 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="preprocessor">#define PICO_PRINTF_ALWAYS_INCLUDED 1</span></div>
 153 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#else</span></div>
 154 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#define PICO_PRINTF_ALWAYS_INCLUDED 0</span></div>
 155 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#endif</span></div>
 156 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#endif</span></div>
 157 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span> </div>
 158 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">#if LIB_PICO_PRINTF_PICO</span></div>
 159 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">// weak raw printf may be a puts if printf has not been called,</span></div>
 160 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">// so that we can support gc of printf when it isn&#39;t called</span></div>
 161 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">//</span></div>
 162 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">// it is called raw to distinguish it from the regular printf which</span></div>
 163 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">// is in stdio.c and does mutex protection</span></div>
 164 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="preprocessor">#if !PICO_PRINTF_ALWAYS_INCLUDED</span></div>
 165 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__pico__stdio.html#gae9afcfe3e3db353e1bddd5b87d7be454">__printflike</a>(1, 0) weak_raw_printf(const <span class="keywordtype">char</span> *fmt, ...);</div>
 166 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="keywordtype">bool</span> weak_raw_vprintf(const <span class="keywordtype">char</span> *fmt, va_list args);</div>
 167 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">#else</span></div>
 168 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="preprocessor">#define weak_raw_printf(...) ({printf(__VA_ARGS__); true;})</span></div>
 169 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="preprocessor">#define weak_raw_vprintf(fmt,va) ({vprintf(fmt,va); true;})</span></div>
 170 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="preprocessor">#endif</span></div>
 171 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span> </div>
 172 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="keywordtype">int</span> vfctprintf(<span class="keywordtype">void</span> (*out)(<span class="keywordtype">char</span> character, <span class="keywordtype">void</span> *arg), <span class="keywordtype">void</span> *arg, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, va_list va);</div>
 173 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span> </div>
 174 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="preprocessor">#else</span></div>
 175 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
 176 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="preprocessor">#define weak_raw_printf(...) ({printf(__VA_ARGS__); true;})</span></div>
 177 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="preprocessor">#define weak_raw_vprintf(fmt,va) ({vprintf(fmt,va); true;})</span></div>
 178 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span> </div>
 179 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="preprocessor">#endif</span></div>
 180 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span> </div>
 181 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 182 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>}</div>
 183 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="preprocessor">#endif</span></div>
 184 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
 185 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="preprocessor">#endif  </span><span class="comment">// _PRINTF_H_</span></div>
 186 <div class="ttc" id="agroup__pico__stdio_html_gae9afcfe3e3db353e1bddd5b87d7be454"><div class="ttname"><a href="group__pico__stdio.html#gae9afcfe3e3db353e1bddd5b87d7be454">__printflike</a></div><div class="ttdeci">int __printflike(1, 0) stdio_printf(const char *format</div><div class="ttdoc">stdio_getchar Alias for printf that definitely does not go thru the implementation in the standard C ...</div></div>
 187 <div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
 188 <div class="ttc" id="astdio_8h_html"><div class="ttname"><a href="stdio_8h.html">stdio.h</a></div></div>
 189 </div><!-- fragment --></div><!-- contents -->
 190 </div><!-- doc-content -->
 191
 192         <script src="main.js"></script>
 193 </body>
 194 </html>