Blinker

1) /* Blinker

2)    Copyright 2011-2019 Stefan Schuermans <stefan@blinkenarea.org>

3)    Copyleft GNU public license - http://www.gnu.org/copyleft/gpl.html
4)    a blinkenarea.org project */
5) 

6) #ifndef BLINKER_DIRECTORY_H
7) #define BLINKER_DIRECTORY_H

8) 
9) #include <list>
10) #include <string>
11) 
12) #include "File.h"
13) 
14) namespace Blinker {
15) 
16) /// information about a directory
17) class Directory: public File
18) {
19) public:
20)   /// type of directory entries
21)   enum Type {
22)     TypeSubdir, ///< subdirectory
23)     TypeFile    ///< file
24)   };
25) 
26) public:
27)   /**
28)    * @brief constructor from path
29)    * @param[in] path path to directory
30)    */
31)   Directory(const std::string &path);
32) 
33) public:
34)   /**
35)    * @brief get list of entries in directory
36)    * @param[in] type type of directory entries to return
37)    * @param[out] entries list of directory entries
38)    */
39)   void getEntries(Type type, std::list<std::string> &entries) const;
40) 
41)   /**
42)    * @brief get subdirectory
43)    * @param[in] name of subdirectory
44)    * @return subdirectory object
45)    */
46)   Directory getSubdir(const std::string &name) const;
47) 

48)   /**
49)    * @brief get parent directory
50)    * @return parent directory object
51)    */
52)   Directory getParent() const;
53) 

54)   /**
55)    * @brief get file in directory
56)    * @param[in] name of file
57)    * @return file object
58)    */
59)   File getFile(const std::string &name) const;
60) }; // class Directory
61) 
62) } // namespace Blinker
63) 

64) #endif // #ifndef BLINKER_DIRECTORY_H