/usr/include/gpiv/gpiv-utils.h is in libgpiv3-dev 0.6.1-4.3build2.
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 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 c-style: "K&R" -*- */
/*
libgpiv - library for Particle Image Velocimetry
Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 Gerber van der Graaf
This file is part of libgpiv.
Libgpiv is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-------------------------------------------------------------------------------
LIBRARY: libgpiv:
EXTERNAL FUNCTIONS:
gpiv_scan_parameter
gpiv_scan_resourcefiles
gpiv_add_datetime_to_comment
gpiv_sort_3,
gpiv_max,
gpiv_min,
gpiv_warning,
gpiv_error,
gpiv_fscan_iph_nl
gpiv_scan_iph,
gpiv_scan_cph,
gpiv_scan_sph,
--------------------------------------------------------------------------- */
/**
\file gpiv-utils.h
\brief miscellaneous utilities
SOURCES: lib/utils.c
LAST MODIFICATION DATE: $Id: gpiv-utils.h,v 1.1 2007-11-23 16:12:18 gerber Exp $
*/
#ifndef __LIBGPIV_UTILS_H__
#define __LIBGPIV_UTILS_H__
#define GPIV_FAIL_INT -914
/**
* Reads parameters from local parameter file PARFILE
*
* @param[in] PAR_KEY Parameter key, specific for each process
* @param[in] parfile Parameter file, specific for each process
* @param[in] verbose flag for printing parameters
* @param[out] pstruct pointer to parameter structure
* @return void
*/
void
gpiv_scan_parameter (const gchar *PAR_KEY,
const gchar *parfile,
void *pstruct,
gboolean verbose
);
/**
* Opens resource files GPIV_HOME_RSC_FILE (hidden) and
* SYSTEM_RSC_DIR, GPIV_SYSTEM_RSC_FILE
* Reads parameters from it
*
* @param[in] PAR_KEY Parameter key, specific for each process
* @param[in] verbose parameter to print to stdout
* @param[out] pstruct pointer to parameter structure
* @return NULL on success or error message on failure
*/
gchar *
gpiv_scan_resourcefiles (const gchar *PAR_KEY,
void *pstruct,
gint verbose
);
/**
* Adds date and timesatmp to the comment for ASCII-formatted data
*
* @param[in] comment character string
* @return comment including date and time on success
* or NULL on failure
*/
gchar *
gpiv_add_datetime_to_comment (gchar *comment
);
/**
* Orders array arr AND its belonging arrays arr_2 and arr_3
* Also swaps accompanying arrays
*
* @param[in] n length of array
* @param[in] arr array to be sorted
* @param[in] arr_2 second belonging array to arr
* @param[in] arr_3 third belonging array to arr
* @return NULL on success or error message on failure
*/
gchar *
gpiv_sort_3 (const unsigned long n,
gfloat arr[],
gfloat arr_2[],
gfloat arr_3[]
);
/**
* Calculates maximum of longs a and b
*
* @param[in] a first variable to be tested
* @param[in] b second variable to be tested
* @return result of maximum
*/
long
gpiv_lmax (long a,
long b
);
/**
* Calculates minimum of longs a and b
*
* @param[in] a first variable to be tested
* @param[in] b second variable to be tested
* @return result of minimum
*/
long
gpiv_lmin (long a,
long b
);
/**
* Calculates maximum of integers a and b
*
* @param[in] a first variable to be tested
* @param[in] b second variable to be tested
* @return result of maximum
*/
gint
gpiv_max (gint a,
gint b
);
/**
* Calculates minimum of integers a and b
*
* @param[in] a first variable to be tested
* @param[in] b second variable to be tested
* @return result of minimum
*/
gint
gpiv_min (gint a,
gint b
);
/**
* Prints warning message with variable argumanent list
*
* @param[in] message warning message
* @return void
*/
void
gpiv_warning (gchar *message, ...
);
/**
* Prints error handling with variable argumanent list to stdout
* and exits program
*
* @param[in] message warning message
* @return void
*/
void
gpiv_error (gchar *message, ...
);
/**
* Scans line string on **integer** parameter key
* and value or image header value (without program key). The
* value to be read is on the next line (_nl) of the key.
*
* @param[in] fp_h file pointer of header to read the data from
* @param[in] MOD_KEY Module key as part of parameter key
* @param[in] PAR_KEY parameter key
* @param[in] use_mod_key flag to use program key
* @param[in] line line to be scanned
* @param[in] par_name parameter name which is scanned in line
* @param[out] parameter parameter value to be returned
* @param[in] verbose flag to print prarameter to stdout
* @param[in] fp file pointer to print parameter to
*
* @return flag representing parameter__set.
* Set to TRUE if parameter has been read, else FALSE
*/
gboolean
gpiv_fscan_iph_nl (FILE *fp_h,
const gchar *MOD_KEY,
const gchar *PAR_KEY,
const gboolean use_mod_key,
gchar *line,
const gchar *par_name,
gint *parameter,
const gboolean verbose,
FILE *fp
);
/**
* Scans line string on **int** parameter key
* and value or image header value (without program key). Prints result
* to file.
*
* @param[in] MOD_KEY module key as part of parameter key
* @param[in] PAR_KEY parameter key
* @param[in] use_mod_key flag to use module key
* @param[in] line line to be scanned
* @param[in] par_name parameter name which is scanned in line
* @param[out] parameter parameter value to be returned
* @param[in] verbose flag to print prarameter to stdout
* @param[in] fp file pointer to print parameter to
* @return flag representing parameter__set.
* Set to TRUE if parameter has been read, else FALSE
*/
gboolean
gpiv_scan_iph (const gchar *MOD_KEY,
const gchar *PAR_KEY,
const gboolean use_mod_key,
const gchar *line,
const gchar *par_name,
gint *parameter,
const gboolean verbose,
FILE *fp
);
/**
* Scans line string on **char** parameter key
* and value or image header value (without program key). Prints result
* to file.
*
* @param[in] MOD_KEY module key as part of parameter key
* @param[in] PAR_KEY parameter key
* @param[in] use_mod_key flag to use module key
* @param[in] line line to be scanned
* @param[in] par_name parameter name which is scanned in line
* @param[out] parameter parameter value to be returned
* @param[in] verbose flag to print prarameter to stdout
* @param[in] fp file pointer to print parameter to
* @return flag representing parameter__set.
* Set to TRUE if parameter has been read, else FALSE
*/
gboolean
gpiv_scan_cph (const gchar *MOD_KEY,
const gchar *PAR_KEY,
const gboolean use_mod_key,
const gchar *line,
const gchar *par_name,
gchar *parameter,
const gboolean verbose,
FILE *fp
);
/**
* Scans line string on **gfloat** parameter/header
* key and value or image header value (without program key). Prints result
* to file.
*
* @param[in] MOD_KEY module key as part of parameter key
* @param[in] PAR_KEY parameter key
* @param[in] use_mod_key flag to use module key
* @param[in] line line to be scanned
* @param[in] par_name parameter name which is scanned in line
* @param[out] parameter parameter value to be returned
* @param[in] verbose flag to print prarameter to stdout
* @param[in] fp file pointer to print parameter to
* @return flag representing parameter__set.
* Set to TRUE if parameter has been read, else FALSE
*/
gboolean
gpiv_scan_fph (const gchar *MOD_KEY,
const gchar *PAR_KEY,
const gboolean use_mod_key,
const gchar *line,
const gchar *par_name,
gfloat *parameter,
const gboolean verbose,
FILE *fp
);
/**
* Scans line string on **string** parameter key
* and value or image header value (without program key). Prints result
* to file.
*
* @param[in] MOD_KEY module key as part of parameter key
* @param[in] PAR_KEY parameter key
* @param[in] use_mod_key flag to use module key
* @param[in] line line to be scanned
* @param[in] par_name parameter name which is scanned in line
* @param[out] parameter parameter value to be returned
* @param[in] verbose flag to print prarameter to stdout
* @param[in] fp file pointer to print parameter to
* @return flag representing parameter__set.
* Set to TRUE if parameter has been read, else FALSE
*/
gboolean
gpiv_scan_sph (const gchar *MOD_KEY,
const gchar *PAR_KEY,
const gboolean use_mod_key,
const gchar *line,
const gchar *par_name,
gchar *parameter,
const gboolean verbose,
FILE *fp
);
#endif /* __LIBGPIV_UTILS_H__ */
|