tools::rroot::file Class Reference

Inheritance diagram for tools::rroot::file:

Collaboration diagram for tools::rroot::file:

Public Member Functions
virtual const std::string &	s_cls () const
virtual const std::string &	path () const
virtual bool	verbose () const
virtual std::ostream &	out () const
virtual bool	byte_swap () const
virtual bool	set_pos (seek a_offset=0, from a_from=begin)
virtual bool	read_buffer (char *a_buffer, uint32 a_length)
virtual bool	unziper (char a_key, decompress_func &a_func) const
virtual key &	sinfos_key ()
	file (std::ostream &a_out, const std::string &a_path, bool a_verbose=false)
virtual	~file ()
uint32	version () const
bool	is_open () const
void	close ()
directory &	dir ()
const directory &	dir () const
bool	add_unziper (char a_key, decompress_func a_func)
bool	dump_streamer_infos ()
streamer_info *	find_streamer_info (const std::string &a_class)
Public Member Functions inherited from tools::rroot::ifile
virtual	~ifile ()

Static Public Member Functions
static const std::string &	s_class ()

Protected Member Functions
	file (const file &a_from)
file &	operator= (const file &)
bool	initialize ()
bool	read_header ()
bool	read_streamer_infos_key ()
bool	read_streamer_infos_data ()
int	error_number ()
void	reset_error_number ()

Static Protected Member Functions
static int	_open (const char *a_name, int a_flags, uint32 a_mode)
static std::string	sout (const std::string &a_string)

Protected Attributes
std::ostream &	m_out
std::string	m_path
bool	m_verbose
int	m_file
uint64	m_bytes_read
directory	m_root_directory
key	m_streamer_infos_key
streamer_fac	m_streamer_fac
obj_list	m_streamer_infos
std::map< char, decompress_func >	m_unzipers
std::string	m_title
uint32	m_version
seek	m_BEGIN
seek	m_END
seek	m_seek_free
seek	m_seek_info
uint32	m_nbytes_free
uint32	m_nbytes_info
uint32	m_nbytes_name

Additional Inherited Members
Public Types inherited from tools::rroot::ifile
enum	from { begin, current, end }

Detailed Description

Definition at line 31 of file file.

Constructor & Destructor Documentation

file() [1/2]

tools::rroot::file::file ( std::ostream &  a_out, const std::string &  a_path, bool  a_verbose = false  )

inline

Definition at line 115 of file file.

  :m_out(a_out)
  ,m_path(a_path)
  ,m_verbose(a_verbose)
  ,m_file(not_open())
  ,m_bytes_read(0)
  ,m_root_directory(get_me())
  ,m_streamer_infos_key(a_out)
  ,m_streamer_fac(a_out)
  ,m_streamer_infos(m_streamer_fac)
  // begin of record :
  ,m_version(0)
  ,m_BEGIN(0)
  ,m_END(0)
  ,m_seek_free(0)
  ,m_seek_info(0)
  ,m_nbytes_free(0)
  ,m_nbytes_info(0)
  ,m_nbytes_name(0)
  {
#ifdef TOOLS_MEM
    mem::increment(s_class().c_str());
#endif
 
    m_file = _open(a_path.c_str(),
#ifdef _MSC_VER
                               O_RDONLY | O_BINARY,S_IREAD | S_IWRITE
#else
                               O_RDONLY,0644
#endif
    );
    if(m_file==not_open()) {
      m_out << "tools::rroot::file::file :"
            << " can't open " << sout(a_path) << "."
            << std::endl;
      return;
    }
    initialize();
  }

~file()

virtual tools::rroot::file::~file ( )

inlinevirtual

Definition at line 154 of file file.

                  {
    close();
#ifdef TOOLS_MEM
    mem::decrement(s_class().c_str());
#endif
  }

file() [2/2]

tools::rroot::file::file ( const file &  a_from )

inlineprotected

Definition at line 161 of file file.

  :ifile(a_from)
  ,m_out(a_from.m_out)
  ,m_root_directory(get_me())
  ,m_streamer_infos_key(a_from.m_out)
  ,m_streamer_fac(a_from.m_out)
  ,m_streamer_infos(m_streamer_fac)
  {
#ifdef TOOLS_MEM
    mem::increment(s_class().c_str());
#endif
  }

Member Function Documentation

_open()

