Release and update docs.
[lms] / www / api / lightmediascanner__utils_8h.html
index f788ac2..6d205d2 100644 (file)
@@ -4,26 +4,27 @@
 <link href="doxygen.css" rel="stylesheet" type="text/css">
 <link href="tabs.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.5.2 -->
-<div class="tabs">
-  <ul>
-    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
-    <li><a href="modules.html"><span>Modules</span></a></li>
-    <li><a href="classes.html"><span>Data&nbsp;Structures</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&nbsp;List</span></a></li>
-    <li><a href="globals.html"><span>Globals</span></a></li>
-  </ul>
+<!-- Generated by Doxygen 1.5.6 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
 </div>
+<div class="contents">
 <h1>src/lib/lightmediascanner_utils.h File Reference</h1>
 <p>
-This graph shows which files directly or indirectly include this file:<p><center><img src="lightmediascanner__utils_8h__dep__incl.png" border="0" usemap="#src/lib/lightmediascanner_utils.hdep_map" alt=""></center>
+<div class="dynheader">
+This graph shows which files directly or indirectly include this file:</div>
+<div class="dynsection">
+<p><center><img src="lightmediascanner__utils_8h__dep__incl.png" border="0" usemap="#src/lib/lightmediascanner_utils.hdep_map" alt=""></center>
 <map name="src/lib/lightmediascanner_utils.hdep_map">
-<area shape="rect" href="lightmediascanner__db_8h.html" title="src/lib/lightmediascanner_db.h" alt="" coords="255,81,441,108"><area shape="rect" href="lightmediascanner__utils_8c.html" title="src/lib/lightmediascanner_utils.c" alt="" coords="251,132,445,159"><area shape="rect" href="lightmediascanner__db__audio_8c.html" title="src/lib/lightmediascanner_db_audio.c" alt="" coords="499,5,720,32"><area shape="rect" href="lightmediascanner__db__image_8c.html" title="src/lib/lightmediascanner_db_image.c" alt="" coords="497,56,721,83"><area shape="rect" href="lightmediascanner__db__playlist_8c.html" title="src/lib/lightmediascanner_db_playlist.c" alt="" coords="495,107,724,133"><area shape="rect" href="lightmediascanner__db__video_8c.html" title="src/lib/lightmediascanner_db_video.c" alt="" coords="499,157,720,184"></map>
+<area shape="rect" href="lightmediascanner__db_8h.html" title="src/lib/lightmediascanner_db.h" alt="" coords="465,84,687,111"><area shape="rect" href="lightmediascanner__utils_8c.html" title="src/lib/lightmediascanner_utils.c" alt="" coords="711,84,943,111"><area shape="rect" href="lightmediascanner__db__audio_8c.html" title="src/lib/lightmediascanner_db_audio.c" alt="" coords="5,162,269,188"><area shape="rect" href="lightmediascanner__db__image_8c.html" title="src/lib/lightmediascanner_db_image.c" alt="" coords="293,162,563,188"><area shape="rect" href="lightmediascanner__db__playlist_8c.html" title="src/lib/lightmediascanner_db_playlist.c" alt="" coords="587,162,861,188"><area shape="rect" href="lightmediascanner__db__video_8c.html" title="src/lib/lightmediascanner_db_video.c" alt="" coords="885,162,1149,188"></map>
+</div>
 
 <p>
 <a href="lightmediascanner__utils_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
@@ -45,7 +46,11 @@ This graph shows which files directly or indirectly include this file:<p><center
 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__utils_8h.html#281568969e526a7bdf687da4d1cc75ab">lms_strstrip</a> (char *str, unsigned int *p_len) GNUC_NON_NULL(1</td></tr>
 
-<tr><td class="memItemLeft" nowrap align="right" valign="top">API void API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__utils_8h.html#92c63007e7d04f626cafc6eef48f7022">lms_which_extension</a> (const char *name, unsigned int name_len, const struct <a class="el" href="structlms__string__size.html">lms_string_size</a> *exts, unsigned int exts_len) GNUC_NON_NULL(1</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">API void API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__utils_8h.html#01cee33e2410ae7081905a4e06d890cc">lms_strstrip_and_free</a> (char **p_str, unsigned int *p_len) GNUC_NON_NULL(1</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">API void API void API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__utils_8h.html#5a7e5da69500a12f447a77177dbb6e0d">lms_string_size_strip_and_free</a> (struct <a class="el" href="structlms__string__size.html">lms_string_size</a> *p) GNUC_NON_NULL(1)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__utils_8h.html#7dfc23066442e00fff5cbe77e6f1426e">lms_which_extension</a> (const char *name, unsigned int name_len, const struct <a class="el" href="structlms__string__size.html">lms_string_size</a> *exts, unsigned int exts_len) GNUC_NON_NULL(1</td></tr>
 
 </table>
 <hr><h2>Define Documentation</h2>
