<?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>libkmime: kmime_codec_base64.h Source File (libkmime)</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" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</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>
<img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM 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_left" style="text-align: left;">
/ <a href="../../">API Reference</a>
/ <a href=".">libkmime</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;">
<h2><a name="content"></a>libkmime</h2>
<!-- Generated by Doxygen 1.5.5 -->
<h1>kmime_codec_base64.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*-</span>
<a name="l00002"></a>00002 <span class="comment"> kmime_codec_base64.h</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> This file is part of KMime, the KDE internet mail/usenet news message library.</span>
<a name="l00005"></a>00005 <span class="comment"> Copyright (c) 2001-2002 Marc Mutz <mutz@kde.org></span>
<a name="l00006"></a>00006 <span class="comment"></span>
<a name="l00007"></a>00007 <span class="comment"> KMime is free software; you can redistribute it and/or modify it</span>
<a name="l00008"></a>00008 <span class="comment"> under the terms of the GNU General Public License, version 2, as</span>
<a name="l00009"></a>00009 <span class="comment"> published by the Free Software Foundation.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> KMime is distributed in the hope that it will be useful, but</span>
<a name="l00012"></a>00012 <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00014"></a>00014 <span class="comment"> General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> along with this library; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment"> In addition, as a special exception, the copyright holders give</span>
<a name="l00021"></a>00021 <span class="comment"> permission to link the code of this library with any edition of</span>
<a name="l00022"></a>00022 <span class="comment"> the Qt library by Trolltech AS, Norway (or with modified versions</span>
<a name="l00023"></a>00023 <span class="comment"> of Qt that use the same license as Qt), and distribute linked</span>
<a name="l00024"></a>00024 <span class="comment"> combinations including the two. You must obey the GNU General</span>
<a name="l00025"></a>00025 <span class="comment"> Public License in all respects for all of the code used other than</span>
<a name="l00026"></a>00026 <span class="comment"> Qt. If you modify this file, you may extend this exception to</span>
<a name="l00027"></a>00027 <span class="comment"> your version of the file, but you are not obligated to do so. If</span>
<a name="l00028"></a>00028 <span class="comment"> you do not wish to do so, delete this exception statement from</span>
<a name="l00029"></a>00029 <span class="comment"> your version.</span>
<a name="l00030"></a>00030 <span class="comment">*/</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#ifndef __KMIME_CODEC_BASE64__</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define __KMIME_CODEC_BASE64__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "kmime_codecs.h"</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">namespace </span>KMime {
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">class </span>Base64Codec : <span class="keyword">public</span> Codec {
<a name="l00040"></a>00040 <span class="keyword">protected</span>:
<a name="l00041"></a>00041 <span class="keyword">friend</span> <span class="keyword">class </span>Codec;
<a name="l00042"></a>00042 Base64Codec() : Codec() {}
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">public</span>:
<a name="l00045"></a>00045 <span class="keyword">virtual</span> ~Base64Codec() {}
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">const</span> <span class="keywordtype">char</span> * name()<span class="keyword"> const </span>{
<a name="l00048"></a>00048 <span class="keywordflow">return</span> <span class="stringliteral">"base64"</span>;
<a name="l00049"></a>00049 }
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keywordtype">int</span> maxEncodedSizeFor( <span class="keywordtype">int</span> insize, <span class="keywordtype">bool</span> withCRLF=<span class="keyword">false</span> )<span class="keyword"> const </span>{
<a name="l00052"></a>00052 <span class="comment">// first, the total number of 4-char packets will be:</span>
<a name="l00053"></a>00053 <span class="keywordtype">int</span> totalNumPackets = ( insize + 2 ) / 3;
<a name="l00054"></a>00054 <span class="comment">// now, after every 76/4'th packet there needs to be a linebreak:</span>
<a name="l00055"></a>00055 <span class="keywordtype">int</span> numLineBreaks = totalNumPackets / (76/4);
<a name="l00056"></a>00056 <span class="comment">// and at the very end, too:</span>
<a name="l00057"></a>00057 ++numLineBreaks;
<a name="l00058"></a>00058 <span class="comment">// putting it all together, we have:</span>
<a name="l00059"></a>00059 <span class="keywordflow">return</span> 4 * totalNumPackets + ( withCRLF ? 2 : 1 ) * numLineBreaks;
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keywordtype">int</span> maxDecodedSizeFor( <span class="keywordtype">int</span> insize, <span class="keywordtype">bool</span> withCRLF=<span class="keyword">false</span> )<span class="keyword"> const </span>{
<a name="l00063"></a>00063 <span class="comment">// assuming all characters are part of the base64 stream (which</span>
<a name="l00064"></a>00064 <span class="comment">// does almost never hold due to required linebreaking; but</span>
<a name="l00065"></a>00065 <span class="comment">// additional non-base64 chars don't affect the output size), each</span>
<a name="l00066"></a>00066 <span class="comment">// 4-tupel of them becomes a 3-tupel in the decoded octet</span>
<a name="l00067"></a>00067 <span class="comment">// stream. So:</span>
<a name="l00068"></a>00068 <span class="keywordtype">int</span> result = ( ( insize + 3 ) / 4 ) * 3;
<a name="l00069"></a>00069 <span class="comment">// but all of them may be \n, so</span>
<a name="l00070"></a>00070 <span class="keywordflow">if</span> ( withCRLF )
<a name="l00071"></a>00071 result *= 2; <span class="comment">// :-o</span>
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordflow">return</span> result;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075
<a name="l00076"></a>00076 Encoder * makeEncoder( <span class="keywordtype">bool</span> withCRLF=<span class="keyword">false</span> ) <span class="keyword">const</span>;
<a name="l00077"></a>00077 Decoder * makeDecoder( <span class="keywordtype">bool</span> withCRLF=<span class="keyword">false</span> ) <span class="keyword">const</span>;
<a name="l00078"></a>00078 };
<a name="l00079"></a>00079
<a name="l00080"></a>00080
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">class </span>Rfc2047BEncodingCodec : <span class="keyword">public</span> Base64Codec {
<a name="l00083"></a>00083 <span class="keyword">protected</span>:
<a name="l00084"></a>00084 <span class="keyword">friend</span> <span class="keyword">class </span>Codec;
<a name="l00085"></a>00085 Rfc2047BEncodingCodec()
<a name="l00086"></a>00086 : Base64Codec() {}
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">public</span>:
<a name="l00089"></a>00089 <span class="keyword">virtual</span> ~Rfc2047BEncodingCodec() {}
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">const</span> <span class="keywordtype">char</span> * name()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"b"</span>; }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keywordtype">int</span> maxEncodedSizeFor( <span class="keywordtype">int</span> insize, <span class="keywordtype">bool</span> withCRLF=<span class="keyword">false</span> )<span class="keyword"> const </span>{
<a name="l00094"></a>00094 (void)withCRLF; <span class="comment">// keep compiler happy</span>
<a name="l00095"></a>00095 <span class="comment">// Each (begun) 3-octet triple becomes a 4 char quartet, so:</span>
<a name="l00096"></a>00096 <span class="keywordflow">return</span> ( ( insize + 2 ) / 3 ) * 4;
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keywordtype">int</span> maxDecodedSizeFor( <span class="keywordtype">int</span> insize, <span class="keywordtype">bool</span> withCRLF=<span class="keyword">false</span> )<span class="keyword"> const </span>{
<a name="l00100"></a>00100 (void)withCRLF; <span class="comment">// keep compiler happy</span>
<a name="l00101"></a>00101 <span class="comment">// Each 4-char quartet becomes a 3-octet triple, the last one</span>
<a name="l00102"></a>00102 <span class="comment">// possibly even less. So:</span>
<a name="l00103"></a>00103 <span class="keywordflow">return</span> ( ( insize + 3 ) / 4 ) * 3;
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105
<a name="l00106"></a>00106 Encoder * makeEncoder( <span class="keywordtype">bool</span> withCRLF=<span class="keyword">false</span> ) <span class="keyword">const</span>;
<a name="l00107"></a>00107 };
<a name="l00108"></a>00108
<a name="l00109"></a>00109
<a name="l00110"></a>00110 } <span class="comment">// namespace KMime</span>
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="preprocessor">#endif // __KMIME_CODEC_BASE64__</span>
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>libkmime</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="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="classAddressField.html">addressfield</option>, <option value="classBCC.html">bcc</option>, <option value="classBoolFlags.html">boolflags</option>, <option value="classCC.html">cc</option>, <option value="classCDescription.html">cdescription</option>, <option value="classCDisposition.html">cdisposition</option>, <option value="classContentType.html">contenttype</option>, <option value="classCTEncoding.html">ctencoding</option>, <option value="classFrom.html">from</option>, <option value="classKMime_1_1Base.html">kmime::base</option>, <option value="classKMime_1_1Codec.html">kmime::codec</option>, <option value="classKMime_1_1Content.html">kmime::content</option>, <option value="classKMime_1_1DateFormatter.html">kmime::dateformatter</option>, <option value="classKMime_1_1Decoder.html">kmime::decoder</option>, <option value="classKMime_1_1Encoder.html">kmime::encoder</option>, <option value="classKMime_1_1Headers_1_1AddressField.html">kmime::headers::addressfield</option>, <option value="classKMime_1_1Headers_1_1Base.html">kmime::headers::base</option>, <option value="classKMime_1_1Headers_1_1BCC.html">kmime::headers::bcc</option>, <option value="classKMime_1_1Headers_1_1CC.html">kmime::headers::cc</option>, <option value="classKMime_1_1Headers_1_1CDescription.html">kmime::headers::cdescription</option>, <option value="classKMime_1_1Headers_1_1CDisposition.html">kmime::headers::cdisposition</option>, <option value="classKMime_1_1Headers_1_1ContentType.html">kmime::headers::contenttype</option>, <option value="classKMime_1_1Headers_1_1Control.html">kmime::headers::control</option>, <option value="classKMime_1_1Headers_1_1CTEncoding.html">kmime::headers::ctencoding</option>, <option value="classKMime_1_1Headers_1_1Date.html">kmime::headers::date</option>, <option value="classKMime_1_1Headers_1_1FollowUpTo.html">kmime::headers::followupto</option>, <option value="classKMime_1_1Headers_1_1From.html">kmime::headers::from</option>, <option value="classKMime_1_1Headers_1_1Generic.html">kmime::headers::generic</option>, <option value="classKMime_1_1Headers_1_1Generics_1_1AddressList.html">kmime::headers::generics::addresslist</option>, <option value="classKMime_1_1Headers_1_1Generics_1_1GIdent.html">kmime::headers::generics::gident</option>, <option value="classKMime_1_1Headers_1_1Generics_1_1GStructured.html">kmime::headers::generics::gstructured</option>, <option value="classKMime_1_1Headers_1_1Generics_1_1GToken.html">kmime::headers::generics::gtoken</option>, <option value="classKMime_1_1Headers_1_1Generics_1_1GUnstructured.html">kmime::headers::generics::gunstructured</option>, <option value="classKMime_1_1Headers_1_1Generics_1_1MailboxList.html">kmime::headers::generics::mailboxlist</option>, <option value="classKMime_1_1Headers_1_1Lines.html">kmime::headers::lines</option>, <option value="classKMime_1_1Headers_1_1MailCopiesTo.html">kmime::headers::mailcopiesto</option>, <option value="classKMime_1_1Headers_1_1MessageID.html">kmime::headers::messageid</option>, <option value="classKMime_1_1Headers_1_1Newsgroups.html">kmime::headers::newsgroups</option>, <option value="classKMime_1_1Headers_1_1Organization.html">kmime::headers::organization</option>, <option value="classKMime_1_1Headers_1_1References.html">kmime::headers::references</option>, <option value="classKMime_1_1Headers_1_1ReplyTo.html">kmime::headers::replyto</option>, <option value="classKMime_1_1Headers_1_1ReturnPath.html">kmime::headers::returnpath</option>, <option value="classKMime_1_1Headers_1_1Subject.html">kmime::headers::subject</option>, <option value="classKMime_1_1Headers_1_1Supersedes.html">kmime::headers::supersedes</option>, <option value="classKMime_1_1Headers_1_1To.html">kmime::headers::to</option>, <option value="classKMime_1_1Headers_1_1UserAgent.html">kmime::headers::useragent</option>, <option value="classKMime_1_1Parser_1_1MultiPart.html">kmime::parser::multipart</option>, <option value="classKMime_1_1Parser_1_1NonMimeParser.html">kmime::parser::nonmimeparser</option>, <option value="classKMime_1_1Parser_1_1UUEncoded.html">kmime::parser::uuencoded</option>, <option value="classKMime_1_1Parser_1_1YENCEncoded.html">kmime::parser::yencencoded</option>, <option value="classMailCopiesTo.html">mailcopiesto</option>, <option value="classMessageID.html">messageid</option>, <option value="classReferences.html">references</option>, <option value="classReplyTo.html">replyto</option>, <option value="classSupersedes.html">supersedes</option>, <option value="classTo.html">to</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</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>