static int tools::rroot::file::_open ( const char *  a_name, int  a_flags, uint32  a_mode  )

inlinestaticprotected

Definition at line 224 of file file.

                                                                 {
#if defined(__linux__) && (__GLIBC__ == 2) && (__GLIBC_MINOR__ >= 2)
     return ::open64(a_name,a_flags,a_mode);
#else
     return ::open(a_name,a_flags,a_mode);
#endif
  }

add_unziper()

bool tools::rroot::file::add_unziper ( char  a_key, decompress_func  a_func  )

inline

Definition at line 190 of file file.

                                                     {
    std::map<char,decompress_func>::const_iterator it = m_unzipers.find(a_key);
    if(it!=m_unzipers.end()) {
      //(*it).second = a_func; //override ?
      return false;
    } else {
      m_unzipers[a_key] = a_func;
      return true;
    }
  }

byte_swap()

virtual bool tools::rroot::file::byte_swap ( ) const

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 46 of file file.

{return is_little_endian();}

close()

void tools::rroot::file::close ( )

inline

Definition at line 181 of file file.

               {
    if(m_file!=not_open()) ::close(m_file);
    m_file = not_open();
    m_root_directory.clear_keys();
  }

dir() [1/2]

directory& tools::rroot::file::dir ( )

inline

Definition at line 187 of file file.

{return m_root_directory;}

dir() [2/2]

const directory& tools::rroot::file::dir ( ) const

inline

Definition at line 188 of file file.

{return m_root_directory;}

dump_streamer_infos()

bool tools::rroot::file::dump_streamer_infos ( )

inline

Definition at line 201 of file file.

                             {
    // read_streamer_infos_data() done here (and not in initialize) since it may need to have unziper declared.
    if(m_streamer_infos.empty()) {if(!read_streamer_infos_data()) return false;}
    tools_vforcit(iro*,m_streamer_infos,it) {
      streamer_info* info = safe_cast<iro,streamer_info>(*(*it));
      if(!info) return false;
      info->out(m_out);
    }
    return true;
  }

error_number()

int tools::rroot::file::error_number ( )

inlineprotected

Definition at line 485 of file file.

{return errno;}

find_streamer_info()

streamer_info* tools::rroot::file::find_streamer_info ( const std::string &  a_class )

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 211 of file file.

                                                              {
    // read_streamer_infos_data() done here (and not in initialize) since it may need to have unziper declared.
    if(m_streamer_infos.empty()) {if(!read_streamer_infos_data()) return 0;}
    tools_vforcit(iro*,m_streamer_infos,it) {
      streamer_info* info = safe_cast<iro,streamer_info>(*(*it));
      if(info) {
        if(info->name()==a_class) return info;
      }
    }
    return 0;
  }

initialize()

bool tools::rroot::file::initialize ( )

inlineprotected

