mirror of
https://github.com/pocoproject/poco.git
synced 2024-12-13 02:22:57 +01:00
123 lines
3.9 KiB
C++
123 lines
3.9 KiB
C++
//
|
|
// SharedLibrary.h
|
|
//
|
|
// $Id: //poco/Main/Foundation/include/Poco/SharedLibrary.h#3 $
|
|
//
|
|
// Library: Foundation
|
|
// Package: SharedLibrary
|
|
// Module: SharedLibrary
|
|
//
|
|
// Definition of the SharedLibrary class.
|
|
//
|
|
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person or organization
|
|
// obtaining a copy of the software and accompanying documentation covered by
|
|
// this license (the "Software") to use, reproduce, display, distribute,
|
|
// execute, and transmit the Software, and to prepare derivative works of the
|
|
// Software, and to permit third-parties to whom the Software is furnished to
|
|
// do so, all subject to the following:
|
|
//
|
|
// The copyright notices in the Software and this entire statement, including
|
|
// the above license grant, this restriction and the following disclaimer,
|
|
// must be included in all copies of the Software, in whole or in part, and
|
|
// all derivative works of the Software, unless such copies or derivative
|
|
// works are solely in the form of machine-executable object code generated by
|
|
// a source language processor.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
|
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
|
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
|
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
//
|
|
|
|
|
|
#ifndef Foundation_SharedLibrary_INCLUDED
|
|
#define Foundation_SharedLibrary_INCLUDED
|
|
|
|
|
|
#include "Poco/Foundation.h"
|
|
|
|
|
|
#if defined(hpux) || defined(_hpux)
|
|
#include "Poco/SharedLibrary_HPUX.h"
|
|
#elif defined(POCO_OS_FAMILY_UNIX)
|
|
#include "Poco/SharedLibrary_UNIX.h"
|
|
#elif defined(POCO_OS_FAMILY_WINDOWS) && defined(POCO_WIN32_UTF8)
|
|
#include "Poco/SharedLibrary_WIN32U.h"
|
|
#elif defined(POCO_OS_FAMILY_WINDOWS)
|
|
#include "Poco/SharedLibrary_WIN32.h"
|
|
#elif defined(POCO_OS_FAMILY_VMS)
|
|
#include "Poco/SharedLibrary_VMS.h"
|
|
#endif
|
|
|
|
|
|
namespace Poco {
|
|
|
|
|
|
class Foundation_API SharedLibrary: private SharedLibraryImpl
|
|
/// The SharedLibrary class dynamically
|
|
/// loads shared libraries at run-time.
|
|
{
|
|
public:
|
|
SharedLibrary();
|
|
/// Creates a SharedLibrary object.
|
|
|
|
SharedLibrary(const std::string& path);
|
|
/// Creates a SharedLibrary object and loads a library
|
|
/// from the given path.
|
|
|
|
virtual ~SharedLibrary();
|
|
/// Destroys the SharedLibrary. The actual library
|
|
/// remains loaded.
|
|
|
|
void load(const std::string& path);
|
|
/// Loads a shared library from the given path.
|
|
/// Throws a LibraryAlreadyLoadedException if
|
|
/// a library has already been loaded.
|
|
/// Throws a LibraryLoadException if the library
|
|
/// cannot be loaded.
|
|
|
|
void unload();
|
|
/// Unloads a shared library.
|
|
|
|
bool isLoaded() const;
|
|
/// Returns true iff a library has been loaded.
|
|
|
|
bool hasSymbol(const std::string& name);
|
|
/// Returns true iff the loaded library contains
|
|
/// a symbol with the given name.
|
|
|
|
void* getSymbol(const std::string& name);
|
|
/// Returns the address of the symbol with
|
|
/// the given name. For functions, this
|
|
/// is the entry point of the function.
|
|
/// Throws a NotFoundException if the symbol
|
|
/// does not exist.
|
|
|
|
const std::string& getPath() const;
|
|
/// Returns the path of the library, as
|
|
/// specified in a call to load() or the
|
|
/// constructor.
|
|
|
|
static std::string suffix();
|
|
/// Returns the platform-specific filename suffix
|
|
/// for shared libraries (including the period).
|
|
/// In debug mode, the suffix also includes a
|
|
/// "d" to specify the debug version of a library.
|
|
|
|
private:
|
|
SharedLibrary(const SharedLibrary&);
|
|
SharedLibrary& operator = (const SharedLibrary&);
|
|
};
|
|
|
|
|
|
} // namespace Poco
|
|
|
|
|
|
#endif // Foundation_SharedLibrary_INCLUDED
|