File.hpp

Go to the documentation of this file.

// DUNE DAQ modification notice:
// This file has been modified from the original ATLAS system source for the DUNE DAQ project.
// Fork baseline commit: system-00-00-20 (2020-09-25).
// Renamed since fork: yes (from system/File.h to include/okssystem/File.hpp).
 
/*
 *  File.h
 *  OksSystem
 *
 *  Created by Matthias Wiesmann on 04.01.05.
 *  Copyright 2005 CERN. All rights reserved.
 *
 */
 
#ifndef OKSSYSTEM_FILE
#define OKSSYSTEM_FILE
 
#include <string>
#include <vector>
 
#include <sys/stat.h>
#include <sys/types.h>
 
#include "okssystem/User.hpp"
 
namespace OksSystem {

 
class File
{
public:
  typedef std::vector<OksSystem::File> file_list_t;
 
protected:
  std::string m_full_name;                   
  void set_name(const std::string& name);    
  static const char* const HUMAN_SIZE_STR[]; 
  static const char* const HUMAN_OPEN_STR[]; 
  static const int KILOBYTE;                 
  static int unit(int u);  
  mode_t get_mode() const; 
  static const char* const FILE_COMMAND_PATH;
 
public:
  static const char* const FILE_FLAG_STR; 
  static const char* const FILE_PROTOCOL; 
 
  static std::string protocol(const std::string& url) throw(); 
  static std::string extension(
    const std::string& url) throw();                      
  static std::string uri(const std::string& url) throw(); 
  static std::string short_name(const std::string& url) throw(); 
  static int depth(const std::string& path) throw();             
 
  static std::string first_line(const std::string& text); 
 
  static File from_url(const std::string& url); 
 
  static std::string working_directory();                      
  static void working_directory(const File& dir);              
  static std::string expand_home(const std::string path);      
  static std::string pretty_permissions(mode_t permissions);   
  static std::string to_string(mode_t permissions) throw();    
  static std::string pretty_open_flag(int flags);              
  static std::string pretty_size(size_t size, bool cut_small); 
 
  File(const std::string& name);
  File(const char* name);
  File(const File& other);
  virtual ~File() {}
  operator std::string() const throw();
  operator const char*() const throw();
  operator bool() const throw();
  bool equals(const File& other) const throw(); 
  operator size_t() const;
 
  const std::string& full_name() const throw(); 
  const char* c_full_name() const throw();
  std::string short_name() const throw();  
  std::string parent_name() const throw(); 
  std::string extension() const throw();   
  int depth() const throw();               
 
  OksSystem::File parent() const;                       
  OksSystem::File child(const std::string& name) const; 
  OksSystem::File temporary(const std::string& prefix) const;
 
  bool exists() const throw();            
  mode_t permissions() const;             
  std::string pretty_permissions() const; 
  size_t size() const;                    
  uid_t owner_id() const;                 
  User owner() const;                     
  gid_t group() const;                    
  bool is_regular() const;                
  bool is_directory() const;              
  bool is_fifo() const;                   
  std::string file_type() const;          
  file_list_t directory() const;          
 
  void unlink() const; 
  void rmdir() const;  
 
  void remove() const;                        
  void rename(const File& other) const;       
  void permissions(mode_t permissions) const; 
  void make_dir(mode_t permissions) const;    
  void make_path(mode_t permissions) const;   
  void make_fifo(mode_t permissions) const;   
 
  void ensure_path(mode_t permissions) const; 
 
  std::istream* input() const;                     
  std::ostream* output(bool append = false) const; 
}; // File
} // OksSystem
 
std::ostream&
operator<<(std::ostream& stream, const OksSystem::File& file);
bool
operator==(const OksSystem::File& a, const OksSystem::File& b) throw();
bool
operator!=(const OksSystem::File& a, const OksSystem::File& b) throw();
 
#endif