Definition at line 232 of file file.

                    {
    if(!read_header()) {
      m_out << "tools::rroot::file::initialize :"
            << " can't read header."
            << std::endl;
      return false;
    }
/*
    fRootDirectory->setSeekDirectory(fBEGIN);
    // Read Free segments structure if file is writable :
    if (fWritable) {
      if (fSeekFree > fBEGIN) {
        if(!readFreeSegments()) {
          m_out << "tools::rroot::file::initialize : Cannot read free segments."
               << std::endl;
          return false;
        }
      } else {
        m_out << "tools::rroot::file::initialize : file \"" << fName
             << "\" probably not closed, cannot read free segments" << std::endl;
      }
    }
*/
    // Read Directory info :
    uint32 nbytes = m_nbytes_name + m_root_directory.record_size(m_version);
    char* header = new char[nbytes];
    char* buffer = header;
    if(!set_pos(m_BEGIN)) {
      m_out << "tools::rroot::file::initialize :"
            << " can't set position."
            << std::endl;
      delete [] header;
      return false;
    }
    if(!read_buffer(buffer,nbytes)) {
      m_out << "tools::rroot::file::initialize :"
            << " can't read buffer."
            << std::endl;
      delete [] header;
      return false;
    }
    buffer = header+m_nbytes_name;
    const char* eob = header+nbytes;
    if(!m_root_directory.from_buffer(eob,buffer)) {
      m_out << "tools::rroot::file::initialize :"
            << " can't read buffer (2)."
            << std::endl;
      delete [] header;
      return false;
    }
    uint32 nk =          //size of Key
      sizeof(int) +      //Key::fNumberOfBytes
      sizeof(short) +    //Key::fVersion
      2*sizeof(int) +    //Key::fObjectSize, Date
      2*sizeof(short) +  //Key::fKeyLength,fCycle
      2*sizeof(seek32);  //Key::fSeekKey,fSeekParentDirectory
                        //WARNING : the upper is seek32 since at begin of file.
    buffer = header+nk;
    std::string cname;
    rbuf rb(m_out,byte_swap(),eob,buffer);
    // Should be "TFile".
    if(!rb.read(cname)) {
      m_out << "tools::rroot::file::initialize :"
            << " can't read buffer (3)."
            << std::endl;
      delete [] header;
      return false;
    }
    if(cname!="TFile") {
      m_out << "tools::rroot::file::initialize : TFile expected." << std::endl;
      delete [] header;
      return false;
    }
    if(m_verbose) {
      m_out << "tools::rroot::file::initialize :"
            << " " << sout("TFile") << " found."
            << std::endl;
    }
    if(!rb.read(cname)) {
      m_out << "tools::rroot::file::initialize :"
            << " can't read buffer (4)."
            << std::endl;
      delete [] header;
      return false;
    }
    if(m_verbose) {
      m_out << "tools::rroot::file::initialize :"
            << " found file name " << sout(cname)
            << std::endl;
    }
    if(!rb.read(m_title)) {
      m_out << "tools::rroot::file::initialize :"
            << " can't read buffer (5)."
            << std::endl;
      delete [] header;
      return false;
    }
    delete [] header;
    if(m_verbose) {
      m_out << "tools::rroot::file::initialize :"
            << " found title " << sout(m_title)
            << std::endl;
    }
    uint32 dirNbytesName = m_root_directory.nbytes_name();
    if (dirNbytesName < 10 || dirNbytesName > 1000) {
      m_out << "tools::rroot::file::initialize :"
            << " can't read directory info."
            << std::endl;
      return false;
    }
    // Read keys of the top directory :
    if(m_root_directory.seek_keys() > m_BEGIN) {
      uint32 n;
      if(!m_root_directory.read_keys(n)) {
        m_out << "tools::rroot::file::initialize :"
              << " can't read keys."
              << std::endl;
        return false;
      }
    } else {
      m_out << "tools::rroot::file::initialize :"
            << " file " << sout(m_path)
            << " probably not closed."
            << std::endl;
      return false;
    }
 
    // Create StreamerInfo index
    if(m_seek_info > m_BEGIN) {
      if(!read_streamer_infos_key()) {
        m_out << "tools::rroot::file::initialize :"
              << " read_streamer_infos_key() failed."
              << std::endl;
        return false;
      }
    } else {
      m_out << "tools::rroot::file::initialize :"
            << " file " << sout(m_path)
            << " probably not closed."
            << std::endl;
      return false;
    }
 
    return true;
  }

is_open()

bool tools::rroot::file::is_open ( ) const

inline

Definition at line 177 of file file.

                       {
    return (m_file==not_open()?false:true);
  }

operator=()

file& tools::rroot::file::operator= ( const file &  )

inlineprotected

Definition at line 173 of file file.

{return *this;}

out()

virtual std::ostream& tools::rroot::file::out ( ) const

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 44 of file file.

{return m_out;}

path()

virtual const std::string& tools::rroot::file::path ( ) const

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 41 of file file.

{return m_path;}

read_buffer()

virtual bool tools::rroot::file::read_buffer ( char *  a_buffer, uint32  a_length  )

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 76 of file file.

                                                           {
    // Read a buffer from the file.
    // This is the basic low level read operation.
#ifdef _MSC_VER
    typedef int ssize_t;
#endif
    ssize_t siz;
    while ((siz = ::read(m_file,a_buffer,a_length)) < 0 &&
           error_number() == EINTR) reset_error_number();
    if (siz < 0) {
      m_out << "tools::rroot::file::read_buffer :"
            << " error reading from file " << sout(m_path) << "."
            << std::endl;
      return false;
    }
    if (siz != ssize_t(a_length)) {
      m_out << "tools::rroot::file::read_buffer :"
            << " error reading all requested bytes from file "
            << sout(m_path) << ", got " << long_out(siz)
            << " of " << a_length
            << std::endl;
      return false;
    }
    m_bytes_read += siz;
    return true;
  }

