libcore/include/sirikata/core/util/DynamicLibrary.hpp

Go to the documentation of this file.

/*  Sirikata Utilities -- Dynamic Library Loading
 *  DynamicLibrary.hpp
 *
 *  Copyright (c) 2009, Ewen Cheslack-Postava
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of Sirikata nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SIRIKATA_DYNAMIC_LIBRARY_HPP_
#define _SIRIKATA_DYNAMIC_LIBRARY_HPP_

#include <sirikata/core/util/Platform.hpp>

#if SIRIKATA_PLATFORM == SIRIKATA_PLATFORM_WINDOWS
struct HINSTANCE__;
#  define DL_HANDLE struct HINSTANCE__*
#elif SIRIKATA_PLATFORM == SIRIKATA_PLATFORM_MAC || SIRIKATA_PLATFORM == SIRIKATA_PLATFORM_LINUX
#  define DL_HANDLE void*
#endif

namespace Sirikata {

class SIRIKATA_EXPORT DynamicLibrary {
public:
    // Helper to initialize loading of dynamic libraries. Certain
    // platform-specific initialization that is common occurs here.
    static void Initialize();
    // Helper for adding locations to load from
    static void AddLoadPath(const String& path);

    DynamicLibrary(const String& path);
    ~DynamicLibrary();

    bool load();
    bool unload();

    void* symbol(const String& name) const;

    static String prefix();
    static String postfix();
    static String extension();
    static String filename(const String& path, const String& name);
    static String filename(const String& name);
    static void gc(DL_HANDLE handle=NULL);
private:
    bool isValidLibraryFilename() const;

    String mPath;
    DL_HANDLE mHandle;
}; // class DynamicLibrary

} // namespace Sirikata

#endif //_SIRIKATA_DYNAMIC_LIBRARY_HPP_