@@ -64,11 +69,11 @@ This graph shows which files directly or indirectly include this file:<p><center
 Copyright (C) 2007 by INdT<p>
 This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.<p>
 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
-You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.<p>
+You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.<p>
 <dl class="author" compact><dt><b>Author:</b></dt><dd>Gustavo Sverzut Barbieri &lt;<a href="mailto:gustavo.barbieri@openbossa.org">gustavo.barbieri@openbossa.org</a>&gt; </dd></dl>
 
-<p>
-Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00022">22</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.
+<p>Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00022">22</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.</p>
+
 </div>
 </div><p>
 <a class="anchor" name="d8ce4efaa307683d3d763b37b4711c53"></a><!-- doxytag: member="lightmediascanner_utils.h::API" ref="d8ce4efaa307683d3d763b37b4711c53" args="" -->
@@ -84,8 +89,8 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
 
 <p>
 
-<p>
-Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00040">40</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.
+<p>Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00040">40</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.</p>
+
 </div>
 </div><p>
 <a class="anchor" name="6fe68cac0abf3e2ca61141920414e93a"></a><!-- doxytag: member="lightmediascanner_utils.h::GNUC_NON_NULL" ref="6fe68cac0abf3e2ca61141920414e93a" args="(...)" -->
@@ -98,7 +103,7 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
           <td class="paramtype"> <em>...</em>&nbsp;</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-          <td width="100%"></td>
+          <td></td>
         </tr>
       </table>
 </div>
@@ -106,8 +111,8 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
 
 <p>
 
-<p>
-Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00041">41</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.
+<p>Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00041">41</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.</p>
+
 </div>
 </div><p>
 <a class="anchor" name="13a0622cfcc91eec261da4285621bdcc"></a><!-- doxytag: member="lightmediascanner_utils.h::LMS_ARRAY_SIZE" ref="13a0622cfcc91eec261da4285621bdcc" args="(a)" -->
@@ -120,7 +125,7 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
           <td class="paramtype">a&nbsp;</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-          <td width="100%">&nbsp;&nbsp;&nbsp;(sizeof(a) / sizeof(*a))</td>
+          <td>&nbsp;&nbsp;&nbsp;(sizeof(a) / sizeof(*a))</td>
         </tr>
       </table>
 </div>
@@ -128,8 +133,8 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
 
 <p>
 
-<p>
-Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00055">55</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.
+<p>Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00055">55</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.</p>
+
 </div>
 </div><p>
 <a class="anchor" name="786c453d995be000d52360f327a6816b"></a><!-- doxytag: member="lightmediascanner_utils.h::LMS_STATIC_STRING_SIZE" ref="786c453d995be000d52360f327a6816b" args="(s)" -->
@@ -142,7 +147,7 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
           <td class="paramtype">s&nbsp;</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-          <td width="100%">&nbsp;&nbsp;&nbsp;{s, sizeof(s) - 1}</td>
+          <td>&nbsp;&nbsp;&nbsp;{s, sizeof(s) - 1}</td>
         </tr>
       </table>
 </div>
@@ -150,11 +155,51 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
 
 <p>
 
-<p>
-Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00054">54</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.
+<p>Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l00054">54</a> of file <a class="el" href="lightmediascanner__utils_8h-source.html">lightmediascanner_utils.h</a>.</p>
+
 </div>
 </div><p>
 <hr><h2>Function Documentation</h2>
