src/support/globbing.h

   1 // -*- C++ -*-
   2 /**
   3  * \file globbing.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef GLOBBING_H
  13 #define GLOBBING_H
  14
  15 #include <string>
  16 #include <vector>
  17
  18 namespace lyx {
  19 namespace support {
  20
  21 /** A wrapper for the Posix function 'glob'.
  22  *  \param matches files found to match \c pattern are appended.
  23  *  \param pattern the glob to be expanded. Eg "*.[Ch]".
  24  *  \param working_dir the starting directory from which \c pattern
  25  *  is to be expanded. Used only if \c pattern is a relative path.
  26  *  \param flags flags to be passed to the system function. See 'man glob'.
  27  */
  28 void glob(std::vector<std::string> & matches,
  29           std::string const & pattern,
  30           std::string const & working_dir,
  31           int flags = 0);
  32
  33 } // namespace support
  34 } // namespace lyx
  35
  36 #endif // NOT GLOBBING_H