<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>id3lib: include/id3/reader.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="id3lib.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">id3lib <span id="projectnumber">3.8.3</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>include/id3/reader.h</h1> </div>
</div>
<div class="contents">
<a href="reader_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- C++ -*-</span>
<a name="l00002"></a>00002 <span class="comment">// $Id: reader.h,v 1.13 2002/07/02 22:10:57 t1mpy Exp $</span>
<a name="l00003"></a>00003
<a name="l00004"></a>00004 <span class="comment">// id3lib: a software library for creating and manipulating id3v1/v2 tags</span>
<a name="l00005"></a>00005 <span class="comment">// Copyright 1999, 2000 Scott Thomas Haug</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="comment">// This library 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 Library General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment">// the Free Software Foundation; either version 2 of the License, or (at your</span>
<a name="l00010"></a>00010 <span class="comment">// option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment">//</span>
<a name="l00012"></a>00012 <span class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</span>
<a name="l00013"></a>00013 <span class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
<a name="l00014"></a>00014 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">// License for more details.</span>
<a name="l00016"></a>00016 <span class="comment">//</span>
<a name="l00017"></a>00017 <span class="comment">// You should have received a copy of the GNU Library General Public License</span>
<a name="l00018"></a>00018 <span class="comment">// along with this library; if not, write to the Free Software Foundation,</span>
<a name="l00019"></a>00019 <span class="comment">// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">// The id3lib authors encourage improvements and optimisations to be sent to</span>
<a name="l00022"></a>00022 <span class="comment">// the id3lib coordinator. Please see the README file for details on where to</span>
<a name="l00023"></a>00023 <span class="comment">// send such submissions. See the AUTHORS file for a list of people who have</span>
<a name="l00024"></a>00024 <span class="comment">// contributed to id3lib. See the ChangeLog file for a list of changes to</span>
<a name="l00025"></a>00025 <span class="comment">// id3lib. These files are distributed with id3lib at</span>
<a name="l00026"></a>00026 <span class="comment">// http://download.sourceforge.net/id3lib/</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef _ID3LIB_READER_H_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _ID3LIB_READER_H_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "id3/globals.h"</span> <span class="comment">//has <stdlib.h> "id3/sized_types.h"</span>
<a name="l00032"></a>00032
<a name="l00033"></a><a class="code" href="class_i_d3___reader.html">00033</a> <span class="keyword">class </span><a class="code" href="globals_8h.html#aa7668e1ebc5c8b89aef71dd98e547f77">ID3_CPP_EXPORT</a> <a class="code" href="class_i_d3___reader.html">ID3_Reader</a>
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00036"></a><a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">00036</a> <span class="keyword">typedef</span> uint32 <a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a>;
<a name="l00037"></a><a class="code" href="class_i_d3___reader.html#abc80771e4ce81188082eaa8fa90a67e6">00037</a> <span class="keyword">typedef</span> uint8 <a class="code" href="class_i_d3___reader.html#abc80771e4ce81188082eaa8fa90a67e6">char_type</a>;
<a name="l00038"></a><a class="code" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">00038</a> <span class="keyword">typedef</span> uint32 <a class="code" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a>;
<a name="l00039"></a><a class="code" href="class_i_d3___reader.html#a384b17f4e4d0a04cf482e54e2f6f54ef">00039</a> <span class="keyword">typedef</span> int32 <a class="code" href="class_i_d3___reader.html#a384b17f4e4d0a04cf482e54e2f6f54ef">off_type</a>;
<a name="l00040"></a><a class="code" href="class_i_d3___reader.html#aa8b2afbb909ee02b838cde53113d1d8b">00040</a> <span class="keyword">typedef</span> int16 <a class="code" href="class_i_d3___reader.html#aa8b2afbb909ee02b838cde53113d1d8b">int_type</a>;
<a name="l00041"></a><a class="code" href="class_i_d3___reader.html#a1bde46166e30a5413daa71053a75dc98">00041</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="class_i_d3___reader.html#aa8b2afbb909ee02b838cde53113d1d8b">int_type</a> <a class="code" href="class_i_d3___reader.html#a1bde46166e30a5413daa71053a75dc98">END_OF_READER</a>;
<a name="l00042"></a>00042
<a name="l00045"></a>00045 <span class="keyword">virtual</span> <span class="keywordtype">void</span> close() = 0;
<a name="l00046"></a>00046
<a name="l00048"></a><a class="code" href="class_i_d3___reader.html#aeaf468ffe03c08731dcaf268fff3391b">00048</a> <span class="keyword">virtual</span> <a class="code" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> <a class="code" href="class_i_d3___reader.html#aeaf468ffe03c08731dcaf268fff3391b" title="Return the beginning position in the reader.">getBeg</a>() { <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><a class="code" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a><span class="keyword">></span>(0); }
<a name="l00049"></a>00049
<a name="l00051"></a><a class="code" href="class_i_d3___reader.html#a5872b6813a652d831b770bfb7d65aec8">00051</a> <span class="keyword">virtual</span> <a class="code" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> <a class="code" href="class_i_d3___reader.html#a5872b6813a652d831b770bfb7d65aec8" title="Return the ending position in the reader.">getEnd</a>() { <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><a class="code" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a><span class="keyword">></span>(-1); }
<a name="l00052"></a>00052
<a name="l00054"></a>00054 <span class="keyword">virtual</span> pos_type getCur() = 0;
<a name="l00055"></a>00055
<a name="l00058"></a>00058 <span class="keyword">virtual</span> pos_type setCur(pos_type pos) = 0;
<a name="l00059"></a>00059
<a name="l00065"></a><a class="code" href="class_i_d3___reader.html#a36e43a57e3ff194ed6e0416c409fbed3">00065</a> <span class="keyword">virtual</span> <a class="code" href="class_i_d3___reader.html#aa8b2afbb909ee02b838cde53113d1d8b">int_type</a> readChar()
<a name="l00066"></a>00066 {
<a name="l00067"></a>00067 <span class="keywordflow">if</span> (this->atEnd())
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <span class="keywordflow">return</span> END_OF_READER;
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071 <a class="code" href="class_i_d3___reader.html#abc80771e4ce81188082eaa8fa90a67e6">char_type</a> ch;
<a name="l00072"></a>00072 this->readChars(&ch, 1);
<a name="l00073"></a>00073 <span class="keywordflow">return</span> ch;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075
<a name="l00080"></a>00080 <span class="keyword">virtual</span> int_type peekChar() = 0;
<a name="l00081"></a>00081
<a name="l00087"></a>00087 <span class="keyword">virtual</span> size_type readChars(char_type buf[], size_type len) = 0;
<a name="l00088"></a><a class="code" href="class_i_d3___reader.html#a01bcb484f8188bb8efe8624b8e19d6b9">00088</a> <span class="keyword">virtual</span> <a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> readChars(<span class="keywordtype">char</span> buf[], <a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> len)
<a name="l00089"></a>00089 {
<a name="l00090"></a>00090 <span class="keywordflow">return</span> this->readChars(reinterpret_cast<char_type *>(buf), len);
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00097"></a><a class="code" href="class_i_d3___reader.html#a12a8002132842435bae3d917bf6985e8">00097</a> <span class="keyword">virtual</span> <a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> skipChars(<a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> len)
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <span class="keyword">const</span> <a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> SIZE = 1024;
<a name="l00100"></a>00100 <a class="code" href="class_i_d3___reader.html#abc80771e4ce81188082eaa8fa90a67e6">char_type</a> bytes[SIZE];
<a name="l00101"></a>00101 <a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> remaining = len;
<a name="l00102"></a>00102 <span class="keywordflow">while</span> (!this->atEnd() && remaining > 0)
<a name="l00103"></a>00103 {
<a name="l00104"></a>00104 remaining -= this->readChars(bytes, (remaining < SIZE ? remaining : SIZE));
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106 <span class="keywordflow">return</span> len - remaining;
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108
<a name="l00109"></a><a class="code" href="class_i_d3___reader.html#a8b516ba5335293c2f278c711161a3aec">00109</a> <span class="keyword">virtual</span> <a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> remainingBytes()
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111 <a class="code" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> end = this->getEnd(), cur = this->getCur();
<a name="l00112"></a>00112 <span class="keywordflow">if</span> (end == <a class="code" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a>(-1))
<a name="l00113"></a>00113 {
<a name="l00114"></a>00114 <span class="keywordflow">return</span> <a class="code" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a>(-1);
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keywordflow">if</span> (end >= cur)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 <span class="keywordflow">return</span> end - cur;
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keywordflow">return</span> 0;
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124
<a name="l00125"></a><a class="code" href="class_i_d3___reader.html#a2d7e9a6e4c4c5f751035ea507c6cadb5">00125</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___reader.html#a2d7e9a6e4c4c5f751035ea507c6cadb5">atEnd</a>() { <span class="keywordflow">return</span> this->getCur() >= this->getEnd(); }
<a name="l00126"></a>00126 };
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="preprocessor">#endif </span><span class="comment">/* _ID3LIB_READER_H_ */</span>
<a name="l00129"></a>00129
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for id3lib by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.3</small></address></body></html>
