/usr/share/doc/libcpl-dev/html/group__cpl__recipedefine.html is in libcpl-doc 7.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 | <!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.10"/>
<title>Common Pipeline Library Reference Manual: Recipe Definition</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" />
<link href="cpl.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">Common Pipeline Library Reference Manual
 <span id="projectnumber">7.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<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="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Recipe Definition</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gad15ab861c2b30b213e4d3e66defd313b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipedefine.html#gad15ab861c2b30b213e4d3e66defd313b">cpl_get_license</a>(PACKAGE_NAME, YEAR) </td></tr>
<tr class="memdesc:gad15ab861c2b30b213e4d3e66defd313b"><td class="mdescLeft"> </td><td class="mdescRight">Generate the recipe copyright and license text (GPL v.2) <a href="#gad15ab861c2b30b213e4d3e66defd313b">More...</a><br /></td></tr>
<tr class="separator:gad15ab861c2b30b213e4d3e66defd313b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad28fb2a0f96bc6c33d632833ffef3a0e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipedefine.html#gad28fb2a0f96bc6c33d632833ffef3a0e">cpl_recipe_define</a>(RECIPE_NAME, RECIPE_VERSION, RECIPE_AUTHOR, RECIPE_EMAIL, RECIPE_YEAR, RECIPE_SYNOPSIS, RECIPE_DESCRIPTION) </td></tr>
<tr class="memdesc:gad28fb2a0f96bc6c33d632833ffef3a0e"><td class="mdescLeft"> </td><td class="mdescRight">Define a standard CPL recipe. <a href="#gad28fb2a0f96bc6c33d632833ffef3a0e">More...</a><br /></td></tr>
<tr class="separator:gad28fb2a0f96bc6c33d632833ffef3a0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e38f468caa7a6642b1ac7a633c7fa23"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipedefine.html#ga4e38f468caa7a6642b1ac7a633c7fa23">CPL_RECIPE_DEFINE</a>(RECIPE_NAME, RECIPE_VERSION, RECIPE_FILL_PARAMS, RECIPE_AUTHOR, RECIPE_AUTHOR_EMAIL, RECIPE_YEAR, RECIPE_SYNOPSIS, RECIPE_DESCRIPTION) </td></tr>
<tr class="memdesc:ga4e38f468caa7a6642b1ac7a633c7fa23"><td class="mdescLeft"> </td><td class="mdescRight">Define a standard CPL recipe. <a href="#ga4e38f468caa7a6642b1ac7a633c7fa23">More...</a><br /></td></tr>
<tr class="separator:ga4e38f468caa7a6642b1ac7a633c7fa23"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This module implements the support for recipe defition.</p>
<dl class="section user"><dt>Synopsis:</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include <cpl_recipedefine.h></span></div>
</div><!-- fragment --> </dd></dl>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gad15ab861c2b30b213e4d3e66defd313b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cpl_get_license</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">PACKAGE_NAME, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">YEAR </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate the recipe copyright and license text (GPL v.2) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">PACKAGE_NAME</td><td>The name as a string literal, e.g. from config.h </td></tr>
<tr><td class="paramname">YEAR</td><td>The year(s) as a string literal </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The recipe copyright and license text as a string literal</dd></dl>
<p>Example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> const char * eso_gpl_license = cpl_get_license(PACKAGE_NAME, "2005, 2008");</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gad28fb2a0f96bc6c33d632833ffef3a0e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cpl_recipe_define</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_NAME, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_VERSION, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_AUTHOR, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_EMAIL, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_YEAR, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_SYNOPSIS, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_DESCRIPTION </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Define a standard CPL recipe. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RECIPE_NAME</td><td>The name as an identifier </td></tr>
<tr><td class="paramname">RECIPE_VERSION</td><td>The binary version number </td></tr>
<tr><td class="paramname">RECIPE_AUTHOR</td><td>The author as a string literal </td></tr>
<tr><td class="paramname">RECIPE_EMAIL</td><td>The contact email as a string literal </td></tr>
<tr><td class="paramname">RECIPE_YEAR</td><td>The copyright year as a string literal </td></tr>
<tr><td class="paramname">RECIPE_SYNOPSIS</td><td>The synopsis as a string literal </td></tr>
<tr><td class="paramname">RECIPE_DESCRIPTION</td><td>The man-page as a string literal</td></tr>
</table>
</dd>
</dl>
<p>A CPL-based recipe may use this macro to define its four mandatory functions: <a class="el" href="group__cpl__plugin.html#gae655fb9d106ccb4575c91bd2c5a9b145" title="Append the plugin information to the given list. ">cpl_plugin_get_info()</a>, <recipe>_create(), <recipe>_exec() and <recipe>_destroy(), as well as declaring the actual data reduction function, <recipe>() as </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> static int <recipe>(cpl_frameset *, const cpl_parameterlist *);</div>
</div><!-- fragment --><p>The macro also declares the recipe-specific function that fills the recipe parameterlist with the supported parameters as </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> static cpl_error_code <recipe>_fill_parameterlist(cpl_parameterlist *self);</div>
</div><!-- fragment --><p> A recipe that invokes <a class="el" href="group__cpl__recipedefine.html#gad28fb2a0f96bc6c33d632833ffef3a0e" title="Define a standard CPL recipe. ">cpl_recipe_define()</a> must define this function.</p>
<p>The macro <a class="el" href="group__cpl__recipedefine.html#gad28fb2a0f96bc6c33d632833ffef3a0e" title="Define a standard CPL recipe. ">cpl_recipe_define()</a> may be used by defining a macro, e.g. in my_recipe.h:</p>
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> #define MY_RECIPE_DEFINE(NAME, SYNOPSIS, DESCRIPTION) \</div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  cpl_recipe_define(NAME, MY_BINARY_VERSION, \</div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  "Firstname Lastname", "2006, 2008", SYNOPSIS, DESCRIPTION)</div>
</div><!-- fragment --><ul>
<li>and then by invoking this macro in each recipe:</li>
</ul>
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> #include "my_recipe.h"</div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> MY_RECIPE_DEFINE(instrume_img_dark,</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  "Dark recipe",</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  "instrume_img_dark -- imaging dark recipe.\n"</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  " ... recipe man-page\n");</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> static</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> cpl_error_code instrume_img_dark_fill_parameterlist(cpl_parameterlist *self);</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  // Fill the parameterlist with the parameters supported by the recipe.</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  retun CPL_ERROR_NONE;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> }</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga4e38f468caa7a6642b1ac7a633c7fa23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CPL_RECIPE_DEFINE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_NAME, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_VERSION, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_FILL_PARAMS, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_AUTHOR, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_AUTHOR_EMAIL, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_YEAR, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_SYNOPSIS, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">RECIPE_DESCRIPTION </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Define a standard CPL recipe. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RECIPE_NAME</td><td>The name as an identifier </td></tr>
<tr><td class="paramname">RECIPE_VERSION</td><td>The binary version number </td></tr>
<tr><td class="paramname">RECIPE_FILL_PARAMS</td><td>A function call to fill the recipe parameterlist. Must evaluate to zero if and only if successful </td></tr>
<tr><td class="paramname">RECIPE_AUTHOR</td><td>The author as a string literal </td></tr>
<tr><td class="paramname">RECIPE_AUTHOR_EMAIL</td><td>The author email as a string literal </td></tr>
<tr><td class="paramname">RECIPE_YEAR</td><td>The copyright year as a string literal </td></tr>
<tr><td class="paramname">RECIPE_SYNOPSIS</td><td>The synopsis as a string literal </td></tr>
<tr><td class="paramname">RECIPE_DESCRIPTION</td><td>The man-page as a string literal </td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000032">Deprecated:</a></b></dt><dd>Use <a class="el" href="group__cpl__recipedefine.html#gad28fb2a0f96bc6c33d632833ffef3a0e" title="Define a standard CPL recipe. ">cpl_recipe_define()</a></dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
|