src/data.h

   1 ///
   2 /// \file       data.h
   3 ///             Class to deal with pre-saved data files
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2010, 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 "dll.h"
  26 #include <iosfwd>
  27 #include <vector>
  28 #include <string>
  29 #include <stdint.h>
  30
  31 namespace Barry {
  32
  33 class BXEXPORT Data
  34 {
  35         unsigned char *m_data;
  36         size_t m_bufsize;               //< size of m_data buffer allocated
  37         size_t m_datasize;              //< number of bytes of actual data
  38         int m_endpoint;
  39
  40         // copy on write feature
  41         const unsigned char *m_externalData;
  42         bool m_external;
  43
  44         // output format flags
  45         static bool bPrintAscii;
  46
  47 protected:
  48         void MakeSpace(size_t desiredsize);
  49         void CopyOnWrite(size_t desiredsize);
  50
  51 public:
  52         Data();
  53         explicit Data(int endpoint, size_t startsize = 0x4000);
  54         Data(const void *ValidData, size_t size);
  55         Data(const Data &other);
  56         ~Data();
  57
  58         void InputHexLine(std::istream &is);
  59         void DumpHexLine(std::ostream &os, size_t index, size_t size) const;
  60         void DumpHex(std::ostream &os) const;
  61
  62         int GetEndpoint() const { return m_endpoint; }
  63
  64         const unsigned char * GetData() const { return m_external ? m_externalData : m_data; }
  65         size_t GetSize() const { return m_datasize; }
  66
  67         unsigned char * GetBuffer(size_t requiredsize = 0);
  68         size_t GetBufSize() const { return m_bufsize; }
  69         void ReleaseBuffer(int datasize = -1);
  70
  71         void AppendHexString(const char *str);
  72
  73         /// set buffer to 0 size, but don't bother overwriting memory with 0
  74         void QuickZap() { m_datasize = 0; }
  75         void Zap();     // does a memset too
  76
  77         Data& operator=(const Data &other);
  78
  79
  80         //
  81         // Utility functions
  82         //
  83         // Writing data... basically does a memcpy(dst,src,sizeof(src))
  84         // for each type.  Does no endian conversions.
  85         // dst is calculated as buffer + offset.
  86         // The buffer is expanded automatically if needed.
  87         // The offset is advanced by the size of the data.
  88         //
  89         void MemCpy(size_t &offset, const void *src, size_t size);
  90         template <class ValueT>
  91         void SetValue(size_t &offset, ValueT value)
  92         {
  93                 this->MemCpy(offset, &value, sizeof(value));
  94         }
  95
  96
  97         // static functions
  98         static void PrintAscii(bool setting) { bPrintAscii = setting; }
  99         static bool PrintAscii() { return bPrintAscii; }
 100 };
 101
 102 BXEXPORT std::istream& operator>> (std::istream &is, Data &data);
 103 BXEXPORT std::ostream& operator<< (std::ostream &os, const Data &data);
 104
 105
 106 class BXEXPORT Diff
 107 {
 108         const Data &m_old, &m_new;
 109
 110         BXLOCAL void Compare(std::ostream &os, size_t index, size_t size) const;
 111
 112 public:
 113         Diff(const Data &old, const Data &new_);
 114
 115         void Dump(std::ostream &os) const;
 116 };
 117
 118 BXEXPORT std::ostream& operator<< (std::ostream &os, const Diff &diff);
 119
 120
 121 // utility functions
 122 BXEXPORT bool LoadDataArray(const std::string &filename, std::vector<Data> &array);
 123 BXEXPORT bool ReadDataArray(std::istream &is, std::vector<Data> &array);
 124
 125
 126 //
 127 // DBData
 128 //
 129 /// Database record data class.  The purpose of this class is to contain
 130 /// the raw data that flows between low level activity such as device
 131 /// read/writes, backup read/writes, and record parsing.
 132 ///
 133 /// This class contains the low level record data block, unparsed, as well
 134 /// as the surrounding meta data, such as the database name it belongs
 135 /// to, the Unique ID, the Rec Type, and format version/type based on what
 136 /// commands were used to extract the data from the device. (When using
 137 /// newer commands, the format of the records, potentially including the
 138 /// individual field type codes, are different.)
 139 ///
 140 /// Possible bi-directional data flow in all of Barry:
 141 /// Note that this class, DBData, represents the data+meta stage.
 142 ///
 143 ///     data+meta <-> device
 144 ///     data+meta <-> backup file
 145 ///     data+meta <-> record object
 146 ///     record object <-> boost serialization
 147 ///     contact record object <-> ldif
 148 ///
 149 /// Possible uni-directional data flow in all of Barry:
 150 ///
 151 ///     record object -> text dump
 152 ///
 153 class BXEXPORT DBData
 154 {
 155 public:
 156         enum RecordFormatVersion
 157         {
 158                 REC_VERSION_1,
 159                 REC_VERSION_2
 160         };
 161
 162 private:
 163         // record meta data
 164         RecordFormatVersion m_version;
 165         std::string m_dbName;
 166         uint8_t m_recType;
 167         uint32_t m_uniqueId;
 168         size_t m_offset;
 169
 170         // the raw data block, internal
 171         Data *m_localData;
 172
 173         // the data block to use... could be external or internal,
 174         // and does not change for the life of the object
 175         Data &m_data;
 176
 177 public:
 178         /// Default constructor, constructs an empty local Data object
 179         DBData();
 180
 181         /// Constructs a local Data object that points to external memory
 182         DBData(const void *ValidData, size_t size);
 183         DBData(RecordFormatVersion ver, const std::string &dbName,
 184                 uint8_t recType, uint32_t uniqueId, size_t offset,
 185                 const void *ValidData, size_t size);
 186
 187         /// If copy == false, constructs an external Data object, no local.
 188         /// If copy == true, constructs an internal Data object copy
 189         /// For speed, set copy to false.
 190         /// If you want Copy On Write behaviour, similar to Data(buf,size),
 191         /// then use the above (buf, size) constructor, not this one,
 192         /// since this constructor uses Data's copy constructor.
 193         DBData(Data &externalData, bool copy);
 194         DBData(RecordFormatVersion ver, const std::string &dbName,
 195                 uint8_t recType, uint32_t uniqueId, size_t offset,
 196                 Data &externalData, bool copy);
 197
 198         ~DBData();
 199
 200         // access meta data
 201         RecordFormatVersion GetVersion() const { return m_version; }
 202         const std::string& GetDBName() const { return m_dbName; }
 203         uint8_t GetRecType() const { return m_recType; }
 204         uint32_t GetUniqueId() const { return m_uniqueId; }
 205         size_t GetOffset() const { return m_offset; }
 206
 207         const Data& GetData() const { return m_data; }
 208         Data& UseData();
 209
 210         // operations
 211         void SetVersion(RecordFormatVersion ver)
 212         {
 213                 m_version = ver;
 214         }
 215
 216         void SetDBName(const std::string &dbName)
 217         {
 218                 m_dbName = dbName;
 219         }
 220
 221         void SetIds(uint8_t recType, uint32_t uniqueId)
 222         {
 223                 m_recType = recType;
 224                 m_uniqueId = uniqueId;
 225         }
 226
 227         void SetOffset(size_t offset)
 228         {
 229                 m_offset = offset;
 230         }
 231 };
 232
 233 } // namespace Barry
 234
 235 #endif
 236