dictquery.h

Go to the documentation of this file.

/*****************************************************************************
 * This file is part of Kiten, a KDE Japanese Reference Tool                 *
 * Copyright (C) 2006 Joseph Kerian <jkerian@gmail.com>                      *
 * Copyright (C) 2011 Daniel E. Moctezuma <democtezuma@gmail.com>            *
 *                                                                           *
 * This library is free software; you can redistribute it and/or             *
 * modify it under the terms of the GNU Library General Public               *
 * License as published by the Free Software Foundation; either              *
 * version 2 of the License, or (at your option) any later version.          *
 *                                                                           *
 * This library 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         *
 * Library General Public License for more details.                          *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public License *
 * along with this library; see the file COPYING.LIB.  If not, write to      *
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,      *
 * Boston, MA 02110-1301, USA.                                               *
 *****************************************************************************/

#ifndef KITEN_DICTQUERY_H
#define KITEN_DICTQUERY_H

#include <QHash>
#include <QHashIterator>
#include <QString>
#include <QStringList>

class QChar;

#include "libkitenexport.h"

class KITEN_EXPORT DictQuery
{
public:
  static const QString mainDelimiter;
  static const QString propertySeperator;
  DictQuery();
  DictQuery( const QString& str );
  DictQuery( const DictQuery& orig );
  ~DictQuery();

  bool isEmpty() const;
  void clear();
  DictQuery &operator=( const DictQuery &old );
  DictQuery *clone() const;
  const QString toString() const;
  operator QString() const;

  const QList<QString> listPropertyKeys() const;
  const QString operator[]( const QString &key ) const;
  QString operator[]( const QString &key );
  QString getProperty( const QString &key ) const;
  bool hasProperty( const QString &key ) const;
  bool setProperty( const QString& key, const QString& value );
  bool removeProperty( const QString &key );
  QString takeProperty( const QString &key );

  QStringList getDictionaries() const;
  void setDictionaries( const QStringList &newDictionaries );

  QString getMeaning() const;
  bool setMeaning( const QString &newMeaning );
  QString getPronunciation() const;
  bool setPronunciation( const QString &newPronunciation );
  QString getWord() const;
  bool setWord( const QString &newWord );

  KITEN_EXPORT friend bool operator==( const DictQuery &a, const DictQuery &b );
  KITEN_EXPORT friend bool operator!=( const DictQuery &other, const DictQuery &query );
  KITEN_EXPORT friend bool operator<( const DictQuery &a, const DictQuery &b );
  KITEN_EXPORT friend bool operator<=( const DictQuery &a, const DictQuery &b );
  DictQuery &operator+=( const DictQuery &old );
  DictQuery &operator=( const QString &old );
  DictQuery &operator+=( const QString &old );
  KITEN_EXPORT friend DictQuery operator+( const DictQuery &a, const DictQuery &b );
#ifndef QT_NO_CAST_ASCII

  DictQuery &operator=( const char* );
#endif

   //Specify the type of matching
  enum MatchType
  {
    Exact,
    Beginning,
    Ending,
    Anywhere
  };
  MatchType getMatchType() const;
  void setMatchType( MatchType newType );

  enum MatchWordType
  {
    Any,
    Verb,
    Noun,
    Adjective,
    Adverb,
    Prefix,
    Suffix,
    Expression
  };
  MatchWordType getMatchWordType() const;
  void setMatchWordType( MatchWordType newType );

  enum FilterType
  {
    NoFilter,
    Rare,
    CommonUncommon
  };
  FilterType getFilterType() const;
  void setFilterType( FilterType newType );

  enum StringTypeEnum
  {
    Kanji,
    Kana,
    Latin,
    Mixed,
    ParseError
  };
  static StringTypeEnum stringTypeCheck( const QString &in );
  static StringTypeEnum charTypeCheck( const QChar &ch );

private:
  class Private;
  Private* const d;
};

//Currently... KDE doesn't seem to want to use exceptions
#ifdef LIBKITEN_USING_EXCEPTIONS
class InvalidQueryException
{
  public:
    InvalidQueryException( QString x ) { m_val = x; }
    InvalidQueryException( QString m = "Invalid Query String", QString x ) { m_val = x; m_msg = m; }
    QString value() { return m_val; }
    QString message() { return m_msg; }

  protected:
    QString m_val;
    QString m_msg;
};
#endif

#endif