Repository URL to install this package:
|
Version:
6.3.5.2-2 ▾
|
<!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.5"/>
<title>LibreOffice: salhelper/refobj.hxx 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">LibreOffice
</div>
<div id="projectbrief">LibreOffice 6.3 SDK C/C++ API Reference</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.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)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_53aa4ad1b831e9847d1f4a68148b5df1.html">salhelper</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">refobj.hxx</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00414.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">/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * This file is part of the LibreOffice project.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This Source Code Form is subject to the terms of the Mozilla Public</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * License, v. 2.0. If a copy of the MPL was not distributed with this</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * This file incorporates work covered by the following license notice:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * with this work for additional information regarding copyright</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * ownership. The ASF licenses this file to you under the Apache</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * License, Version 2.0 (the "License"); you may not use this file</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * except in compliance with the License. You may obtain a copy of</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * the License at http://www.apache.org/licenses/LICENSE-2.0 .</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef INCLUDED_SALHELPER_REFOBJ_HXX</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_SALHELPER_REFOBJ_HXX</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cassert></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="a00409.html">sal/types.h</a>"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="a00365.html">rtl/alloc.h</a>"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="a00345.html">osl/interlck.h</a>"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>salhelper</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="a00175.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="a00175.html">ReferenceObject</a></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="a00345.html#a6cdf14ac1622489e99a8e69554156b04">oslInterlockedCount</a> m_nReferenceCount;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="a00175.html#ad8d404899263cacef5d1788d385d8637">ReferenceObject</a> (<span class="keyword">const</span> <a class="code" href="a00175.html">ReferenceObject</a>&) <a class="code" href="a00409.html#a1f708c2b11d04207c54202e980f9e181">SAL_DELETED_FUNCTION</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="a00175.html">ReferenceObject</a>& operator= (<span class="keyword">const</span> <a class="code" href="a00175.html">ReferenceObject</a>&) <a class="code" href="a00409.html#a1f708c2b11d04207c54202e980f9e181">SAL_DELETED_FUNCTION</a>;</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="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="a00175.html#ab08ecb555c9c17aa8c9b236e511c5a1d"> 48</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span>* <span class="keyword">operator</span> <span class="keyword">new</span> (<span class="keywordtype">size_t</span> n)</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="a00365.html#a31b50a70291076f8968830c0eb726472">return ::rtl_allocateMemory</a> (n);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="a00175.html#a037a2b026a637eb6ce31618d2237f8c4"> 52</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span> (<span class="keywordtype">void</span>* p)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="a00365.html#a05b90fe06dcf919e92d7b73af6dd1f6a">::rtl_freeMemory</a> (p);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="a00175.html#af7c177f8e58e39163bc67e39134f661b"> 56</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span>* <span class="keyword">operator</span> <span class="keyword">new</span> (size_t, <span class="keywordtype">void</span>* p)</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> p;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="a00175.html#a8b5227b7682cfe6417c45d69d385ed70"> 60</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span> (<span class="keywordtype">void</span>*, <span class="keywordtype">void</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> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="a00175.html#ad8d404899263cacef5d1788d385d8637"> 66</a></span>  <a class="code" href="a00175.html#ad8d404899263cacef5d1788d385d8637">ReferenceObject</a>() : m_nReferenceCount(0)</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> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="a00175.html#a75c8ae93c14d4accfc34fe220b9c4612"> 70</a></span>  <span class="keywordtype">void</span> SAL_CALL <a class="code" href="a00175.html#a75c8ae93c14d4accfc34fe220b9c4612">acquire</a>()</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  osl_atomic_increment(&m_nReferenceCount);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="a00175.html#af274492258ecfe501e730def47617d97"> 75</a></span>  <span class="keywordtype">void</span> SAL_CALL <a class="code" href="a00175.html#af274492258ecfe501e730def47617d97">release</a>()</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  {</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">if</span> (osl_atomic_decrement(&m_nReferenceCount) == 0)</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  {</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// Last reference released.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">delete</span> <span class="keyword">this</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="a00175.html#ab8d669fe470eedaa8412b31b6b8adad1"> 87</a></span>  <span class="keyword">virtual</span> <a class="code" href="a00175.html#ab8d669fe470eedaa8412b31b6b8adad1">~ReferenceObject</a>()</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  assert(m_nReferenceCount == 0);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</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">// namespace salhelper</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#endif </span><span class="comment">/* ! INCLUDED_SALHELPER_REFOBJ_HXX */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/* vim:set shiftwidth=4 softtabstop=4 expandtab: */</span></div>
<div class="ttc" id="a00175_html_ab8d669fe470eedaa8412b31b6b8adad1"><div class="ttname"><a href="a00175.html#ab8d669fe470eedaa8412b31b6b8adad1">salhelper::ReferenceObject::~ReferenceObject</a></div><div class="ttdeci">virtual ~ReferenceObject()</div><div class="ttdoc">Destruction. </div><div class="ttdef"><b>Definition:</b> refobj.hxx:87</div></div>
<div class="ttc" id="a00365_html_a05b90fe06dcf919e92d7b73af6dd1f6a"><div class="ttname"><a href="a00365.html#a05b90fe06dcf919e92d7b73af6dd1f6a">rtl_freeMemory</a></div><div class="ttdeci">SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()</div><div class="ttdoc">Free memory. </div></div>
<div class="ttc" id="a00175_html"><div class="ttname"><a href="a00175.html">salhelper::ReferenceObject</a></div><div class="ttdoc">A base implementation for reference-counted objects. </div><div class="ttdef"><b>Definition:</b> refobj.hxx:36</div></div>
<div class="ttc" id="a00345_html_a6cdf14ac1622489e99a8e69554156b04"><div class="ttname"><a href="a00345.html#a6cdf14ac1622489e99a8e69554156b04">oslInterlockedCount</a></div><div class="ttdeci">sal_Int32 oslInterlockedCount</div><div class="ttdef"><b>Definition:</b> interlck.h:40</div></div>
<div class="ttc" id="a00409_html"><div class="ttname"><a href="a00409.html">types.h</a></div></div>
<div class="ttc" id="a00175_html_af274492258ecfe501e730def47617d97"><div class="ttname"><a href="a00175.html#af274492258ecfe501e730def47617d97">salhelper::ReferenceObject::release</a></div><div class="ttdeci">void release()</div><div class="ttdef"><b>Definition:</b> refobj.hxx:75</div></div>
<div class="ttc" id="a00365_html_a31b50a70291076f8968830c0eb726472"><div class="ttname"><a href="a00365.html#a31b50a70291076f8968830c0eb726472">rtl_allocateMemory</a></div><div class="ttdeci">SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()</div><div class="ttdoc">Allocate memory. </div></div>
<div class="ttc" id="a00175_html_a75c8ae93c14d4accfc34fe220b9c4612"><div class="ttname"><a href="a00175.html#a75c8ae93c14d4accfc34fe220b9c4612">salhelper::ReferenceObject::acquire</a></div><div class="ttdeci">void acquire()</div><div class="ttdef"><b>Definition:</b> refobj.hxx:70</div></div>
<div class="ttc" id="a00175_html_ad8d404899263cacef5d1788d385d8637"><div class="ttname"><a href="a00175.html#ad8d404899263cacef5d1788d385d8637">salhelper::ReferenceObject::ReferenceObject</a></div><div class="ttdeci">ReferenceObject()</div><div class="ttdoc">Construction. </div><div class="ttdef"><b>Definition:</b> refobj.hxx:66</div></div>
<div class="ttc" id="a00345_html"><div class="ttname"><a href="a00345.html">interlck.h</a></div></div>
<div class="ttc" id="a00365_html"><div class="ttname"><a href="a00365.html">alloc.h</a></div></div>
<div class="ttc" id="a00409_html_a1f708c2b11d04207c54202e980f9e181"><div class="ttname"><a href="a00409.html#a1f708c2b11d04207c54202e980f9e181">SAL_DELETED_FUNCTION</a></div><div class="ttdeci">#define SAL_DELETED_FUNCTION</div><div class="ttdoc">short-circuit extra-verbose API namespaces </div><div class="ttdef"><b>Definition:</b> types.h:396</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>