file_info.h

Go to the documentation of this file.

#ifndef FILE_INFO_CLASS
#define FILE_INFO_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : file_info                                                         *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1993-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include "filename.h"
#include "file_time.h"
 
#include <basis/definitions.h>
#include <basis/enhance_cpp.h>
 
namespace filesystem {
 
 
class file_info : public filename 
{
public:
  enum file_similarity {
    EQUAL_NAME = 0,         // we assume name equality is pre-eminent and always required.
    EQUAL_CHECKSUM = 0x1,   // the files have the same checksum, however computed.
    EQUAL_TIMESTAMP = 0x2,  // the files have exactly equal timestamps.
    EQUAL_FILESIZE = 0x4,   // the files have the same sizes.
    EQUAL_CHECKSUM_TIMESTAMP_FILESIZE = EQUAL_CHECKSUM & EQUAL_TIMESTAMP & EQUAL_FILESIZE
  };
 
  double _file_size;  
  file_time _time;  
  int _checksum;  
 
  file_info();  
 
  file_info(const filename &to_copy, double file_size, 
         const file_time &time = file_time(), int checksum = 0);
 
  file_info(const file_info &to_copy);
 
  virtual ~file_info();
 
  DEFINE_CLASS_NAME("file_info");
 
  file_info &operator = (const file_info &to_copy);
 
  basis::astring text_form() const;
 
  bool calculate(const basis::astring &prefix, bool just_size_n_time,
        int checksum_edge = 1 * basis::KILOBYTE);
 
  const basis::astring &secondary() const;
  void secondary(const basis::astring &new_sec);
 
  const basis::byte_array &attachment() const;
 
  void attachment(const basis::byte_array &new_attachment);
 
  // standard streaming operations.
  virtual int packed_size() const;
  virtual void pack(basis::byte_array &packed_form) const;
  virtual bool unpack(basis::byte_array &packed_form);
 
private:
  basis::astring c_secondary;  
  basis::byte_array c_attachment;  
};
 
} //namespace.
 
#endif