LLVM API Documentation

Classes | Namespaces | Enumerations | Functions
FileSystem.h File Reference
#include "llvm/ADT/IntrusiveRefCntPtr.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Support/DataTypes.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/TimeValue.h"
#include <ctime>
#include <iterator>
#include <stack>
#include <string>
#include <system_error>
#include <tuple>
#include <vector>
Include dependency graph for FileSystem.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  llvm::sys::fs::space_info
 space_info - Self explanatory. More...
class  llvm::sys::fs::UniqueID
class  llvm::sys::fs::file_status
struct  llvm::sys::fs::file_magic
class  llvm::sys::fs::mapped_file_region
class  llvm::sys::fs::directory_entry
struct  llvm::sys::fs::detail::DirIterState
class  llvm::sys::fs::directory_iterator
struct  llvm::sys::fs::detail::RecDirIterState
class  llvm::sys::fs::recursive_directory_iterator

Namespaces

namespace  llvm
 

List of target independent CodeGen pass IDs.


namespace  llvm::sys
namespace  llvm::sys::fs
namespace  llvm::sys::fs::detail

Enumerations

enum  llvm::sys::fs::file_type {
  llvm::sys::fs::status_error, llvm::sys::fs::file_not_found, llvm::sys::fs::regular_file, llvm::sys::fs::directory_file,
  llvm::sys::fs::symlink_file, llvm::sys::fs::block_file, llvm::sys::fs::character_file, llvm::sys::fs::fifo_file,
  llvm::sys::fs::socket_file, llvm::sys::fs::type_unknown
}
 An enumeration for the file system's view of the type. More...
enum  llvm::sys::fs::perms {
  llvm::sys::fs::no_perms = 0, llvm::sys::fs::owner_read = 0400, llvm::sys::fs::owner_write = 0200, llvm::sys::fs::owner_exe = 0100,
  llvm::sys::fs::owner_all = owner_read | owner_write | owner_exe, llvm::sys::fs::group_read = 040, llvm::sys::fs::group_write = 020, llvm::sys::fs::group_exe = 010,
  llvm::sys::fs::group_all = group_read | group_write | group_exe, llvm::sys::fs::others_read = 04, llvm::sys::fs::others_write = 02, llvm::sys::fs::others_exe = 01,
  llvm::sys::fs::others_all = others_read | others_write | others_exe, llvm::sys::fs::all_read = owner_read | group_read | others_read, llvm::sys::fs::all_write = owner_write | group_write | others_write, llvm::sys::fs::all_exe = owner_exe | group_exe | others_exe,
  llvm::sys::fs::all_all = owner_all | group_all | others_all, llvm::sys::fs::set_uid_on_exe = 04000, llvm::sys::fs::set_gid_on_exe = 02000, llvm::sys::fs::sticky_bit = 01000,
  llvm::sys::fs::perms_not_known = 0xFFFF
}
enum  llvm::sys::fs::AccessMode { llvm::sys::fs::Exist, llvm::sys::fs::Write, llvm::sys::fs::Execute }
enum  llvm::sys::fs::OpenFlags {
  llvm::sys::fs::F_None = 0, llvm::sys::fs::F_Excl = 1, llvm::sys::fs::F_Append = 2, llvm::sys::fs::F_Text = 4,
  llvm::sys::fs::F_RW = 8
}

Functions

perms llvm::sys::fs::operator| (perms l, perms r)
perms llvm::sys::fs::operator& (perms l, perms r)
perms & llvm::sys::fs::operator|= (perms &l, perms r)
perms & llvm::sys::fs::operator&= (perms &l, perms r)
perms llvm::sys::fs::operator~ (perms x)
std::error_code llvm::sys::fs::make_absolute (SmallVectorImpl< char > &path)
 Make path an absolute path.
std::error_code llvm::sys::fs::create_directories (const Twine &path, bool IgnoreExisting=true)
 Create all the non-existent directories in path.
std::error_code llvm::sys::fs::create_directory (const Twine &path, bool IgnoreExisting=true)
 Create the directory in path.
std::error_code llvm::sys::fs::create_link (const Twine &to, const Twine &from)
 Create a link from from to to.
std::error_code llvm::sys::fs::current_path (SmallVectorImpl< char > &result)
 Get the current path.
std::error_code llvm::sys::fs::remove (const Twine &path, bool IgnoreNonExisting=true)
 Remove path. Equivalent to POSIX remove().
std::error_code llvm::sys::fs::rename (const Twine &from, const Twine &to)
 Rename from to to. Files are renamed as if by POSIX rename().
std::error_code llvm::sys::fs::copy_file (const Twine &From, const Twine &To)
 Copy the contents of From to To.
