X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=blobdiff_plain;f=source%2Fpath.h;h=0b946fdcdb18bb00ab79ffe189249946fc5bc8be;hp=1da6a934cd800874107503ab0fea7d259061f951;hb=d3c9b9abb9e3c69aeecbca1044b43e7ec83f3b8c;hpb=0ba3e9d15af4e8c30eef5445d2b64fee4870505f

diff --git a/source/path.h b/source/path.h
index 1da6a93..0b946fd 100644
--- a/source/path.h
+++ b/source/path.h
@@ -1,70 +1,95 @@
 /* $Id$
 
-This file is part of libmsppath
-Copyright © 2006-2007  Mikko Rasa, Mikkosoft Productions
+This file is part of libmspfs
+Copyright © 2006-2008  Mikko Rasa, Mikkosoft Productions
 Distributed under the LGPL
 */
 
-#ifndef MSP_PATH_PATH_H_
-#define MSP_PATH_PATH_H_
+#ifndef MSP_FS_PATH_H_
+#define MSP_FS_PATH_H_
 
 #include <ostream>
 #include <string>
 
 namespace Msp {
+namespace FS {
 
 enum
 {
 #ifdef WIN32
-	DIRCHAR='\\'
+	DIRSEP='\\'
 #else
-	DIRCHAR='/'
+	DIRSEP='/'
 #endif
 };
 
+/**
+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.
+*/
 class Path
 {
 public:
 	class Iterator
 	{
+		friend class Path;
+
+	private:
+		const Path &path;
+		std::string::size_type start,end;
+
+		Iterator(const Path &);
 	public:
 		Iterator    &operator++();
 		Iterator    &operator--();
 		std::string operator*() const;
 		bool        operator==(const Iterator &i) const { return (start==i.start && end==i.end); }
 		bool        operator!=(const Iterator &i) const { return !(*this==i); }
-	private:
-		const Path &path;
-		unsigned   start,end;
+	};
 
-		Iterator(const Path &);
+private:
+	std::string path;
 
-		friend class Path;
-	};
+public:
+	Path();
+	Path(const std::string &);
+	Path(const char *);
 
-	Path() { }
-	Path(const std::string &p)     { init(p); }
-	Path(const char *p)            { init(p); }
 	const std::string &str() const { return path; }
+
+	/// Returns the number of components in the path.
 	unsigned    size() const;
+
 	bool        empty() const { return path.empty(); }
-	bool        is_absolute() const;
-	Path        subpath(unsigned, unsigned =static_cast<unsigned>(-1)) const;
-	Path        operator/(const Path &p) const { Path a=*this; a/=p; return a; }
-	Path        &operator/=(const Path &);
+
+	/// 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
+	Path operator/(const Path &p) const;
+	Path &operator/=(const Path &);
+
+	/**
+	Extracts a single component from the path.  Negative indices count from the
+	end of the path.
+	*/
 	std::string operator[](int) const;
+
 	bool        operator==(const Path &) const;
-	Iterator    begin() const { return Iterator(*this); }
-	Iterator    end() const   { Iterator i(*this); i.start=i.end=std::string::npos; return i; }
+	Iterator    begin() const;
+	Iterator    end() const;
 private:
-	std::string path;
-
 	void init(const std::string &);
 	void add_component(const std::string &);
 };
 
 inline std::ostream &operator<<(std::ostream &o, const Path &p) { o<<p.str(); return o; }
 
+} // namespace FS
 } // namespace Msp
 
 #endif