<!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/writer.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.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <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 class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <h1>include/id3/writer.h</h1><a href="writer_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: writer.h,v 1.8 2002/07/02 22:11:10 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_WRITER_H_</span> <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _ID3LIB_WRITER_H_</span> <a name="l00030"></a>00030 <span class="preprocessor"></span> <a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="globals_8h.html">id3/globals.h</a>"</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___writer.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___writer.html">ID3_Writer</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___writer.html#afc6c0639631a72aca77af87de8bad947">00036</a> <span class="keyword">typedef</span> uint32 size_type; <a name="l00037"></a><a class="code" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">00037</a> <span class="keyword">typedef</span> uint8 char_type; <a name="l00038"></a><a class="code" href="class_i_d3___writer.html#acc8ea5caeb95f604ab658d6ccd50b13c">00038</a> <span class="keyword">typedef</span> uint32 pos_type; <a name="l00039"></a><a class="code" href="class_i_d3___writer.html#ae969719ec5e0d5a7cd2dda8705ec1e59">00039</a> <span class="keyword">typedef</span> int32 off_type; <a name="l00040"></a><a class="code" href="class_i_d3___writer.html#a2bc2a476eaf88ae5661bfb27f2a0a836">00040</a> <span class="keyword">typedef</span> int16 int_type; <a name="l00041"></a><a class="code" href="class_i_d3___writer.html#ad86a1c643939307f19d311d8e272a68b">00041</a> <span class="keyword">static</span> <span class="keyword">const</span> int_type END_OF_WRITER; <a name="l00042"></a>00042 <a name="l00044"></a>00044 <span class="keyword">virtual</span> <span class="keywordtype">void</span> close() = 0; <a name="l00045"></a>00045 <a name="l00047"></a>00047 <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush() = 0; <a name="l00048"></a>00048 <a name="l00050"></a><a class="code" href="class_i_d3___writer.html#a7695d972b7c066f4684ffc1fa187d56a">00050</a> <span class="keyword">virtual</span> pos_type <a class="code" href="class_i_d3___writer.html#a7695d972b7c066f4684ffc1fa187d56a" title="Return the beginning position in the writer.">getBeg</a>() { <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>pos_type<span class="keyword">></span>(0); } <a name="l00051"></a>00051 <a name="l00055"></a><a class="code" href="class_i_d3___writer.html#a54d6983dfa470242f826b4f791b916ac">00055</a> <span class="keyword">virtual</span> pos_type <a class="code" href="class_i_d3___writer.html#a54d6983dfa470242f826b4f791b916ac" title="Return the first position that can&#39;t be written to.">getEnd</a>() { <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>pos_type<span class="keyword">></span>(-1); } <a name="l00056"></a>00056 <a name="l00058"></a>00058 <span class="keyword">virtual</span> pos_type getCur() = 0; <a name="l00059"></a>00059 <a name="l00061"></a><a class="code" href="class_i_d3___writer.html#a4a96c280c5a5b5a35cab0eaab34c0eff">00061</a> <span class="keyword">virtual</span> size_type <a class="code" href="class_i_d3___writer.html#a4a96c280c5a5b5a35cab0eaab34c0eff" title="Return the number of bytes written.">getSize</a>() { <span class="keywordflow">return</span> this->getCur() - this->getBeg(); } <a name="l00062"></a>00062 <a name="l00064"></a><a class="code" href="class_i_d3___writer.html#a20932cb9ad23402f9f3ada0f987ff6fc">00064</a> <span class="keyword">virtual</span> size_type <a class="code" href="class_i_d3___writer.html#a20932cb9ad23402f9f3ada0f987ff6fc" title="Return the maximum number of bytes that can be written.">getMaxSize</a>() { <span class="keywordflow">return</span> this->getEnd() - this->getBeg(); } <a name="l00065"></a>00065 <a name="l00071"></a><a class="code" href="class_i_d3___writer.html#a2fd7fda2100f38a45038b80de8ed4432">00071</a> <span class="keyword">virtual</span> int_type writeChar(char_type ch) <a name="l00072"></a>00072 { <a name="l00073"></a>00073 <span class="keywordflow">if</span> (this->atEnd()) <a name="l00074"></a>00074 { <a name="l00075"></a>00075 <span class="keywordflow">return</span> END_OF_WRITER; <a name="l00076"></a>00076 } <a name="l00077"></a>00077 this->writeChars(&ch, 1); <a name="l00078"></a>00078 <span class="keywordflow">return</span> ch; <a name="l00079"></a>00079 } <a name="l00080"></a>00080 <a name="l00086"></a>00086 <span class="keyword">virtual</span> size_type writeChars(<span class="keyword">const</span> char_type buf[], size_type len) = 0; <a name="l00087"></a><a class="code" href="class_i_d3___writer.html#ae9e686731d705c7f26c80160734a31fb">00087</a> <span class="keyword">virtual</span> size_type writeChars(<span class="keyword">const</span> <span class="keywordtype">char</span> buf[], size_type len) <a name="l00088"></a>00088 { <a name="l00089"></a>00089 <span class="keywordflow">return</span> this->writeChars(reinterpret_cast<const char_type *>(buf), len); <a name="l00090"></a>00090 } <a name="l00091"></a>00091 <a name="l00092"></a><a class="code" href="class_i_d3___writer.html#a6b6a9a7d697332c154b779353b013d00">00092</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> atEnd() <a name="l00093"></a>00093 { <a name="l00094"></a>00094 <span class="keywordflow">return</span> this->getCur() >= this->getEnd(); <a name="l00095"></a>00095 } <a name="l00096"></a>00096 }; <a name="l00097"></a>00097 <a name="l00098"></a>00098 <span class="preprocessor">#endif </span><span class="comment">/* _ID3LIB_WRITER_H_ */</span> <a name="l00099"></a>00099 </pre></div></div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Jan 12 23:46:35 2011 for id3lib by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>