diff engine/core/vfs/directoryprovider.h @ 693:5e010218273d

This commit is to back port a fix from 0.3.3 dev branch to the trunk. The directory provider will now use the boost::filesystem::is_directory function to determine if the passed in source is a directory. This allows a python client (through VFS::addNewSource) to add a directory source that is either an absolute path or a relative path from where the application is launched. [t:544]
author vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date Wed, 08 Jun 2011 04:34:50 +0000
parents 90005975cdbb
children
line wrap: on
line diff
--- a/engine/core/vfs/directoryprovider.h	Wed Jun 08 03:08:58 2011 +0000
+++ b/engine/core/vfs/directoryprovider.h	Wed Jun 08 04:34:50 2011 +0000
@@ -43,18 +43,20 @@
 		public:
 			DirectoryProvider() : VFSSourceProvider("OS Directory") { }
 
-			/** Check if a given directory is readable for this VFSSource.
- 			 * Directory sources must be denoted by a trailing '/', otherwise VFS will consider
- 			 * the source to be a file, and unreadable asa a directory.
+			/** Check if a given directory is readable.
+ 			 * The path must either be an absolute path or relative
+             * to the current working directory where the client was launched
 			 *
-			 * @param file the filename to check
+			 * @param path the filename to check
 			 * @return true if readable, false otherwise
 			 */
 			virtual bool isReadable(const std::string& path) const;
 
 			/** Create a new instance of a VFSSource initialized with the given directory
-			 *
-			 * @param file the directory to open
+			 * This will only pass if the path is readable and recognized
+             * as a directory as per the description of isReadable
+             *
+			 * @param path the directory to open
 			 * @return the new VFSSource
 			 */
 			virtual VFSSource* createSource(const std::string& path) const;