read_header()

bool tools::rroot::file::read_header ( )

inlineprotected

Definition at line 377 of file file.

                     {
    static const uint32 kBegin = 64;
    char header[kBegin];
    if(!set_pos()) return false;
    if(!read_buffer(header,kBegin)) return false;
    // make sure this is a root file
    if(::strncmp(header, "root", 4)) {
      m_out << "tools::rroot::file::read_header :"
            << " " << sout(m_path) << " not a file at the CERN-ROOT format."
            << std::endl;
      return false;
    }
    if(m_verbose) {
      m_out << "tools::rroot::file::read_header :"
            << " file signature is " << sout("root")
            << std::endl;
    }
    char* buffer = header + 4;    // skip the "root" file identifier
    const char* eob = header + kBegin;
    rbuf rb(m_out,byte_swap(),eob,buffer);
   {int v;
    if(!rb.read(v)) return false;
    m_version = v;}
   {seek32 i;
    if(!rb.read(i)) return false;
    m_BEGIN = i;}
    if(m_version>1000000) {
      if(!rb.read(m_END)) return false;
      if(!rb.read(m_seek_free)) return false;
    } else {
     {seek32 i;
      if(!rb.read(i)) return false;
      m_END = i;}
     {seek32 i;
      if(!rb.read(i)) return false;
      m_seek_free = i;}
    }
    if(m_verbose) {
      m_out << "tools::rroot::file::read_header :"
            << " begin " << m_BEGIN
            << " end " << m_END
            << std::endl;
    }
   {int v;
    if(!rb.read(v)) return false;
    m_nbytes_free = v;}
    int nfree = 0;
    if(!rb.read(nfree)) return false;
   {int v;
    if(!rb.read(v)) return false;
    m_nbytes_name = v;}
    //m_out << "debug : 1002 " << m_nbytes_name << std::endl;
   {char fUnits;
    if(!rb.read(fUnits)) return false;}
   {int fCompress;
    if(!rb.read(fCompress)) return false;}
    if(m_version>1000000) {
      if(!rb.read(m_seek_info)) return false;
    } else {
     {seek32 i;
      if(!rb.read(i)) return false;
      m_seek_info = i;}
    }
    if(!rb.read(m_nbytes_info)) return false;
    //m_out << "debug : seek_info " << m_seek_info << " nbytes_info " << m_nbytes_info << std::endl;
    return true;
  }

read_streamer_infos_data()

bool tools::rroot::file::read_streamer_infos_data ( )

inlineprotected

Definition at line 463 of file file.

                                  {
    key& k = m_streamer_infos_key;
    if(k.object_class()!="TList") {
      m_out << "tools::rroot::file::read_streamer_infos_data : key not a TList." << std::endl;
      return false;
    }
    unsigned int sz;
    char* buf = k.get_object_buffer(*this,sz); //we don't have ownership of buf.
    if(!buf) {
      m_out << "tools::rroot::file::read_streamer_infos :"
          << " can't get data buffer of " << k.object_name() << "."
          << std::endl;
      return false;
    }
    buffer b(m_out,byte_swap(),sz,buf,k.key_length(),false);
    return m_streamer_infos.stream(b);
  }

read_streamer_infos_key()

bool tools::rroot::file::read_streamer_infos_key ( )

inlineprotected

Definition at line 445 of file file.

                                 {
    // Read the list of StreamerInfo from this file
    // The key with name holding the list of TStreamerInfo objects is read.
    // The corresponding TClass objects are updated.
    if(m_seek_info<=0) return false;
    if(m_seek_info>=m_END) return false;
    if(!set_pos(m_seek_info)) return false;
    char* buffer = new char[m_nbytes_info+1];
    if(!read_buffer(buffer,m_nbytes_info)) {delete [] buffer;return false;}
    char* buf = buffer;
    if(!m_streamer_infos_key.from_buffer(byte_swap(),buffer+m_nbytes_info,buf,m_verbose)) {
      delete [] buffer;
      return false;
    }
    delete [] buffer;
    return true;
  }

reset_error_number()

void tools::rroot::file::reset_error_number ( )

inlineprotected

Definition at line 486 of file file.

{errno = 0;}

s_class()

static const std::string& tools::rroot::file::s_class ( )

inlinestatic

