blob: 2a0efa9763f8a0604482ae2556243b5de23b55d4 [file] [log] [blame]
/*
* Copyright 2004 The WebRTC Project Authors. All rights reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef WEBRTC_BASE_PATHUTILS_H__
#define WEBRTC_BASE_PATHUTILS_H__
#include <string>
// Temporary, until deprecated helpers are removed.
#include "webrtc/base/fileutils.h"
namespace rtc {
///////////////////////////////////////////////////////////////////////////////
// Pathname - parsing of pathnames into components, and vice versa.
//
// To establish consistent terminology, a filename never contains a folder
// component. A folder never contains a filename. A pathname may include
// a folder and/or filename component. Here are some examples:
//
// pathname() /home/john/example.txt
// folder() /home/john/
// filename() example.txt
// parent_folder() /home/
// folder_name() john/
// basename() example
// extension() .txt
//
// Basename may begin, end, and/or include periods, but no folder delimiters.
// If extension exists, it consists of a period followed by zero or more
// non-period/non-delimiter characters, and basename is non-empty.
///////////////////////////////////////////////////////////////////////////////
class Pathname {
public:
// Folder delimiters are slash and backslash
static bool IsFolderDelimiter(char ch);
static char DefaultFolderDelimiter();
Pathname();
Pathname(const Pathname&);
Pathname(Pathname&&);
Pathname(const std::string& pathname);
Pathname(const std::string& folder, const std::string& filename);
Pathname& operator=(const Pathname&);
Pathname& operator=(Pathname&&);
// Set's the default folder delimiter for this Pathname
char folder_delimiter() const { return folder_delimiter_; }
void SetFolderDelimiter(char delimiter);
// Normalize changes all folder delimiters to folder_delimiter()
void Normalize();
// Reset to the empty pathname
void clear();
// Returns true if the pathname is empty. Note: this->pathname().empty()
// is always false.
bool empty() const;
std::string url() const;
// Returns the folder and filename components. If the pathname is empty,
// returns a string representing the current directory (as a relative path,
// i.e., ".").
std::string pathname() const;
void SetPathname(const std::string& pathname);
void SetPathname(const std::string& folder, const std::string& filename);
// Append pathname to the current folder (if any). Any existing filename
// will be discarded.
void AppendPathname(const std::string& pathname);
std::string folder() const;
std::string folder_name() const;
std::string parent_folder() const;
// SetFolder and AppendFolder will append a folder delimiter, if needed.
void SetFolder(const std::string& folder);
void AppendFolder(const std::string& folder);
std::string basename() const;
bool SetBasename(const std::string& basename);
std::string extension() const;
// SetExtension will prefix a period, if needed.
bool SetExtension(const std::string& extension);
std::string filename() const;
bool SetFilename(const std::string& filename);
#if defined(WEBRTC_WIN)
bool GetDrive(char* drive, uint32_t bytes) const;
static bool GetDrive(char* drive,
uint32_t bytes,
const std::string& pathname);
#endif
private:
std::string folder_, basename_, extension_;
char folder_delimiter_;
};
///////////////////////////////////////////////////////////////////////////////
// Global Helpers (deprecated)
///////////////////////////////////////////////////////////////////////////////
inline void SetOrganizationName(const std::string& organization) {
Filesystem::SetOrganizationName(organization);
}
inline void SetApplicationName(const std::string& application) {
Filesystem::SetApplicationName(application);
}
inline void GetOrganizationName(std::string* organization) {
Filesystem::GetOrganizationName(organization);
}
inline void GetApplicationName(std::string* application) {
Filesystem::GetApplicationName(application);
}
inline bool CreateFolder(const Pathname& path) {
return Filesystem::CreateFolder(path);
}
inline bool FinishPath(Pathname& path, bool create, const std::string& append) {
if (!append.empty())
path.AppendFolder(append);
return !create || CreateFolder(path);
}
// Note: this method uses the convention of <temp>/<appname> for the temporary
// folder. Filesystem uses <temp>/<exename>. We will be migrating exclusively
// to <temp>/<orgname>/<appname> eventually. Since these are temp folders,
// it's probably ok to orphan them during the transition.
inline bool GetTemporaryFolder(Pathname& path, bool create,
const std::string& append) {
std::string application_name;
Filesystem::GetApplicationName(&application_name);
ASSERT(!application_name.empty());
return Filesystem::GetTemporaryFolder(path, create, &application_name)
&& FinishPath(path, create, append);
}
inline bool GetAppDataFolder(Pathname& path, bool create,
const std::string& append) {
ASSERT(!create); // TODO: Support create flag on Filesystem::GetAppDataFolder.
return Filesystem::GetAppDataFolder(&path, true)
&& FinishPath(path, create, append);
}
inline bool CleanupTemporaryFolder() {
Pathname path;
if (!GetTemporaryFolder(path, false, ""))
return false;
if (Filesystem::IsAbsent(path))
return true;
if (!Filesystem::IsTemporaryPath(path)) {
ASSERT(false);
return false;
}
return Filesystem::DeleteFolderContents(path);
}
///////////////////////////////////////////////////////////////////////////////
} // namespace rtc
#endif // WEBRTC_BASE_PATHUTILS_H__