Sirikata
libcore/include/sirikata/core/util/Plugin.hpp
Go to the documentation of this file.
00001 /*  Sirikata Utilities -- Plugin
00002  *  Plugin.hpp
00003  *
00004  *  Copyright (c) 2009, Ewen Cheslack-Postava
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions are
00009  *  met:
00010  *  * Redistributions of source code must retain the above copyright
00011  *    notice, this list of conditions and the following disclaimer.
00012  *  * Redistributions in binary form must reproduce the above copyright
00013  *    notice, this list of conditions and the following disclaimer in
00014  *    the documentation and/or other materials provided with the
00015  *    distribution.
00016  *  * Neither the name of Sirikata nor the names of its contributors may
00017  *    be used to endorse or promote products derived from this software
00018  *    without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00021  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00022  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00023  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00024  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00026  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031  */
00032 
00033 #ifndef _SIRIKATA_PLUGIN_HPP_
00034 #define _SIRIKATA_PLUGIN_HPP_
00035 
00036 #include <sirikata/core/util/DynamicLibrary.hpp>
00037 #include <list>
00038 
00039 namespace Sirikata {
00040 
00054 class Plugin {
00055 public:
00056     Plugin(const String& path);
00057     ~Plugin();
00058 
00062     bool load();
00063 
00065     bool unload();
00066 
00068     void initialize();
00069 
00071     int incref();
00072 
00074     int decref();
00075 
00077     void destroy();
00078 
00080     String name();
00081 
00083     int refcount();
00084 private:
00085     typedef void(*InitFunc)();
00086     typedef void(*DestroyFunc)();
00087     typedef const char*(*NameFunc)();
00088     typedef int(*RefCountFunc)();
00089     typedef int(*IncRefCountFunc)();
00090     typedef int(*DecRefCountFunc)();
00091 
00092     DynamicLibrary mDL;
00093     InitFunc mInit;
00094     DestroyFunc mDestroy;
00095     NameFunc mName;
00096     RefCountFunc mRefCount;
00097     IncRefCountFunc mIncRefCount;
00098     DecRefCountFunc mDecRefCount;
00099     int mInitialized;
00100 }; // class Plugin
00101 
00102 } // namespace Sirikata
00103 
00104 #endif //_SIRIKATA_PLUGIN_HPP_