Definition at line 35 of file file.

                                    {
    static const std::string s_v("tools::rroot::file");
    return s_v;
  }

s_cls()

virtual const std::string& tools::rroot::file::s_cls ( ) const

inlinevirtual

Definition at line 39 of file file.

{return s_class();}

set_pos()

virtual bool tools::rroot::file::set_pos ( seek  a_offset = 0, from  a_from = begin  )

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 47 of file file.

                                                             {
    int whence = 0;
    switch(a_from) {
    case begin:
      whence = SEEK_SET;
      break;
    case current:
      whence = SEEK_CUR;
      break;
    case end:
      whence = SEEK_END;
      break;
    }
 
#if defined(__linux__) && (__GLIBC__ == 2) && (__GLIBC_MINOR__ >= 2)
    if (::lseek64(m_file, a_offset, whence) < 0) {
#elif defined(_MSC_VER)
    if (::_lseeki64(m_file, a_offset, whence) < 0) {
#else
    if (::lseek(m_file, a_offset, whence) < 0) {
#endif
      m_out << "tools::rroot::file::set_pos :"
            << " cannot set position " << a_offset
            << " in file " << sout(m_path) << "."
            << std::endl;
      return false;
    }
    return true;
  }

sinfos_key()

virtual key& tools::rroot::file::sinfos_key ( )

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 112 of file file.

{return m_streamer_infos_key;}

sout()

static std::string tools::rroot::file::sout ( const std::string &  a_string )

inlinestaticprotected

Definition at line 231 of file file.

{return "\""+a_string+"\"";}

unziper()

virtual bool tools::rroot::file::unziper ( char  a_key, decompress_func &  a_func  ) const

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 102 of file file.

                                                                 {
    std::map<char,decompress_func>::const_iterator it = m_unzipers.find(a_key);
    if(it==m_unzipers.end()) {
      a_func = 0;
      return false;
    }
    a_func = (*it).second;
    return true;
  }

verbose()

virtual bool tools::rroot::file::verbose ( ) const

inlinevirtual

Implements tools::rroot::ifile.

Definition at line 43 of file file.

{return m_verbose;}

version()

uint32 tools::rroot::file::version ( ) const

inline

Definition at line 175 of file file.

{return m_version;}

Member Data Documentation

m_BEGIN

seek tools::rroot::file::m_BEGIN

protected

Definition at line 503 of file file.

m_bytes_read

uint64 tools::rroot::file::m_bytes_read

protected

Definition at line 494 of file file.

m_END

seek tools::rroot::file::m_END

protected

Definition at line 504 of file file.

m_file

int tools::rroot::file::m_file

protected

Definition at line 493 of file file.

m_nbytes_free

uint32 tools::rroot::file::m_nbytes_free

protected

Definition at line 507 of file file.

m_nbytes_info

uint32 tools::rroot::file::m_nbytes_info

protected

Definition at line 508 of file file.

m_nbytes_name

uint32 tools::rroot::file::m_nbytes_name

protected

Definition at line 510 of file file.

m_out

std::ostream& tools::rroot::file::m_out

protected

Definition at line 490 of file file.

m_path

std::string tools::rroot::file::m_path

protected

Definition at line 491 of file file.

m_root_directory

directory tools::rroot::file::m_root_directory

protected

Definition at line 495 of file file.

m_seek_free

seek tools::rroot::file::m_seek_free

protected

Definition at line 505 of file file.

m_seek_info

seek tools::rroot::file::m_seek_info

protected

Definition at line 506 of file file.

m_streamer_fac

streamer_fac tools::rroot::file::m_streamer_fac

protected

Definition at line 497 of file file.

m_streamer_infos

obj_list tools::rroot::file::m_streamer_infos

protected

Definition at line 498 of file file.

m_streamer_infos_key

key tools::rroot::file::m_streamer_infos_key

protected

Definition at line 496 of file file.

m_title

std::string tools::rroot::file::m_title

protected

Definition at line 500 of file file.

m_unzipers

std::map<char,decompress_func> tools::rroot::file::m_unzipers

protected

Definition at line 499 of file file.

m_verbose

bool tools::rroot::file::m_verbose

protected

Definition at line 492 of file file.

m_version

uint32 tools::rroot::file::m_version

protected

Definition at line 502 of file file.

---

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

• /Users/barrand/private/dev/softinex/g4tools/g4tools/tools/rroot/file