kencodingprober.h

Go to the documentation of this file.

/*
    This file is part of the KDE libraries

    Copyright (C) 2008 Wang Hoi (zealot.hoi@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 KENCODINGPROBER_H
#define KENCODINGPROBER_H

// enable debug of private probers
// #define DEBUG_PROBE

#include <kdecore_export.h>
#ifdef DEBUG_PROBE
#include <kdebug.h>
#endif
#include <QtCore/QString>

class KEncodingProberPrivate;

class KDECORE_EXPORT KEncodingProber
{
public:

    enum ProberState {
        FoundIt,  
        NotMe,    
        Probing   
    };

    enum ProberType {
        None,
        Universal,
        Arabic,
        Baltic,
        CentralEuropean,
        ChineseSimplified,
        ChineseTraditional,
        Cyrillic,
        Greek,
        Hebrew,
        Japanese,
        Korean,
        NorthernSaami,
        Other,
        SouthEasternEurope,
        Thai,
        Turkish,
        Unicode,
        WesternEuropean
    };

    KEncodingProber(ProberType proberType=Universal);

    ~KEncodingProber();

    void reset();

    ProberState feed(const QByteArray &data);
    ProberState feed(const char* data, int len);

    ProberState state() const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED const char* encodingName() const;
#endif

    QByteArray encoding() const;

    float confidence() const;

    ProberType proberType() const;

    void setProberType(ProberType proberType);

    static ProberType proberTypeForName(const QString& lang);

    static QString nameForProberType(ProberType proberType);

private:
    KEncodingProberPrivate* const d;
};

#endif