Library.h

/*
 * Copyright (C) 2006-2008 Marc Boris Duerner
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef PT_SYSTEM_LIBRARY_H
#define PT_SYSTEM_LIBRARY_H

#include <Pt/System/Api.h>
#include <Pt/System/SystemError.h>
#include <Pt/System/Path.h>
#include <string>

namespace Pt {

namespace System {

class Symbol;

class PT_SYSTEM_API SymbolNotFound : public SystemError
{
    public:
        SymbolNotFound(const std::string& sym);

        SymbolNotFound(const char* sym);

        ~SymbolNotFound() throw()
        {}

        const std::string& symbol() const
        { return _symbol; }

    private:
        std::string _symbol;
};

class PT_SYSTEM_API Library
{
    public:
        Library();

        explicit Library(const Path& path);

        Library(const Library& other);

        Library& operator=(const Library& other);

        ~Library();

        Library& open(const Path& path);

        void close();

        void* operator[](const char* symbol) const
        { return this->resolve(symbol); }

        void* resolve(const char* symbol) const;

        operator const void*() const;

        Symbol getSymbol(const char* symbol) const;

        bool operator!() const;

        const Path& path() const;

        static const char* suffix();

        static const char* prefix();

    protected:
        void detach();

    private:
        class LibraryImpl* _impl;

        System::Path _path;
};

class Symbol
{
    public:
        Symbol()
        : _sym(0)
        { }

        Symbol(const Library& lib, void* sym)
        : _lib(lib), _sym(sym)
        { }

        void* sym() const
        { return _sym; }

        const Library& library() const
        { return _lib; }

        operator void*() const
        { return _sym; }

    private:
        Library _lib;
        void* _sym;
};

} // namespace System

} // namespace Pt

#endif // PT_SYSTEM_LIBRARY_H