DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
392 Commits
7 Branches
59MB
Tree: 8cba07e97a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '8cba07e97a'
${ noResults }
DPF/Base_8hpp_source.html

220 lines
21KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.6"/>

  7. <title>DISTRHO Plugin Framework: dgl/Base.hpp Source File</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/search.js"></script>

  13. <script type="text/javascript">

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.6 -->

  34. <script type="text/javascript">

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li class="current"><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="files.html"><span>File&#160;List</span></a></li>

  64.     </ul>

  65.   </div>

  66. <!-- window showing the filter options -->

  67. <div id="MSearchSelectWindow"

  68.      onmouseover="return searchBox.OnSearchSelectShow()"

  69.      onmouseout="return searchBox.OnSearchSelectHide()"

  70.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  71. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  72. 

  73. <!-- iframe showing the search results (closed by default) -->

  74. <div id="MSearchResultsWindow">

  75. <iframe src="javascript:void(0)" frameborder="0" 

  76.         name="MSearchResults" id="MSearchResults">

  77. </iframe>

  78. </div>

  79. 

  80. <div id="nav-path" class="navpath">

  81.   <ul>

  82. <li class="navelem"><a class="el" href="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li>  </ul>

  83. </div>

  84. </div><!-- top -->

  85. <div class="header">

  86.   <div class="headertitle">

  87. <div class="title">Base.hpp</div>  </div>

  88. </div><!--header-->

  89. <div class="contents">

  90. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>

  91. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>

  92. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright (C) 2012-2019 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>

  93. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>

  94. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>

  95. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>

  96. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>

  97. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>

  98. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>

  99. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>

  100. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>

  101. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>

  102. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>

  103. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>

  104. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>

  105. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>

  106. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef DGL_BASE_HPP_INCLUDED</span></div>

  107. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define DGL_BASE_HPP_INCLUDED</span></div>

  108. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor"></span></div>

  109. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;../distrho/extra/LeakDetector.hpp&quot;</span></div>

  110. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;../distrho/extra/ScopedPointer.hpp&quot;</span></div>

  111. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>

  112. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  113. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// Define namespace</span></div>

  114. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>

  115. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#ifndef DGL_NAMESPACE</span></div>

  116. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor"></span><span class="preprocessor"># define DGL_NAMESPACE DGL</span></div>

  117. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>

  118. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor"></span></div>

  119. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#define START_NAMESPACE_DGL namespace DGL_NAMESPACE {</span></div>

  120. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define END_NAMESPACE_DGL }</span></div>

  121. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define USE_NAMESPACE_DGL using namespace DGL_NAMESPACE;</span></div>

  122. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor"></span></div>

  123. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;START_NAMESPACE_DGL</div>

  124. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>

  125. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  126. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">// Base DGL enums</span></div>

  127. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"></span></div>

  128. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">/**</span></div>

  129. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">   Convenience symbols for ASCII control characters.</span></div>

  130. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"> */</span></div>

  131. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">enum</span> Char {</div>

  132. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    kCharBackspace = 0x08,</div>

  133. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    kCharEscape    = 0x1B,</div>

  134. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    kCharDelete    = 0x7F</div>

  135. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;};</div>

  136. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"></span></div>

  137. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">/**</span></div>

  138. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">   Keyboard modifier flags.</span></div>

  139. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"> */</span></div>

  140. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="keyword">enum</span> Modifier {</div>

  141. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    kModifierShift   = 1 &lt;&lt; 0, <span class="comment">/**&lt; Shift key */</span></div>

  142. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    kModifierControl = 1 &lt;&lt; 1, <span class="comment">/**&lt; Control key */</span></div>

  143. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    kModifierAlt     = 1 &lt;&lt; 2, <span class="comment">/**&lt; Alt/Option key */</span></div>

  144. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    kModifierSuper   = 1 &lt;&lt; 3  <span class="comment">/**&lt; Mod4/Command/Windows key */</span></div>

  145. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;};</div>

  146. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"></span></div>

  147. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">/**</span></div>

  148. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">   Special (non-Unicode) keyboard keys.</span></div>

  149. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> */</span></div>

  150. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keyword">enum</span> Key {</div>

  151. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    kKeyF1 = 1,</div>

  152. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    kKeyF2,</div>

  153. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    kKeyF3,</div>

  154. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    kKeyF4,</div>

  155. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    kKeyF5,</div>

  156. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    kKeyF6,</div>

  157. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    kKeyF7,</div>

  158. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    kKeyF8,</div>

  159. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    kKeyF9,</div>

  160. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    kKeyF10,</div>

  161. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    kKeyF11,</div>

  162. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    kKeyF12,</div>

  163. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    kKeyLeft,</div>

  164. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    kKeyUp,</div>

  165. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    kKeyRight,</div>

  166. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    kKeyDown,</div>

  167. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    kKeyPageUp,</div>

  168. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    kKeyPageDown,</div>

  169. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    kKeyHome,</div>

  170. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    kKeyEnd,</div>

  171. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    kKeyInsert,</div>

  172. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    kKeyShift,</div>

  173. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    kKeyControl,</div>

  174. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    kKeyAlt,</div>

  175. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    kKeySuper</div>

  176. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;};</div>

  177. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div>

  178. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  179. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">// Base DGL classes</span></div>

  180. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"></span></div>

  181. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">/**</span></div>

  182. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment">   Graphics context, definition depends on build type.</span></div>

  183. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> */</span></div>

  184. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="keyword">struct </span><a class="code" href="structGraphicsContext.html">GraphicsContext</a>;</div>

  185. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"></span></div>

  186. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment">/**</span></div>

  187. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment">   Idle callback.</span></div>

  188. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> */</span></div>

  189. <div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classIdleCallback.html">  100</a></span>&#160;<span class="keyword">class </span><a class="code" href="classIdleCallback.html">IdleCallback</a></div>

  190. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;{</div>

  191. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="keyword">public</span>:</div>

  192. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="classIdleCallback.html">IdleCallback</a>() {}</div>

  193. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> idleCallback() = 0;</div>

  194. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;};</div>

  195. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div>

  196. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  197. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div>

  198. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;END_NAMESPACE_DGL</div>

  199. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;</div>

  200. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="preprocessor">#ifndef DONT_SET_USING_DGL_NAMESPACE</span></div>

  201. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="preprocessor"></span>  <span class="comment">// If your code uses a lot of DGL classes, then this will obviously save you</span></div>

  202. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;  <span class="comment">// a lot of typing, but can be disabled by setting DONT_SET_USING_DGL_NAMESPACE.</span></div>

  203. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;  <span class="keyword">using namespace </span>DGL_NAMESPACE;</div>

  204. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="preprocessor">#endif</span></div>

  205. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="preprocessor"></span></div>

  206. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  207. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div>

  208. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="preprocessor">#endif // DGL_BASE_HPP_INCLUDED</span></div>

  209. <div class="ttc" id="structGraphicsContext_html"><div class="ttname"><a href="structGraphicsContext.html">GraphicsContext</a></div><div class="ttdef"><b>Definition:</b> Cairo.hpp:31</div></div>

  210. <div class="ttc" id="classIdleCallback_html"><div class="ttname"><a href="classIdleCallback.html">IdleCallback</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:100</div></div>

  211. </div><!-- fragment --></div><!-- contents -->

  212. <!-- start footer part -->

  213. <hr class="footer"/><address class="footer"><small>

  214. Generated on Mon Jun 24 2019 11:56:27 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  215. <img class="footer" src="doxygen.png" alt="doxygen"/>

  216. </a> 1.8.6

  217. </small></address>

  218. </body>

  219. </html>