<!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 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="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.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="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">editorconfig.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Header file of EditorConfig.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="editorconfig__handle_8h_source.html">editorconfig/editorconfig_handle.h</a>></code><br />
</div>
<p><a href="editorconfig_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a7a8131a3c229adb8eba19262e981b0f7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#a7a8131a3c229adb8eba19262e981b0f7">EDITORCONFIG_PARSE_NOT_FULL_PATH</a>   (-2)</td></tr>
<tr class="separator:a7a8131a3c229adb8eba19262e981b0f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a492500afec561a16fc6e8e23b261abaf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#a492500afec561a16fc6e8e23b261abaf">EDITORCONFIG_PARSE_MEMORY_ERROR</a>   (-3)</td></tr>
<tr class="separator:a492500afec561a16fc6e8e23b261abaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe623becaffb01263d1b22bd320f7916"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#afe623becaffb01263d1b22bd320f7916">EDITORCONFIG_PARSE_VERSION_TOO_NEW</a>   (-4)</td></tr>
<tr class="separator:afe623becaffb01263d1b22bd320f7916"><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:add6bebe96bf90c48fef01cf5300ddf92"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92">editorconfig_parse</a> (const char *full_filename, <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> h)</td></tr>
<tr class="memdesc:add6bebe96bf90c48fef01cf5300ddf92"><td class="mdescLeft"> </td><td class="mdescRight">Parse editorconfig files corresponding to the file path given by full_filename, and related information is input and output in h. <a href="#add6bebe96bf90c48fef01cf5300ddf92">More...</a><br /></td></tr>
<tr class="separator:add6bebe96bf90c48fef01cf5300ddf92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a779a54d57d57198a089ea7221751330c"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#a779a54d57d57198a089ea7221751330c">editorconfig_get_error_msg</a> (int err_num)</td></tr>
<tr class="memdesc:a779a54d57d57198a089ea7221751330c"><td class="mdescLeft"> </td><td class="mdescRight">Get the error message from the error number returned by <a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92" title="Parse editorconfig files corresponding to the file path given by full_filename, and related informati...">editorconfig_parse()</a>. <a href="#a779a54d57d57198a089ea7221751330c">More...</a><br /></td></tr>
<tr class="separator:a779a54d57d57198a089ea7221751330c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c5961b81ee3d6cd296dc8f1e6d7c6d0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#a5c5961b81ee3d6cd296dc8f1e6d7c6d0">editorconfig_get_version</a> (int *major, int *minor, int *patch)</td></tr>
<tr class="memdesc:a5c5961b81ee3d6cd296dc8f1e6d7c6d0"><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of EditorConfig. <a href="#a5c5961b81ee3d6cd296dc8f1e6d7c6d0">More...</a><br /></td></tr>
<tr class="separator:a5c5961b81ee3d6cd296dc8f1e6d7c6d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a353d4f1b9fd424c837a2efba6c6b02ad"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#a353d4f1b9fd424c837a2efba6c6b02ad">editorconfig_get_version_suffix</a> (void)</td></tr>
<tr class="memdesc:a353d4f1b9fd424c837a2efba6c6b02ad"><td class="mdescLeft"> </td><td class="mdescRight">Get the version suffix. <a href="#a353d4f1b9fd424c837a2efba6c6b02ad">More...</a><br /></td></tr>
<tr class="separator:a353d4f1b9fd424c837a2efba6c6b02ad"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header file of EditorConfig. </p>
<p>Related page: <a class="el" href="editorconfig-format.html">EditorConfig File Format</a> <dl class="section author"><dt>Author</dt><dd>EditorConfig Team </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a492500afec561a16fc6e8e23b261abaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a492500afec561a16fc6e8e23b261abaf">◆ </a></span>EDITORCONFIG_PARSE_MEMORY_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EDITORCONFIG_PARSE_MEMORY_ERROR   (-3)</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92" title="Parse editorconfig files corresponding to the file path given by full_filename, and related informati...">editorconfig_parse()</a> return value: a memory error occurs. </p>
</div>
</div>
<a id="a7a8131a3c229adb8eba19262e981b0f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a8131a3c229adb8eba19262e981b0f7">◆ </a></span>EDITORCONFIG_PARSE_NOT_FULL_PATH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EDITORCONFIG_PARSE_NOT_FULL_PATH   (-2)</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92" title="Parse editorconfig files corresponding to the file path given by full_filename, and related informati...">editorconfig_parse()</a> return value: the full_filename parameter of <a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92" title="Parse editorconfig files corresponding to the file path given by full_filename, and related informati...">editorconfig_parse()</a> is not a full path name </p>
</div>
</div>
<a id="afe623becaffb01263d1b22bd320f7916"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe623becaffb01263d1b22bd320f7916">◆ </a></span>EDITORCONFIG_PARSE_VERSION_TOO_NEW</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EDITORCONFIG_PARSE_VERSION_TOO_NEW   (-4)</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92" title="Parse editorconfig files corresponding to the file path given by full_filename, and related informati...">editorconfig_parse()</a> return value: the required version specified in <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> is greater than the current version. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a779a54d57d57198a089ea7221751330c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a779a54d57d57198a089ea7221751330c">◆ </a></span>editorconfig_get_error_msg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* editorconfig_get_error_msg </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>err_num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the error message from the error number returned by <a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92" title="Parse editorconfig files corresponding to the file path given by full_filename, and related informati...">editorconfig_parse()</a>. </p>
<p>An example is available at <a href="https://github.com/editorconfig/editorconfig-core/blob/master/src/bin/main.c">src/bin/main.c</a> in EditorConfig C Core source code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err_num</td><td>The error number that is used to obtain the error message.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The error message corresponding to err_num. </dd></dl>
</div>
</div>
<a id="a5c5961b81ee3d6cd296dc8f1e6d7c6d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c5961b81ee3d6cd296dc8f1e6d7c6d0">◆ </a></span>editorconfig_get_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void editorconfig_get_version </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>major</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>minor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>patch</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the version number of EditorConfig. </p>
<p>An example is available at <a href="https://github.com/editorconfig/editorconfig-core/blob/master/src/bin/main.c">src/bin/main.c</a> in EditorConfig C Core source code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">major</td><td>If not null, the integer pointed by major will be filled with the major version of EditorConfig.</td></tr>
<tr><td class="paramname">minor</td><td>If not null, the integer pointed by minor will be filled with the minor version of EditorConfig.</td></tr>
<tr><td class="paramname">patch</td><td>If not null, the integer pointed by patch will be filled with the patch version of EditorConfig.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a id="a353d4f1b9fd424c837a2efba6c6b02ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a353d4f1b9fd424c837a2efba6c6b02ad">◆ </a></span>editorconfig_get_version_suffix()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* editorconfig_get_version_suffix </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the version suffix. </p>
<dl class="section return"><dt>Returns</dt><dd>The version suffix, such as "-development" for a development version, empty string for a stable version. </dd></dl>
</div>
</div>
<a id="add6bebe96bf90c48fef01cf5300ddf92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add6bebe96bf90c48fef01cf5300ddf92">◆ </a></span>editorconfig_parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int editorconfig_parse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>full_filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse editorconfig files corresponding to the file path given by full_filename, and related information is input and output in h. </p>
<p>An example is available at <a href="https://github.com/editorconfig/editorconfig-core/blob/master/src/bin/main.c">src/bin/main.c</a> in EditorConfig C Core source code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">full_filename</td><td>The full path of a file that is edited by the editor for which the parsing result is.</td></tr>
<tr><td class="paramname">h</td><td>The <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> to be used and returned from this function (including the parsing result). The <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> should be created by <a class="el" href="editorconfig__handle_8h.html#a8e3f1681e835a2946ba93b341ebc3dca" title="Create and intialize a default editorconfig_handle object. ">editorconfig_handle_init()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Everything is OK.</td></tr>
<tr><td class="paramname">Positive Integer</td><td>A parsing error occurs. The return value would be the line number of parsing error. err_file obtained from h by calling <a class="el" href="editorconfig__handle_8h.html#ae0c5207a1986dfea2f641008ddefdd93" title="Get the err_file field of an editorconfig_handle object. ">editorconfig_handle_get_err_file()</a> will also be filled with the file path that caused the parsing error.</td></tr>
<tr><td class="paramname">Negative Integer</td><td>Some error occured. See below for the reason of the error for each return value.</td></tr>
<tr><td class="paramname">EDITORCONFIG_PARSE_NOT_FULL_PATH</td><td>The full_filename is not a full path name.</td></tr>
<tr><td class="paramname">EDITORCONFIG_PARSE_MEMORY_ERROR</td><td>A memory error occurs.</td></tr>
<tr><td class="paramname">EDITORCONFIG_PARSE_VERSION_TOO_NEW</td><td>The required version specified in <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> is greater than the current version. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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>