std::error_code llvm::sys::fs::resize_file (const Twine &path, uint64_t size)
 Resize path to size. File is resized as if by POSIX truncate().
bool llvm::sys::fs::exists (file_status status)
 Does file exist?
std::error_code llvm::sys::fs::access (const Twine &Path, AccessMode Mode)
 Can the file be accessed?
bool llvm::sys::fs::exists (const Twine &Path)
 Does file exist?
bool llvm::sys::fs::can_execute (const Twine &Path)
 Can we execute this file?
bool llvm::sys::fs::can_write (const Twine &Path)
 Can we write this file?
bool llvm::sys::fs::equivalent (file_status A, file_status B)
 Do file_status's represent the same thing?
std::error_code llvm::sys::fs::equivalent (const Twine &A, const Twine &B, bool &result)
 Do paths represent the same thing?
bool llvm::sys::fs::equivalent (const Twine &A, const Twine &B)
 Simpler version of equivalent for clients that don't need to differentiate between an error and false.
bool llvm::sys::fs::is_directory (file_status status)
 Does status represent a directory?
std::error_code llvm::sys::fs::is_directory (const Twine &path, bool &result)
 Is path a directory?
bool llvm::sys::fs::is_directory (const Twine &Path)
 Simpler version of is_directory for clients that don't need to differentiate between an error and false.
bool llvm::sys::fs::is_regular_file (file_status status)
 Does status represent a regular file?
std::error_code llvm::sys::fs::is_regular_file (const Twine &path, bool &result)
 Is path a regular file?
bool llvm::sys::fs::is_regular_file (const Twine &Path)
 Simpler version of is_regular_file for clients that don't need to differentiate between an error and false.
bool llvm::sys::fs::is_other (file_status status)
 Does this status represent something that exists but is not a directory, regular file, or symlink?
std::error_code llvm::sys::fs::is_other (const Twine &path, bool &result)
 Is path something that exists but is not a directory, regular file, or symlink?
std::error_code llvm::sys::fs::status (const Twine &path, file_status &result)
 Get file status as if by POSIX stat().
std::error_code llvm::sys::fs::status (int FD, file_status &Result)
 A version for when a file descriptor is already available.
std::error_code llvm::sys::fs::file_size (const Twine &Path, uint64_t &Result)
 Get file size.
std::error_code llvm::sys::fs::setLastModificationAndAccessTime (int FD, TimeValue Time)
 Set the file modification and access time.
bool llvm::sys::fs::status_known (file_status s)
 Is status available?
std::error_code llvm::sys::fs::status_known (const Twine &path, bool &result)
 Is status available?
std::error_code llvm::sys::fs::createUniqueFile (const Twine &Model, int &ResultFD, SmallVectorImpl< char > &ResultPath, unsigned Mode=all_read|all_write)
 Create a uniquely named file.
std::error_code llvm::sys::fs::createUniqueFile (const Twine &Model, SmallVectorImpl< char > &ResultPath)
 Simpler version for clients that don't want an open file.
std::error_code llvm::sys::fs::createTemporaryFile (const Twine &Prefix, StringRef Suffix, int &ResultFD, SmallVectorImpl< char > &ResultPath)
 Create a file in the system temporary directory.
std::error_code llvm::sys::fs::createTemporaryFile (const Twine &Prefix, StringRef Suffix, SmallVectorImpl< char > &ResultPath)
 Simpler version for clients that don't want an open file.
std::error_code llvm::sys::fs::createUniqueDirectory (const Twine &Prefix, SmallVectorImpl< char > &ResultPath)
OpenFlags llvm::sys::fs::operator| (OpenFlags A, OpenFlags B)
OpenFlags & llvm::sys::fs::operator|= (OpenFlags &A, OpenFlags B)
std::error_code llvm::sys::fs::openFileForWrite (const Twine &Name, int &ResultFD, OpenFlags Flags, unsigned Mode=0666)
std::error_code llvm::sys::fs::openFileForRead (const Twine &Name, int &ResultFD)
file_magic llvm::sys::fs::identify_magic (StringRef magic)
 Identify the type of a binary file based on how magical it is.
std::error_code llvm::sys::fs::identify_magic (const Twine &path, file_magic &result)
 Get and identify path's type based on its content.
std::error_code llvm::sys::fs::getUniqueID (const Twine Path, UniqueID &Result)
std::string llvm::sys::fs::getMainExecutable (const char *argv0, void *MainExecAddr)
std::error_code llvm::sys::fs::detail::directory_iterator_construct (DirIterState &, StringRef)
std::error_code llvm::sys::fs::detail::directory_iterator_increment (DirIterState &)
std::error_code llvm::sys::fs::detail::directory_iterator_destruct (DirIterState &)