src/data.h

   1 ///
   2 /// \file       data.h
   3 ///             Class to deal with pre-saved data files
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2007, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __SB_DATA_H__
  23 #define __SB_DATA_H__
  24
  25 #include <iosfwd>
  26 #include <vector>
  27
  28 namespace Barry {
  29
  30 class Data
  31 {
  32         unsigned char *m_data;
  33         size_t m_bufsize;               //< size of m_data buffer allocated
  34         size_t m_datasize;              //< number of bytes of actual data
  35         int m_endpoint;
  36
  37         // copy on write feature
  38         const unsigned char *m_externalData;
  39         bool m_external;
  40
  41         // output format flags
  42         static bool bPrintAscii;
  43
  44 protected:
  45         void MakeSpace(size_t desiredsize);
  46         void CopyOnWrite(size_t desiredsize);
  47
  48 public:
  49         Data();
  50         explicit Data(int endpoint, size_t startsize = 0x4000);
  51         Data(const void *ValidData, size_t size);
  52         Data(const Data &other);
  53         ~Data();
  54
  55         void InputHexLine(std::istream &is);
  56         void DumpHexLine(std::ostream &os, size_t index, size_t size) const;
  57         void DumpHex(std::ostream &os) const;
  58
  59         int GetEndpoint() const { return m_endpoint; }
  60
  61         const unsigned char * GetData() const { return m_external ? m_externalData : m_data; }
  62         size_t GetSize() const { return m_datasize; }
  63
  64         unsigned char * GetBuffer(size_t requiredsize = 0);
  65         size_t GetBufSize() const { return m_bufsize; }
  66         void ReleaseBuffer(int datasize = -1);
  67
  68         void AppendHexString(const char *str);
  69
  70         void Zap();
  71
  72         Data& operator=(const Data &other);
  73
  74
  75         // static functions
  76         static void PrintAscii(bool setting) { bPrintAscii = setting; }
  77         static bool PrintAscii() { return bPrintAscii; }
  78 };
  79
  80 std::istream& operator>> (std::istream &is, Data &data);
  81 std::ostream& operator<< (std::ostream &os, const Data &data);
  82
  83
  84 class Diff
  85 {
  86         const Data &m_old, &m_new;
  87
  88         void Compare(std::ostream &os, size_t index, size_t size) const;
  89
  90 public:
  91         Diff(const Data &old, const Data &new_);
  92
  93         void Dump(std::ostream &os) const;
  94 };
  95
  96 std::ostream& operator<< (std::ostream &os, const Diff &diff);
  97
  98
  99 // utility functions
 100 bool LoadDataArray(const std::string &filename, std::vector<Data> &array);
 101 bool ReadDataArray(std::istream &is, std::vector<Data> &array);
 102
 103 } // namespace Barry
 104
 105 #endif
 106