directory_utils Class Reference

Directory and path utilities. More...

#include <playlist.h>

List of all members.

Static Public Member Functions
static string	join_file_to_directory (const string directory, const string &file)
	Join the file to the directory.
static string	get_directory_from_file (const string &file)
	Obtain the directory from the file.
static string	get_absolute_path_to_file (const string &directory, const string &file)
	Get absolute path to file.
static string	get_relative_path_to_file (const string &directory, const string &file)
	Get relative path to file.
static string	expand_directory (const string directory)
	Expand directories with ~ as the first item.

---

Detailed Description

Directory and path utilities.

Definition at line 108 of file playlist.h.

---

Member Function Documentation

string directory_utils::expand_directory (  const string  directory  )  [static]

Expand directories with ~ as the first item. Definition at line 235 of file playlist.cc. References StringUtils::split(). Referenced by PlayList::GetProjectDirectory(). { string output; vector <string> items; StringUtils::split( directory, "/", items ); vector< string >::iterator item = items.begin( ); if ( item != items.end( ) && *item == "~" ) { output = getenv( "HOME" ); item ++; } for ( ; item != items.end( ); item ++ ) output += "/" + *item; return output; }

string directory_utils::get_absolute_path_to_file (  const string &  directory, const string &  file )  [static]

Get absolute path to file. If file has an absolute path, then you will get a cleaned up version of that path and file returned (ie: /'directory'/'sub'/..///'file' becomes /'directory'/'file'). If file is relative (ie: not starting with a /) and directory is absolute (ie: starting with a /) then you will receive the appended output. If neither is absolute, then cwd is pre-pended to directory and file is appended and a cleaned up file spec is returned. Definition at line 190 of file playlist.cc. References join_file_to_directory(). Referenced by fillMap(), and PlayList::LoadMediaObject(). { return join_file_to_directory( directory, file ); }

string directory_utils::get_directory_from_file (  const string &  file  )  [static]

Obtain the directory from the file. A value of 'file' that actually corresponds to a directory will result in the parent directory being returned ie: /'parent'/'directory' returns /'parent' which is probably not what you want... Definition at line 173 of file playlist.cc. References join_file_to_directory(). Referenced by KinoCommon::getFileToOpen(), PlayList::GetPlayList(), PlayList::GetProjectDirectory(), PlayList::InsertPlayList(), PlayList::LoadPlayList(), KinoCommon::loadPlayList(), and PlayList::SavePlayList(). { return join_file_to_directory( "", file + "/.." ); }

string directory_utils::get_relative_path_to_file (  const string &  directory, const string &  file )  [static]

Get relative path to file. Given a directory of /same-path/different-path and file of /same-path/blah, the output should be ../blah. Definition at line 201 of file playlist.cc. References StringUtils::join(), join_file_to_directory(), and StringUtils::split(). Referenced by relativeMap(). { string output = ""; string absolute = join_file_to_directory( directory, file ); vector < string > directory_items; vector < string > absolute_items; StringUtils::split( absolute, "/", absolute_items ); StringUtils::split( directory, "/", directory_items ); vector < string >::iterator directory_item; vector < string >::iterator absolute_item; // While they're both the same, remove from both for ( directory_item = directory_items.begin(), absolute_item = absolute_items.begin(); directory_item != directory_items.end() && absolute_item != absolute_items.end() && *directory_item == *absolute_item; ) { directory_items.erase( directory_item ); absolute_items.erase( absolute_item ); directory_item = directory_items.begin(); absolute_item = absolute_items.begin(); } // For each item left in the directory_items, output a ../ for ( directory_item = directory_items.begin(); directory_item != directory_items.end() ; directory_item ++ ) output += "../"; // Now simply join what's left in absolute to output and return output += StringUtils::join( absolute_items, "/" ); return output; }

string directory_utils::join_file_to_directory (  const string  directory, const string &  file )  [static]

Join the file to the directory. It is assumed that if the input file is not an absolute path (ie: starting with a /) then the full path is relative to the current working directory. So 'file' would return /'cwd' and 'relative/file' would be /'cwd + relative'. Note that .. directory specs in the file input are normalised to the full path minus the .. and erroneously formed paths (containing double slashes for example) are also corrected in the output. Definition at line 121 of file playlist.cc. References StringUtils::join(), and StringUtils::split(). Referenced by get_absolute_path_to_file(), get_directory_from_file(), get_relative_path_to_file(), and PlayList::GetProjectDirectory(). { vector <string> items; // Determine if the file is a full file spec or not if ( file[ 0 ] != '/' && directory[ 0 ] != '/' ) { char path[ PATH_MAX ]; getcwd( path, PATH_MAX ); StringUtils::split( path, "/", items ); } // Now add the directory if file is not absolute if ( file[ 0 ] != '/' ) StringUtils::split( directory, "/", items ); // Split the file and append to the directory info StringUtils::split( file, "/", items ); // iterate through the items vector for ( vector< string >::iterator item = items.begin( ); item != items.end( ); ) { if ( *item == ".." ) { if ( item == items.begin( ) ) { items.erase( item ); item = items.begin(); } else { items.erase( -- item + 1 ); items.erase( -- item + 1 ); item ++; } } else { item ++; } } return "/" + StringUtils::join( items, "/" ); }

---

The documentation for this class was generated from the following files:

• playlist.h
• playlist.cc

---