<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>gmerlin: Filesystem support</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Filesystem support<br>
<small>
[<a class="el" href="group__utils.html">Utilities</a>]</small>
</h1>Functions for files and directories.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__files.html#g3f47b08c836218f12113a6b6687ee360">bg_fix_path</a> (char *path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a trailing slash to a path name. <a href="#g3f47b08c836218f12113a6b6687ee360"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__files.html#g50749de9533e0e50ef7539905cf7d4ec">bg_ensure_directory</a> (const char *dir)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ensure that a directory exists. <a href="#g50749de9533e0e50ef7539905cf7d4ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__files.html#g195a6818345b0567e610abb32a27d9b3">bg_search_file_read</a> (const char *directory, const char *file)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search for a file for reading. <a href="#g195a6818345b0567e610abb32a27d9b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__files.html#g591565d0087d5fd623b05bca2d973c24">bg_search_file_write</a> (const char *directory, const char *file)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search for a file for writing. <a href="#g591565d0087d5fd623b05bca2d973c24"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__files.html#g87ee654a2054b10219247db03daffb71">bg_search_file_exec</a> (const char *file, char **path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search for an executable. <a href="#g87ee654a2054b10219247db03daffb71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__files.html#gb80249fd80dff27f45109de51be0eefe">bg_find_url_launcher</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find an URL launcher. <a href="#gb80249fd80dff27f45109de51be0eefe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__files.html#gad78656e05a0cc1cc885079960acc7c7">bg_display_html_help</a> (const char *path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Display html help. <a href="#gad78656e05a0cc1cc885079960acc7c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__files.html#g3945d74fa10a7e5319a76bf0162c146e">bg_create_unique_filename</a> (char *format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a unique filename. <a href="#g3945d74fa10a7e5319a76bf0162c146e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Functions for files and directories. <hr><h2>Function Documentation</h2>
<a class="anchor" name="g3f47b08c836218f12113a6b6687ee360"></a><!-- doxytag: member="utils.h::bg_fix_path" ref="g3f47b08c836218f12113a6b6687ee360" args="(char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* bg_fix_path </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>path</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a trailing slash to a path name.
<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>path</em> </td><td>Old path (will eventually be freed). </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The path, which is garantueed to end with a '/' </dd></dl>
</div>
</div><p>
<a class="anchor" name="g50749de9533e0e50ef7539905cf7d4ec"></a><!-- doxytag: member="utils.h::bg_ensure_directory" ref="g50749de9533e0e50ef7539905cf7d4ec" args="(const char *dir)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bg_ensure_directory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dir</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ensure that a directory exists.
<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>dir</em> </td><td>Directory </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the directory exists after the function call, 0 else</dd></dl>
Non-existing directories will be created if possible
</div>
</div><p>
<a class="anchor" name="g195a6818345b0567e610abb32a27d9b3"></a><!-- doxytag: member="utils.h::bg_search_file_read" ref="g195a6818345b0567e610abb32a27d9b3" args="(const char *directory, const char *file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* bg_search_file_read </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>directory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Search for a file for reading.
<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>directory</em> </td><td>Directory </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>Filename </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A filename or NULL</dd></dl>
This function first seeks in the system gmerlin data directory (e.g. /usr/local/share/gmerlin), then in $HOME/.gmerlin for the specified file, which must be readable. The directory can also contain subdirectories e.g. "player/tree".
</div>
</div><p>
<a class="anchor" name="g591565d0087d5fd623b05bca2d973c24"></a><!-- doxytag: member="utils.h::bg_search_file_write" ref="g591565d0087d5fd623b05bca2d973c24" args="(const char *directory, const char *file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* bg_search_file_write </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>directory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Search for a file for writing.
<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>directory</em> </td><td>Directory </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>Filename </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A filename or NULL</dd></dl>
This function first seeks in the in $HOME/.gmerlin for the specified file, which must be writable. If the file doesn't exist, an empty file is created. If the directory doesn't exist, it's created as well. The directory can also contain subdirectories e.g. "player/tree".
</div>
</div><p>
<a class="anchor" name="g87ee654a2054b10219247db03daffb71"></a><!-- doxytag: member="utils.h::bg_search_file_exec" ref="g87ee654a2054b10219247db03daffb71" args="(const char *file, char **path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bg_search_file_exec </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>path</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Search for an executable.
<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>file</em> </td><td>Name of the file (without dirtectory) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>If non NULL, the complete path to the exectuable will be returned </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if executeable is found anywhere in $PATH:/opt/gmerlin/bin, 0 else.</dd></dl>
If path is non NULL, it will contain the path to the executable, which must be freed after
</div>
</div><p>
<a class="anchor" name="gb80249fd80dff27f45109de51be0eefe"></a><!-- doxytag: member="utils.h::bg_find_url_launcher" ref="gb80249fd80dff27f45109de51be0eefe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* bg_find_url_launcher </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find an URL launcher.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A newly allocated string, which must be freed</dd></dl>
This returnes the path of a webbrowser. Under gnome, it will be the your default webbrowser, under other systems, this function will try a list of known webbrowsers.
</div>
</div><p>
<a class="anchor" name="gad78656e05a0cc1cc885079960acc7c7"></a><!-- doxytag: member="utils.h::bg_display_html_help" ref="gad78656e05a0cc1cc885079960acc7c7" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_display_html_help </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Display html help.
<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>path</em> </td><td>Path</td></tr>
</table>
</dl>
Launch a webbrowser and display a html file. Path is something lile "userguide/Player.html"
</div>
</div><p>
<a class="anchor" name="g3945d74fa10a7e5319a76bf0162c146e"></a><!-- doxytag: member="utils.h::bg_create_unique_filename" ref="g3945d74fa10a7e5319a76bf0162c146e" args="(char *format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* bg_create_unique_filename </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>format</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a unique filename.
<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>format</em> </td><td>Printf like format. Must contain "%08x" as the only placeholder. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A newly allocated string</dd></dl>
Create a unique filename, and create an empty file of this name.
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 22 01:28:05 2009 for gmerlin by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
874255f3b26b44feb57fbe38a7384518
>
files
>
201
