Fix CoreFeatures; disable SASL support if core isn't new enough

[quassel.git] / src / common / quassel.h

diff --git a/src/common/quassel.h b/src/common/quassel.h
index bb4771e..86469c4 100644 (file)
--- a/src/common/quassel.h
+++ b/src/common/quassel.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -22,9 +22,10 @@
 #define QUASSEL_H_
 
 #include <QCoreApplication>
+#include <QLocale>
 #include <QString>
 
-#include "cliparser.h"
+#include "abstractcliparser.h"
 
 class Quassel {
   Q_DECLARE_TR_FUNCTIONS(Quassel)
@@ -57,13 +58,62 @@ public:
     QString organizationDomain;
   };
 
+  //! A list of features that are optional in core and/or client, but need runtime checking
+  /** Some features require an uptodate counterpart, but don't justify a protocol break.
+   *  This is what we use this enum for. Add such features to it and check at runtime on the other
+   *  side for their existence.
+   *
+   *  This list should be cleaned up after every protocol break, as we can assume them to be present then.
+   */
+  enum Feature {
+    SynchronizedMarkerLine = 0x0001,
+    SaslAuthentication = 0x0002,
+
+    NumFeatures = 0x0002
+  };
+  Q_DECLARE_FLAGS(Features, Feature);
+
+  //! The features the current version of Quassel supports (\sa Feature)
+  /** \return An ORed list of all enum values in Feature
+   */
+  static Features features();
+
   virtual ~Quassel();
 
   static void setupBuildInfo(const QString &generated);
   static inline const BuildInfo & buildInfo();
   static inline RunMode runMode();
 
-  static inline CliParser *cliParser();
+  static QString configDirPath();
+
+  //! Returns a list of data directory paths
+  /** There are several locations for applications to install their data files in. On Unix,
+  *  a common location is /usr/share; others include $PREFIX/share and additional directories
+  *  specified in the env variable XDG_DATA_DIRS.
+  *  \return A list of directory paths to look for data files in
+  */
+  static QStringList dataDirPaths();
+
+  //! Searches for a data file in the possible data directories
+  /** Data files can reside in $DATA_DIR/apps/quassel, where $DATA_DIR is one of the directories
+  *  returned by \sa dataDirPaths().
+  *  \Note With KDE integration enabled, files are searched (only) in KDE's appdata dirs.
+  *  \return The full path to the data file if found; a null QString else
+  */
+  static QString findDataFilePath(const QString &filename);
+
+  static QString translationDirPath();
+
+  //! Returns a list of directories we look for scripts in
+  /** We look for a subdirectory named "scripts" in the configdir and in all datadir paths.
+  *   \return A list of directory paths containing executable scripts for /exec
+  */
+  static QStringList scriptDirPaths();
+
+  static void loadTranslation(const QLocale &locale);
+
+  static inline void setCliParser(AbstractCliParser *cliParser);
+  static inline AbstractCliParser *cliParser();
   static inline QString optionValue(const QString &option);
   static inline bool isOptionSet(const QString &option);
 
@@ -76,8 +126,12 @@ public:
 protected:
   Quassel();
   virtual bool init();
+  virtual void quit();
 
   inline void setRunMode(RunMode mode);
+  inline void setDataDirPaths(const QStringList &paths);
+  QStringList findDataDirPaths() const;
+  inline void disableCrashhandler();
 
 private:
   void registerMetaTypes();
@@ -85,19 +139,29 @@ private:
   static void handleSignal(int signal);
   static void logBacktrace(const QString &filename);
 
+  static Quassel *_instance;
   static BuildInfo _buildInfo;
-  static CliParser *_cliParser;
+  static AbstractCliParser *_cliParser;
   static RunMode _runMode;
   static bool _initialized;
+  static bool _handleCrashes;
 
   static QString _coreDumpFileName;
+  static QString _configDirPath;
+  static QStringList _dataDirPaths;
+  static QString _translationDirPath;
 };
 
+Q_DECLARE_OPERATORS_FOR_FLAGS(Quassel::Features);
+
 const Quassel::BuildInfo & Quassel::buildInfo() { return _buildInfo; }
 Quassel::RunMode Quassel::runMode() { return _runMode; }
 void Quassel::setRunMode(Quassel::RunMode mode) { _runMode = mode; }
+void Quassel::setDataDirPaths(const QStringList &paths) { _dataDirPaths = paths; }
+void Quassel::disableCrashhandler() { _handleCrashes = false; }
 
-CliParser *Quassel::cliParser() { return _cliParser ? _cliParser : _cliParser = new CliParser(); }
+void Quassel::setCliParser(AbstractCliParser *parser) { _cliParser = parser; }
+AbstractCliParser *Quassel::cliParser() { return _cliParser; }
 QString Quassel::optionValue(const QString &key) { return cliParser()->value(key); }
 bool Quassel::isOptionSet(const QString &key) { return cliParser()->isSet(key); }