src/data.h

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