File: optional-interface-factory_8h_source.html

package info (click to toggle)
telepathy-qt4 0.3.6-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 14,260 kB
  • ctags: 12,185
  • sloc: cpp: 29,241; xml: 23,692; ansic: 16,079; sh: 10,327; python: 3,080; makefile: 1,553
file content (167 lines) | stat: -rw-r--r-- 15,457 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>TelepathyQt4: optional-interface-factory.h Source File</title>
  <link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="1">&nbsp;&nbsp;</td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a>&nbsp;&middot;
<a href="classes.html">
<font color="#004faf">All Classes</font></a>&nbsp;&middot;
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a>&nbsp;&middot;
<a href="modules.html">
<font color="#004faf">Modules</font></a>&nbsp;&middot;
<a href="functions.html">
<font color="#004faf">Functions</font></a>&nbsp;&middot;
<a href="files.html">
<font color="#004faf">Files</font></a>
</td>
</tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.6.3 -->
<h1>optional-interface-factory.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * This file is part of TelepathyQt4</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2008-2009 Collabora Ltd. &lt;http://www.collabora.co.uk/&gt;</span>
<a name="l00005"></a>00005 <span class="comment"> * Copyright (C) 2008-2009 Nokia Corporation</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00008"></a>00008 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00009"></a>00009 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00010"></a>00010 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00015"></a>00015 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00018"></a>00018 <span class="comment"> * License along with this library; if not, write to the Free Software</span>
<a name="l00019"></a>00019 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _TelepathyQt4_optional_interface_factory_h_HEADER_GUARD_</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _TelepathyQt4_optional_interface_factory_h_HEADER_GUARD_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef IN_TELEPATHY_QT4_HEADER</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#error IN_TELEPATHY_QT4_HEADER</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;TelepathyQt4/Global&gt;</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;QObject&gt;</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;QStringList&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;QtGlobal&gt;</span>
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 <span class="keyword">namespace </span>Tp
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 
<a name="l00038"></a>00038 <span class="keyword">class </span>AbstractInterface;
<a name="l00039"></a>00039 
<a name="l00040"></a><a class="code" href="classTp_1_1OptionalInterfaceCache.html">00040</a> <span class="keyword">class </span>TELEPATHY_QT4_EXPORT <a class="code" href="classTp_1_1OptionalInterfaceCache.html">OptionalInterfaceCache</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042     Q_DISABLE_COPY(<a class="code" href="classTp_1_1OptionalInterfaceCache.html">OptionalInterfaceCache</a>)
<a name="l00043"></a>00043 
<a name="l00044"></a>00044 <span class="keyword">public</span>:
<a name="l00045"></a>00045     <span class="keyword">explicit</span> <a class="code" href="classTp_1_1OptionalInterfaceCache.html">OptionalInterfaceCache</a>(QObject *proxy);
<a name="l00046"></a>00046 
<a name="l00047"></a>00047     ~<a class="code" href="classTp_1_1OptionalInterfaceCache.html">OptionalInterfaceCache</a>();
<a name="l00048"></a>00048 
<a name="l00049"></a>00049 <span class="keyword">protected</span>:
<a name="l00050"></a>00050     <a class="code" href="classTp_1_1AbstractInterface.html">AbstractInterface</a> *getCached(<span class="keyword">const</span> QString &amp;name) <span class="keyword">const</span>;
<a name="l00051"></a>00051     <span class="keywordtype">void</span> cache(<a class="code" href="classTp_1_1AbstractInterface.html">AbstractInterface</a> *interface) <span class="keyword">const</span>;
<a name="l00052"></a>00052     QObject *proxy() <span class="keyword">const</span>;
<a name="l00053"></a>00053 
<a name="l00054"></a>00054 <span class="keyword">private</span>:
<a name="l00055"></a><a class="code" href="classTp_1_1OptionalInterfaceCache.html#a15a94ff2bd578e608a94d0a1ba4bd3e0">00055</a>     <span class="keyword">struct </span>Private;
<a name="l00056"></a>00056     <span class="keyword">friend</span> <span class="keyword">struct </span>Private;
<a name="l00057"></a>00057     Private *mPriv;
<a name="l00058"></a>00058 };
<a name="l00059"></a>00059 
<a name="l00060"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html">00060</a> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> DBusProxySub<span class="keyword">class</span>&gt; <span class="keyword">class </span><a class="code" href="classTp_1_1OptionalInterfaceFactory.html" title="Implementation helper class for high-level proxy classes willing to offer access...">OptionalInterfaceFactory</a>
<a name="l00061"></a>00061     : <span class="keyword">private</span> <a class="code" href="classTp_1_1OptionalInterfaceCache.html">OptionalInterfaceCache</a>
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063     Q_DISABLE_COPY(<a class="code" href="classTp_1_1OptionalInterfaceFactory.html" title="Implementation helper class for high-level proxy classes willing to offer access...">OptionalInterfaceFactory</a>)
<a name="l00064"></a>00064 
<a name="l00065"></a>00065 <span class="keyword">public</span>:
<a name="l00066"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937f">00066</a>     <span class="keyword">enum</span> <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937f">InterfaceSupportedChecking</a>
<a name="l00067"></a>00067     {
<a name="l00068"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937fa3656e4c2bd93aa3aac424933c316d655">00068</a>         <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937fa3656e4c2bd93aa3aac424933c316d655">CheckInterfaceSupported</a>,
<a name="l00069"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937fa24a4d338ee86ab43371d960a1faedcd9">00069</a>         <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937fa24a4d338ee86ab43371d960a1faedcd9">BypassInterfaceCheck</a>
<a name="l00070"></a>00070     };
<a name="l00071"></a>00071 
<a name="l00072"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a246a25e9db61df8f276dc16d2802e945">00072</a>     <span class="keyword">inline</span> <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a246a25e9db61df8f276dc16d2802e945">OptionalInterfaceFactory</a>(DBusProxySubclass *this_)
<a name="l00073"></a>00073         : <a class="code" href="classTp_1_1OptionalInterfaceCache.html">OptionalInterfaceCache</a>(this_)
<a name="l00074"></a>00074     {
<a name="l00075"></a>00075     }
<a name="l00076"></a>00076 
<a name="l00077"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a33a51382c8d11e0b2d2e5e38de96e490">00077</a>     <span class="keyword">inline</span> <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a33a51382c8d11e0b2d2e5e38de96e490">~OptionalInterfaceFactory</a>()
<a name="l00078"></a>00078     {
<a name="l00079"></a>00079     }
<a name="l00080"></a>00080 
<a name="l00081"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#afa2877d62298299d006b46d77fecc09e">00081</a>     <span class="keyword">inline</span> QStringList <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#afa2877d62298299d006b46d77fecc09e">interfaces</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mInterfaces; }
<a name="l00082"></a>00082 
<a name="l00083"></a>00083     <span class="keyword">template</span> &lt;<span class="keyword">class</span> Interface&gt;
<a name="l00084"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a50d2019f8aa967d6482d9fa9d34c66f4">00084</a>     <span class="keyword">inline</span> Interface *<a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a50d2019f8aa967d6482d9fa9d34c66f4">optionalInterface</a>(
<a name="l00085"></a>00085             <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937f">InterfaceSupportedChecking</a> check = <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937fa3656e4c2bd93aa3aac424933c316d655">CheckInterfaceSupported</a>)<span class="keyword"> const</span>
<a name="l00086"></a>00086 <span class="keyword">    </span>{
<a name="l00087"></a>00087         <span class="comment">// Check for the remote object supporting the interface</span>
<a name="l00088"></a>00088         QString name(QLatin1String(Interface::staticInterfaceName()));
<a name="l00089"></a>00089         <span class="keywordflow">if</span> (check == <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#a7d7b4eec46ac3258e70177f6e3e4937fa3656e4c2bd93aa3aac424933c316d655">CheckInterfaceSupported</a> &amp;&amp; !mInterfaces.contains(name)) {
<a name="l00090"></a>00090             <span class="keywordflow">return</span> 0;
<a name="l00091"></a>00091         }
<a name="l00092"></a>00092 
<a name="l00093"></a>00093         <span class="comment">// If present or forced, delegate to OptionalInterfaceFactory</span>
<a name="l00094"></a>00094         <span class="keywordflow">return</span> interface&lt;Interface&gt;();
<a name="l00095"></a>00095     }
<a name="l00096"></a>00096 
<a name="l00097"></a>00097     <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Interface&gt;
<a name="l00098"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#aab61b88e18a952800de75d40053e9340">00098</a>     <span class="keyword">inline</span> Interface *<a class="code" href="classTp_1_1OptionalInterfaceFactory.html#aab61b88e18a952800de75d40053e9340">interface</a>()<span class="keyword"> const</span>
<a name="l00099"></a>00099 <span class="keyword">    </span>{
<a name="l00100"></a>00100         <a class="code" href="classTp_1_1AbstractInterface.html">AbstractInterface</a>* interfaceMustBeASubclassOfAbstractInterface = <span class="keyword">static_cast&lt;</span>Interface *<span class="keyword">&gt;</span>(NULL);
<a name="l00101"></a>00101         Q_UNUSED(interfaceMustBeASubclassOfAbstractInterface);
<a name="l00102"></a>00102 
<a name="l00103"></a>00103         <span class="comment">// If there is a interface cached already, return it</span>
<a name="l00104"></a>00104         QString name(QLatin1String(Interface::staticInterfaceName()));
<a name="l00105"></a>00105         <a class="code" href="classTp_1_1AbstractInterface.html">AbstractInterface</a> *cached = <a class="code" href="classTp_1_1OptionalInterfaceCache.html#a199ebf6a96fffac2cfd775154a680a10">getCached</a>(name);
<a name="l00106"></a>00106         <span class="keywordflow">if</span> (cached)
<a name="l00107"></a>00107             <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>Interface *<span class="keyword">&gt;</span>(cached);
<a name="l00108"></a>00108 
<a name="l00109"></a>00109         <span class="comment">// Otherwise, cache and return a newly constructed proxy</span>
<a name="l00110"></a>00110         Interface *<a class="code" href="classTp_1_1OptionalInterfaceFactory.html#aab61b88e18a952800de75d40053e9340">interface</a> = <span class="keyword">new</span> Interface(
<a name="l00111"></a>00111                 static_cast&lt;DBusProxySubclass *&gt;(<a class="code" href="classTp_1_1OptionalInterfaceCache.html#a1f6948bfd272547ccb96d7c3f0dfd973">proxy</a>()));
<a name="l00112"></a>00112         <a class="code" href="classTp_1_1OptionalInterfaceCache.html#a1e63353d05571a69bd910b7319718bc3">cache</a>(interface);
<a name="l00113"></a>00113         <span class="keywordflow">return</span> interface;
<a name="l00114"></a>00114     }
<a name="l00115"></a>00115 
<a name="l00116"></a>00116 <span class="keyword">protected</span>:
<a name="l00117"></a><a class="code" href="classTp_1_1OptionalInterfaceFactory.html#ae57eceda64422bb29f0aa121609c1f19">00117</a>     <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classTp_1_1OptionalInterfaceFactory.html#ae57eceda64422bb29f0aa121609c1f19">setInterfaces</a>(<span class="keyword">const</span> QStringList &amp;<a class="code" href="classTp_1_1OptionalInterfaceFactory.html#afa2877d62298299d006b46d77fecc09e">interfaces</a>)
<a name="l00118"></a>00118     {
<a name="l00119"></a>00119         mInterfaces = interfaces;
<a name="l00120"></a>00120     }
<a name="l00121"></a>00121 
<a name="l00122"></a>00122 <span class="keyword">private</span>:
<a name="l00123"></a>00123     QStringList mInterfaces;
<a name="l00124"></a>00124 };
<a name="l00125"></a>00125 
<a name="l00126"></a>00126 } <span class="comment">// Tp</span>
<a name="l00127"></a>00127 
<a name="l00128"></a>00128 <span class="preprocessor">#endif</span>
</pre></div></div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright &copy; 2008-2010 Collabora Ltd. and Nokia Corporation</td>
<td width="30%" align="right"><div align="right">Telepathy-Qt4 0.3.6</div></td>
</tr></table></div></address>
</body>
</html>