<!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_source_file.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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">tm_source_file.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="structTMSourceFile.html">TMSourceFile</a> structure and associated functions are used to maintain tags for individual files.
<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="structTMSourceFile.html">TMSourceFile</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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8e074d98a9861086e5458af8c2bc8eac"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="tm__source__file_8h.html#a8e074d98a9861086e5458af8c2bc8eac">tm_source_file_buffer_update</a> (<a class="el" href="structTMWorkObject.html">TMWorkObject</a> *source_file, guchar *text_buf, gint buf_size, gboolean update_parent)</td></tr>
<tr class="separator:a8e074d98a9861086e5458af8c2bc8eac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23932c4605aa03bca56a506b8489d9ee"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="tm__source__file_8h.html#a23932c4605aa03bca56a506b8489d9ee">tm_source_file_update</a> (<a class="el" href="structTMWorkObject.html">TMWorkObject</a> *source_file, gboolean force, gboolean recurse, gboolean update_parent)</td></tr>
<tr class="separator:a23932c4605aa03bca56a506b8489d9ee"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="structTMSourceFile.html">TMSourceFile</a> structure and associated functions are used to maintain tags for individual files. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a8e074d98a9861086e5458af8c2bc8eac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean tm_source_file_buffer_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structTMWorkObject.html">TMWorkObject</a> * </td>
<td class="paramname"><em>source_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guchar * </td>
<td class="paramname"><em>text_buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint </td>
<td class="paramname"><em>buf_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"><em>update_parent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the source file by reparsing the text-buffer passed as parameter. Ctags will use a parsing based on buffer instead of on files. You should call this function when you don't want a previous saving of the file you're editing. It's useful for a "real-time" updating of the tags. The tags array and the tags themselves are destroyed and re-created, hence any other tag arrays pointing to these tags should be rebuilt as well. All sorting information is also lost. The language parameter is automatically set the first time the file is parsed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source_file</td><td>The source file to update with a buffer. </td></tr>
<tr><td class="paramname">text_buf</td><td>A text buffer. The user should take care of allocate and free it after the use here. </td></tr>
<tr><td class="paramname">buf_size</td><td>The size of text_buf. </td></tr>
<tr><td class="paramname">update_parent</td><td>If set to TRUE, sends an update signal to parent if required. You should always set this to TRUE if you are calling this function directly. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the file was parsed, FALSE otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd>tm_work_object_update(), tm_project_update(), tm_workspace_update() </dd></dl>
</div>
</div>
<a class="anchor" id="a23932c4605aa03bca56a506b8489d9ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean tm_source_file_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structTMWorkObject.html">TMWorkObject</a> * </td>
<td class="paramname"><em>source_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"><em>force</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"><em>recurse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"><em>update_parent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the source file by reparsing if the modification time is greater than the timestamp in the structure, or if force is TRUE. The tags array and the tags themselves are destroyed and re-created, hence any other tag arrays pointing to these tags should be rebuilt as well. All sorting information is also lost. The language parameter is automatically set the first time the file is parsed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source_file</td><td>The source file to update. </td></tr>
<tr><td class="paramname">force</td><td>Ignored. The source file is always updated. </td></tr>
<tr><td class="paramname">recurse</td><td>This parameter is ignored for source files and is only there for consistency. </td></tr>
<tr><td class="paramname">update_parent</td><td>If set to TRUE, sends an update signal to parent if required. You should always set this to TRUE if you are calling this function directly. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the file was parsed, FALSE otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd>tm_work_object_update(), tm_project_update(), tm_workspace_update() </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>
