lib/third_party/Pluma/Dir.hpp

   1 ////////////////////////////////////////////////////////////\r
   2 //\r
   3 // Pluma - Plug-in Management Framework\r
   4 // Copyright (C) 2010-2012 Gil Costa (gsaurus@gmail.com)\r
   5 //\r
   6 // This software is provided 'as-is', without any express or implied warranty.\r
   7 // In no event will the authors be held liable for any damages arising from the use of this software.\r
   8 //\r
   9 // Permission is granted to anyone to use this software for any purpose,\r
  10 // including commercial applications, and to alter it and redistribute it freely,\r
  11 // subject to the following restrictions:\r
  12 //\r
  13 // 1. The origin of this software must not be misrepresented;\r
  14 //    you must not claim that you wrote the original software.\r
  15 //    If you use this software in a product, an acknowledgment\r
  16 //    in the product documentation would be appreciated but is not required.\r
  17 //\r
  18 // 2. Altered source versions must be plainly marked as such,\r
  19 //    and must not be misrepresented as being the original software.\r
  20 //\r
  21 // 3. This notice may not be removed or altered from any source distribution.\r
  22 //\r
  23 ////////////////////////////////////////////////////////////\r
  24 \r
  25 #ifndef PLUMA_DIRECTORY_HPP\r
  26 #define PLUMA_DIRECTORY_HPP\r
  27 \r
  28 ////////////////////////////////////////////////////////////\r
  29 // Headers\r
  30 ////////////////////////////////////////////////////////////\r
  31 #include <Pluma/Config.hpp>\r
  32 #include <string>\r
  33 #include <list>\r
  34 \r
  35 \r
  36 namespace pluma{\r
  37 \r
  38 namespace dir{\r
  39 \r
  40 ////////////////////////////////////////////////////////////\r
  41 /// \brief List files of a directory.\r
  42 ///\r
  43 /// \param list The output files list.\r
  44 /// \param folder The folder where to search in\r
  45 /// \param extension A file extension filter,\r
  46 /// empty extension will match all files.\r
  47 /// \param recursive If true it will list files in\r
  48 /// sub directories as well.\r
  49 ///\r
  50 ////////////////////////////////////////////////////////////\r
  51 void listFiles(\r
  52     std::list<std::string>& list,\r
  53     const std::string& folder,\r
  54     const std::string& extension = "",\r
  55     bool recursive = false\r
  56 );\r
  57 \r
  58 \r
  59 }   // namespace dir\r
  60 \r
  61 }   // namespace pluma\r
  62 \r
  63 \r
  64 #endif // PLUMA_DIRECTORY_HPP\r