file.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <sys/stat.h>
#include <sys/types.h>
 
#include <string>
 
#include "android-base/macros.h"
#include "android-base/off64_t.h"
#include "android-base/unique_fd.h"
 
#if !defined(_WIN32) && !defined(O_BINARY)
#define O_BINARY 0
#endif
 
#if defined(_WIN32) && !defined(O_CLOEXEC)
#define O_CLOEXEC O_NOINHERIT
#endif
 
class TemporaryFile {
 public:
  TemporaryFile();
  explicit TemporaryFile(const std::string& tmp_dir);
  ~TemporaryFile();
 
  // Release the ownership of fd, caller is responsible for closing the
  // fd or stream properly.
  int release();
  // Don't remove the temporary file in the destructor.
  void DoNotRemove() { remove_file_ = false; }
 
  int fd;
  char path[1024];
 
 private:
  void init(const std::string& tmp_dir);
 
  bool remove_file_ = true;
 
  DISALLOW_COPY_AND_ASSIGN(TemporaryFile);
};
 
class TemporaryDir {
 public:
  TemporaryDir();
  ~TemporaryDir();
  // Don't remove the temporary dir in the destructor.
  void DoNotRemove() { remove_dir_and_contents_ = false; }
 
  char path[1024];
 
 private:
  bool init(const std::string& tmp_dir);
 
  bool remove_dir_and_contents_ = true;
 
  DISALLOW_COPY_AND_ASSIGN(TemporaryDir);
};
 
namespace android {
namespace base {
 
bool ReadFdToString(borrowed_fd fd, std::string* content);
bool ReadFileToString(const std::string& path, std::string* content,
                      bool follow_symlinks = false);
 
bool WriteStringToFile(const std::string& content, const std::string& path,
                       bool follow_symlinks = false);
bool WriteStringToFd(std::string_view content, borrowed_fd fd);
 
#if !defined(_WIN32)
bool WriteStringToFile(const std::string& content, const std::string& path,
                       mode_t mode, uid_t owner, gid_t group,
                       bool follow_symlinks = false);
#endif
 
bool ReadFully(borrowed_fd fd, void* data, size_t byte_count);
 
// Reads `byte_count` bytes from the file descriptor at the specified offset.
// Returns false if there was an IO error or EOF was reached before reading `byte_count` bytes.
//
// NOTE: On Linux/Mac, this function wraps pread, which provides atomic read support without
// modifying the read pointer of the file descriptor. On Windows, however, the read pointer does
// get modified. This means that ReadFullyAtOffset can be used concurrently with other calls to the
// same function, but concurrently seeking or reading incrementally can lead to unexpected
// behavior.
bool ReadFullyAtOffset(borrowed_fd fd, void* data, size_t byte_count, off64_t offset);
 
bool WriteFully(borrowed_fd fd, const void* data, size_t byte_count);
bool WriteFullyAtOffset(borrowed_fd fd, const void* data, size_t byte_count, off64_t offset);
 
bool RemoveFileIfExists(const std::string& path, std::string* err = nullptr);
 
#if !defined(_WIN32)
bool Realpath(const std::string& path, std::string* result);
bool Readlink(const std::string& path, std::string* result);
#endif
 
std::string GetExecutablePath();
std::string GetExecutableDirectory();
 
// Like the regular basename and dirname, but thread-safe on all
// platforms and capable of correctly handling exotic Windows paths.
std::string Basename(std::string_view path);
std::string Dirname(std::string_view path);
 
}  // namespace base
}  // namespace android