<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EditorConfig: editorconfig.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EditorConfig
</div>
<div id="projectbrief">Configuration file format for defining coding styles in shared projects.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('editorconfig_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">editorconfig.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="editorconfig_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2011-2013 EditorConfig Team</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * </span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modification, are permitted provided that the following conditions are met:</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * </span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright notice,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * this list of conditions and the following disclaimer.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * this list of conditions and the following disclaimer in the documentation</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * and/or other materials provided with the distribution.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * </span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> */</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="preprocessor">#ifndef __EDITORCONFIG_EDITORCONFIG_H__</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="preprocessor">#define __EDITORCONFIG_EDITORCONFIG_H__</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">/* When included from a user program, EDITORCONFIG_EXPORT may not be defined,</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * and we define it here*/</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="preprocessor">#ifndef EDITORCONFIG_EXPORT</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor"># define EDITORCONFIG_EXPORT</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="preprocessor">#include <<a class="code" href="editorconfig__handle_8h.html">editorconfig/editorconfig_handle.h</a>></span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="keywordtype">int</span> <a class="code" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92">editorconfig_parse</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* full_filename, <a class="code" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> h);</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="editorconfig_8h.html#a779a54d57d57198a089ea7221751330c">editorconfig_get_error_msg</a>(<span class="keywordtype">int</span> err_num);</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div><div class="line"><a name="l00269"></a><span class="lineno"><a class="line" href="editorconfig_8h.html#a7a8131a3c229adb8eba19262e981b0f7"> 269</a></span> <span class="preprocessor">#define EDITORCONFIG_PARSE_NOT_FULL_PATH (-2)</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> </div><div class="line"><a name="l00273"></a><span class="lineno"><a class="line" href="editorconfig_8h.html#a492500afec561a16fc6e8e23b261abaf"> 273</a></span> <span class="preprocessor">#define EDITORCONFIG_PARSE_MEMORY_ERROR (-3)</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div><div class="line"><a name="l00278"></a><span class="lineno"><a class="line" href="editorconfig_8h.html#afe623becaffb01263d1b22bd320f7916"> 278</a></span> <span class="preprocessor">#define EDITORCONFIG_PARSE_VERSION_TOO_NEW (-4)</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="keywordtype">void</span> <a class="code" href="editorconfig_8h.html#a5c5961b81ee3d6cd296dc8f1e6d7c6d0">editorconfig_get_version</a>(<span class="keywordtype">int</span>* major, <span class="keywordtype">int</span>* minor, <span class="keywordtype">int</span>* patch);</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> </div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="editorconfig_8h.html#a353d4f1b9fd424c837a2efba6c6b02ad">editorconfig_get_version_suffix</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> </div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> }</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> </div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="preprocessor">#endif </span><span class="comment">/* !__EDITORCONFIG_EDITORCONFIG_H__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> </div><div class="ttc" id="editorconfig__handle_8h_html_a0c51d798e0e22051d0057a567245010c"><div class="ttname"><a href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a></div><div class="ttdeci">void * editorconfig_handle</div><div class="ttdoc">The editorconfig handle object type. </div><div class="ttdef"><b>Definition:</b> editorconfig_handle.h:50</div></div>
<div class="ttc" id="editorconfig_8h_html_a5c5961b81ee3d6cd296dc8f1e6d7c6d0"><div class="ttname"><a href="editorconfig_8h.html#a5c5961b81ee3d6cd296dc8f1e6d7c6d0">editorconfig_get_version</a></div><div class="ttdeci">void editorconfig_get_version(int *major, int *minor, int *patch)</div><div class="ttdoc">Get the version number of EditorConfig. </div></div>
<div class="ttc" id="editorconfig_8h_html_add6bebe96bf90c48fef01cf5300ddf92"><div class="ttname"><a href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92">editorconfig_parse</a></div><div class="ttdeci">int editorconfig_parse(const char *full_filename, editorconfig_handle h)</div><div class="ttdoc">Parse editorconfig files corresponding to the file path given by full_filename, and related informati...</div></div>
<div class="ttc" id="editorconfig_8h_html_a353d4f1b9fd424c837a2efba6c6b02ad"><div class="ttname"><a href="editorconfig_8h.html#a353d4f1b9fd424c837a2efba6c6b02ad">editorconfig_get_version_suffix</a></div><div class="ttdeci">const char * editorconfig_get_version_suffix(void)</div><div class="ttdoc">Get the version suffix. </div></div>
<div class="ttc" id="editorconfig__handle_8h_html"><div class="ttname"><a href="editorconfig__handle_8h.html">editorconfig_handle.h</a></div><div class="ttdoc">Header file of EditorConfig handle. </div></div>
<div class="ttc" id="editorconfig_8h_html_a779a54d57d57198a089ea7221751330c"><div class="ttname"><a href="editorconfig_8h.html#a779a54d57d57198a089ea7221751330c">editorconfig_get_error_msg</a></div><div class="ttdeci">const char * editorconfig_get_error_msg(int err_num)</div><div class="ttdoc">Get the error message from the error number returned by editorconfig_parse(). </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_97a02d125655f590b2920fe29957f8f2.html">editorconfig</a></li><li class="navelem"><a class="el" href="editorconfig_8h.html">editorconfig.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
