/**********************************************************************
** Copyright (C) 2000-2005 Trolltech AS.  All rights reserved.
**
** This file is part of Qt Linguist.
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
** licenses may use this file in accordance with the Qt Commercial License
** Agreement provided with the Software.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/gpl/ for GPL licensing information.
** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
**   information about Qt Commercial License Agreements.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/

#ifndef METATRANSLATOR_H
#define METATRANSLATOR_H

#include <qmap.h>
#include <qstring.h>
#include <qtranslator.h>
#include <qvaluelist.h>

class QTextCodec;

class MetaTranslatorMessage : public QTranslatorMessage {
public:
  enum Type { Unfinished, Finished, Obsolete };

  MetaTranslatorMessage();
  MetaTranslatorMessage( const char *context, const char *sourceText,
                         const char *comment,
                         const QString& translation = QString::null,
                         bool utf8 = FALSE, Type type = Unfinished );
  MetaTranslatorMessage( const MetaTranslatorMessage& m );

  MetaTranslatorMessage& operator=( const MetaTranslatorMessage& m );

  void setType( Type nt ) {
    ty = nt;
  }
  Type type() const {
    return ty;
  }
  bool utf8() const {
    return utfeight;
  }

  bool operator==( const MetaTranslatorMessage& m ) const;
  bool operator!=( const MetaTranslatorMessage& m ) const {
    return !operator==( m );
  }
  bool operator<( const MetaTranslatorMessage& m ) const;
  bool operator<=( const MetaTranslatorMessage& m ) {
    return !operator>( m );
  }
  bool operator>( const MetaTranslatorMessage& m ) const {
    return this->operator<( m );
  }
  bool operator>=( const MetaTranslatorMessage& m ) const {
    return !operator<( m );
  }

private:
  bool utfeight;
  Type ty;
};

class MetaTranslator {
public:
  MetaTranslator();
  MetaTranslator( const MetaTranslator& tor );

  MetaTranslator& operator=( const MetaTranslator& tor );

  void clear();
  bool load( const QString& filename );
  bool save( const QString& filename ) const;
  bool release( const QString& filename, bool verbose = FALSE,
                QTranslator::SaveMode mode = QTranslator::Stripped ) const;

  bool contains( const char *context, const char *sourceText,
                 const char *comment ) const;
  void insert( const MetaTranslatorMessage& m );

  void stripObsoleteMessages();
  void stripEmptyContexts();

  void setCodec( const char *name );
  QString toUnicode( const char *str, bool utf8 ) const;

  QValueList<MetaTranslatorMessage> messages() const;
  QValueList<MetaTranslatorMessage> translatedMessages() const;

private:
  typedef QMap<MetaTranslatorMessage, int> TMM;
  typedef QMap<int, MetaTranslatorMessage> TMMInv;

  TMM mm;
  QCString codecName;
  QTextCodec *codec;
};

/*
  This is a quick hack. The proper way to handle this would be
  to extend MetaTranslator's interface.
*/
#define ContextComment "QT_LINGUIST_INTERNAL_CONTEXT_COMMENT"

#endif