<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>Audacious: VFSConstructor Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Audacious  <span id="projectnumber">$Id:Doxyfile42802007-03-2104:39:00Znenolod$</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-attribs">Public Attributes</a> | <a href="struct__VFSConstructor-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">VFSConstructor Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p><a class="el" href="structVFSConstructor.html">VFSConstructor</a> objects contain the base vtables used for extrapolating a VFS stream. <a href="struct__VFSConstructor.html#details">More...</a></p> <p><code>#include <<a class="el" href="vfs_8h_source.html">vfs.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:a865266715cd054e87412b039adbea094"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a865266715cd054e87412b039adbea094">vfs_fopen_impl</a> )(const char *<a class="el" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>, const char *mode)</td></tr> <tr class="memdesc:a865266715cd054e87412b039adbea094"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a fopen implementation. <a href="#a865266715cd054e87412b039adbea094"></a><br/></td></tr> <tr class="separator:a865266715cd054e87412b039adbea094"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a73b97d43c38033f3b3e3aca63e44ebef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a73b97d43c38033f3b3e3aca63e44ebef">vfs_fclose_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td></tr> <tr class="memdesc:a73b97d43c38033f3b3e3aca63e44ebef"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a fclose implementation. <a href="#a73b97d43c38033f3b3e3aca63e44ebef"></a><br/></td></tr> <tr class="separator:a73b97d43c38033f3b3e3aca63e44ebef"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1436e30f6cf25d9f59247e51605bf155"><td class="memItemLeft" align="right" valign="top">int64_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a1436e30f6cf25d9f59247e51605bf155">vfs_fread_impl</a> )(void *ptr, int64_t size, int64_t nmemb, <a class="el" href="structVFSFile.html">VFSFile</a> *file)</td></tr> <tr class="memdesc:a1436e30f6cf25d9f59247e51605bf155"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a fread implementation. <a href="#a1436e30f6cf25d9f59247e51605bf155"></a><br/></td></tr> <tr class="separator:a1436e30f6cf25d9f59247e51605bf155"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a17baacec48c3ab1aff5677f056923b28"><td class="memItemLeft" align="right" valign="top">int64_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a17baacec48c3ab1aff5677f056923b28">vfs_fwrite_impl</a> )(const void *ptr, int64_t size, int64_t nmemb, <a class="el" href="structVFSFile.html">VFSFile</a> *file)</td></tr> <tr class="memdesc:a17baacec48c3ab1aff5677f056923b28"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a fwrite implementation. <a href="#a17baacec48c3ab1aff5677f056923b28"></a><br/></td></tr> <tr class="separator:a17baacec48c3ab1aff5677f056923b28"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7b6e9e0bf040159f72b9d8b2cc1b5d6c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a7b6e9e0bf040159f72b9d8b2cc1b5d6c">vfs_getc_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr> <tr class="memdesc:a7b6e9e0bf040159f72b9d8b2cc1b5d6c"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a getc implementation. <a href="#a7b6e9e0bf040159f72b9d8b2cc1b5d6c"></a><br/></td></tr> <tr class="separator:a7b6e9e0bf040159f72b9d8b2cc1b5d6c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad48093c6c4c30889f21f180b93efb8d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#ad48093c6c4c30889f21f180b93efb8d2">vfs_ungetc_impl</a> )(<a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a> c, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr> <tr class="memdesc:ad48093c6c4c30889f21f180b93efb8d2"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to an ungetc implementation. <a href="#ad48093c6c4c30889f21f180b93efb8d2"></a><br/></td></tr> <tr class="separator:ad48093c6c4c30889f21f180b93efb8d2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3001256384bfae96a2bbc67e71f576bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a3001256384bfae96a2bbc67e71f576bf">vfs_fseek_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *file, int64_t offset, <a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a> whence)</td></tr> <tr class="memdesc:a3001256384bfae96a2bbc67e71f576bf"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a fseek implementation. <a href="#a3001256384bfae96a2bbc67e71f576bf"></a><br/></td></tr> <tr class="separator:a3001256384bfae96a2bbc67e71f576bf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a637007407f026e7dc22864e2530e6343"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a637007407f026e7dc22864e2530e6343">vfs_rewind_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td></tr> <tr class="memdesc:a637007407f026e7dc22864e2530e6343"><td class="mdescLeft"> </td><td class="mdescRight">function pointer which points to a rewind implementation. <a href="#a637007407f026e7dc22864e2530e6343"></a><br/></td></tr> <tr class="separator:a637007407f026e7dc22864e2530e6343"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a94912ffae2c4542cc37e5562bef4f7ba"><td class="memItemLeft" align="right" valign="top">int64_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a94912ffae2c4542cc37e5562bef4f7ba">vfs_ftell_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td></tr> <tr class="memdesc:a94912ffae2c4542cc37e5562bef4f7ba"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a ftell implementation. <a href="#a94912ffae2c4542cc37e5562bef4f7ba"></a><br/></td></tr> <tr class="separator:a94912ffae2c4542cc37e5562bef4f7ba"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a253a222d3762e1805fa98baac361d88f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a253a222d3762e1805fa98baac361d88f">vfs_feof_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td></tr> <tr class="memdesc:a253a222d3762e1805fa98baac361d88f"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a feof implementation. <a href="#a253a222d3762e1805fa98baac361d88f"></a><br/></td></tr> <tr class="separator:a253a222d3762e1805fa98baac361d88f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a22dd55ad54a5aa7b45f1c50c54894b7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a22dd55ad54a5aa7b45f1c50c54894b7d">vfs_ftruncate_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *file, int64_t length)</td></tr> <tr class="memdesc:a22dd55ad54a5aa7b45f1c50c54894b7d"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a ftruncate implementation. <a href="#a22dd55ad54a5aa7b45f1c50c54894b7d"></a><br/></td></tr> <tr class="separator:a22dd55ad54a5aa7b45f1c50c54894b7d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a679916c97158e70a15928ca423d5a058"><td class="memItemLeft" align="right" valign="top">int64_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#a679916c97158e70a15928ca423d5a058">vfs_fsize_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td></tr> <tr class="memdesc:a679916c97158e70a15928ca423d5a058"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a fsize implementation. <a href="#a679916c97158e70a15928ca423d5a058"></a><br/></td></tr> <tr class="separator:a679916c97158e70a15928ca423d5a058"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae5c8762a1b6623ddf978b9245559251a"><td class="memItemLeft" align="right" valign="top">char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VFSConstructor.html#ae5c8762a1b6623ddf978b9245559251a">vfs_get_metadata_impl</a> )(<a class="el" href="structVFSFile.html">VFSFile</a> *file, const char *field)</td></tr> <tr class="memdesc:ae5c8762a1b6623ddf978b9245559251a"><td class="mdescLeft"> </td><td class="mdescRight">A function pointer which points to a (stream) metadata fetching implementation. <a href="#ae5c8762a1b6623ddf978b9245559251a"></a><br/></td></tr> <tr class="separator:ae5c8762a1b6623ddf978b9245559251a"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="structVFSConstructor.html">VFSConstructor</a> objects contain the base vtables used for extrapolating a VFS stream. </p> <p><a class="el" href="structVFSConstructor.html">VFSConstructor</a> objects should be considered virtual in nature. VFS base vtables are registered via vfs_register_transport(). </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00052">52</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div><h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="a73b97d43c38033f3b3e3aca63e44ebef"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* VFSConstructor::vfs_fclose_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a fclose implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00056">56</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a253a222d3762e1805fa98baac361d88f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a>(* VFSConstructor::vfs_feof_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a feof implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00077">77</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a865266715cd054e87412b039adbea094"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void*(* VFSConstructor::vfs_fopen_impl)(const char *<a class="el" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>, const char *mode)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a fopen implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00054">54</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a1436e30f6cf25d9f59247e51605bf155"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int64_t(* VFSConstructor::vfs_fread_impl)(void *ptr, int64_t size, int64_t nmemb, <a class="el" href="structVFSFile.html">VFSFile</a> *file)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a fread implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00059">59</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a3001256384bfae96a2bbc67e71f576bf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* VFSConstructor::vfs_fseek_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *file, int64_t offset, <a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a> whence)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a fseek implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00071">71</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a679916c97158e70a15928ca423d5a058"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int64_t(* VFSConstructor::vfs_fsize_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a fsize implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00081">81</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a94912ffae2c4542cc37e5562bef4f7ba"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int64_t(* VFSConstructor::vfs_ftell_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a ftell implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00075">75</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a22dd55ad54a5aa7b45f1c50c54894b7d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* VFSConstructor::vfs_ftruncate_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *file, int64_t length)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a ftruncate implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00079">79</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a17baacec48c3ab1aff5677f056923b28"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int64_t(* VFSConstructor::vfs_fwrite_impl)(const void *ptr, int64_t size, int64_t nmemb, <a class="el" href="structVFSFile.html">VFSFile</a> *file)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a fwrite implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00062">62</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="ae5c8762a1b6623ddf978b9245559251a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char*(* VFSConstructor::vfs_get_metadata_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *file, const char *field)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a (stream) metadata fetching implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00084">84</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a7b6e9e0bf040159f72b9d8b2cc1b5d6c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* VFSConstructor::vfs_getc_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to a getc implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00066">66</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="a637007407f026e7dc22864e2530e6343"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void(* VFSConstructor::vfs_rewind_impl)(<a class="el" href="structVFSFile.html">VFSFile</a> *file)</td> </tr> </table> </div><div class="memdoc"> <p>function pointer which points to a rewind implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00073">73</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <a class="anchor" id="ad48093c6c4c30889f21f180b93efb8d2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a>(* VFSConstructor::vfs_ungetc_impl)(<a class="el" href="plugins-api_8h.html#a61569f2965b7a369eb10b6d75d410d11">int</a> c, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td> </tr> </table> </div><div class="memdoc"> <p>A function pointer which points to an ungetc implementation. </p> <p>Definition at line <a class="el" href="vfs_8h_source.html#l00068">68</a> of file <a class="el" href="vfs_8h_source.html">vfs.h</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="vfs_8h_source.html">vfs.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3 </small></address> </body> </html>