/usr/include/pcl-1.7/pcl/console/parse.h is in libpcl-dev 1.7.2-14build1.
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 350 351 352 353 354 355 356 357 358 359 360 361 362 | /*
* Software License Agreement (BSD License)
*
* Point Cloud Library (PCL) - www.pointclouds.org
* Copyright (c) 2010-2012, Willow Garage, Inc.
* Copyright (c) 2012-, Open Perception, Inc.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of the copyright holder(s) nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef PCL_CONSOLE_PARSE_H_
#define PCL_CONSOLE_PARSE_H_
#include <vector>
#include <sstream>
#include <pcl/pcl_macros.h>
namespace pcl
{
namespace console
{
/** \brief Finds whether the argument with name "argument_name" is in the argument list "argv".
* An example for a widely used switch argument is the "-r" flag for unix commands that indicates whether
* the command should run recursively or not.
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] argument_name the string value to search for
* \return true if argument was found, false otherwise
* \note find_switch is simply returning find_argument != -1.
*/
PCL_EXPORTS bool
find_switch (int argc, char** argv, const char* argument_name);
/** \brief Finds the position of the argument with name "argument_name" in the argument list "argv"
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] argument_name the string value to search for
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
find_argument (int argc, char** argv, const char* argument_name);
/** \brief Template version for parsing arguments. Template parameter needs to have input stream operator overloaded!
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] argument_name the name of the argument to search for
* \param[out] value The value of the argument
* \return index of found argument or -1 if arguments do not appear in list
*/
template<typename Type> int
parse (int argc, char** argv, const char* argument_name, Type& value)
{
int index = find_argument (argc, argv, argument_name) + 1;
if (index > 0 && index < argc)
{
std::istringstream stream;
stream.clear ();
stream.str (argv[index]);
stream >> value;
}
return (index - 1);
}
/** \brief Parse for a specific given command line argument.
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the string value to search for
* \param[out] val the resultant value
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_argument (int argc, char** argv, const char* str, std::string &val);
/** \brief Parse for a specific given command line argument.
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the string value to search for
* \param[out] val the resultant value
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_argument (int argc, char** argv, const char* str, bool &val);
/** \brief Parse for a specific given command line argument.
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the string value to search for
* \param[out] val the resultant value
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_argument (int argc, char** argv, const char* str, float &val);
/** \brief Parse for a specific given command line argument.
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the string value to search for
* \param[out] val the resultant value
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_argument (int argc, char** argv, const char* str, double &val);
/** \brief Parse for a specific given command line argument.
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the string value to search for
* \param[out] val the resultant value
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_argument (int argc, char** argv, const char* str, int &val);
/** \brief Parse for a specific given command line argument.
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the string value to search for
* \param[out] val the resultant value
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_argument (int argc, char** argv, const char* str, unsigned int &val);
/** \brief Parse for a specific given command line argument.
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the string value to search for
* \param[out] val the resultant value
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_argument (int argc, char** argv, const char* str, char &val);
/** \brief Parse for specific given command line arguments (2x values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] f the first output value
* \param[out] s the second output value
* \param[in] debug whether to print debug info or not
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_2x_arguments (int argc, char** argv, const char* str, float &f, float &s, bool debug = true);
/** \brief Parse for specific given command line arguments (2x values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] f the first output value
* \param[out] s the second output value
* \param[in] debug whether to print debug info or not
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_2x_arguments (int argc, char** argv, const char* str, double &f, double &s, bool debug = true);
/** \brief Parse for specific given command line arguments (2x values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] f the first output value
* \param[out] s the second output value
* \param[in] debug whether to print debug info or not
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_2x_arguments (int argc, char** argv, const char* str, int &f, int &s, bool debug = true);
/** \brief Parse for specific given command line arguments (3x values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] f the first output value
* \param[out] s the second output value
* \param[out] t the third output value
* \param[in] debug whether to print debug info or not
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_3x_arguments (int argc, char** argv, const char* str, float &f, float &s, float &t, bool debug = true);
/** \brief Parse for specific given command line arguments (3x values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] f the first output value
* \param[out] s the second output value
* \param[out] t the third output value
* \param[in] debug whether to print debug info or not
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_3x_arguments (int argc, char** argv, const char* str, double &f, double &s, double &t, bool debug = true);
/** \brief Parse for specific given command line arguments (3x values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] f the first output value
* \param[out] s the second output value
* \param[out] t the third output value
* \param[in] debug whether to print debug info or not
* return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_3x_arguments (int argc, char** argv, const char* str, int &f, int &s, int &t, bool debug = true);
/** \brief Parse for specific given command line arguments (3x values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] v the vector into which the parsed values will be copied
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_x_arguments (int argc, char** argv, const char* str, std::vector<double>& v);
/** \brief Parse for specific given command line arguments (N values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] v the vector into which the parsed values will be copied
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_x_arguments (int argc, char** argv, const char* str, std::vector<float>& v);
/** \brief Parse for specific given command line arguments (N values comma
* separated).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] v the vector into which the parsed values will be copied
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS int
parse_x_arguments (int argc, char** argv, const char* str, std::vector<int>& v);
/** \brief Parse for specific given command line arguments (multiple occurences
* of the same command line parameter).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] values the resultant output values
* \return index of found argument or -1 if arguments do not appear in list
*/
PCL_EXPORTS bool
parse_multiple_arguments (int argc, char** argv, const char* str, std::vector<int> &values);
/** \brief Parse for specific given command line arguments (multiple occurences
* of the same command line parameter).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] values the resultant output values
* \return true if found, false otherwise
*/
PCL_EXPORTS bool
parse_multiple_arguments (int argc, char** argv, const char* str, std::vector<float> &values);
/** \brief Parse for specific given command line arguments (multiple occurences
* of the same command line parameter).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] values the resultant output values
* \return true if found, false otherwise
*/
PCL_EXPORTS bool
parse_multiple_arguments (int argc, char** argv, const char* str, std::vector<double> &values);
/** \brief Parse for a specific given command line argument (multiple occurences
* of the same command line parameter).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the string value to search for
* \param[out] values the resultant output values
* \return true if found, false otherwise
*/
PCL_EXPORTS bool
parse_multiple_arguments (int argc, char** argv, const char* str, std::vector<std::string> &values);
/** \brief Parse command line arguments for file names with given extension (multiple occurences
* of 2x argument groups, separated by commas).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] values_f the first vector of output values
* \param[out] values_s the second vector of output values
* \return true if found, false otherwise
*/
PCL_EXPORTS bool
parse_multiple_2x_arguments (int argc, char** argv, const char* str,
std::vector<double> &values_f,
std::vector<double> &values_s);
/** \brief Parse command line arguments for file names with given extension (multiple occurences
* of 3x argument groups, separated by commas).
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] str the command line argument to search for
* \param[out] values_f the first vector of output values
* \param[out] values_s the second vector of output values
* \param[out] values_t the third vector of output values
* \return true if found, false otherwise
*/
PCL_EXPORTS bool
parse_multiple_3x_arguments (int argc, char** argv, const char* str,
std::vector<double> &values_f,
std::vector<double> &values_s,
std::vector<double> &values_t);
/** \brief Parse command line arguments for file names with given extension
* \param[in] argc the number of command line arguments
* \param[in] argv the command line arguments
* \param[in] ext the extension to search for
* \return a vector with file names indices
*/
PCL_EXPORTS std::vector<int>
parse_file_extension_argument (int argc, char** argv, const std::string &ext);
}
}
#endif // PCL_CONSOLE_PARSE_H_
|