<!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.4"/>
<title>WCSLIB 4.18: wcsprintf.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 style="padding-left: 0.5em;">
<div id="projectname">WCSLIB 4.18
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_af99bb3c152a306abd27951285ad1127.html">C</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">wcsprintf.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="wcsprintf_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*============================================================================</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> WCSLIB 4.18 - an implementation of the FITS WCS standard.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (C) 1995-2013, Mark Calabretta</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> This file is part of WCSLIB.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> WCSLIB is free software: you can redistribute it and/or modify it under the</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> terms of the GNU Lesser General Public License as published by the Free</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> Software Foundation, either version 3 of the License, or (at your option)</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> any later version.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> WCSLIB is distributed in the hope that it will be useful, but WITHOUT ANY</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> more details.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> along with WCSLIB. If not, see http://www.gnu.org/licenses.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> Direct correspondence concerning WCSLIB to mark@calabretta.id.au</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> Author: Mark Calabretta, Australia Telescope National Facility, CSIRO.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> http://www.atnf.csiro.au/people/Mark.Calabretta</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> $Id: wcsprintf.h,v 4.18 2013/07/13 10:00:04 mcalabre Exp $</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">*=============================================================================</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">* WCSLIB 4.18 - C routines that implement the FITS World Coordinate System</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">* (WCS) standard.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">*</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">* Summary of the wcsprintf routines</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">* ---------------------------------</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">* These routines allow diagnostic output from celprt(), linprt(), prjprt(),</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">* spcprt(), tabprt(), wcsprt(), and wcserr_prt() to be redirected to a file or</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">* captured in a string buffer. Those routines all use wcsprintf() for output.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">* Likewise wcsfprintf() is used by wcsbth() and wcspih(). Both functions may</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">* be used by application programmers to have other output go to the same</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">* place.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">*</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">*</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">* wcsprintf() - Print function used by WCSLIB diagnostic routines</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">* ---------------------------------------------------------------</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">* wcsprintf() is used by celprt(), linprt(), prjprt(), spcprt(), tabprt(),</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">* wcsprt(), and wcserr_prt() for diagnostic output which by default goes to</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">* stdout. However, it may be redirected to a file or string buffer via</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">* wcsprintf_set().</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">*</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">* format char* Format string, passed to one of the printf(3) family</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">* of stdio library functions.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">*</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">* ... mixed Argument list matching format, as per printf(3).</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">*</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">* int Number of bytes written.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">*</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">*</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">* wcsfprintf() - Print function used by WCSLIB diagnostic routines</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">* ----------------------------------------------------------------</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">* wcsfprintf() is used by wcsbth(), and wcspih() for diagnostic output which</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">* they send to stderr. However, it may be redirected to a file or string</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">* buffer via wcsprintf_set().</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">*</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">* stream FILE* The output stream if not overridden by a call to</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">* wcsprintf_set().</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">*</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">* format char* Format string, passed to one of the printf(3) family</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">* of stdio library functions.</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">*</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">* ... mixed Argument list matching format, as per printf(3).</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">*</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">* int Number of bytes written.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">*</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">*</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">* wcsprintf_set() - Set output disposition for wcsprintf() and wcsfprintf()</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">* -------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">* wcsprintf_set() sets the output disposition for wcsprintf() which is used by</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">* the celprt(), linprt(), prjprt(), spcprt(), tabprt(), wcsprt(), and</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">* wcserr_prt() routines, and for wcsfprintf() which is used by wcsbth() and</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">* wcspih().</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">*</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">* wcsout FILE* Pointer to an output stream that has been opened for</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">* writing, e.g. by the fopen() stdio library function,</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">* or one of the predefined stdio output streams - stdout</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">* and stderr. If zero (NULL), output is written to an</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">* internally-allocated string buffer, the address of</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">* which may be obtained by wcsprintf_buf().</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">*</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">*</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">*</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">* wcsprintf_buf() - Get the address of the internal string buffer</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">* ---------------------------------------------------------------</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">* wcsprintf_buf() returns the address of the internal string buffer created</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">* when wcsprintf_set() is invoked with its FILE* argument set to zero.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">*</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">* const char *</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">* Address of the internal string buffer. The user may</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">* free this buffer by calling wcsprintf_set() with a</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">* valid FILE*, e.g. stdout. The free() stdlib library</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">* function must NOT be invoked on this const pointer.</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">*</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">*</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">* WCSPRINTF_PTR() macro - Print addresses in a consistent way</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">* -----------------------------------------------------------</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">* WCSPRINTF_PTR() is a preprocessor macro used to print addresses in a</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">* consistent way.</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">*</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">* On some systems the "%p" format descriptor renders a NULL pointer as the</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">* string "0x0". On others, however, it produces "0" or even "(nil)". On</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">* some systems a non-zero address is prefixed with "0x", on others, not.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">*</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">* The WCSPRINTF_PTR() macro ensures that a NULL pointer is always rendered as</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">* "0x0" and that non-zero addresses are prefixed with "0x" thus providing</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">* consistency, for example, for comparing the output of test programs.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">*</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">*===========================================================================*/</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor">#ifndef WCSLIB_WCSPRINTF</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_WCSPRINTF</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#include <stdio.h></span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00134"></a><span class="lineno"><a class="code" href="wcsprintf_8h.html#a7af03fe3aabc25673cc012adc1e3f8cc"> 134</a></span> <span class="preprocessor">#define WCSPRINTF_PTR(str1, ptr, str2) \</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor"> if (ptr) { \</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor"> wcsprintf("%s%#lx%s", (str1), (unsigned long)(ptr), (str2)); \</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor"> } else { \</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor"> wcsprintf("%s0x0%s", (str1), (str2)); \</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor"> }</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="keywordtype">int</span> <a class="code" href="wcsprintf_8h.html#a5c6f91916a0b8f8c2d85274c0ba130f6" title="Set output disposition for wcsprintf() and wcsfprintf(). ">wcsprintf_set</a>(FILE *wcsout);</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">int</span> <a class="code" href="wcsprintf_8h.html#a46950abaf5a27347da8160741f98f973" title="Print function used by WCSLIB diagnostic routines. ">wcsprintf</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="keywordtype">int</span> <a class="code" href="wcsprintf_8h.html#aa210b2b1b6f802804265e3bff399300a" title="Print function used by WCSLIB diagnostic routines. ">wcsfprintf</a>(FILE *stream, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="wcsprintf_8h.html#ab8a869f35385b17a26cb5070ab63e5d5" title="Get the address of the internal string buffer. ">wcsprintf_buf</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="preprocessor">#endif </span><span class="comment">/* WCSLIB_WCSPRINTF */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jul 13 2013 20:00:26 for WCSLIB 4.18 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
