File: group__m17nCore.html

package info (click to toggle)
m17n-docs 1.8.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 53,736 kB
  • sloc: javascript: 7,609; sh: 1,256; makefile: 351; ansic: 206
file content (198 lines) | stat: -rw-r--r-- 12,951 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>The m17n Library: CORE API</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="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="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">The m17n Library
   &#160;<span id="projectnumber">1.8.4</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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="#groups">Modules</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle">
<div class="title">CORE API</div>  </div>
</div><!--header-->
<div class="contents">

<p>API provided by libm17n-core.so <br  />
  
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for CORE API:</div>
<div class="dyncontent">
<div class="center"><img src="group__m17nCore.png" border="0" usemap="#agroup____m17nCore" alt=""/></div>
<map name="agroup____m17nCore" id="agroup____m17nCore">
<area shape="rect" href="group__m17nTextProperty.html" title="Function to handle text properties." alt="" coords="146,5,254,31"/>
<area shape="rect" href="group__m17nCharacter.html" title="Character objects and API for them." alt="" coords="157,55,243,80"/>
<area shape="rect" href="group__m17nSymbol.html" title="Symbol objects and API for them." alt="" coords="165,104,235,129"/>
<area shape="rect" href="group__m17nChartable.html" title="Chartable objects and API for them." alt="" coords="157,153,243,179"/>
<area shape="rect" title="API provided by libm17n&#45;core.so" alt="" coords="5,179,88,204"/>
<area shape="rect" href="group__m17nMtext.html" title="M&#45;text objects and API for them." alt="" coords="167,203,233,228"/>
<area shape="rect" href="group__m17nDatabase.html" title="The m17n database and API for it." alt="" coords="158,252,242,277"/>
<area shape="rect" href="group__m17nPlist.html" title=" " alt="" coords="148,301,252,327"/>
<area shape="rect" href="group__m17nObject.html" title="Objects managed by the reference count" alt="" coords="136,351,264,376"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__m17nObject"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nObject.html">Managed Object</a></td></tr>
<tr class="memdesc:group__m17nObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Objects managed by the reference count <br  />
 <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__m17nSymbol"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nSymbol.html">Symbol</a></td></tr>
<tr class="memdesc:group__m17nSymbol"><td class="mdescLeft">&#160;</td><td class="mdescRight">Symbol objects and API for them. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__m17nPlist"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nPlist.html">Property List</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__m17nCharacter"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nCharacter.html">Character</a></td></tr>
<tr class="memdesc:group__m17nCharacter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character objects and API for them. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__m17nChartable"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nChartable.html">Chartable</a></td></tr>
<tr class="memdesc:group__m17nChartable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chartable objects and API for them. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__m17nMtext"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nMtext.html">M-text</a></td></tr>
<tr class="memdesc:group__m17nMtext"><td class="mdescLeft">&#160;</td><td class="mdescRight">M-text objects and API for them. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__m17nTextProperty"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nTextProperty.html">Text Property</a></td></tr>
<tr class="memdesc:group__m17nTextProperty"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to handle text properties. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__m17nDatabase"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nDatabase.html">Database</a></td></tr>
<tr class="memdesc:group__m17nDatabase"><td class="mdescLeft">&#160;</td><td class="mdescRight">The m17n database and API for it. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga56e45d7b0345761359001fe038d121ae"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nCore.html#ga56e45d7b0345761359001fe038d121ae">M17N_FUNC</a>(func)&#160;&#160;&#160;((<a class="el" href="group__m17nCore.html#ga19c0932d1f3f2067bd1d7175cc26932b">M17NFunc</a>) (func))</td></tr>
<tr class="memdesc:ga56e45d7b0345761359001fe038d121ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper for a generic function type.  <a href="group__m17nCore.html#ga56e45d7b0345761359001fe038d121ae">More...</a><br /></td></tr>
<tr class="separator:ga56e45d7b0345761359001fe038d121ae"><td class="memSeparator" colspan="2">&#160;</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:ga19c0932d1f3f2067bd1d7175cc26932b"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nCore.html#ga19c0932d1f3f2067bd1d7175cc26932b">M17NFunc</a>) (void)</td></tr>
<tr class="memdesc:ga19c0932d1f3f2067bd1d7175cc26932b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic function type.  <a href="group__m17nCore.html#ga19c0932d1f3f2067bd1d7175cc26932b">More...</a><br /></td></tr>
<tr class="separator:ga19c0932d1f3f2067bd1d7175cc26932b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>API provided by libm17n-core.so <br  />
 </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga56e45d7b0345761359001fe038d121ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga56e45d7b0345761359001fe038d121ae">&#9670;&nbsp;</a></span>M17N_FUNC</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define M17N_FUNC</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">func</td><td>)</td>
          <td>&#160;&#160;&#160;((<a class="el" href="group__m17nCore.html#ga19c0932d1f3f2067bd1d7175cc26932b">M17NFunc</a>) (func))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Wrapper for a generic function type. </p>
<p>The macro <a class="el" href="group__m17nCore.html#ga56e45d7b0345761359001fe038d121ae" title="Wrapper for a generic function type.">M17N_FUNC()</a> casts a function to the type <a class="el" href="group__m17nCore.html#ga19c0932d1f3f2067bd1d7175cc26932b" title="Generic function type.">M17NFunc</a>. <br  />
 </p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga19c0932d1f3f2067bd1d7175cc26932b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga19c0932d1f3f2067bd1d7175cc26932b">&#9670;&nbsp;</a></span>M17NFunc</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* M17NFunc) (void)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Generic function type. </p>
<p><a class="el" href="group__m17nCore.html#ga19c0932d1f3f2067bd1d7175cc26932b" title="Generic function type.">M17NFunc</a> is a generic function type for setting a function pointer as a value of #MSymbol property or <a class="el" href="structMPlist.html" title="Type of property list objects.">MPlist</a>. <br  />
</p>
<dl class="section user"><dt>See Also:</dt><dd><a class="el" href="group__m17nSymbol.html#gaf0e0b5b8e6e0702ed87df88ad642d7f7" title="Set the value (function pointer) of a symbol property.">msymbol_put_func()</a>, <a class="el" href="group__m17nSymbol.html#ga6446566f8f6a53e825cea16ffbf4c3bd" title="Get the value (function pointer) of a symbol property.">msymbol_get_func()</a>, <a class="el" href="group__m17nPlist.html#gab1654476aef37dbea02c56476353ab8e" title="Set the value (function pointer) of a property in a property list.">mplist_put_func()</a>, <a class="el" href="group__m17nPlist.html#ga215ddb45ee970edbee7ff2e2e6bc1e8d" title="Get the value (function pointer) of a property in a property list.">mplist_get_func()</a>. <br  />
 </dd></dl>

</div>
</div>
</div><!-- contents -->
<hr>
<ADDRESS>
<a href="http://www.m17n.org/m17n-lib-en/index.html" target="mulewindow"><img src="parrot.png" align=bottom alt="m17n-lib Home" border=0></a>
</ADDRESS>
</body>
</HTML>
<!-- Copyright information
Copyright (C) 2001 Information-technology Promotion Agency (IPA)
Copyright (C) 2001-2011
  National Institute of Advanced Industrial Science and Technology (AIST)
This file is part of the m17n library documentation.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Section, no Front-Cover Texts,
and no Back-Cover Texts.  A copy of the license is included in the
appendix entitled "GNU Free Documentation License".
-->