src/Initializer/Initializer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Sverre Rabbelier                                *
   3  *   sverre@rabbelier.nl                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 3 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #pragma once
  21
  22 /**
  23  * @file Initializer.h
  24  * This file contains the Initializer class.
  25  *
  26  * @see Initializer
  27  */
  28
  29 #include "Types.h"
  30
  31 class Database;
  32
  33 /**
  34  * This class will check and initialize the database.
  35  *
  36  * It will first check whether the database is already initialized.
  37  * If it is not yet initialized it will create the appropriate tables.
  38  * Therafter it will verify that the schema is good (regardless of earlier actions).
  39  * When all is well it will initialize the Database with some default values.
  40  * Also the Colours and Commands table will be filled.
  41  */
  42 class Initializer
  43 {
  44 public:
  45         /** Constructs an Initializer with the specified database connection. */
  46         explicit Initializer(Database* db) : m_db(db) {};
  47
  48         /** Destructor, a noop. */
  49         ~Initializer() {};
  50
  51
  52         /** Whether the database version is the same as the version that was used to build this Initializer. */
  53         bool VerifyDatabaseVersion();
  54
  55         /** Whether the tables match. */
  56         bool VerifyTables(TableImplVector::const_iterator begin, TableImplVector::const_iterator end);
  57
  58
  59         /** Create the tables in the database. */
  60         void InitTables(TableImplVector::const_iterator begin, TableImplVector::const_iterator end);
  61
  62         /** Fill the tables with some default values. */
  63         void InitDatabase();
  64
  65         /** Fill the colour table. */
  66         void InitColours();
  67
  68         /** Fill the command table. */
  69         void InitCommands();
  70
  71         /** Creates 'the void'. */
  72         void InitSpace();
  73
  74         /** Creates a set of sample chunks. */
  75         void InitSampleChunks(int size);
  76
  77 private:
  78         /** Hide the copy constructor. */
  79         Initializer(const Initializer& rhs);
  80
  81         /** Hide the assignment operator. */
  82         Initializer operator=(const Initializer& rhs);
  83
  84         Database* m_db; /**< The database connection to use. */
  85
  86         /** A struct to store colour definitions in. */
  87         struct colour
  88         {
  89                 std::string name; /**< The name of the colour. */
  90                 std::string code; /**< The colourcode of the colour. */
  91                 std::string cstr; /**< The string value of the colour. */
  92         };
  93
  94         /** A struct to store command definitions in. */
  95         struct command
  96         {
  97                 std::string name; /**< The fully qualified ('Editor::Name' format) name of the command. */
  98                 value_type grantgroup; /**< The grantgroup this command belongs to. */
  99                 int highforce; /**< Whether it is possible to highforce someone to execute this command. */
 100                 int force; /**< Whether it is possible to force someone to execute this command. */
 101                 int lowforce; /**< Whether it is possible to lowforce someone to execute this command. */
 102                 std::string help; /**< A help string describing what the command does. */
 103         };
 104 };