src/r_bookmark.h

   1 ///
   2 /// \file       r_bookmark.h
   3 ///             Record parsing class for call logs
   4 ///
   5
   6 /*
   7     Copyright (C) 2008-2009, Nicolas VIVIEN
   8     Copyright (C) 2005-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_BOOKMARK_H__
  24 #define __BARRY_RECORD_BOOKMARK_H__
  25
  26 #include "dll.h"
  27 #include "record.h"
  28 #include <vector>
  29 #include <string>
  30 #include <stdint.h>
  31
  32 namespace Barry {
  33
  34 // forward declarations
  35 class IConverter;
  36
  37 class BXEXPORT Bookmark
  38 {
  39 public:
  40         typedef Barry::UnknownsType             UnknownsType;
  41
  42         uint8_t RecType;
  43         uint32_t RecordId;
  44
  45         uint8_t Index;
  46
  47         std::string Name;
  48         std::string Icon;
  49         std::string Url;
  50
  51         enum BrowserIdentityType
  52         {
  53                 IdentityAuto = 0,
  54                 IdentityBlackBerry,
  55                 IdentityFireFox,
  56                 IdentityInternetExplorer,
  57                 IdentityUnknown
  58         };
  59         BrowserIdentityType BrowserIdentity;
  60
  61         enum DisplayModeType
  62         {
  63                 DisplayAuto = 0,
  64                 DisplayColomn,
  65                 DisplayPage,
  66                 DisplayUnknown
  67         };
  68         DisplayModeType DisplayMode;
  69
  70         enum JavaScriptModeType
  71         {
  72                 JavaScriptAuto = 0,
  73                 JavaScriptEnabled,
  74                 JavaScriptDisabled,
  75                 JavaScriptUnknown
  76         };
  77         JavaScriptModeType JavaScriptMode;
  78
  79         UnknownsType Unknowns;
  80
  81 protected:
  82         const unsigned char* ParseStruct1Field(const unsigned char *begin,
  83                 const unsigned char *end, const IConverter *ic = 0);
  84         const unsigned char* ParseStruct2(const unsigned char *begin,
  85                 const unsigned char *end, const IConverter *ic = 0);
  86
  87 public:
  88         Bookmark();
  89         ~Bookmark();
  90
  91         // Parser / Builder API (see parser.h / builder.h)
  92         void Validate() const;
  93         const unsigned char* ParseField(const unsigned char *begin,
  94                 const unsigned char *end, const IConverter *ic = 0);
  95         uint8_t GetRecType() const { return RecType; }
  96         uint32_t GetUniqueId() const { return RecordId; }
  97         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
  98         void ParseHeader(const Data &data, size_t &offset);
  99         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
 100         void BuildHeader(Data &data, size_t &offset) const;
 101         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
 102
 103         // operations (common among record classes
 104         void Clear();
 105         void Dump(std::ostream &os) const;
 106         std::string GetDescription() const;
 107
 108         // Sorting - use enough data to make the sorting as
 109         //           consistent as possible
 110         bool operator<(const Bookmark &other) const;
 111
 112         // database name
 113         static const char * GetDBName() { return "Browser Bookmarks"; }
 114         static uint8_t GetDefaultRecType() { return 1; }
 115
 116         // Generic Field Handle support
 117         static const FieldHandle<Bookmark>::ListT& GetFieldHandles();
 118 };
 119
 120 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Bookmark &msg) {
 121         msg.Dump(os);
 122         return os;
 123 }
 124
 125 } // namespace Barry
 126
 127 #endif
 128