<!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.5"/> <title>Geany: tm_work_object.h File 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">Geany  <span id="projectnumber">1.23.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <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><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_907687f7c764111b7539bc23e763d98c.html">tagmanager</a></li><li class="navelem"><a class="el" href="dir_fbaa723b1f8a3eea6f197d82c57d4088.html">src</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">tm_work_object.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>A <a class="el" href="structTMWorkObject.html">TMWorkObject</a> structure is the base class for <a class="el" href="structTMSourceFile.html">TMSourceFile</a> and TMProject. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structTMWorkObject.html">TMWorkObject</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a170a3435e5d954f8c80520214aa70446"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structTMWorkObject.html">TMWorkObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="tm__work__object_8h.html#a170a3435e5d954f8c80520214aa70446">TMWorkObject</a></td></tr> <tr class="separator:a170a3435e5d954f8c80520214aa70446"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a3100e21475dedda4837a582e57404b11"><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="tm__work__object_8h.html#a3100e21475dedda4837a582e57404b11">tm_get_real_path</a> (const gchar *file_name)</td></tr> <tr class="separator:a3100e21475dedda4837a582e57404b11"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaf4268873b9317d27144207933cac98c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="tm__work__object_8h.html#aaf4268873b9317d27144207933cac98c">tm_work_object_free</a> (gpointer work_object)</td></tr> <tr class="separator:aaf4268873b9317d27144207933cac98c"><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 <a class="el" href="structTMWorkObject.html">TMWorkObject</a> structure is the base class for <a class="el" href="structTMSourceFile.html">TMSourceFile</a> and TMProject. </p> </div><h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="a170a3435e5d954f8c80520214aa70446"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structTMWorkObject.html">TMWorkObject</a> <a class="el" href="structTMWorkObject.html">TMWorkObject</a></td> </tr> </table> </div><div class="memdoc"> <p>A <a class="el" href="structTMWorkObject.html">TMWorkObject</a> structure is the base class for <a class="el" href="structTMSourceFile.html">TMSourceFile</a> and TMProject. This struct contains data common to all work objects, namely, a file name, time when the file was analyzed (for caching) and an array of tags which should be populated when the object is analyzed. </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a3100e21475dedda4837a582e57404b11"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gchar* tm_get_real_path </td> <td>(</td> <td class="paramtype">const gchar * </td> <td class="paramname"><em>file_name</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Given a file name, returns a newly allocated string containing the realpath() of the file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">file_name</td><td>The original file_name </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A newly allocated string containing the real path to the file. NULL if none is available. </dd></dl> </div> </div> <a class="anchor" id="aaf4268873b9317d27144207933cac98c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tm_work_object_free </td> <td>(</td> <td class="paramtype">gpointer </td> <td class="paramname"><em>work_object</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Deallocates a work object and it's component structures. The user can call this function directly since it will automatically call the correct deallocator function of the derived class if required. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">work_object</td><td>Pointer to a work object or an object derived from it. </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 18 2013 23:44:59 for Geany by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>