aboutsummaryrefslogtreecommitdiff
path: root/doc/html/php__isis_8h_source.html
blob: 3e124deae684f7dda0ab311530e119bf39b2546e (plain)
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
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>IsisReader: contrib/pecl-isis/php_isis.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    </ul>
  </div>
<h1>contrib/pecl-isis/php_isis.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">Copyright (c) 2003, Braulio Jos� Solano Rojas, OpenIsis Verein</span>
<a name="l00004"></a>00004 <span class="comment">All rights reserved.</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">Redistribution and use in source and binary forms, with or without modification, are</span>
<a name="l00007"></a>00007 <span class="comment">permitted provided that the following conditions are met:</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">*       Redistributions of source code must retain the above copyright notice, this list of</span>
<a name="l00010"></a>00010 <span class="comment">        conditions and the following disclaimer.</span>
<a name="l00011"></a>00011 <span class="comment">*       Redistributions in binary form must reproduce the above copyright notice, this list of</span>
<a name="l00012"></a>00012 <span class="comment">        conditions and the following disclaimer in the documentation and/or other materials</span>
<a name="l00013"></a>00013 <span class="comment">        provided with the distribution.</span>
<a name="l00014"></a>00014 <span class="comment">*       Neither the name of the &quot;OpenIsis Verein&quot; nor the names of its contributors may</span>
<a name="l00015"></a>00015 <span class="comment">        be used to endorse or promote products derived from this software without specific</span>
<a name="l00016"></a>00016 <span class="comment">        prior written permission.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND</span>
<a name="l00019"></a>00019 <span class="comment">CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES,</span>
<a name="l00020"></a>00020 <span class="comment">INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF</span>
<a name="l00021"></a>00021 <span class="comment">MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span>
<a name="l00022"></a>00022 <span class="comment">DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span>
<a name="l00023"></a>00023 <span class="comment">CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
<a name="l00024"></a>00024 <span class="comment">SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT</span>
<a name="l00025"></a>00025 <span class="comment">NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span>
<a name="l00026"></a>00026 <span class="comment">LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span>
<a name="l00027"></a>00027 <span class="comment">HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span>
<a name="l00028"></a>00028 <span class="comment">CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span>
<a name="l00029"></a>00029 <span class="comment">OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,</span>
<a name="l00030"></a>00030 <span class="comment">EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment">*/</span>
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="preprocessor">#ifndef PHP_ISIS_H</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#define PHP_ISIS_H</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>
<a name="l00037"></a>00037 <span class="keyword">extern</span> zend_module_entry isis_module_entry;
<a name="l00038"></a>00038 <span class="preprocessor">#define phpext_isis_ptr &amp;isis_module_entry</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#ifdef PHP_WIN32</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define PHP_ISIS_API __declspec(dllexport)</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define PHP_ISIS_API</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046 <span class="preprocessor">#ifdef ZTS</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#include &quot;TSRM.h&quot;</span>
<a name="l00048"></a>00048 <span class="preprocessor">#endif</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>
<a name="l00050"></a>00050 <span class="preprocessor">#include &quot;openisis.h&quot;</span>
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 <span class="comment">/* Resources types */</span>
<a name="l00053"></a><a class="code" href="structisis__result.html">00053</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055         <span class="keywordtype">long</span> index;
<a name="l00056"></a>00056         <a class="code" href="structOpenIsisSet.html">OpenIsisSet</a> <span class="keyword">set</span>;
<a name="l00057"></a>00057         <span class="keywordtype">int</span> dbid;
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059 <a class="code" href="structisis__result.html">isis_result</a>;
<a name="l00060"></a>00060 
<a name="l00061"></a><a class="code" href="structisis__dbid.html">00061</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063         <span class="keywordtype">int</span> id;
<a name="l00064"></a>00064         <span class="keywordtype">char</span> *dbname;
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066 <a class="code" href="structisis__dbid.html">isis_dbid</a>;
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 
<a name="l00069"></a>00069 ZEND_MINIT_FUNCTION(isis);
<a name="l00070"></a>00070 ZEND_MSHUTDOWN_FUNCTION(isis);
<a name="l00071"></a>00071 ZEND_RINIT_FUNCTION(isis);
<a name="l00072"></a>00072 ZEND_RSHUTDOWN_FUNCTION(isis);
<a name="l00073"></a>00073 ZEND_MINFO_FUNCTION(isis);
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 <span class="comment">/* Functions */</span>
<a name="l00076"></a>00076 ZEND_FUNCTION(isis_open);
<a name="l00077"></a>00077 ZEND_FUNCTION(isis_close);
<a name="l00078"></a>00078 ZEND_FUNCTION(isis_search);
<a name="l00079"></a>00079 ZEND_FUNCTION(isis_query);
<a name="l00080"></a>00080 ZEND_FUNCTION(isis_terms);
<a name="l00081"></a>00081 ZEND_FUNCTION(isis_fetch_array);
<a name="l00082"></a>00082 ZEND_FUNCTION(isis_fetch_flat_array);
<a name="l00083"></a>00083 ZEND_FUNCTION(isis_fetch_flat_array_from_mfn);
<a name="l00084"></a>00084 ZEND_FUNCTION(isis_num_rows);
<a name="l00085"></a>00085 ZEND_FUNCTION(isis_data_seek);
<a name="l00086"></a>00086 ZEND_FUNCTION(isis_mfn_data_seek);
<a name="l00087"></a>00087 ZEND_FUNCTION(isis_free_result);
<a name="l00088"></a>00088 ZEND_FUNCTION(isis_write);
<a name="l00089"></a>00089 ZEND_FUNCTION(isis_last_mfn);
<a name="l00090"></a>00090 <span class="keyword">static</span> <span class="keywordtype">void</span> isis_result_destructor(<a class="code" href="structisis__result.html">isis_result</a> *result);
<a name="l00091"></a>00091 <span class="keyword">static</span> <span class="keywordtype">void</span> isis_dbid_destructor(<a class="code" href="structisis__dbid.html">isis_dbid</a> *dbid);
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 ZEND_BEGIN_MODULE_GLOBALS(isis)
<a name="l00094"></a>00094         char *default_dir;
<a name="l00095"></a>00095         <span class="keywordtype">char</span> *default_database;
<a name="l00096"></a>00096 ZEND_END_MODULE_GLOBALS(isis)
<a name="l00097"></a>00097 
<a name="l00098"></a>00098 <span class="comment">/* In every utility function you add that needs to use variables</span>
<a name="l00099"></a>00099 <span class="comment">   in php_isis_globals, call TSRM_FETCH(); after declaring other</span>
<a name="l00100"></a>00100 <span class="comment">   variables used by that function, or better yet, pass in TSRMG_CC</span>
<a name="l00101"></a>00101 <span class="comment">   after the last function argument and declare your utility function</span>
<a name="l00102"></a>00102 <span class="comment">   with TSRMG_DC after the last declared argument.  Always refer to</span>
<a name="l00103"></a>00103 <span class="comment">   the globals in your function as ISIS_G(variable).  You are</span>
<a name="l00104"></a>00104 <span class="comment">   encouraged to rename these macros something shorter, see</span>
<a name="l00105"></a>00105 <span class="comment">   examples in any other php module directory.</span>
<a name="l00106"></a>00106 <span class="comment">*/</span>
<a name="l00107"></a>00107 
<a name="l00108"></a>00108 <span class="preprocessor">#ifdef ZTS</span>
<a name="l00109"></a>00109 <span class="preprocessor"></span><span class="preprocessor">#define ISIS_G(v) TSRMG(isis_globals_id, zend_isis_globals *, v)</span>
<a name="l00110"></a>00110 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span><span class="preprocessor">#define ISIS_G(v) (isis_globals.v)</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span>
<a name="l00114"></a>00114 <span class="preprocessor">#endif  </span><span class="comment">/* PHP_ISIS_H */</span>
<a name="l00115"></a>00115 
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 <span class="comment">/*</span>
<a name="l00118"></a>00118 <span class="comment"> * Local variables:</span>
<a name="l00119"></a>00119 <span class="comment"> * tab-width: 4</span>
<a name="l00120"></a>00120 <span class="comment"> * c-basic-offset: 4</span>
<a name="l00121"></a>00121 <span class="comment"> * indent-tabs-mode: t</span>
<a name="l00122"></a>00122 <span class="comment"> * End:</span>
<a name="l00123"></a>00123 <span class="comment"> */</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Mar 30 14:47:13 2010 for IsisReader by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>