File: DirIterator.hh

package info (click to toggle)
exactimage 1.2.1-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,048 kB
  • sloc: cpp: 35,940; ansic: 1,952; xml: 1,447; makefile: 338; perl: 138; sh: 110; python: 45; php: 37; ruby: 12
file content (179 lines) | stat: -rw-r--r-- 4,499 bytes parent folder | download | duplicates (6)
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
/*
 * --- GSMP-COPYRIGHT-NOTE-BEGIN ---
 * 
 * This copyright note is auto-generated by ./scripts/Create-CopyPatch.
 * Please add additional copyright information _after_ the line containing
 * the GSMP-COPYRIGHT-NOTE-END tag. Otherwise it might get removed by
 * the ./scripts/Create-CopyPatch script. Do not edit this copyright text!
 * 
 * GSMP: utility/include/DirIterator.hh
 * General Sound Manipulation Program is Copyright (C) 2000 - 2004
 *   Valentin Ziegler and René Rebe
 * 
 * This program 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; version 2. A copy of the GNU General
 * Public License can be found in the file LICENSE.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANT-
 * ABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 * Public License for more details.
 * 
 * --- GSMP-COPYRIGHT-NOTE-END ---
 */

/* Short Description:
 *   A simple directory iterator.
 */

#ifndef UTILITY__DIRITERATOR_HH__
#define UTILITY__DIRITERATOR_HH__

#include <dirent.h>    // used by directory iterator
#include <string>

#include <File.hh>

namespace Utility
{
  
  /* Find a unique filename, "fname + i". The first i can be
     specified.  The fname is overwritten - the used index is
     returned. - A file is unique when there is no file with the
     tested name -> even if the trailing path is not available */
  int FindUniqueName (std::string& fname, const std::string& base,
		      const std::string& ext,
		      int first_tried_index = 0);
  
  /* this is some wrapping around the (ugly) posix directory stuff
     not really an iterator ... */
  class DirList
  {
  public:
    class Iterator
    {
    public:
      Iterator ();
      Iterator (DirList* i_dirlist);
      Iterator (const Iterator& i_other);
      ~Iterator ();
      
      const FileType Type ();
      
      const Iterator& operator++ () {
	Next ();
	return *this;
      }

      const Iterator operator++ (int) {
	Iterator it (*this);
	Next ();
	return it;
      }
      
      const std::string& operator* () {
	// maybe Open() was delayed?
	if (!m_open && !m_end)
	  Open();
	return m_entry_name;
      }
      
      const Iterator& operator= (const Iterator& other) {
	if (m_open)
	  Close ();
	
	m_end = other.m_end;
	m_dirlist = other.m_dirlist;
	m_entry_name = other.m_entry_name;
	
	// no Open() here - delayed until next access
	return *this;
      }

      bool operator== (const Iterator& other) {
	return (m_dirlist == other.m_dirlist &&
		m_end == other.m_end &&
		m_entry_name == other.m_entry_name);
      }
      
      bool operator!= (const Iterator& other) {
	return (m_dirlist != other.m_dirlist ||
		m_end != other.m_end ||
		m_entry_name != other.m_entry_name);
      }
      
      friend class Utility::DirList;
      
    private:
      
      void Open ();
      void Close ();
      
      // must be Opened!
      void Next () {
	
	// avoid recursion ;-)
	while (true) {
	  m_internal_dir_entry = readdir (m_internal_dir);
	  if (m_internal_dir_entry == 0) {
	    m_entry_name = "";
	    m_end = true;
	    return;
	  }
	  
	  // skip . and .. - any dir has those and apps normally do not need them
	  // here are some optimizations since Next() is performance critical
	  m_entry_name = m_internal_dir_entry->d_name;
	  
	  // short path
	  if (m_entry_name[0] != '.' || m_entry_name.size() > 2)
	    return;
	  
	  // expensive checks
	  if (!(m_entry_name == "." || m_entry_name == ".."))
	    return;
	}
      }
      
      // direct state
      bool m_open;
      bool m_end;
      DirList* m_dirlist;
      std::string m_entry_name;
      
      // indirect state of C API
      DIR* m_internal_dir;
      dirent* m_internal_dir_entry;
      
      // a File object for the case the dirent does not yield a
      // valid d_type
      File m_file;
    };
    
    DirList (const std::string& i_dirmname = "/");
    ~DirList ();
    
#ifdef TODO
    // navigate in the directory tree
    void Down ();
    bool Up (const Iterator& it);
    // navigation alias
    bool Enter (const Iterator& it) {
      return Up (it);
    };
#endif
    
    const Iterator Begin ();
    const Iterator End ();
    
    friend class Iterator;
    
  protected:
    
    std::string m_dirname;
  };
  
} // end namespace utility

#endif // UTILITY__DIRITERATOR_HH__