src/Resource/Global.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 Global.h
  24  * This file contains the Global class.
  25  *
  26  * @see Global
  27  */
  28
  29 #include <stdarg.h>
  30
  31 #include "Types.h"
  32
  33 /**
  34  * This class is used to contain otherwise global variables and methods.
  35  */
  36 class Global : public Singleton<Global>
  37 {
  38 public:
  39         /** The maximum character buffer size. */
  40         static const int MAXSIZE = (1<<16);
  41
  42         /** The 'empty' string. */
  43         std::string EmptyString;
  44
  45         /** The character that identifies an OOC command. */
  46         char OOCIdentifier;
  47
  48         /** The character that identifies emotes. */
  49         char SocialIdentifier;
  50
  51         /** Returns the formatted data. */
  52         std::string sprintf(const char* format, ...);
  53
  54         /** Returns the formatted data. */
  55         std::string sprint(va_list& args, const char* format);
  56
  57
  58         /*
  59          * Logging
  60          */
  61
  62
  63         /** Prints the specified raw msg. */
  64         void printraw(const std::string& msg);
  65
  66         /** Prints the specified mode msg. */
  67         void printmode(const std::string& msg);
  68
  69         /** Prints the specified bug msg. */
  70         void printbug(const std::string& msg);
  71
  72         /** Prints the specified exception msg. */
  73         void printexception(const std::string& msg);
  74
  75         /** Prints the specified exception msg. */
  76         void printexception(const std::string& msg, const std::string& what);
  77
  78         /** Prints the specified sql msg. */
  79         void printsql(const std::string& msg);
  80
  81         /** Prints the specified status msg. */
  82         void printstatus(const std::string& msg);
  83
  84         /** Prints the specified log msg. */
  85         void printlog(const std::string& msg);
  86
  87 private:
  88         /** This is a singleton class, use <code>Get</code> to retreive the instance. */
  89         Global(void);
  90
  91         /** This is a singleton class, use <code>Free</code> to free the instance. */
  92         ~Global(void);
  93
  94         friend class Singleton<Global>;
  95
  96         char m_workspace[MAXSIZE]; /**< The workspace to use when using sprintf/bugf/logf. */
  97 };
  98