klfmain.h

Go to the documentation of this file.

/***************************************************************************
 *   file klfmain.h
 *   This file is part of the KLatexFormula Project.
 *   Copyright (C) 2011 by Philippe Faist
 *   philippe.faist at bluewin.ch
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
/* $Id: klfmain.h 603 2011-02-26 23:14:55Z phfaist $ */

#ifndef KLFMAIN_H
#define KLFMAIN_H

#include <QCoreApplication>
#include <QString>
#include <QList>
#include <QMap>
#include <QStringList>
#include <QDataStream>
#include <QTranslator>
#include <QDir>

#include <klfdefs.h>




// SOME DEFINITIONS

#if defined(Q_WS_WIN)
#define KLF_DLL_EXT_LIST (QStringList()<<"*.dll")
#elif defined(Q_WS_MAC)
#define KLF_DLL_EXT_LIST (QStringList()<<"*.so"<<"*.dylib")
#else
#define KLF_DLL_EXT_LIST (QStringList()<<"*.so")
#endif



// SOME DECLARATIONS FOR ADD-ONS

class KLF_EXPORT KLFAddOnInfo
{
public:
  KLFAddOnInfo(QString rccfpath, bool isFresh = false);

  KLFAddOnInfo(const KLFAddOnInfo& o);

  struct KLF_EXPORT PluginSysInfo {
    QString dir;
    QString qtminversion;
    QString klfminversion;
    QString os;
    QString arch;

    bool isCompatibleWithCurrentSystem() const;
  };

  ~KLFAddOnInfo();

  QString dir() { return d->dir; }
  QString fname() { return d->fname; };
  QString fpath() { return d->fpath; }
  bool islocal() { return d->islocal; }

  QString title() { return d->title; }
  QString author() { return d->author; }
  QString description() { return d->description; }
  QString klfminversion() { return d->klfminversion; }

  QString rccmountroot() { return d->rccmountroot; }
    
  QStringList pluginList() const { return d->pluginList; }

  PluginSysInfo pluginSysInfo(const QString& plugin) const { return d->plugins[plugin]; }

  QString pluginLocalSubDirName(const QString& plugin) const
  {
    if ( ! d->plugins[plugin].klfminversion.isEmpty() )
      return QString("klf%1").arg(d->plugins[plugin].klfminversion);
    return QString(".");
  }

  QStringList localPluginList() const;


  QStringList translations() { return d->translations; }

  bool isfresh() { return d->isfresh; }

private:

  struct Private {
    int ref; // number of times this data structure is referenced

    QString dir;
    QString fname;
    QString fpath;
    bool islocal;

    QString title;
    QString author;
    QString description;
    QString klfminversion;

    QString rccmountroot;
    
    QStringList pluginList;
    QMap<QString,PluginSysInfo> plugins;
    
    QStringList translations;
    
    bool isfresh;
  };

  Private *d;

  void initPlugins();
};

KLF_EXPORT extern QList<KLFAddOnInfo> klf_addons;
KLF_EXPORT extern bool klf_addons_canimport;

KLF_EXPORT QDebug& operator<<(QDebug& str, const KLFAddOnInfo::PluginSysInfo& i);



// SOME DEFINITIONS FOR PLUGINS

class KLFPluginGenericInterface;

struct KLFPluginInfo
{
  QString name;
  QString author;
  QString title;
  QString description;

  QString fpath;
  QString fname;

  KLFPluginGenericInterface * instance;
};


KLF_EXPORT extern QList<KLFPluginInfo> klf_plugins;






struct KLF_EXPORT KLFTranslationInfo
{
  KLFTranslationInfo() : hasnicetranslatedname(false) { }

  QString localename;
  QString translatedname;
  bool hasnicetranslatedname;
};

KLF_EXPORT extern QList<KLFTranslationInfo> klf_avail_translations;

KLF_EXPORT extern QList<QTranslator*> klf_translators;


class KLF_EXPORT KLFI18nFile
{
public:
  QString fpath;
  QString name;
  QString locale;
  int locale_specificity;

  KLFI18nFile(QString filepath);
};



KLF_EXPORT void klf_add_avail_translation(KLFI18nFile i18nfile);


KLF_EXPORT void klf_reload_translations(QCoreApplication *app, const QString& currentlocale);



// eg. baseFileName="cmdl-help"  extension=".txt" will look for
// "cmdl-help_fr_CH.txt", "cmdl-help_fr.txt", "cmdl-help.txt" assuming current locale is "fr_CH"
KLF_EXPORT QString klfFindTranslatedDataFile(const QString& baseFileName, const QString& extension);




#define KLF_DATA_STREAM_APP_VERSION  "3.2"
//                                --- don't forget to update below too! ---

#define KLF_DATA_STREAM_APP_VERSION_MAJ  3

#define KLF_DATA_STREAM_APP_VERSION_MIN  2


inline QString klfDataStreamAppVersion(const QDataStream& d)
{ return d.device()->property("klfDataStreamAppVersion").toString(); }


KLF_EXPORT void klfDataStreamWriteHeader(QDataStream& stream, const QString headermagic);

KLF_EXPORT bool klfDataStreamReadHeader(QDataStream& stream, const QStringList possibleHeaders,
                                        QString * readHeader = NULL, QString * readCompatKLFVersion = NULL) ;



#endif