<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kdoctools: kbzip2filter.cpp Source File (kdoctools)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kdoctools</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.4.4 -->
<div class="nav">
<a class="el" href="dir_000000.html">kdoctools</a></div>
<h1>kbzip2filter.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This file is part of the KDE libraries</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2000 David Faure <faure@kde.org></span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> $Id: kbzip2filter.cpp 465272 2005-09-29 09:47:40Z mueller $</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment"> License version 2 as published by the Free Software Foundation.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public License</span>
<a name="l00016"></a>00016 <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to</span>
<a name="l00017"></a>00017 <span class="comment"> the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span>
<a name="l00018"></a>00018 <span class="comment"> Boston, MA 02110-1301, USA.</span>
<a name="l00019"></a>00019 <span class="comment">*/</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#include <config.h></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#if defined( HAVE_BZIP2_SUPPORT )</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="comment">// we don't need that</span>
<a name="l00026"></a>00026 <span class="preprocessor">#define BZ_NO_STDIO</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00028"></a>00028 <span class="preprocessor"> #include <bzlib.h></span>
<a name="l00029"></a>00029 }
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#ifdef NEED_BZ2_PREFIX</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor"> #define bzDecompressInit(x,y,z) BZ2_bzDecompressInit(x,y,z)</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor"> #define bzDecompressEnd(x) BZ2_bzDecompressEnd(x)</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor"> #define bzCompressEnd(x) BZ2_bzCompressEnd(x)</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor"> #define bzDecompress(x) BZ2_bzDecompress(x)</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor"> #define bzCompress(x,y) BZ2_bzCompress(x, y)</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor"> #define bzCompressInit(x,y,z,a) BZ2_bzCompressInit(x, y, z, a);</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <kdebug.h></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include <klibloader.h></span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="preprocessor">#include "kbzip2filter.h"</span>
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="comment">// For docu on this, see /usr/doc/bzip2-0.9.5d/bzip2-0.9.5d/manual_3.html</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">class </span>KBzip2FilterFactory : <span class="keyword">public</span> KLibFactory
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 KBzip2FilterFactory() : KLibFactory() {}
<a name="l00051"></a>00051 <span class="keyword">virtual</span> ~KBzip2FilterFactory(){}
<a name="l00052"></a>00052 <a class="codeRef" doxygen="qt.tag:" href="qobject.html">QObject</a> *createObject( <a class="codeRef" doxygen="qt.tag:" href="qobject.html">QObject</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> & )
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 <span class="keywordflow">return</span> <span class="keyword">new</span> KBzip2Filter;
<a name="l00055"></a>00055 }
<a name="l00056"></a>00056 };
<a name="l00057"></a>00057
<a name="l00058"></a>00058 K_EXPORT_COMPONENT_FACTORY( kbzip2filter, KBzip2FilterFactory )
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="comment">// Not really useful anymore</span>
<a name="l00061"></a>00061 class KBzip2Filter::KBzip2FilterPrivate
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 <span class="keyword">public</span>:
<a name="l00064"></a>00064 bz_stream zStream;
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066
<a name="l00067"></a>00067 KBzip2Filter::KBzip2Filter()
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 d = <span class="keyword">new</span> KBzip2FilterPrivate;
<a name="l00070"></a>00070 d->zStream.bzalloc = 0;
<a name="l00071"></a>00071 d->zStream.bzfree = 0;
<a name="l00072"></a>00072 d->zStream.opaque = 0;
<a name="l00073"></a>00073 m_mode = 0;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075
<a name="l00076"></a>00076
<a name="l00077"></a>00077 KBzip2Filter::~KBzip2Filter()
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <span class="keyword">delete</span> d;
<a name="l00080"></a>00080 }
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keywordtype">void</span> KBzip2Filter::init( <span class="keywordtype">int</span> mode )
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 d->zStream.next_in = 0;
<a name="l00085"></a>00085 d->zStream.avail_in = 0;
<a name="l00086"></a>00086 <span class="keywordflow">if</span> ( mode == IO_ReadOnly )
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088 (void)bzDecompressInit(&d->zStream, 0, 0);
<a name="l00089"></a>00089 <span class="comment">//kdDebug(7118) << "bzDecompressInit returned " << result << endl;</span>
<a name="l00090"></a>00090 <span class="comment">// No idea what to do with result :)</span>
<a name="l00091"></a>00091 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> ( mode == IO_WriteOnly ) {
<a name="l00092"></a>00092 (void)bzCompressInit(&d->zStream, 5, 0, 0);
<a name="l00093"></a>00093 <span class="comment">//kdDebug(7118) << "bzDecompressInit returned " << result << endl;</span>
<a name="l00094"></a>00094 } <span class="keywordflow">else</span>
<a name="l00095"></a>00095 kdWarning(7118) << <span class="stringliteral">"Unsupported mode "</span> << mode << <span class="stringliteral">". Only IO_ReadOnly and IO_WriteOnly supported"</span> << endl;
<a name="l00096"></a>00096 m_mode = mode;
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keywordtype">void</span> KBzip2Filter::terminate()
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="keywordflow">if</span> ( m_mode == IO_ReadOnly )
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103 <span class="keywordtype">int</span> result = bzDecompressEnd(&d->zStream);
<a name="l00104"></a>00104 kdDebug(7118) << <span class="stringliteral">"bzDecompressEnd returned "</span> << result << endl;
<a name="l00105"></a>00105 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> ( m_mode == IO_WriteOnly )
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keywordtype">int</span> result = bzCompressEnd(&d->zStream);
<a name="l00108"></a>00108 kdDebug(7118) << <span class="stringliteral">"bzCompressEnd returned "</span> << result << endl;
<a name="l00109"></a>00109 } <span class="keywordflow">else</span>
<a name="l00110"></a>00110 kdWarning(7118) << <span class="stringliteral">"Unsupported mode "</span> << m_mode << <span class="stringliteral">". Only IO_ReadOnly and IO_WriteOnly supported"</span> << endl;
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keywordtype">void</span> KBzip2Filter::reset()
<a name="l00115"></a>00115 {
<a name="l00116"></a>00116 kdDebug(7118) << <span class="stringliteral">"KBzip2Filter::reset"</span> << endl;
<a name="l00117"></a>00117 <span class="comment">// bzip2 doesn't seem to have a reset call...</span>
<a name="l00118"></a>00118 terminate();
<a name="l00119"></a>00119 init( m_mode );
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keywordtype">void</span> KBzip2Filter::setOutBuffer( <span class="keywordtype">char</span> * data, uint maxlen )
<a name="l00123"></a>00123 {
<a name="l00124"></a>00124 d->zStream.avail_out = maxlen;
<a name="l00125"></a>00125 d->zStream.next_out = data;
<a name="l00126"></a>00126 }
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keywordtype">void</span> KBzip2Filter::setInBuffer( <span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size )
<a name="l00129"></a>00129 {
<a name="l00130"></a>00130 d->zStream.avail_in = size;
<a name="l00131"></a>00131 d->zStream.next_in = const_cast<char *>(data);
<a name="l00132"></a>00132 }
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="keywordtype">int</span> KBzip2Filter::inBufferAvailable()<span class="keyword"> const</span>
<a name="l00135"></a>00135 <span class="keyword"></span>{
<a name="l00136"></a>00136 <span class="keywordflow">return</span> d->zStream.avail_in;
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordtype">int</span> KBzip2Filter::outBufferAvailable()<span class="keyword"> const</span>
<a name="l00140"></a>00140 <span class="keyword"></span>{
<a name="l00141"></a>00141 <span class="keywordflow">return</span> d->zStream.avail_out;
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143
<a name="l00144"></a>00144 KBzip2Filter::Result KBzip2Filter::uncompress()
<a name="l00145"></a>00145 {
<a name="l00146"></a>00146 <span class="comment">//kdDebug(7118) << "Calling bzDecompress with avail_in=" << inBufferAvailable() << " avail_out=" << outBufferAvailable() << endl;</span>
<a name="l00147"></a>00147 <span class="keywordtype">int</span> result = bzDecompress(&d->zStream);
<a name="l00148"></a>00148 <span class="keywordflow">if</span> ( result != BZ_OK )
<a name="l00149"></a>00149 {
<a name="l00150"></a>00150 kdDebug(7118) << <span class="stringliteral">"bzDecompress returned "</span> << result << endl;
<a name="l00151"></a>00151 kdDebug(7118) << <span class="stringliteral">"KBzip2Filter::uncompress "</span> << ( result == BZ_OK ? OK : ( result == BZ_STREAM_END ? END : ERROR ) ) << endl;
<a name="l00152"></a>00152 }
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keywordflow">switch</span> (result) {
<a name="l00155"></a>00155 <span class="keywordflow">case</span> BZ_OK:
<a name="l00156"></a>00156 <span class="keywordflow">return</span> OK;
<a name="l00157"></a>00157 <span class="keywordflow">case</span> BZ_STREAM_END:
<a name="l00158"></a>00158 <span class="keywordflow">return</span> END;
<a name="l00159"></a>00159 <span class="keywordflow">default</span>:
<a name="l00160"></a>00160 <span class="keywordflow">return</span> ERROR;
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162 }
<a name="l00163"></a>00163
<a name="l00164"></a>00164 KBzip2Filter::Result KBzip2Filter::compress( <span class="keywordtype">bool</span> finish )
<a name="l00165"></a>00165 {
<a name="l00166"></a>00166 <span class="comment">//kdDebug(7118) << "Calling bzCompress with avail_in=" << inBufferAvailable() << " avail_out=" << outBufferAvailable() << endl;</span>
<a name="l00167"></a>00167 <span class="keywordtype">int</span> result = bzCompress(&d->zStream, finish ? BZ_FINISH : BZ_RUN );
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="keywordflow">switch</span> (result) {
<a name="l00170"></a>00170 <span class="keywordflow">case</span> BZ_OK:
<a name="l00171"></a>00171 <span class="keywordflow">case</span> BZ_FLUSH_OK:
<a name="l00172"></a>00172 <span class="keywordflow">case</span> BZ_RUN_OK:
<a name="l00173"></a>00173 <span class="keywordflow">case</span> BZ_FINISH_OK:
<a name="l00174"></a>00174 <span class="keywordflow">return</span> OK;
<a name="l00175"></a>00175 <span class="keywordflow">break</span>;
<a name="l00176"></a>00176 <span class="keywordflow">case</span> BZ_STREAM_END:
<a name="l00177"></a>00177 kdDebug(7118) << <span class="stringliteral">" bzCompress returned "</span> << result << endl;
<a name="l00178"></a>00178 <span class="keywordflow">return</span> END;
<a name="l00179"></a>00179 <span class="keywordflow">break</span>;
<a name="l00180"></a>00180 <span class="keywordflow">default</span>:
<a name="l00181"></a>00181 kdDebug(7118) << <span class="stringliteral">" bzCompress returned "</span> << result << endl;
<a name="l00182"></a>00182 <span class="keywordflow">return</span> ERROR;
<a name="l00183"></a>00183 <span class="keywordflow">break</span>;
<a name="l00184"></a>00184 }
<a name="l00185"></a>00185 }
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="preprocessor">#endif</span>
</pre></div> </div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kdoctools</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="dirs.html">Directories</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classHelpProtocol.html">helpprotocol</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
distrib
>
PLD
>
ac
>
amd64
>
media
>
dist
>
by-pkgid
>
90467ea6a387df728f7218a11e972208
>
files
>
5816
