]> git.tdb.fi Git - libs/core.git/blobdiff - source/fs/path.h
Use #ifdef _WIN32 rather than WIN32
[libs/core.git] / source / fs / path.h
index 9bc93f6c003eab2db5a695c2a312c9b1db1fc4c8..82600dc35c28d5787f69b56f0af3b8b12af50f22 100644 (file)
@@ -10,7 +10,7 @@ namespace FS {
 
 enum
 {
-#ifdef WIN32
+#ifdef _WIN32
        DIRSEP = '\\'
 #else
        DIRSEP = '/'
@@ -21,6 +21,12 @@ enum
 Stores a filesystem path.  Paths are always stored in a normalized form; there
 are never any "." or ".." components in the middle of the path, and relative
 paths always begin with a single "." component or a sequence ".." components.
+As a special case, calling the constructor with no arguments or with an empty
+string will construct an empty path; this can be usedful as an invalid value.
+
+A path can also be treated as an array of components, supporting indexing,
+iteration and slicing.  In this context the root directory is treated as a
+component of its own.
 */
 class Path
 {
@@ -30,10 +36,18 @@ private:
 public:
        class Iterator
        {
+       public:
+               typedef PositionArray::difference_type difference_type;
+               typedef const std::string value_type;
+               typedef const std::string *pointer;
+               typedef const std::string &reference;
+               typedef std::input_iterator_tag iterator_category;
+
        private:
                const Path *path;
                PositionArray::const_iterator iter;
                bool end;
+               std::string current;
 
                Iterator(const Path &, bool = false);
        public:
@@ -41,10 +55,14 @@ public:
                static Iterator at_end(const Path &p) { return Iterator(p, true); }
 
                Iterator &operator++();
+               Iterator operator++(int) { Iterator i = *this; ++*this; return i; }
                Iterator &operator--();
-               std::string operator*() const;
+               const std::string &operator*() const { return current; }
+               const std::string *operator->() const { return &current; }
                bool operator==(const Iterator &i) const { return (iter==i.iter && end==i.end); }
                bool operator!=(const Iterator &i) const { return !(*this==i); }
+       private:
+               void update();
        };
 
 private:
@@ -59,20 +77,26 @@ private:
        void init(const std::string &);
 
 public:
+       /// Returns the path as a string.
        const std::string &str() const { return path; }
 
+       /// Returns the path as a pointer to a null-terminated string.
+       const char *c_str() const { return path.c_str(); }
+
        /// Returns the number of components in the path.
        unsigned size() const;
 
+       /** Indicates whether the path is empty.  This really means empty; a path
+       pointing to the current directory is not empty. */
        bool empty() const { return path.empty(); }
 
-       /// Determines whether the path starts from the root directory
+       /// Determines whether the path starts from the root directory.
        bool is_absolute() const;
 
        /// Extracts a range of components from the path.
        Path subpath(unsigned start, unsigned count = static_cast<unsigned>(-1)) const;
 
-       /// Concatenates this path with another one, with usual filesystem semantics
+       /// Concatenates this path with another one, with usual filesystem semantics.
        Path operator/(const Path &p) const;
        Path &operator/=(const Path &);