src/r_cstore.h

   1 ///
   2 /// \file       r_cstore.h
   3 ///             Blackberry database record parser class for
   4 ///             Content Store records.
   5 ///
   6
   7 /*
   8     Copyright (C) 2010-2013, Net Direct Inc. (http://www.netdirect.ca/)
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18
  19     See the GNU General Public License in the COPYING file at the
  20     root directory of this project for more details.
  21 */
  22
  23 #ifndef __BARRY_RECORD_CSTORE_H__
  24 #define __BARRY_RECORD_CSTORE_H__
  25
  26 #include "dll.h"
  27 #include "record.h"
  28 #include <iosfwd>
  29 #include <string>
  30 #include <vector>
  31 #include <map>
  32 #include <stdint.h>
  33
  34 namespace Barry {
  35
  36 // forward declarations
  37 class IConverter;
  38
  39 //
  40 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  41 //        operators in the future.
  42 //
  43
  44 /// \addtogroup RecordParserClasses
  45 /// @{
  46
  47 //
  48 // Content Store record class
  49 //
  50 /// Represents a single record in the Content Store Blackberry database.
  51 ///
  52 class BXEXPORT ContentStore
  53 {
  54 public:
  55         typedef Barry::UnknownsType             UnknownsType;
  56
  57         //
  58         // Record fields
  59         //
  60
  61         // contact specific data
  62         uint8_t RecType;
  63         uint32_t RecordId;
  64
  65         std::string Filename;
  66         bool FolderFlag;
  67         std::string FileContent;
  68         std::string FileDescriptor;
  69
  70         UnknownsType Unknowns;
  71
  72 private:
  73         uint64_t FileSize;
  74
  75 public:
  76         const unsigned char* ParseField(const unsigned char *begin,
  77                 const unsigned char *end, const IConverter *ic = 0);
  78
  79 public:
  80         ContentStore();
  81         ~ContentStore();
  82
  83         // operations (common among record classes)
  84         void Clear();                   // erase everything
  85         void Dump(std::ostream &os) const;
  86         std::string GetDescription() const;
  87
  88         // Sorting - use enough data to make the sorting as
  89         //           consistent as possible
  90         bool operator<(const ContentStore &other) const;
  91
  92         // Parser / Builder API (see parser.h / builder.h)
  93         void Validate() const;
  94         uint8_t GetRecType() const { return RecType; }
  95         uint32_t GetUniqueId() const { return RecordId; }
  96         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
  97         void ParseHeader(const Data &data, size_t &offset);
  98         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
  99         void BuildHeader(Data &data, size_t &offset) const;
 100         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
 101         static const char * GetDBName() { return "Content Store"; }
 102         static uint8_t GetDefaultRecType() { return 0; }
 103
 104         // Generic Field Handle support
 105         static const FieldHandle<ContentStore>::ListT& GetFieldHandles();
 106 };
 107
 108 BXEXPORT inline std::ostream& operator<< (std::ostream &os,
 109                                         const ContentStore &cstore)
 110 {
 111         cstore.Dump(os);
 112         return os;
 113 }
 114
 115 /// @}
 116
 117 } // namespace Barry
 118
 119 #endif
 120