+<a class="anchor" name="5a7e5da69500a12f447a77177dbb6e0d"></a><!-- doxytag: member="lightmediascanner_utils.h::lms_string_size_strip_and_free" ref="5a7e5da69500a12f447a77177dbb6e0d" args="(struct lms_string_size *p) GNUC_NON_NULL(1)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">API void API void API void lms_string_size_strip_and_free           </td>
+          <td>(</td>
+          <td class="paramtype">struct <a class="el" href="structlms__string__size.html">lms_string_size</a> *&nbsp;</td>
+          <td class="paramname"> <em>p</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+<a class="el" href="structlms__string__size.html">lms_string_size</a> version of <a class="el" href="lightmediascanner__utils_8c.html#45d15c8bfeddaef0d5b1d0bd9ecc0c79">lms_strstrip_and_free()</a>.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>*p</em>&nbsp;</td><td>pointer to <a class="el" href="structlms__string__size.html">lms_string_size</a> to be stripped.</td></tr>
+  </table>
+</dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>this will call free() on lms_string_size-&gt;str if it becomes empty. </dd></dl>
+
+<p>Definition at line <a class="el" href="lightmediascanner__utils_8c-source.html#l00114">114</a> of file <a class="el" href="lightmediascanner__utils_8c-source.html">lightmediascanner_utils.c</a>.</p>
+
+<p>References <a class="el" href="lightmediascanner__utils_8h-source.html#l00051">lms_string_size::len</a>, <a class="el" href="lightmediascanner__utils_8c-source.html#l00034">lms_strstrip()</a>, and <a class="el" href="lightmediascanner__utils_8h-source.html#l00050">lms_string_size::str</a>.</p>
+
+<p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dynsection">
+<p><center><img src="lightmediascanner__utils_8h_5a7e5da69500a12f447a77177dbb6e0d_cgraph.png" border="0" usemap="#lightmediascanner__utils_8h_5a7e5da69500a12f447a77177dbb6e0d_cgraph_map" alt=""></center>
+<map name="lightmediascanner__utils_8h_5a7e5da69500a12f447a77177dbb6e0d_cgraph_map">
+<area shape="rect" href="lightmediascanner__utils_8c.html#086d2449129976541c66a83984bffbe6" title="lms_strstrip" alt="" coords="281,5,380,32"></map>
+</div>
+
+</div>
+</div><p>
 <a class="anchor" name="281568969e526a7bdf687da4d1cc75ab"></a><!-- doxytag: member="lightmediascanner_utils.h::lms_strstrip" ref="281568969e526a7bdf687da4d1cc75ab" args="(char *str, unsigned int *p_len) GNUC_NON_NULL(1" -->
 <div class="memitem">
 <div class="memproto">
@@ -174,7 +219,36 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
         <tr>
           <td></td>
           <td>)</td>
-          <td></td><td></td><td width="100%"></td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="01cee33e2410ae7081905a4e06d890cc"></a><!-- doxytag: member="lightmediascanner_utils.h::lms_strstrip_and_free" ref="01cee33e2410ae7081905a4e06d890cc" args="(char **p_str, unsigned int *p_len) GNUC_NON_NULL(1" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">API void API void lms_strstrip_and_free           </td>
+          <td>(</td>
+          <td class="paramtype">char **&nbsp;</td>
+          <td class="paramname"> <em>p_str</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">unsigned int *&nbsp;</td>
+          <td class="paramname"> <em>p_len</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
         </tr>
       </table>
 </div>
@@ -184,12 +258,12 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
 
 </div>
 </div><p>
-<a class="anchor" name="92c63007e7d04f626cafc6eef48f7022"></a><!-- doxytag: member="lightmediascanner_utils.h::lms_which_extension" ref="92c63007e7d04f626cafc6eef48f7022" args="(const char *name, unsigned int name_len, const struct lms_string_size *exts, unsigned int exts_len) GNUC_NON_NULL(1" -->
+<a class="anchor" name="7dfc23066442e00fff5cbe77e6f1426e"></a><!-- doxytag: member="lightmediascanner_utils.h::lms_which_extension" ref="7dfc23066442e00fff5cbe77e6f1426e" args="(const char *name, unsigned int name_len, const struct lms_string_size *exts, unsigned int exts_len) GNUC_NON_NULL(1" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">API void API int lms_which_extension           </td>
+          <td class="memname">API int lms_which_extension           </td>
           <td>(</td>
           <td class="paramtype">const char *&nbsp;</td>
           <td class="paramname"> <em>name</em>, </td>
@@ -215,7 +289,7 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
         <tr>
           <td></td>
           <td>)</td>
-          <td></td><td></td><td width="100%"></td>
+          <td></td><td></td><td></td>
         </tr>
       </table>
 </div>
@@ -225,8 +299,9 @@ Definition at line <a class="el" href="lightmediascanner__utils_8h-source.html#l
 
 </div>
 </div><p>
-<hr size="1"><address style="text-align: right;"><small>Generated on Thu Dec 13 02:04:05 2007 for Light Media Scanner by&nbsp;
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Sun Oct 5 12:24:57 2008 for Light Media Scanner by&nbsp;
 <a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 </body>
 </html>