138 lines
44 KiB
HTML
138 lines
44 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.8.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: gscip_message_handler.cc 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">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</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
|
|
 <span id="projectnumber">9.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('gscip__message__handler_8cc_source.html','');});
|
|
/* @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">gscip_message_handler.cc</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="gscip__message__handler_8cc.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">// Copyright 2010-2021 Google LLC</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <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> <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> <span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <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> <span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="gscip__message__handler_8h.html">ortools/gscip/gscip_message_handler.h</a>"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <stdio.h></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "absl/status/statusor.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="scip__helper__macros_8h.html">ortools/linear_solver/scip_helper_macros.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "scip/pub_message.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "scip/type_message.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// This is an incomplete SCIP struct meant to be fully defined by SCIP users.</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="struct_s_c_i_p___messagehdlr_data.html"> 28</a></span> <span class="keyword">struct </span><a class="code" href="struct_s_c_i_p___messagehdlr_data.html">SCIP_MessagehdlrData</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="struct_s_c_i_p___messagehdlr_data.html#a5fe24b87ed3ef5aec1a017d3b38094fe"> 29</a></span>  <span class="keyword">explicit</span> <a class="code" href="struct_s_c_i_p___messagehdlr_data.html#a5fe24b87ed3ef5aec1a017d3b38094fe">SCIP_MessagehdlrData</a>(</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">const</span> <a class="code" href="namespaceoperations__research.html#a2899c1afc60224e18c3d9d4a95c5064e">operations_research::GScipMessageHandler</a> <a class="code" href="struct_s_c_i_p___messagehdlr_data.html#aa938c4d35726f7670238b00c73cfddb2">gscip_message_handler</a>)</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  : <a class="code" href="struct_s_c_i_p___messagehdlr_data.html#aa938c4d35726f7670238b00c73cfddb2">gscip_message_handler</a>(<a class="code" href="base_2logging_8h.html#aeef651f886eb5252c08835194213efe2">ABSL_DIE_IF_NULL</a>(<a class="code" href="struct_s_c_i_p___messagehdlr_data.html#aa938c4d35726f7670238b00c73cfddb2">gscip_message_handler</a>)) {}</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// This will be set to true by ScopedSCIPMessageHandlerDisabler when</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// GScip::Solve() returns. We use an atomic here since SCIP can be</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// multi-threaded.</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="struct_s_c_i_p___messagehdlr_data.html#a23a6eca8a8b09f8bb1c8f49056f427b5"> 36</a></span>  std::atomic<bool> <a class="code" href="struct_s_c_i_p___messagehdlr_data.html#a23a6eca8a8b09f8bb1c8f49056f427b5">disabled</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="struct_s_c_i_p___messagehdlr_data.html#aa938c4d35726f7670238b00c73cfddb2"> 38</a></span>  <span class="keyword">const</span> <a class="code" href="namespaceoperations__research.html#a2899c1afc60224e18c3d9d4a95c5064e">operations_research::GScipMessageHandler</a> <a class="code" href="struct_s_c_i_p___messagehdlr_data.html#aa938c4d35726f7670238b00c73cfddb2">gscip_message_handler</a>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> };</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">namespace </span><a class="code" href="namespaceinternal.html">internal</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">namespace </span>{</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// Equivalent to SCIP_DECL_MESSAGEHDLRFREE(SCIPMessageHandlerFree).</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> SCIP_RETCODE SCIPMessageHandlerFree(SCIP_MESSAGEHDLR* <span class="keyword">const</span> handler) {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="struct_s_c_i_p___messagehdlr_data.html">SCIP_MessagehdlrData</a>* <span class="keyword">const</span> data = SCIPmessagehdlrGetData(handler);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">delete</span> data;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="base_2logging_8h.html#a7c0ce053b28d53aa4eaf3eb7fb71663b">CHECK_EQ</a>(SCIPmessagehdlrSetData(handler, <span class="keyword">nullptr</span>), SCIP_OKAY);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> SCIP_OKAY;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Shared function used by all three implementations below.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">void</span> SCIPMessageHandlerPrinter(<span class="keyword">const</span> <a class="code" href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982">GScipMessageType</a> message_type,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  SCIP_MESSAGEHDLR* <span class="keyword">const</span> handler,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>) {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// Contrary to SCIP's documentation, the code of handleMessage() in</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// src/scip/message.c never calls the handler functions when its input `msg`</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// is NULL.</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a>(<a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a> != <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="struct_s_c_i_p___messagehdlr_data.html">SCIP_MessagehdlrData</a>* <span class="keyword">const</span> data = SCIPmessagehdlrGetData(handler);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">if</span> (data-><a class="code" href="struct_s_c_i_p___messagehdlr_data.html#a23a6eca8a8b09f8bb1c8f49056f427b5">disabled</a>) {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="base_2logging_8h.html#accad43a85d781d53381cd53a9894b6ae">LOG</a>(<a class="code" href="log__severity_8h.html#ac9bcbe19995a8140cd4ec61773cd6e67">ERROR</a>) << <span class="stringliteral">"Unexpected SCIP message: "</span> << <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// We ignore empty messages. The implementation of handleMessage() in</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// src/scip/message.c calls this function with an empty message when the</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// handler's buffer is flushed but was empty.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">//</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// This typically happenbs when the handler is freed since messagehdlrFree()</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// calls messagePrintWarning(), messagePrintDialog() and messagePrintInfo()</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// will NULL message just before calling the handler free function (which is</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// SCIPMessageHandlerFree() above). So this function is usually called three</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// times when the custom handler is freed. There is no need to redirect these</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// useless calls to the gscip_message_handler user function.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">//</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// Note that we do this test only in the `!disabled` branch since we want to</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// detect cases of unexpected calls even with empty messages in the other</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// branch.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">if</span> (<a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>[0] == <span class="charliteral">'\0'</span>) {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  data-><a class="code" href="struct_s_c_i_p___messagehdlr_data.html#aa938c4d35726f7670238b00c73cfddb2">gscip_message_handler</a>(<a class="code" href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982afe3f540d315882ec4f18def8e100f446">GScipMessageType::kInfoMessage</a>, <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> }</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// Equivalent to SCIP_DECL_MESSAGEINFO(SCIPMessageHandlerInfo).</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">void</span> SCIPMessageHandlerInfo(SCIP_MESSAGEHDLR* <span class="keyword">const</span> handler, FILE*,</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>) {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  SCIPMessageHandlerPrinter(<a class="code" href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982afe3f540d315882ec4f18def8e100f446">GScipMessageType::kInfoMessage</a>, handler, <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// Equivalent to SCIP_DECL_MESSAGEDIALOG(SCIPMessageHandlerDialog).</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">void</span> SCIPMessageHandlerDialog(SCIP_MESSAGEHDLR* <span class="keyword">const</span> handler, FILE*,</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>) {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  SCIPMessageHandlerPrinter(<a class="code" href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982a56673af8302b6d4c940c046bf94a0d30">GScipMessageType::kDialogMessage</a>, handler, <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// Equivalent to SCIP_DECL_MESSAGEWARNING(SCIPMessageHandlerWarning).</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">void</span> SCIPMessageHandlerWarning(SCIP_MESSAGEHDLR* <span class="keyword">const</span> handler, FILE*,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>) {</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  SCIPMessageHandlerPrinter(<a class="code" href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982a706708cd9a814cabf8a83ed922629e57">GScipMessageType::kWarningMessage</a>, handler,</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> } <span class="comment">// namespace</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="structoperations__research_1_1internal_1_1_release_s_c_i_p_message_handler.html#a9e3c0a531833b981e951732fae5ef855"> 109</a></span> <span class="keywordtype">void</span> <a class="code" href="structoperations__research_1_1internal_1_1_release_s_c_i_p_message_handler.html#a9e3c0a531833b981e951732fae5ef855">ReleaseSCIPMessageHandler::operator()</a>(SCIP_MESSAGEHDLR* handler)<span class="keyword"> const </span>{</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">if</span> (handler != <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="base_2logging_8h.html#a7c0ce053b28d53aa4eaf3eb7fb71663b">CHECK_EQ</a>(SCIPmessagehdlrRelease(&handler), SCIP_OKAY);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1internal.html#a84d9f77b34f5e4c84d94ab189fe3b723"> 115</a></span> <a class="code" href="namespaceoperations__research_1_1internal.html#a6fbd1395eee3ec0c87ef3f1eded2a5d4">MessageHandlerPtr</a> <a class="code" href="namespaceoperations__research_1_1internal.html#a84d9f77b34f5e4c84d94ab189fe3b723">CaptureMessageHandlerPtr</a>(SCIP_MESSAGEHDLR* <span class="keyword">const</span> handler) {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">if</span> (handler != <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  SCIPmessagehdlrCapture(handler);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceoperations__research_1_1internal.html#a6fbd1395eee3ec0c87ef3f1eded2a5d4">MessageHandlerPtr</a>(handler);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> }</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1internal.html#a107e5a31c5391197d0e9d51c3693895d"> 122</a></span> absl::StatusOr<MessageHandlerPtr> <a class="code" href="namespaceoperations__research_1_1internal.html#a107e5a31c5391197d0e9d51c3693895d">MakeSCIPMessageHandler</a>(</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">const</span> <a class="code" href="namespaceoperations__research.html#a2899c1afc60224e18c3d9d4a95c5064e">GScipMessageHandler</a> gscip_message_handler) {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="comment">// We use a unique_ptr here to make sure we delete the data if</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="comment">// SCIPmessagehdlrCreate() fails.</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">auto</span> data = std::make_unique<SCIP_MessagehdlrData>(gscip_message_handler);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  SCIP_MESSAGEHDLR* message_handler = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <a class="code" href="scip__helper__macros_8h.html#a0bfa86b99ad635aeb448799ddf03cb1c">RETURN_IF_SCIP_ERROR</a>(</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  SCIPmessagehdlrCreate(&message_handler,</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment">/*bufferedoutput=*/</span><span class="keyword">true</span>,</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="comment">/*filename=*/</span><span class="keyword">nullptr</span>,</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment">/*quiet=*/</span><span class="keyword">false</span>,</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="comment">/*messagewarning=*/</span>SCIPMessageHandlerWarning,</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="comment">/*messagedialog=*/</span>SCIPMessageHandlerDialog,</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment">/*messageinfo=*/</span>SCIPMessageHandlerInfo,</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="comment">/*messagehdlrfree=*/</span>SCIPMessageHandlerFree,</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment">/*messagehdlrdata=*/</span>data.get()));</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="comment">// SCIPmessagehdlrCreate() succeeded, we disable the deletion of the data by</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="comment">// the unique_ptr since the ownership has been transferred to SCIP.</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  data.release();</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceoperations__research_1_1internal.html#a6fbd1395eee3ec0c87ef3f1eded2a5d4">MessageHandlerPtr</a>(message_handler);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> }</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="classoperations__research_1_1internal_1_1_scoped_s_c_i_p_message_handler_disabler.html#a3a0de98ecc7819bffb95f62522e316de"> 146</a></span> <a class="code" href="classoperations__research_1_1internal_1_1_scoped_s_c_i_p_message_handler_disabler.html#a3a0de98ecc7819bffb95f62522e316de">ScopedSCIPMessageHandlerDisabler::ScopedSCIPMessageHandlerDisabler</a>(</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">const</span> <a class="code" href="namespaceoperations__research_1_1internal.html#a6fbd1395eee3ec0c87ef3f1eded2a5d4">MessageHandlerPtr</a>& handler)</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  : <a class="code" href="interval_8cc.html#addaf89e29c8752c2df3ca372153236fc">handler_</a>(handler) {}</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="classoperations__research_1_1internal_1_1_scoped_s_c_i_p_message_handler_disabler.html#a5d33eb150375654a5cf86bfc19d74bba"> 150</a></span> <a class="code" href="classoperations__research_1_1internal_1_1_scoped_s_c_i_p_message_handler_disabler.html#a5d33eb150375654a5cf86bfc19d74bba">ScopedSCIPMessageHandlerDisabler::~ScopedSCIPMessageHandlerDisabler</a>() {</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordflow">if</span> (handler_ != <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="comment">// Note that SCIPmessagehdlrGetData is a macro in optimized builds and a</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="comment">// function in debug ones. Hence here we assign the result to a variable</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="comment">// instead of chaining the calls.</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <a class="code" href="struct_s_c_i_p___messagehdlr_data.html">SCIP_MessagehdlrData</a>* <span class="keyword">const</span> data = SCIPmessagehdlrGetData(handler_.get());</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  data-><a class="code" href="struct_s_c_i_p___messagehdlr_data.html#a23a6eca8a8b09f8bb1c8f49056f427b5">disabled</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  }</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> }</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> } <span class="comment">// namespace internal</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> } <span class="comment">// namespace operations_research</span></div><div class="ttc" id="namespaceoperations__research_html_ab05776694f43218498fa4ccdbd8cf982a56673af8302b6d4c940c046bf94a0d30"><div class="ttname"><a href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982a56673af8302b6d4c940c046bf94a0d30">operations_research::GScipMessageType::kDialogMessage</a></div></div>
|
|
<div class="ttc" id="base_2logging_8h_html_a3e1cfef60e774a81f30eaddf26a3a274"><div class="ttname"><a href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a></div><div class="ttdeci">#define CHECK(condition)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00491">base/logging.h:491</a></div></div>
|
|
<div class="ttc" id="gscip__message__handler_8h_html"><div class="ttname"><a href="gscip__message__handler_8h.html">gscip_message_handler.h</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_1_1internal_html_a84d9f77b34f5e4c84d94ab189fe3b723"><div class="ttname"><a href="namespaceoperations__research_1_1internal.html#a84d9f77b34f5e4c84d94ab189fe3b723">operations_research::internal::CaptureMessageHandlerPtr</a></div><div class="ttdeci">MessageHandlerPtr CaptureMessageHandlerPtr(SCIP_MESSAGEHDLR *const handler)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00115">gscip_message_handler.cc:115</a></div></div>
|
|
<div class="ttc" id="structoperations__research_1_1internal_1_1_release_s_c_i_p_message_handler_html_a9e3c0a531833b981e951732fae5ef855"><div class="ttname"><a href="structoperations__research_1_1internal_1_1_release_s_c_i_p_message_handler.html#a9e3c0a531833b981e951732fae5ef855">operations_research::internal::ReleaseSCIPMessageHandler::operator()</a></div><div class="ttdeci">void operator()(SCIP_MESSAGEHDLR *handler) const</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00109">gscip_message_handler.cc:109</a></div></div>
|
|
<div class="ttc" id="log__severity_8h_html_ac9bcbe19995a8140cd4ec61773cd6e67"><div class="ttname"><a href="log__severity_8h.html#ac9bcbe19995a8140cd4ec61773cd6e67">ERROR</a></div><div class="ttdeci">const int ERROR</div><div class="ttdef"><b>Definition:</b> <a href="log__severity_8h_source.html#l00032">log_severity.h:32</a></div></div>
|
|
<div class="ttc" id="struct_s_c_i_p___messagehdlr_data_html_a5fe24b87ed3ef5aec1a017d3b38094fe"><div class="ttname"><a href="struct_s_c_i_p___messagehdlr_data.html#a5fe24b87ed3ef5aec1a017d3b38094fe">SCIP_MessagehdlrData::SCIP_MessagehdlrData</a></div><div class="ttdeci">SCIP_MessagehdlrData(const operations_research::GScipMessageHandler gscip_message_handler)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00029">gscip_message_handler.cc:29</a></div></div>
|
|
<div class="ttc" id="base_2logging_8h_html_accad43a85d781d53381cd53a9894b6ae"><div class="ttname"><a href="base_2logging_8h.html#accad43a85d781d53381cd53a9894b6ae">LOG</a></div><div class="ttdeci">#define LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00416">base/logging.h:416</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_1_1internal_html_a107e5a31c5391197d0e9d51c3693895d"><div class="ttname"><a href="namespaceoperations__research_1_1internal.html#a107e5a31c5391197d0e9d51c3693895d">operations_research::internal::MakeSCIPMessageHandler</a></div><div class="ttdeci">absl::StatusOr< MessageHandlerPtr > MakeSCIPMessageHandler(const GScipMessageHandler gscip_message_handler)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00122">gscip_message_handler.cc:122</a></div></div>
|
|
<div class="ttc" id="interval_8cc_html_addaf89e29c8752c2df3ca372153236fc"><div class="ttname"><a href="interval_8cc.html#addaf89e29c8752c2df3ca372153236fc">handler_</a></div><div class="ttdeci">Handler handler_</div><div class="ttdef"><b>Definition:</b> <a href="interval_8cc_source.html#l00429">interval.cc:429</a></div></div>
|
|
<div class="ttc" id="struct_s_c_i_p___messagehdlr_data_html_aa938c4d35726f7670238b00c73cfddb2"><div class="ttname"><a href="struct_s_c_i_p___messagehdlr_data.html#aa938c4d35726f7670238b00c73cfddb2">SCIP_MessagehdlrData::gscip_message_handler</a></div><div class="ttdeci">const operations_research::GScipMessageHandler gscip_message_handler</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00038">gscip_message_handler.cc:38</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html_ab05776694f43218498fa4ccdbd8cf982"><div class="ttname"><a href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982">operations_research::GScipMessageType</a></div><div class="ttdeci">GScipMessageType</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8h_source.html#l00028">gscip_message_handler.h:28</a></div></div>
|
|
<div class="ttc" id="classoperations__research_1_1internal_1_1_scoped_s_c_i_p_message_handler_disabler_html_a3a0de98ecc7819bffb95f62522e316de"><div class="ttname"><a href="classoperations__research_1_1internal_1_1_scoped_s_c_i_p_message_handler_disabler.html#a3a0de98ecc7819bffb95f62522e316de">operations_research::internal::ScopedSCIPMessageHandlerDisabler::ScopedSCIPMessageHandlerDisabler</a></div><div class="ttdeci">ScopedSCIPMessageHandlerDisabler(const MessageHandlerPtr &handler)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00146">gscip_message_handler.cc:146</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html_ab05776694f43218498fa4ccdbd8cf982a706708cd9a814cabf8a83ed922629e57"><div class="ttname"><a href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982a706708cd9a814cabf8a83ed922629e57">operations_research::GScipMessageType::kWarningMessage</a></div></div>
|
|
<div class="ttc" id="trace_8cc_html_a36bd74109f547f7f8198faf5a12d2879"><div class="ttname"><a href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a></div><div class="ttdeci">std::string message</div><div class="ttdef"><b>Definition:</b> <a href="trace_8cc_source.html#l00398">trace.cc:398</a></div></div>
|
|
<div class="ttc" id="base_2logging_8h_html_a7c0ce053b28d53aa4eaf3eb7fb71663b"><div class="ttname"><a href="base_2logging_8h.html#a7c0ce053b28d53aa4eaf3eb7fb71663b">CHECK_EQ</a></div><div class="ttdeci">#define CHECK_EQ(val1, val2)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00698">base/logging.h:698</a></div></div>
|
|
<div class="ttc" id="scip__helper__macros_8h_html_a0bfa86b99ad635aeb448799ddf03cb1c"><div class="ttname"><a href="scip__helper__macros_8h.html#a0bfa86b99ad635aeb448799ddf03cb1c">RETURN_IF_SCIP_ERROR</a></div><div class="ttdeci">#define RETURN_IF_SCIP_ERROR(x)</div><div class="ttdef"><b>Definition:</b> <a href="scip__helper__macros_8h_source.html#l00043">scip_helper_macros.h:43</a></div></div>
|
|
<div class="ttc" id="classoperations__research_1_1internal_1_1_scoped_s_c_i_p_message_handler_disabler_html_a5d33eb150375654a5cf86bfc19d74bba"><div class="ttname"><a href="classoperations__research_1_1internal_1_1_scoped_s_c_i_p_message_handler_disabler.html#a5d33eb150375654a5cf86bfc19d74bba">operations_research::internal::ScopedSCIPMessageHandlerDisabler::~ScopedSCIPMessageHandlerDisabler</a></div><div class="ttdeci">~ScopedSCIPMessageHandlerDisabler()</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00150">gscip_message_handler.cc:150</a></div></div>
|
|
<div class="ttc" id="base_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
|
|
<div class="ttc" id="struct_s_c_i_p___messagehdlr_data_html"><div class="ttname"><a href="struct_s_c_i_p___messagehdlr_data.html">SCIP_MessagehdlrData</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00028">gscip_message_handler.cc:28</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_1_1internal_html_a6fbd1395eee3ec0c87ef3f1eded2a5d4"><div class="ttname"><a href="namespaceoperations__research_1_1internal.html#a6fbd1395eee3ec0c87ef3f1eded2a5d4">operations_research::internal::MessageHandlerPtr</a></div><div class="ttdeci">std::unique_ptr< SCIP_MESSAGEHDLR, ReleaseSCIPMessageHandler > MessageHandlerPtr</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8h_source.html#l00055">gscip_message_handler.h:55</a></div></div>
|
|
<div class="ttc" id="namespaceinternal_html"><div class="ttname"><a href="namespaceinternal.html">internal</a></div><div class="ttdef"><b>Definition:</b> <a href="bop__parameters_8pb_8h_source.html#l00039">bop_parameters.pb.h:39</a></div></div>
|
|
<div class="ttc" id="struct_s_c_i_p___messagehdlr_data_html_a23a6eca8a8b09f8bb1c8f49056f427b5"><div class="ttname"><a href="struct_s_c_i_p___messagehdlr_data.html#a23a6eca8a8b09f8bb1c8f49056f427b5">SCIP_MessagehdlrData::disabled</a></div><div class="ttdeci">std::atomic< bool > disabled</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8cc_source.html#l00036">gscip_message_handler.cc:36</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</a></div></div>
|
|
<div class="ttc" id="scip__helper__macros_8h_html"><div class="ttname"><a href="scip__helper__macros_8h.html">scip_helper_macros.h</a></div></div>
|
|
<div class="ttc" id="base_2logging_8h_html_aeef651f886eb5252c08835194213efe2"><div class="ttname"><a href="base_2logging_8h.html#aeef651f886eb5252c08835194213efe2">ABSL_DIE_IF_NULL</a></div><div class="ttdeci">#define ABSL_DIE_IF_NULL</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00041">base/logging.h:41</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html_ab05776694f43218498fa4ccdbd8cf982afe3f540d315882ec4f18def8e100f446"><div class="ttname"><a href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982afe3f540d315882ec4f18def8e100f446">operations_research::GScipMessageType::kInfoMessage</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html_a2899c1afc60224e18c3d9d4a95c5064e"><div class="ttname"><a href="namespaceoperations__research.html#a2899c1afc60224e18c3d9d4a95c5064e">operations_research::GScipMessageHandler</a></div><div class="ttdeci">std::function< void(GScipMessageType type, absl::string_view message)> GScipMessageHandler</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8h_source.html#l00037">gscip_message_handler.h:37</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_7ebe005d782fae78e581b12d74364053.html">gscip</a></li><li class="navelem"><a class="el" href="gscip__message__handler_8cc.html">gscip_message_handler.cc</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.15 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|