BuilderExtensionSignatureMacros.hpp
Go to the documentation of this file.
1 /*
2 
3  This file is part of OpenFLUID software
4  Copyright(c) 2007, INRA - Montpellier SupAgro
5 
6 
7  == GNU General Public License Usage ==
8 
9  OpenFLUID is free software: you can redistribute it and/or modify
10  it under the terms of the GNU General Public License as published by
11  the Free Software Foundation, either version 3 of the License, or
12  (at your option) any later version.
13 
14  OpenFLUID is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
21 
22 
23  == Other Usage ==
24 
25  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
26  license, and requires a written agreement between You and INRA.
27  Licensees for Other Usage of OpenFLUID may use this file in accordance
28  with the terms contained in the written agreement between You and INRA.
29 
30 */
31 
32 
33 /**
34  @file BuilderExtensionSignatureMacros.hpp
35 
36  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
37  */
38 
39 
40 #ifndef __OPENFLUID_BUILDEREXT_BUILDEREXTENSIONSIGNATUREMACROS_HPP__
41 #define __OPENFLUID_BUILDEREXT_BUILDEREXTENSIONSIGNATUREMACROS_HPP__
42 
43 
45 
46 
47 /**
48  @deprecated This declaration is not needed anymore since version 2.1.0
49 */
50 #define DECLARE_BUILDEREXT_PLUGIN
51 
52 
53 /**
54  Macro for definition of builder extension class hook
55  @param[in] pluginclassname The name of the class to instantiate
56 */
57 #define DEFINE_BUILDEREXT_CLASS(pluginclassname) \
58  extern "C" \
59  { \
60  OPENFLUID_PLUGIN std::string WAREABIVERSION_PROC_DECL() \
61  { \
62  return std::string(openfluid::config::VERSION_FULL); \
63  } \
64  \
65  OPENFLUID_PLUGIN openfluid::builderext::PluggableBuilderExtension* WAREBODY_PROC_DECL() \
66  { \
67  return new pluginclassname(); \
68  } \
69  }
70 
71 
72 #endif /* __OPENFLUID_BUILDEREXT_BUILDEREXTENSIONSIGNATUREMACROS_HPP__ */