<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>src/tag_impl.h Source File</title> <link href="id3lib.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.12 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>src/tag_impl.h</h1><a href="tag__impl_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">// -*- C++ -*-</font> 00002 <font class="comment">// $Id: tag_impl.h,v 1.1 2000/10/24 16:15:35 eldamitri Exp $</font> 00003 00004 <font class="comment">// id3lib: a software library for creating and manipulating id3v1/v2 tags</font> 00005 <font class="comment">// Copyright 1999, 2000 Scott Thomas Haug</font> 00006 00007 <font class="comment">// This library is free software; you can redistribute it and/or modify it</font> 00008 <font class="comment">// under the terms of the GNU Library General Public License as published by</font> 00009 <font class="comment">// the Free Software Foundation; either version 2 of the License, or (at your</font> 00010 <font class="comment">// option) any later version.</font> 00011 <font class="comment">//</font> 00012 <font class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</font> 00013 <font class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</font> 00014 <font class="comment">// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public</font> 00015 <font class="comment">// License for more details.</font> 00016 <font class="comment">//</font> 00017 <font class="comment">// You should have received a copy of the GNU Library General Public License</font> 00018 <font class="comment">// along with this library; if not, write to the Free Software Foundation,</font> 00019 <font class="comment">// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</font> 00020 00021 <font class="comment">// The id3lib authors encourage improvements and optimisations to be sent to</font> 00022 <font class="comment">// the id3lib coordinator. Please see the README file for details on where to</font> 00023 <font class="comment">// send such submissions. See the AUTHORS file for a list of people who have</font> 00024 <font class="comment">// contributed to id3lib. See the ChangeLog file for a list of changes to</font> 00025 <font class="comment">// id3lib. These files are distributed with id3lib at</font> 00026 <font class="comment">// http://download.sourceforge.net/id3lib/</font> 00027 00028 <font class="preprocessor">#ifndef _ID3LIB_TAG_IMPL_H_</font> 00029 <font class="preprocessor"></font><font class="preprocessor">#define _ID3LIB_TAG_IMPL_H_</font> 00030 <font class="preprocessor"></font> 00031 <font class="preprocessor">#include <list></font> 00032 <font class="preprocessor">#include <stdio.h></font> 00033 <font class="preprocessor">#include "<a class="code" href="tag_8h.html">tag.h</a>"</font> 00034 <font class="preprocessor">#include "<a class="code" href="header__tag_8h.html">header_tag.h</a>"</font> 00035 <font class="preprocessor">#include "<a class="code" href="frame_8h.html">frame.h</a>"</font> 00036 <font class="preprocessor">#include "<a class="code" href="field_8h.html">field.h</a>"</font> 00037 <font class="preprocessor">#include "<a class="code" href="spec_8h.html">spec.h</a>"</font> 00038 <font class="preprocessor">#include "strings.h"</font> 00039 00040 <font class="keyword">class </font><a class="code" href="class_i_d3___reader.html">ID3_Reader</a>; 00041 <font class="keyword">class </font><a class="code" href="class_i_d3___writer.html">ID3_Writer</a>; 00042 <a name="l00043"></a><a class="code" href="namespacedami.html">00043</a> <font class="keyword">namespace </font>dami 00044 { <a name="l00045"></a><a class="code" href="namespacedami_1_1id3.html">00045</a> <font class="keyword">namespace </font>id3 00046 { <a name="l00047"></a><a class="code" href="namespacedami_1_1id3_1_1v1.html">00047</a> <font class="keyword">namespace </font>v1 00048 { 00049 <font class="keywordtype">bool</font> <a class="code" href="namespacedami_1_1id3_1_1v1.html#a0">parse</a>(<a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>&, <a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&); 00050 <font class="keywordtype">void</font> <a class="code" href="namespacedami_1_1id3_1_1v1.html#a1">render</a>(<a class="code" href="class_i_d3___writer.html">ID3_Writer</a>&, <font class="keyword">const</font> <a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>&); 00051 }; <a name="l00052"></a><a class="code" href="namespacedami_1_1id3_1_1v2.html">00052</a> <font class="keyword">namespace </font>v2 00053 { 00054 <font class="keywordtype">bool</font> <a class="code" href="namespacedami_1_1id3_1_1v2.html#a0">parse</a>(<a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>& tag, <a class="code" href="class_i_d3___reader.html">ID3_Reader</a>& rdr); 00055 <font class="keywordtype">void</font> <a class="code" href="namespacedami_1_1id3_1_1v2.html#a1">render</a>(<a class="code" href="class_i_d3___writer.html">ID3_Writer</a>& writer, <font class="keyword">const</font> <a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>& tag); 00056 }; 00057 }; <a name="l00058"></a><a class="code" href="namespacedami_1_1lyr3.html">00058</a> <font class="keyword">namespace </font>lyr3 00059 { <a name="l00060"></a><a class="code" href="namespacedami_1_1lyr3_1_1v1.html">00060</a> <font class="keyword">namespace </font>v1 00061 { 00062 <font class="keywordtype">bool</font> <a class="code" href="namespacedami_1_1lyr3_1_1v1.html#a0">parse</a>(<a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>&, <a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&); 00063 }; <a name="l00064"></a><a class="code" href="namespacedami_1_1lyr3_1_1v2.html">00064</a> <font class="keyword">namespace </font>v2 00065 { 00066 <font class="keywordtype">bool</font> <a class="code" href="namespacedami_1_1lyr3_1_1v2.html#a0">parse</a>(<a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>&, <a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&); 00067 }; 00068 }; <a name="l00069"></a><a class="code" href="namespacedami_1_1mm.html">00069</a> <font class="keyword">namespace </font>mm 00070 { 00071 <font class="keywordtype">bool</font> <a class="code" href="namespacedami_1_1mm.html#a0">parse</a>(<a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>&, <a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&); 00072 }; 00073 }; 00074 <a name="l00075"></a><a class="code" href="class_i_d3___tag_impl.html">00075</a> <font class="keyword">class </font><a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a> 00076 { 00077 <font class="keyword">typedef</font> std::list<ID3_Frame *> Frames; 00078 <font class="keyword">public</font>: <a name="l00079"></a><a class="code" href="class_i_d3___tag_impl.html#s0">00079</a> <font class="keyword">typedef</font> Frames::iterator <a class="code" href="class_i_d3___tag_impl.html#s0">iterator</a>; <a name="l00080"></a><a class="code" href="class_i_d3___tag_impl.html#s1">00080</a> <font class="keyword">typedef</font> Frames::const_iterator <a class="code" href="class_i_d3___tag_impl.html#s1">const_iterator</a>; 00081 <font class="keyword">public</font>: 00082 <a class="code" href="class_i_d3___tag_impl.html#a0">ID3_TagImpl</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *name = <a class="code" href="globals_8h.html#a24">NULL</a>); 00083 <a class="code" href="class_i_d3___tag_impl.html#a0">ID3_TagImpl</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a> &tag); 00084 <font class="keyword">virtual</font> <a class="code" href="class_i_d3___tag_impl.html#a2">~ID3_TagImpl</a>(); 00085 00086 <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#a3">Clear</a>(); 00087 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a4">HasChanged</a>() <font class="keyword">const</font>; <a name="l00088"></a><a class="code" href="class_i_d3___tag_impl.html#a5">00088</a> <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#a5">SetChanged</a>(<font class="keywordtype">bool</font> b) { _changed = b; } 00089 size_t <a class="code" href="class_i_d3___tag_impl.html#a6">Size</a>() <font class="keyword">const</font>; 00090 00091 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a7">SetUnsync</a>(<font class="keywordtype">bool</font>); 00092 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a8">SetExtended</a>(<font class="keywordtype">bool</font>); 00093 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a9">SetExperimental</a>(<font class="keywordtype">bool</font>); 00094 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a10">SetPadding</a>(<font class="keywordtype">bool</font>); 00095 00096 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a11">GetUnsync</a>() <font class="keyword">const</font>; 00097 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a12">GetExtended</a>() <font class="keyword">const</font>; 00098 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a13">GetExperimental</a>() <font class="keyword">const</font>; 00099 00100 <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#a14">AddFrame</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>&); 00101 <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#a14">AddFrame</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>*); 00102 <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#a16">AttachFrame</a>(<a class="code" href="class_i_d3___frame.html">ID3_Frame</a>*); 00103 <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="class_i_d3___tag_impl.html#a17">RemoveFrame</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a> *); 00104 00105 size_t <a class="code" href="class_i_d3___tag_impl.html#a18">Link</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *fileInfo, <a class="code" href="globals_8h.html#a40">flags_t</a> = (<a class="code" href="globals_8h.html#a40">flags_t</a>) <a class="code" href="globals_8h.html#a217a67">ID3TT_ALL</a>); 00106 <a class="code" href="globals_8h.html#a40">flags_t</a> <a class="code" href="class_i_d3___tag_impl.html#a19">Update</a>(<a class="code" href="globals_8h.html#a40">flags_t</a> = (<a class="code" href="globals_8h.html#a40">flags_t</a>) <a class="code" href="globals_8h.html#a217a67">ID3TT_ALL</a>); 00107 <a class="code" href="globals_8h.html#a40">flags_t</a> <a class="code" href="class_i_d3___tag_impl.html#a20">Strip</a>(<a class="code" href="globals_8h.html#a40">flags_t</a> = (<a class="code" href="globals_8h.html#a40">flags_t</a>) <a class="code" href="globals_8h.html#a217a67">ID3TT_ALL</a>); 00108 <a name="l00109"></a><a class="code" href="class_i_d3___tag_impl.html#a21">00109</a> size_t <a class="code" href="class_i_d3___tag_impl.html#a21">GetPrependedBytes</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> _prepended_bytes; } <a name="l00110"></a><a class="code" href="class_i_d3___tag_impl.html#a22">00110</a> size_t <a class="code" href="class_i_d3___tag_impl.html#a22">GetAppendedBytes</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> _appended_bytes; } <a name="l00111"></a><a class="code" href="class_i_d3___tag_impl.html#a23">00111</a> size_t <a class="code" href="class_i_d3___tag_impl.html#a23">GetFileSize</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> _file_size; } <a name="l00112"></a><a class="code" href="class_i_d3___tag_impl.html#a24">00112</a> dami::String <a class="code" href="class_i_d3___tag_impl.html#a24">GetFileName</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> _file_name; } 00113 00114 <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="class_i_d3___tag_impl.html#a25">Find</a>(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> id) <font class="keyword">const</font>; 00115 <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="class_i_d3___tag_impl.html#a25">Find</a>(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> id, <a class="code" href="globals_8h.html#a218">ID3_FieldID</a> fld, <a class="code" href="sized__types_8h.html#a4">uint32</a> data) <font class="keyword">const</font>; 00116 <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="class_i_d3___tag_impl.html#a25">Find</a>(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> id, <a class="code" href="globals_8h.html#a218">ID3_FieldID</a> fld, dami::String) <font class="keyword">const</font>; 00117 <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="class_i_d3___tag_impl.html#a25">Find</a>(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> id, <a class="code" href="globals_8h.html#a218">ID3_FieldID</a> fld, dami::WString) <font class="keyword">const</font>; 00118 <a name="l00119"></a><a class="code" href="class_i_d3___tag_impl.html#a29">00119</a> size_t <a class="code" href="class_i_d3___tag_impl.html#a29">NumFrames</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> _frames.size(); } 00120 <a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>& <a class="code" href="class_i_d3___tag_impl.html#a30">operator=</a>( <font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a> & ); 00121 <a name="l00122"></a><a class="code" href="class_i_d3___tag_impl.html#a31">00122</a> <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a31">HasTagType</a>(<a class="code" href="sized__types_8h.html#a2">uint16</a> tt)<font class="keyword"> const </font>{ <font class="keywordflow">return</font> _file_tags.<a class="code" href="class_i_d3___flags.html#a3">test</a>(tt); } 00123 <a class="code" href="globals_8h.html#a216">ID3_V2Spec</a> <a class="code" href="class_i_d3___tag_impl.html#a32">GetSpec</a>() <font class="keyword">const</font>; 00124 <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a33">SetSpec</a>(<a class="code" href="globals_8h.html#a216">ID3_V2Spec</a>); 00125 00126 <font class="keyword">static</font> size_t <a class="code" href="class_i_d3___tag_impl.html#d0">IsV2Tag</a>(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&); 00127 <a name="l00128"></a><a class="code" href="class_i_d3___tag_impl.html#a34">00128</a> <a class="code" href="class_i_d3___tag_impl.html#s0">iterator</a> <a class="code" href="class_i_d3___tag_impl.html#a34">begin</a>() { <font class="keywordflow">return</font> _frames.begin(); } <a name="l00129"></a><a class="code" href="class_i_d3___tag_impl.html#a35">00129</a> <a class="code" href="class_i_d3___tag_impl.html#s0">iterator</a> <a class="code" href="class_i_d3___tag_impl.html#a35">end</a>() { <font class="keywordflow">return</font> _frames.end(); } <a name="l00130"></a><a class="code" href="class_i_d3___tag_impl.html#a36">00130</a> <a class="code" href="class_i_d3___tag_impl.html#s1">const_iterator</a> <a class="code" href="class_i_d3___tag_impl.html#a34">begin</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> _frames.begin(); } <a name="l00131"></a><a class="code" href="class_i_d3___tag_impl.html#a37">00131</a> <a class="code" href="class_i_d3___tag_impl.html#s1">const_iterator</a> <a class="code" href="class_i_d3___tag_impl.html#a35">end</a>() <font class="keyword">const</font> { <font class="keywordflow">return</font> _frames.end(); } 00132 00133 <font class="comment">/* Deprecated! */</font> <a name="l00134"></a><a class="code" href="class_i_d3___tag_impl.html#a38">00134</a> <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#a38">AddNewFrame</a>(<a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* f) { this-><a class="code" href="class_i_d3___tag_impl.html#a16">AttachFrame</a>(f); } 00135 size_t <a class="code" href="class_i_d3___tag_impl.html#a18">Link</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *fileInfo, <font class="keywordtype">bool</font> parseID3v1, <font class="keywordtype">bool</font> parseLyrics3); <a name="l00136"></a><a class="code" href="class_i_d3___tag_impl.html#a40">00136</a> <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#a40">SetCompression</a>(<font class="keywordtype">bool</font>) { ; } 00137 <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#a41">AddFrames</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a> *, size_t); <a name="l00138"></a><a class="code" href="class_i_d3___tag_impl.html#a42">00138</a> <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a42">HasLyrics</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> this-><a class="code" href="class_i_d3___tag_impl.html#a31">HasTagType</a>(<a class="code" href="globals_8h.html#a217a65">ID3TT_LYRICS</a>); } <a name="l00139"></a><a class="code" href="class_i_d3___tag_impl.html#a43">00139</a> <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a43">HasV2Tag</a>() <font class="keyword">const</font> { <font class="keywordflow">return</font> this-><a class="code" href="class_i_d3___tag_impl.html#a31">HasTagType</a>(<a class="code" href="globals_8h.html#a217a61">ID3TT_ID3V2</a>); } <a name="l00140"></a><a class="code" href="class_i_d3___tag_impl.html#a44">00140</a> <font class="keywordtype">bool</font> <a class="code" href="class_i_d3___tag_impl.html#a44">HasV1Tag</a>() <font class="keyword">const</font> { <font class="keywordflow">return</font> this-><a class="code" href="class_i_d3___tag_impl.html#a31">HasTagType</a>(<a class="code" href="globals_8h.html#a217a60">ID3TT_ID3V1</a>); } 00141 size_t <a class="code" href="class_i_d3___tag_impl.html#a45">PaddingSize</a>(size_t) <font class="keyword">const</font>; 00142 00143 <font class="keyword">protected</font>: 00144 <a class="code" href="class_i_d3___tag_impl.html#s1">const_iterator</a> <a class="code" href="class_i_d3___tag_impl.html#a25">Find</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a> *) <font class="keyword">const</font>; 00145 <a class="code" href="class_i_d3___tag_impl.html#s0">iterator</a> <a class="code" href="class_i_d3___tag_impl.html#a25">Find</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a> *); 00146 00147 <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#b2">RenderExtHeader</a>(<a class="code" href="globals_8h.html#a33">uchar</a> *); 00148 00149 <font class="keywordtype">void</font> <a class="code" href="class_i_d3___tag_impl.html#b3">ParseFile</a>(); 00150 00151 <font class="keyword">private</font>: 00152 <a class="code" href="class_i_d3___tag_header.html">ID3_TagHeader</a> _hdr; <font class="comment">// information relevant to the tag header</font> 00153 <font class="keywordtype">bool</font> _is_padded; <font class="comment">// add padding to tags?</font> 00154 00155 Frames _frames; 00156 00157 <font class="keyword">mutable</font> <a class="code" href="class_i_d3___tag_impl.html#s1">const_iterator</a> _cursor; <font class="comment">// which frame in list are we at</font> 00158 <font class="keyword">mutable</font> <font class="keywordtype">bool</font> _changed; <font class="comment">// has tag changed since last parse or render?</font> 00159 00160 <font class="comment">// file-related member variables</font> 00161 dami::String _file_name; <font class="comment">// name of the file we are linked to</font> 00162 size_t _file_size; <font class="comment">// the size of the file (without any tag(s))</font> 00163 size_t _prepended_bytes; <font class="comment">// number of tag bytes at start of file</font> 00164 size_t _appended_bytes; <font class="comment">// number of tag bytes at end of file</font> 00165 <font class="keywordtype">bool</font> _is_file_writable;<font class="comment">// is the associated file (via Link) writable?</font> 00166 <a class="code" href="class_i_d3___flags.html">ID3_Flags</a> _tags_to_parse; <font class="comment">// which tag types should attempt to be parsed</font> 00167 <a class="code" href="class_i_d3___flags.html">ID3_Flags</a> _file_tags; <font class="comment">// which tag types does the file contain</font> 00168 }; 00169 00170 size_t <a class="code" href="tag__impl_8h.html#a0">ID3_GetDataSize</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>&); 00171 00172 <font class="preprocessor">#endif </font><font class="comment">/* _ID3LIB_TAG_IMPL_H_ */</font> </pre></div><hr><address><small>Generated on Thu Jan 3 07:35:56 2002 for id3lib by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.gif" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.12 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001</small></address> </body> </html>