Files
ortools-clone/docs/cpp/jniutil_8h_source.html
2021-01-26 11:34:47 +01:00

181 lines
18 KiB
HTML

<!-- HTML header for doxygen 1.8.18-->
<!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>OR-Tools: jniutil.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>
<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" />
<link href="styleSheet.tmp.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="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">8.2</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 -->
<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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('jniutil_8h_source.html',''); initResizable(); });
/* @license-end */
</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">jniutil.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="jniutil_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>&#160;<span class="comment">// Copyright 2010-2018 Google LLC</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#ifndef OR_TOOLS_BASE_JNIUTIL_H_</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define OR_TOOLS_BASE_JNIUTIL_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;jni.h&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="class_j_n_i_util.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_j_n_i_util.html">JNIUtil</a> {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// Creates a Java jstring from a null-terminated UTF-8 encoded C String.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">// The caller must delete the jstring reference.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="class_j_n_i_util.html#afe22e1d61c504c8826aaa1dc2a58218b"> 27</a></span>&#160; <span class="keyword">static</span> jstring <a class="code" href="class_j_n_i_util.html#afe22e1d61c504c8826aaa1dc2a58218b">MakeJString</a>(JNIEnv* env, <span class="keyword">const</span> <span class="keywordtype">char</span>* cstr) {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">if</span> (cstr == NULL) <span class="keywordflow">return</span> NULL;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">return</span> env-&gt;NewStringUTF(cstr);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; }</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="comment">// Creates a null-terminated UTF-8 encoded C string from a jstring.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// The returned string should be &quot;delete[]&quot;-ed when no longer needed.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_j_n_i_util.html#a3387a526bd53b5a94510ccdc035a7710"> 34</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">char</span>* <a class="code" href="class_j_n_i_util.html#a3387a526bd53b5a94510ccdc035a7710">MakeCString</a>(JNIEnv* env, jstring str) {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">if</span> (str == NULL) <span class="keywordflow">return</span> NULL;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; jsize length = env-&gt;GetStringUTFLength(str);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* src = env-&gt;GetStringUTFChars(str, NULL);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">char</span>* dst = <span class="keyword">new</span> <span class="keywordtype">char</span>[length + 1];</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; memcpy(dst, src, length);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; dst[length] = <span class="charliteral">&#39;\0&#39;</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; env-&gt;ReleaseStringUTFChars(str, src);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> dst;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// Creates a new char array from a jbyteArray.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// The caller must delete[] the returned array.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="class_j_n_i_util.html#a6f5db428a454e2baf7edc4e6efad313b"> 47</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">char</span>* <a class="code" href="class_j_n_i_util.html#a6f5db428a454e2baf7edc4e6efad313b">MakeCharArray</a>(JNIEnv* env, jbyteArray <a class="code" href="constraint__solver_2table_8cc.html#af730895c6c6ef6e03caaf6251192dfd2">a</a>, <span class="keywordtype">int</span>* size) {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; jsize n = env-&gt;GetArrayLength(<a class="code" href="constraint__solver_2table_8cc.html#af730895c6c6ef6e03caaf6251192dfd2">a</a>);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; *size = n;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; jbyte* jba = <span class="keyword">new</span> jbyte[n];</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; env-&gt;GetByteArrayRegion(<a class="code" href="constraint__solver_2table_8cc.html#af730895c6c6ef6e03caaf6251192dfd2">a</a>, 0, n, jba);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">// We make use of the fact that jbyte&#39;s are really just chars.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// If this changes (different VM, etc.) things will break.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span><span class="keywordtype">char</span>*<span class="keyword">&gt;</span>(jba);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">// Produces a jbyteArray from a char array.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="class_j_n_i_util.html#a2224bd53075f9bdb75729359d470e6f9"> 59</a></span>&#160; <span class="keyword">static</span> jbyteArray <a class="code" href="class_j_n_i_util.html#a2224bd53075f9bdb75729359d470e6f9">MakeJByteArray</a>(JNIEnv* env, <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="constraint__solver_2table_8cc.html#af730895c6c6ef6e03caaf6251192dfd2">a</a>, <span class="keywordtype">int</span> size) {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="comment">// Create empty array object</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; jbyteArray output = env-&gt;NewByteArray(size);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// Fill it</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; env-&gt;SetByteArrayRegion(output, 0, size, <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span>jbyte*<span class="keyword">&gt;</span>(<a class="code" href="constraint__solver_2table_8cc.html#af730895c6c6ef6e03caaf6251192dfd2">a</a>));</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">return</span> output;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; }</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;};</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_BASE_JNIUTIL_H_</span></div>
<div class="ttc" id="abase_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="aclass_j_n_i_util_html"><div class="ttname"><a href="class_j_n_i_util.html">JNIUtil</a></div><div class="ttdef"><b>Definition:</b> <a href="jniutil_8h_source.html#l00023">jniutil.h:23</a></div></div>
<div class="ttc" id="aclass_j_n_i_util_html_a2224bd53075f9bdb75729359d470e6f9"><div class="ttname"><a href="class_j_n_i_util.html#a2224bd53075f9bdb75729359d470e6f9">JNIUtil::MakeJByteArray</a></div><div class="ttdeci">static jbyteArray MakeJByteArray(JNIEnv *env, const char *a, int size)</div><div class="ttdef"><b>Definition:</b> <a href="jniutil_8h_source.html#l00059">jniutil.h:59</a></div></div>
<div class="ttc" id="aclass_j_n_i_util_html_a3387a526bd53b5a94510ccdc035a7710"><div class="ttname"><a href="class_j_n_i_util.html#a3387a526bd53b5a94510ccdc035a7710">JNIUtil::MakeCString</a></div><div class="ttdeci">static char * MakeCString(JNIEnv *env, jstring str)</div><div class="ttdef"><b>Definition:</b> <a href="jniutil_8h_source.html#l00034">jniutil.h:34</a></div></div>
<div class="ttc" id="aclass_j_n_i_util_html_a6f5db428a454e2baf7edc4e6efad313b"><div class="ttname"><a href="class_j_n_i_util.html#a6f5db428a454e2baf7edc4e6efad313b">JNIUtil::MakeCharArray</a></div><div class="ttdeci">static char * MakeCharArray(JNIEnv *env, jbyteArray a, int *size)</div><div class="ttdef"><b>Definition:</b> <a href="jniutil_8h_source.html#l00047">jniutil.h:47</a></div></div>
<div class="ttc" id="aclass_j_n_i_util_html_afe22e1d61c504c8826aaa1dc2a58218b"><div class="ttname"><a href="class_j_n_i_util.html#afe22e1d61c504c8826aaa1dc2a58218b">JNIUtil::MakeJString</a></div><div class="ttdeci">static jstring MakeJString(JNIEnv *env, const char *cstr)</div><div class="ttdef"><b>Definition:</b> <a href="jniutil_8h_source.html#l00027">jniutil.h:27</a></div></div>
<div class="ttc" id="aconstraint__solver_2table_8cc_html_af730895c6c6ef6e03caaf6251192dfd2"><div class="ttname"><a href="constraint__solver_2table_8cc.html#af730895c6c6ef6e03caaf6251192dfd2">a</a></div><div class="ttdeci">int64 a</div><div class="ttdef"><b>Definition:</b> <a href="constraint__solver_2table_8cc_source.html#l00042">constraint_solver/table.cc:42</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_8f9dc966244f4c6e9b2fa0dee1e4ef1a.html">base</a></li><li class="navelem"><a class="el" href="jniutil_8h.html">jniutil.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.9.1 </li>
</ul>
</div>
</body>
</html>