Kate::TextLoader

Kate::TextLoader Class Reference

#include <katetextloader.h>

Public Member Functions

 TextLoader (const QString &filename, KEncodingProber::ProberType proberType)
 
 ~TextLoader ()
 
bool byteOrderMarkFound () const
 
QByteArray digest ()
 
bool eof () const
 
TextBuffer::EndOfLineMode eol () const
 
const QStringmimeTypeForFilterDev () const
 
bool open (QTextCodec *codec)
 
bool readLine (int &offset, int &length)
 
QTextCodectextCodec () const
 
const QCharunicode () const
 

Detailed Description

File Loader, will handle reading of files + detecting encoding.

Definition at line 44 of file katetextloader.h.

Constructor & Destructor Documentation

Kate::TextLoader::TextLoader ( const QString filename,
KEncodingProber::ProberType  proberType 
)
inline

Construct file loader for given file.

Parameters
filenamefile to open
proberTypeprober type

Definition at line 52 of file katetextloader.h.

Kate::TextLoader::~TextLoader ( )
inline

Destructor.

Definition at line 81 of file katetextloader.h.

Member Function Documentation

bool Kate::TextLoader::byteOrderMarkFound ( ) const
inline

BOM found?

Returns
byte order mark found?

Definition at line 143 of file katetextloader.h.

bool Kate::TextLoader::eof ( ) const
inline

end of file reached?

Returns
end of file reached

Definition at line 124 of file katetextloader.h.

TextBuffer::EndOfLineMode Kate::TextLoader::eol ( ) const
inline

Detected end of line mode for this file.

Detected during reading, is valid after complete file is read.

Returns
eol mode of this file

Definition at line 134 of file katetextloader.h.

const QString& Kate::TextLoader::mimeTypeForFilterDev ( ) const
inline

mime type used to create filter dev

Returns
mime-type of filter device

Definition at line 152 of file katetextloader.h.

bool Kate::TextLoader::open ( QTextCodec codec)
inline

open file with given codec

Parameters
codeccodec to use, if 0, will do some auto-detect or fallback
Returns
success

Definition at line 92 of file katetextloader.h.

bool Kate::TextLoader::readLine ( int &  offset,
int &  length 
)
inline

read a line, return length + offset in Unicode data

Parameters
offsetoffset into internal Unicode data for read line
lengthlength of read line
Returns
true if no encoding errors occurred

did we read two time but got no stuff? encoding error fixes problem with one character latin-1 files, which lead to crash otherwise! bug 272579

reading loop

if no codec given, do autodetection

byte order said something about encoding?

no Unicode BOM found, trigger prober

first: try to get HTML header encoding

else: use KEncodingProber

Definition at line 181 of file katetextloader.h.

QTextCodec* Kate::TextLoader::textCodec ( ) const
inline

Get codec for this loader.

Returns
currently in use codec of this loader

Definition at line 170 of file katetextloader.h.

const QChar* Kate::TextLoader::unicode ( ) const
inline

internal Unicode data array

Returns
internal Unicode data

Definition at line 161 of file katetextloader.h.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Jul 12 2020 22:58:03 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.