• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KEncodingDetector Class Reference

Provides encoding detection capabilities. More...

#include <kencodingdetector.h>

List of all members.


Public Types

enum  AutoDetectScript {
  None, SemiautomaticDetection, Arabic, Baltic,
  CentralEuropean, ChineseSimplified, ChineseTraditional, Cyrillic,
  Greek, Hebrew, Japanese, Korean,
  NorthernSaami, SouthEasternEurope, Thai, Turkish,
  Unicode, WesternEuropean
}
enum  EncodingChoiceSource {
  DefaultEncoding, AutoDetectedEncoding, BOM, EncodingFromXMLHeader,
  EncodingFromMetaTag, EncodingFromHTTPHeader, UserChosenEncoding
}

Public Member Functions

AutoDetectScript autoDetectLanguage () const
QString decode (const QByteArray &data)
QString decode (const char *data, int len)
QString decodeWithBuffering (const char *data, int len)
const char * encoding () const
EncodingChoiceSource encodingChoiceSource () const
QString flush ()
 KEncodingDetector (QTextCodec *codec, EncodingChoiceSource source, AutoDetectScript script=None)
 KEncodingDetector ()
void setAutoDetectLanguage (AutoDetectScript)
bool setEncoding (const char *encoding, EncodingChoiceSource type)
bool visuallyOrdered () const
 ~KEncodingDetector ()

Static Public Member Functions

static bool hasAutoDetectionForScript (AutoDetectScript)
static QString nameForScript (AutoDetectScript)
static AutoDetectScript scriptForName (const QString &lang)

Protected Member Functions

bool analyze (const char *data, int len)
QTextDecoder * decoder ()
bool errorsIfUtf8 (const char *data, int length)
bool processNull (char *data, int length)

Detailed Description

Provides encoding detection capabilities.

Searches for encoding declaration inside raw data -- meta and xml tags. In the case it can't find it, uses heuristics for specified language.

If it finds unicode BOM marks, it changes encoding regardless of what the user has told

Intended lifetime of the object: one instance per document.

Typical use:

 QByteArray data;
 ...
 KEncodingDetector detector;
 detector.setAutoDetectLanguage(KEncodingDetector::Cyrillic);
 QString out=detector.decode(data);

Do not mix decode() with decodeWithBuffering()

Guess encoding of char array

Definition at line 58 of file kencodingdetector.h.


Member Enumeration Documentation

enum KEncodingDetector::AutoDetectScript

Enumerator:
None 
SemiautomaticDetection 
Arabic 
Baltic 
CentralEuropean 
ChineseSimplified 
ChineseTraditional 
Cyrillic 
Greek 
Hebrew 
Japanese 
Korean 
NorthernSaami 
SouthEasternEurope 
Thai 
Turkish 
Unicode 
WesternEuropean 

Definition at line 72 of file kencodingdetector.h.

enum KEncodingDetector::EncodingChoiceSource

Enumerator:
DefaultEncoding 
AutoDetectedEncoding 
BOM 
EncodingFromXMLHeader 
EncodingFromMetaTag 
EncodingFromHTTPHeader 
UserChosenEncoding 

Definition at line 61 of file kencodingdetector.h.


Constructor & Destructor Documentation

KEncodingDetector::KEncodingDetector (  ) 

Default codec is latin1 (as html spec says), EncodingChoiceSource is default, AutoDetectScript=Semiautomatic.

Definition at line 650 of file kencodingdetector.cpp.

KEncodingDetector::KEncodingDetector ( QTextCodec *  codec,
EncodingChoiceSource  source,
AutoDetectScript  script = None 
)

Allows to set Default codec, EncodingChoiceSource, AutoDetectScript.

Definition at line 654 of file kencodingdetector.cpp.

KEncodingDetector::~KEncodingDetector (  ) 

Definition at line 659 of file kencodingdetector.cpp.


Member Function Documentation

bool KEncodingDetector::analyze ( const char *  data,
int  len 
) [protected]

Analyze text data.

Returns:
true if there was enough data for accurate detection

Definition at line 857 of file kencodingdetector.cpp.

KEncodingDetector::AutoDetectScript KEncodingDetector::autoDetectLanguage (  )  const

Definition at line 668 of file kencodingdetector.cpp.

QString KEncodingDetector::decode ( const QByteArray &  data  ) 

Definition at line 771 of file kencodingdetector.cpp.

QString KEncodingDetector::decode ( const char *  data,
int  len 
)

The main class method.

Calls protected analyze() only the first time of the whole object life

Replaces all null chars with spaces.

Definition at line 759 of file kencodingdetector.cpp.

QTextDecoder * KEncodingDetector::decoder (  )  [protected]

Returns:
QTextDecoder for detected encoding

Definition at line 694 of file kencodingdetector.cpp.

QString KEncodingDetector::decodeWithBuffering ( const char *  data,
int  len 
)

Convenience method that uses buffering.

It waits for full html head to be buffered (i.e. calls analyze every time until it returns true).

Replaces all null chars with spaces.

Returns:
Decoded data, or empty string, if there was not enough data for accurate detection
See also:
flush()

Definition at line 783 of file kencodingdetector.cpp.

const char * KEncodingDetector::encoding (  )  const

Convenience method.

Returns:
mime name of detected encoding

Definition at line 678 of file kencodingdetector.cpp.

KEncodingDetector::EncodingChoiceSource KEncodingDetector::encodingChoiceSource (  )  const

Definition at line 673 of file kencodingdetector.cpp.

bool KEncodingDetector::errorsIfUtf8 ( const char *  data,
int  length 
) [protected]

Check if we are really utf8.

Taken from kate

Returns:
true if current encoding is utf8 and the text cannot be in this encoding
Please somebody read http://de.wikipedia.org/wiki/UTF-8 and check this code...

Definition at line 585 of file kencodingdetector.cpp.

QString KEncodingDetector::flush (  ) 

Convenience method to be used with decodeForHtml.

Flushes buffer.

See also:
decodeForHtml()

Definition at line 843 of file kencodingdetector.cpp.

bool KEncodingDetector::hasAutoDetectionForScript ( KEncodingDetector::AutoDetectScript  script  )  [static]

Definition at line 1148 of file kencodingdetector.cpp.

QString KEncodingDetector::nameForScript ( KEncodingDetector::AutoDetectScript  script  )  [static]

Definition at line 1182 of file kencodingdetector.cpp.

bool KEncodingDetector::processNull ( char *  data,
int  length 
) [protected]

This nice method will kill all 0 bytes (or double bytes) and remember if this was a binary or not ;).

Definition at line 556 of file kencodingdetector.cpp.

KEncodingDetector::AutoDetectScript KEncodingDetector::scriptForName ( const QString &  lang  )  [static]

Takes lang name _after_ it were i18n()'ed.

Definition at line 1120 of file kencodingdetector.cpp.

void KEncodingDetector::setAutoDetectLanguage ( KEncodingDetector::AutoDetectScript  lang  ) 

Definition at line 664 of file kencodingdetector.cpp.

bool KEncodingDetector::setEncoding ( const char *  encoding,
EncodingChoiceSource  type 
)

Returns:
true if specified encoding was recognized

Definition at line 699 of file kencodingdetector.cpp.

bool KEncodingDetector::visuallyOrdered (  )  const

Definition at line 684 of file kencodingdetector.cpp.


The documentation for this class was generated from the following files:
  • kencodingdetector.h
  • kencodingdetector.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal