src/m_desktop.h

   1 ///
   2 /// \file       m_desktop.h
   3 ///             Mode class for the Desktop mode
   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 __BARRY_M_DESKTOP_H__
  23 #define __BARRY_M_DESKTOP_H__
  24
  25 #include "dll.h"
  26 #include "m_mode_base.h"
  27 #include "data.h"
  28 #include "socket.h"
  29 #include "record.h"
  30
  31 namespace Barry {
  32
  33 // forward declarations
  34 class Parser;
  35 class Builder;
  36 class IConverter;
  37
  38 namespace Mode {
  39
  40 class DBLoader;
  41
  42 //
  43 // Desktop class
  44 //
  45 /// The main interface class to the device databases.
  46 ///
  47 /// To use this class, use the following steps:
  48 ///
  49 ///     - Create a Controller object (see Controller class for more details)
  50 ///     - Create this Mode::Desktop object, passing in the Controller
  51 ///             object during construction
  52 ///     - Call Open() to open database socket and finish constructing.
  53 ///     - Call GetDBDB() to get the device's database database
  54 ///     - Call GetDBID() to get a database ID by name
  55 ///     - Call LoadDatabase() to retrieve and store a database
  56 ///
  57 class BXEXPORT Desktop : public Mode
  58 {
  59         friend class DBLoader;
  60
  61 public:
  62         enum CommandType { Unknown, DatabaseAccess };
  63
  64 private:
  65         // packet data
  66         Data m_command, m_response;
  67
  68         CommandTable m_commandTable;
  69         DatabaseDatabase m_dbdb;
  70
  71         // external objects (optional, can be null)
  72         const IConverter *m_ic;
  73
  74 protected:
  75         void LoadCommandTable();
  76         void LoadDBDB();
  77
  78         //////////////////////////////////
  79         // overrides
  80
  81         virtual void OnOpen();
  82
  83 public:
  84         Desktop(Controller &con);
  85         Desktop(Controller &con, const IConverter &ic);
  86         ~Desktop();
  87
  88         //////////////////////////////////
  89         // meta access
  90
  91         /// Returns DatabaseDatabase object for this connection.
  92         /// Must call Open() first, which loads the DBDB.
  93         const DatabaseDatabase& GetDBDB() const { return m_dbdb; }
  94         unsigned int GetDBID(const std::string &name) const;
  95         unsigned int GetDBCommand(CommandType ct);
  96
  97         void SetIConverter(const IConverter &ic);
  98
  99         //////////////////////////////////
 100         // Desktop mode - database specific
 101
 102         // dirty flag related functions, for sync operations
 103         void GetRecordStateTable(unsigned int dbId, RecordStateTable &result);
 104         void AddRecord(unsigned int dbId, Builder &build); // RecordId is
 105                 // retrieved from build, and duplicate IDs are allowed,
 106                 // but *not* recommended!
 107         void GetRecord(unsigned int dbId, unsigned int stateTableIndex, Parser &parser);
 108         void SetRecord(unsigned int dbId, unsigned int stateTableIndex, Builder &build);
 109         void ClearDirty(unsigned int dbId, unsigned int stateTableIndex);
 110         void DeleteRecord(unsigned int dbId, unsigned int stateTableIndex);
 111
 112         // pure load/save operations
 113         void LoadDatabase(unsigned int dbId, Parser &parser);
 114         void ClearDatabase(unsigned int dbId);
 115         void SaveDatabase(unsigned int dbId, Builder &builder);
 116
 117         template <class RecordT, class StorageT> void LoadDatabaseByType(StorageT &store);
 118         template <class RecordT, class StorageT> void SaveDatabaseByType(StorageT &store);
 119
 120         template <class StorageT> void LoadDatabaseByName(const std::string &name, StorageT &store);
 121         template <class StorageT> void SaveDatabaseByName(const std::string &name, StorageT &store);
 122
 123         template <class RecordT> void AddRecordByType(uint32_t recordId, const RecordT &rec);
 124
 125 };
 126
 127 // used to hold internal-only state
 128 struct DBLoaderData;
 129
 130 //
 131 // DBLoader
 132 //
 133 /// Database Loader operation class.  Encapsulates the load / save
 134 /// logic of Desktop::LoadDatabase() and someday Desktop::SaveDatabase()
 135 /// in such a way that the loading of individual records is
 136 /// controllable by the user, instead of using the parser callback mechanism.
 137 ///
 138 /// This class can be reused to load / save multiple databases, but
 139 /// do not call Desktop members while a load operation is in progress.
 140 ///
 141 class BXEXPORT DBLoader
 142 {
 143         DBLoaderData *m_loader;
 144         Desktop &m_desktop;
 145         DBData &m_data;
 146         bool m_loading;
 147         std::string m_dbName;
 148
 149 public:
 150         DBLoader(Desktop &desktop, DBData &data);
 151         ~DBLoader();
 152
 153         /// Do not call Desktop members if this is true.
 154         bool IsBusy() const { return m_loading; }
 155
 156         // caller-controllable load/save operations... if
 157         // these functions return true, then new data has
 158         // just been loaded into the data object passed to
 159         // the constructor
 160         bool StartDBLoad(unsigned int dbId);
 161         bool GetNextRecord();
 162 };
 163
 164 }} // namespace Barry::Mode
 165
 166 #endif
 167