<!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"/>
<title>Crypto++: factory.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>factory.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef CRYPTOPP_OBJFACT_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define CRYPTOPP_OBJFACT_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include "<a class="code" href="cryptlib_8h.html">cryptlib.h</a>"</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include <map></span>
<a name="l00006"></a>00006 <span class="preprocessor">#include <vector></span>
<a name="l00007"></a>00007
<a name="l00008"></a>00008 NAMESPACE_BEGIN(CryptoPP)
<a name="l00009"></a>00009
<a name="l00010"></a>00010 <span class="comment">//! _</span>
<a name="l00011"></a>00011 <span class="comment"></span>template <class AbstractClass>
<a name="l00012"></a><a class="code" href="class_object_factory.html">00012</a> class <a class="code" href="class_object_factory.html" title="_">ObjectFactory</a>
<a name="l00013"></a>00013 {
<a name="l00014"></a>00014 <span class="keyword">public</span>:
<a name="l00015"></a>00015 <span class="keyword">virtual</span> AbstractClass * CreateObject() <span class="keyword">const</span> =0;
<a name="l00016"></a>00016 };
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">//! _</span>
<a name="l00019"></a>00019 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> AbstractClass, <span class="keyword">class</span> ConcreteClass>
<a name="l00020"></a><a class="code" href="class_default_object_factory.html">00020</a> <span class="keyword">class </span><a class="code" href="class_default_object_factory.html" title="_">DefaultObjectFactory</a> : <span class="keyword">public</span> <a class="code" href="class_object_factory.html" title="_">ObjectFactory</a><AbstractClass>
<a name="l00021"></a>00021 {
<a name="l00022"></a>00022 <span class="keyword">public</span>:
<a name="l00023"></a>00023 AbstractClass * CreateObject()<span class="keyword"> const</span>
<a name="l00024"></a>00024 <span class="keyword"> </span>{
<a name="l00025"></a>00025 <span class="keywordflow">return</span> <span class="keyword">new</span> ConcreteClass;
<a name="l00026"></a>00026 }
<a name="l00027"></a>00027
<a name="l00028"></a>00028 };
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">//! _</span>
<a name="l00031"></a>00031 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> AbstractClass, <span class="keywordtype">int</span> instance=0>
<a name="l00032"></a><a class="code" href="class_object_factory_registry.html">00032</a> <span class="keyword">class </span><a class="code" href="class_object_factory_registry.html" title="_">ObjectFactoryRegistry</a>
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 <span class="keyword">public</span>:
<a name="l00035"></a><a class="code" href="class_object_factory_registry_1_1_factory_not_found.html">00035</a> <span class="keyword">class </span><a class="code" href="class_object_factory_registry_1_1_factory_not_found.html">FactoryNotFound</a> : <span class="keyword">public</span> <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">public</span>:
<a name="l00038"></a>00038 <a class="code" href="class_object_factory_registry_1_1_factory_not_found.html">FactoryNotFound</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name) : <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>(<a class="code" href="class_exception.html#a8e53909d979479380e0274807c074c0aa27d9ee7704100a88e4ae4adcc4072015" title="some error not belong to any of the above categories">OTHER_ERROR</a>, std::string(<span class="stringliteral">"ObjectFactoryRegistry: could not find factory for algorithm "</span>) + name) {}
<a name="l00039"></a>00039 };
<a name="l00040"></a>00040
<a name="l00041"></a>00041 ~<a class="code" href="class_object_factory_registry.html" title="_">ObjectFactoryRegistry</a>()
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="keywordflow">for</span> (CPP_TYPENAME Map::iterator i = m_map.begin(); i != m_map.end(); ++i)
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">delete</span> (<a class="code" href="class_object_factory.html" title="_">ObjectFactory<AbstractClass></a> *)i->second;
<a name="l00046"></a>00046 i->second = NULL;
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048 }
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keywordtype">void</span> RegisterFactory(<span class="keyword">const</span> std::string &name, <a class="code" href="class_object_factory.html" title="_">ObjectFactory<AbstractClass></a> *factory)
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052 m_map[name] = factory;
<a name="l00053"></a>00053 }
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keyword">const</span> <a class="code" href="class_object_factory.html" title="_">ObjectFactory<AbstractClass></a> * GetFactory(<span class="keyword">const</span> <span class="keywordtype">char</span> *name)<span class="keyword"> const</span>
<a name="l00056"></a>00056 <span class="keyword"> </span>{
<a name="l00057"></a>00057 CPP_TYPENAME Map::const_iterator i = m_map.find(name);
<a name="l00058"></a>00058 <span class="keywordflow">return</span> i == m_map.end() ? NULL : (<a class="code" href="class_object_factory.html" title="_">ObjectFactory<AbstractClass></a> *)i->second;
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060
<a name="l00061"></a>00061 AbstractClass *CreateObject(<span class="keyword">const</span> <span class="keywordtype">char</span> *name)<span class="keyword"> const</span>
<a name="l00062"></a>00062 <span class="keyword"> </span>{
<a name="l00063"></a>00063 <span class="keyword">const</span> <a class="code" href="class_object_factory.html" title="_">ObjectFactory<AbstractClass></a> *factory = GetFactory(name);
<a name="l00064"></a>00064 <span class="keywordflow">if</span> (!factory)
<a name="l00065"></a>00065 <span class="keywordflow">throw</span> FactoryNotFound(name);
<a name="l00066"></a>00066 <span class="keywordflow">return</span> factory->CreateObject();
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">// Return a vector containing the factory names. This is easier than returning an iterator.</span>
<a name="l00070"></a>00070 <span class="comment">// from Andrew Pitonyak</span>
<a name="l00071"></a>00071 std::vector<std::string> GetFactoryNames()<span class="keyword"> const</span>
<a name="l00072"></a>00072 <span class="keyword"> </span>{
<a name="l00073"></a>00073 std::vector<std::string> names;
<a name="l00074"></a>00074 CPP_TYPENAME Map::const_iterator iter;
<a name="l00075"></a>00075 <span class="keywordflow">for</span> (iter = m_map.begin(); iter != m_map.end(); ++iter)
<a name="l00076"></a>00076 names.push_back(iter->first);
<a name="l00077"></a>00077 <span class="keywordflow">return</span> names;
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079
<a name="l00080"></a>00080 CRYPTOPP_NOINLINE <span class="keyword">static</span> <a class="code" href="class_object_factory_registry.html" title="_">ObjectFactoryRegistry<AbstractClass, instance></a> & Registry(CRYPTOPP_NOINLINE_DOTDOTDOT);
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">private</span>:
<a name="l00083"></a>00083 <span class="comment">// use void * instead of ObjectFactory<AbstractClass> * to save code size</span>
<a name="l00084"></a>00084 <span class="keyword">typedef</span> std::map<std::string, void *> Map;
<a name="l00085"></a>00085 Map m_map;
<a name="l00086"></a>00086 };
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">template</span> <<span class="keyword">class</span> AbstractClass, <span class="keywordtype">int</span> instance>
<a name="l00089"></a>00089 <a class="code" href="class_object_factory_registry.html" title="_">ObjectFactoryRegistry<AbstractClass, instance></a> & <a class="code" href="class_object_factory_registry.html" title="_">ObjectFactoryRegistry<AbstractClass, instance>::Registry</a>(CRYPTOPP_NOINLINE_DOTDOTDOT)
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="keyword">static</span> <a class="code" href="class_object_factory_registry.html" title="_">ObjectFactoryRegistry<AbstractClass, instance></a> s_registry;
<a name="l00092"></a>00092 <span class="keywordflow">return</span> s_registry;
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keyword">template</span> <<span class="keyword">class</span> AbstractClass, <span class="keyword">class</span> ConcreteClass, <span class="keywordtype">int</span> instance = 0>
<a name="l00096"></a><a class="code" href="struct_register_default_factory_for.html">00096</a> <span class="keyword">struct </span><a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor</a> {
<a name="l00097"></a>00097 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name=NULL)
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <span class="comment">// BCB2006 workaround</span>
<a name="l00100"></a>00100 std::string n = name ? std::string(name) : std::string(ConcreteClass::StaticAlgorithmName());
<a name="l00101"></a>00101 <a class="code" href="class_object_factory_registry.html" title="_">ObjectFactoryRegistry<AbstractClass, instance>::Registry</a>().
<a name="l00102"></a>00102 RegisterFactory(n, <span class="keyword">new</span> <a class="code" href="class_default_object_factory.html" title="_">DefaultObjectFactory<AbstractClass, ConcreteClass></a>);
<a name="l00103"></a>00103 }};
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keyword">template</span> <<span class="keyword">class</span> SchemeClass>
<a name="l00106"></a>00106 <span class="keywordtype">void</span> RegisterAsymmetricCipherDefaultFactories(<span class="keyword">const</span> <span class="keywordtype">char</span> *name=NULL, SchemeClass *dummy=NULL)
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor<PK_Encryptor, CPP_TYPENAME SchemeClass::Encryptor></a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *)name);
<a name="l00109"></a>00109 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor<PK_Decryptor, CPP_TYPENAME SchemeClass::Decryptor></a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *)name);
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keyword">template</span> <<span class="keyword">class</span> SchemeClass>
<a name="l00113"></a>00113 <span class="keywordtype">void</span> RegisterSignatureSchemeDefaultFactories(<span class="keyword">const</span> <span class="keywordtype">char</span> *name=NULL, SchemeClass *dummy=NULL)
<a name="l00114"></a>00114 {
<a name="l00115"></a>00115 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor<PK_Signer, CPP_TYPENAME SchemeClass::Signer></a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *)name);
<a name="l00116"></a>00116 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor<PK_Verifier, CPP_TYPENAME SchemeClass::Verifier></a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *)name);
<a name="l00117"></a>00117 }
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="keyword">template</span> <<span class="keyword">class</span> SchemeClass>
<a name="l00120"></a>00120 <span class="keywordtype">void</span> RegisterSymmetricCipherDefaultFactories(<span class="keyword">const</span> <span class="keywordtype">char</span> *name=NULL, SchemeClass *dummy=NULL)
<a name="l00121"></a>00121 {
<a name="l00122"></a>00122 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor<SymmetricCipher, CPP_TYPENAME SchemeClass::Encryption, ENCRYPTION></a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *)name);
<a name="l00123"></a>00123 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor<SymmetricCipher, CPP_TYPENAME SchemeClass::Decryption, DECRYPTION></a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *)name);
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keyword">template</span> <<span class="keyword">class</span> SchemeClass>
<a name="l00127"></a>00127 <span class="keywordtype">void</span> RegisterAuthenticatedSymmetricCipherDefaultFactories(<span class="keyword">const</span> <span class="keywordtype">char</span> *name=NULL, SchemeClass *dummy=NULL)
<a name="l00128"></a>00128 {
<a name="l00129"></a>00129 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor<AuthenticatedSymmetricCipher, CPP_TYPENAME SchemeClass::Encryption, ENCRYPTION></a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *)name);
<a name="l00130"></a>00130 <a class="code" href="struct_register_default_factory_for.html">RegisterDefaultFactoryFor<AuthenticatedSymmetricCipher, CPP_TYPENAME SchemeClass::Decryption, DECRYPTION></a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *)name);
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132
<a name="l00133"></a>00133 NAMESPACE_END
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
07dfcfe50d66c9a48a3c5e6c1693f12a
>
files
>
1721
