kmime_charfreq.h

Go to the documentation of this file.

/*  -*- c++ -*-
    kmime_charfreq.h

    KMime, the KDE Internet mail/usenet news message library.
    Copyright (c) 2001-2002 Marc Mutz <mutz@kde.org>

    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 __KMIME_CHARFREQ_H__
#define __KMIME_CHARFREQ_H__

#include <QByteArray>
#undef None

namespace KMime
{

class CharFreq
{
public:
    explicit CharFreq(const QByteArray &buf);

    CharFreq(const char *buf, size_t len);

    enum Type {
        None = 0,              
        EightBitData,          
        Binary = EightBitData, 
        SevenBitData,          
        EightBitText,          
        SevenBitText           
    };

    Q_REQUIRED_RESULT Type type() const;

    Q_REQUIRED_RESULT bool isEightBitData() const;

    Q_REQUIRED_RESULT bool isEightBitText() const;

    Q_REQUIRED_RESULT bool isSevenBitData() const;

    Q_REQUIRED_RESULT bool isSevenBitText() const;

    Q_REQUIRED_RESULT bool hasTrailingWhitespace() const;

    Q_REQUIRED_RESULT bool hasLeadingFrom() const;

    Q_REQUIRED_RESULT float printableRatio() const;

    Q_REQUIRED_RESULT float controlCodesRatio() const;

private:
    //@cond PRIVATE
    uint mNUL;         // count of NUL chars
    uint mCTL;         // count of CTLs (incl. DEL, excl. CR, LF, HT)
    uint mCR;          // count of CR chars
    uint mLF;          // count of LF chars
    uint mCRLF;        // count of LFs, preceded by CRs
    uint mPrintable;   // count of printable US-ASCII chars (SPC..~)
    uint mEightBit;    // count of other latin1 chars (those with 8th bit set)
    uint mTotal;       // count of all chars
    uint mLineMin;     // minimum line length
    uint mLineMax;     // maximum line length
    bool mTrailingWS;  // does the buffer contain trailing whitespace?
    bool mLeadingFrom; // does the buffer contain lines starting with "From "?
    //@endcond

    void count(const char *buf, size_t len);
};

} // namespace KMime

#endif /* __KMIME_CHARFREQ_H__ */