klibloader.cpp
/* This file is part of the KDE libraries
Copyright (C) 1999 Torben Weis <weis@kde.org>
Copyright (C) 2000 Michael Matz <matz@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include "config.h"
#include <config.h>
#include <qclipboard.h>
#include <qfile.h>
#include <qdir.h>
#include <qtimer.h>
#include <qobjectdict.h>
#include "kapplication.h"
#include "klibloader.h"
#include "kstandarddirs.h"
#include "kdebug.h"
#include "klocale.h"
#include "ltdl.h"
template class QAsciiDict<KLibrary>;
#include <stdlib.h> //getenv
#if HAVE_DLFCN_H
# include <dlfcn.h>
#endif
#ifdef RTLD_GLOBAL
# define LT_GLOBAL RTLD_GLOBAL
#else
# ifdef DL_GLOBAL
# define LT_GLOBAL DL_GLOBAL
# endif
#endif /* !RTLD_GLOBAL */
#ifndef LT_GLOBAL
# define LT_GLOBAL 0
#endif /* !LT_GLOBAL */
class KLibLoaderPrivate
{
public:
QPtrList<KLibWrapPrivate> loaded_stack;
QPtrList<KLibWrapPrivate> pending_close;
enum {UNKNOWN, UNLOAD, DONT_UNLOAD} unload_mode;
QString errorMessage;
};
KLibLoader* KLibLoader::s_self = 0;
// -------------------------------------------------------------------------
KLibFactory::KLibFactory( QObject* parent, const char* name )
: QObject( parent, name )
{
}
KLibFactory::~KLibFactory()
{
// kdDebug(150) << "Deleting KLibFactory " << this << endl;
}
QObject* KLibFactory::create( QObject* parent, const char* name, const char* classname, const QStringList &args )
{
QObject* obj = createObject( parent, name, classname, args );
if ( obj )
emit objectCreated( obj );
return obj;
}
QObject* KLibFactory::createObject( QObject*, const char*, const char*, const QStringList &)
{
return 0;
}
// -----------------------------------------------
KLibrary::KLibrary( const QString& libname, const QString& filename, void * handle )
{
/* Make sure, we have a KLibLoader */
(void) KLibLoader::self();
m_libname = libname;
m_filename = filename;
m_handle = handle;
m_factory = 0;
m_timer = 0;
}
KLibrary::~KLibrary()
{
// kdDebug(150) << "Deleting KLibrary " << this << " " << m_libname << endl;
if ( m_timer && m_timer->isActive() )
m_timer->stop();
// If any object is remaining, delete
if ( m_objs.count() > 0 )
{
QPtrListIterator<QObject> it( m_objs );
for ( ; it.current() ; ++it )
{
kdDebug(150) << "Factory still has object " << it.current() << " " << it.current()->name () << " Library = " << m_libname << endl;
disconnect( it.current(), SIGNAL( destroyed() ),
this, SLOT( slotObjectDestroyed() ) );
}
m_objs.setAutoDelete(true);
m_objs.clear();
}
if ( m_factory ) {
// kdDebug(150) << " ... deleting the factory " << m_factory << endl;
delete m_factory;
m_factory = 0L;
}
}
QString KLibrary::name() const
{
return m_libname;
}
QString KLibrary::fileName() const
{
return m_filename;
}
KLibFactory* KLibrary::factory()
{
if ( m_factory )
return m_factory;
QCString symname;
symname.sprintf("init_%s", name().latin1() );
void* sym = symbol( symname );
if ( !sym )
{
KLibLoader::self()->d->errorMessage = i18n( "The library %1 does not offer an %2 function." ).arg( name(), "init_" + name() );
kdWarning(150) << KLibLoader::self()->d->errorMessage << endl;
return 0;
}
typedef KLibFactory* (*t_func)();
t_func func = (t_func)sym;
m_factory = func();
if( !m_factory )
{
KLibLoader::self()->d->errorMessage = i18n( "The library %1 does not offer a KDE compatible factory." ).arg( name() );
kdWarning(150) << KLibLoader::self()->d->errorMessage << endl;
return 0;
}
connect( m_factory, SIGNAL( objectCreated( QObject * ) ),
this, SLOT( slotObjectCreated( QObject * ) ) );
return m_factory;
}
void* KLibrary::symbol( const char* symname ) const
{
void* sym = lt_dlsym( (lt_dlhandle) m_handle, symname );
if ( !sym )
{
KLibLoader::self()->d->errorMessage = "KLibrary: " + QString::fromLocal8Bit( lt_dlerror() );
kdWarning(150) << KLibLoader::self()->d->errorMessage << endl;
return 0;
}
return sym;
}
bool KLibrary::hasSymbol( const char* symname ) const
{
void* sym = lt_dlsym( (lt_dlhandle) m_handle, symname );
return (sym != 0L );
}
void KLibrary::unload() const
{
if (KLibLoader::s_self)
KLibLoader::s_self->unloadLibrary(QFile::encodeName(name()));
}
void KLibrary::slotObjectCreated( QObject *obj )
{
if ( !obj )
return;
if ( m_timer && m_timer->isActive() )
m_timer->stop();
if ( m_objs.containsRef( obj ) )
return; // we know this object already
connect( obj, SIGNAL( destroyed() ),
this, SLOT( slotObjectDestroyed() ) );
m_objs.append( obj );
}
void KLibrary::slotObjectDestroyed()
{
m_objs.removeRef( sender() );
if ( m_objs.count() == 0 )
{
// kdDebug(150) << "KLibrary: shutdown timer for " << name() << " started!"
// << endl;
if ( !m_timer )
{
m_timer = new QTimer( this, "klibrary_shutdown_timer" );
connect( m_timer, SIGNAL( timeout() ),
this, SLOT( slotTimeout() ) );
}
// as long as it's not stable make the timeout short, for debugging
// pleasure (matz)
//m_timer->start( 1000*60, true );
m_timer->start( 1000*10, true );
}
}
void KLibrary::slotTimeout()
{
if ( m_objs.count() != 0 )
return;
/* Don't go through KLibLoader::unloadLibrary(), because that uses the
ref counter, but this timeout means to unconditionally close this library
The destroyed() signal will take care to remove us from all lists.
*/
delete this;
}
// -------------------------------------------------
/* This helper class is needed, because KLibraries can go away without
being unloaded. So we need some info about KLibraries even after its
death. */
class KLibWrapPrivate
{
public:
KLibWrapPrivate(KLibrary *l, lt_dlhandle h);
KLibrary *lib;
enum {UNKNOWN, UNLOAD, DONT_UNLOAD} unload_mode;
int ref_count;
lt_dlhandle handle;
QString name;
QString filename;
};
KLibWrapPrivate::KLibWrapPrivate(KLibrary *l, lt_dlhandle h)
: lib(l), ref_count(1), handle(h), name(l->name()), filename(l->fileName())
{
unload_mode = UNKNOWN;
if (lt_dlsym(handle, "__kde_do_not_unload") != 0) {
// kdDebug(150) << "Will not unload " << name << endl;
unload_mode = DONT_UNLOAD;
} else if (lt_dlsym(handle, "__kde_do_unload") != 0) {
unload_mode = UNLOAD;
}
}
KLibLoader* KLibLoader::self()
{
if ( !s_self )
s_self = new KLibLoader;
return s_self;
}
void KLibLoader::cleanUp()
{
if ( !s_self )
return;
delete s_self;
s_self = 0L;
}
KLibLoader::KLibLoader( QObject* parent, const char* name )
: QObject( parent, name )
{
s_self = this;
d = new KLibLoaderPrivate;
lt_dlinit();
d->unload_mode = KLibLoaderPrivate::UNKNOWN;
if (getenv("KDE_NOUNLOAD") != 0)
d->unload_mode = KLibLoaderPrivate::DONT_UNLOAD;
else if (getenv("KDE_DOUNLOAD") != 0)
d->unload_mode = KLibLoaderPrivate::UNLOAD;
d->loaded_stack.setAutoDelete( true );
}
KLibLoader::~KLibLoader()
{
// kdDebug(150) << "Deleting KLibLoader " << this << " " << name() << endl;
QAsciiDictIterator<KLibWrapPrivate> it( m_libs );
for (; it.current(); ++it )
{
kdDebug(150) << "The KLibLoader contains the library " << it.current()->name
<< " (" << it.current()->lib << ")" << endl;
d->pending_close.append(it.current());
}
close_pending(0);
delete d;
d = 0L;
}
static inline QCString makeLibName( const char* name )
{
QCString libname(name);
// only append ".la" if there is no extension
// this allows to load non-libtool libraries as well
// (mhk, 20000228)
int pos = libname.findRev('/');
if (pos < 0)
pos = 0;
if (libname.find('.', pos) < 0)
libname += ".la";
return libname;
}
//static
QString KLibLoader::findLibrary( const char * name, const KInstance * instance )
{
QCString libname = makeLibName( name );
// only look up the file if it is not an absolute filename
// (mhk, 20000228)
QString libfile;
if (!QDir::isRelativePath(libname))
libfile = QFile::decodeName( libname );
else
{
libfile = instance->dirs()->findResource( "module", libname );
if ( libfile.isEmpty() )
{
libfile = instance->dirs()->findResource( "lib", libname );
#ifndef NDEBUG
if ( !libfile.isEmpty() && libname.left(3) == "lib" ) // don't warn for kdeinit modules
kdDebug(150) << "library " << libname << " not found under 'module' but under 'lib'" << endl;
#endif
}
}
return libfile;
}
KLibrary* KLibLoader::globalLibrary( const char *name )
{
KLibrary *tmp;
int olt_dlopen_flag = lt_dlopen_flag;
lt_dlopen_flag |= LT_GLOBAL;
kdDebug(150) << "Loading the next library global with flag "
<< lt_dlopen_flag
<< "." << endl;
tmp = library(name);
lt_dlopen_flag = olt_dlopen_flag;
return tmp;
}
KLibrary* KLibLoader::library( const char *name )
{
if (!name)
return 0;
KLibWrapPrivate* wrap = m_libs[name];
if (wrap) {
/* Nothing to do to load the library. */
wrap->ref_count++;
return wrap->lib;
}
/* Test if this library was loaded at some time, but got
unloaded meanwhile, whithout being dlclose()'ed. */
QPtrListIterator<KLibWrapPrivate> it(d->loaded_stack);
for (; it.current(); ++it) {
if (it.current()->name == name)
wrap = it.current();
}
if (wrap) {
d->pending_close.removeRef(wrap);
if (!wrap->lib) {
/* This lib only was in loaded_stack, but not in m_libs. */
wrap->lib = new KLibrary( name, wrap->filename, wrap->handle );
}
wrap->ref_count++;
} else {
QString libfile = findLibrary( name );
if ( libfile.isEmpty() )
{
const QCString libname = makeLibName( name );
#ifndef NDEBUG
kdDebug(150) << "library=" << name << ": No file named " << libname << " found in paths." << endl;
#endif
d->errorMessage = i18n("Library files for \"%1\" not found in paths.").arg(libname);
return 0;
}
lt_dlhandle handle = lt_dlopen( QFile::encodeName(libfile) );
if ( !handle )
{
const char* errmsg = lt_dlerror();
if(errmsg)
d->errorMessage = QString::fromLocal8Bit(errmsg);
else
d->errorMessage = QString::null;
return 0;
}
else
d->errorMessage = QString::null;
KLibrary *lib = new KLibrary( name, libfile, handle );
wrap = new KLibWrapPrivate(lib, handle);
d->loaded_stack.prepend(wrap);
}
m_libs.insert( name, wrap );
connect( wrap->lib, SIGNAL( destroyed() ),
this, SLOT( slotLibraryDestroyed() ) );
return wrap->lib;
}
QString KLibLoader::lastErrorMessage() const
{
return d->errorMessage;
}
void KLibLoader::unloadLibrary( const char *libname )
{
KLibWrapPrivate *wrap = m_libs[ libname ];
if (!wrap)
return;
if (--wrap->ref_count)
return;
// kdDebug(150) << "closing library " << libname << endl;
m_libs.remove( libname );
disconnect( wrap->lib, SIGNAL( destroyed() ),
this, SLOT( slotLibraryDestroyed() ) );
close_pending( wrap );
}
KLibFactory* KLibLoader::factory( const char* name )
{
KLibrary* lib = library( name );
if ( !lib )
return 0;
return lib->factory();
}
void KLibLoader::slotLibraryDestroyed()
{
const KLibrary *lib = static_cast<const KLibrary *>( sender() );
QAsciiDictIterator<KLibWrapPrivate> it( m_libs );
for (; it.current(); ++it )
if ( it.current()->lib == lib )
{
KLibWrapPrivate *wrap = it.current();
wrap->lib = 0; /* the KLibrary object is already away */
m_libs.remove( it.currentKey() );
close_pending( wrap );
return;
}
}
void KLibLoader::close_pending(KLibWrapPrivate *wrap)
{
if (wrap && !d->pending_close.containsRef( wrap ))
d->pending_close.append( wrap );
/* First delete all KLibrary objects in pending_close, but _don't_ unload
the DSO behind it. */
QPtrListIterator<KLibWrapPrivate> it(d->pending_close);
for (; it.current(); ++it) {
wrap = it.current();
if (wrap->lib) {
disconnect( wrap->lib, SIGNAL( destroyed() ),
this, SLOT( slotLibraryDestroyed() ) );
KLibrary* to_delete = wrap->lib;
wrap->lib = 0L; // unset first, because KLibrary dtor can cause
delete to_delete; // recursive call to close_pending()
}
}
if (d->unload_mode == KLibLoaderPrivate::DONT_UNLOAD) {
d->pending_close.clear();
return;
}
bool deleted_one = false;
while ((wrap = d->loaded_stack.first())) {
/* Let's first see, if we want to try to unload this lib.
If the env. var KDE_DOUNLOAD is set, we try to unload every lib.
If not, we look at the lib itself, and unload it only, if it exports
the symbol __kde_do_unload. */
if (d->unload_mode != KLibLoaderPrivate::UNLOAD
&& wrap->unload_mode != KLibWrapPrivate::UNLOAD)
break;
/* Now ensure, that the libs are only unloaded in the reverse direction
they were loaded. */
if (!d->pending_close.containsRef( wrap )) {
if (!deleted_one)
/* Only diagnose, if we really haven't deleted anything. */
// kdDebug(150) << "try to dlclose " << wrap->name << ": not yet" << endl;
break;
}
// kdDebug(150) << "try to dlclose " << wrap->name << ": yes, done." << endl;
if ( !deleted_one ) {
/* Only do the hack once in this loop.
WABA: *HACK*
We need to make sure to clear the clipboard before unloading a DSO
because the DSO could have defined an object derived from QMimeSource
and placed that on the clipboard. */
/*kapp->clipboard()->clear();*/
/* Well.. let's do something more subtle... convert the clipboard context
to text. That should be safe as it only uses objects defined by Qt. */
if( kapp->clipboard()->ownsSelection()) {
kapp->clipboard()->setText(
kapp->clipboard()->text( QClipboard::Selection ), QClipboard::Selection );
}
if( kapp->clipboard()->ownsClipboard()) {
kapp->clipboard()->setText(
kapp->clipboard()->text( QClipboard::Clipboard ), QClipboard::Clipboard );
}
}
deleted_one = true;
lt_dlclose(wrap->handle);
d->pending_close.removeRef(wrap);
/* loaded_stack is AutoDelete, so wrap is freed */
d->loaded_stack.remove();
}
}
void KLibLoader::virtual_hook( int, void* )
{ /*BASE::virtual_hook( id, data );*/ }
void KLibFactory::virtual_hook( int, void* )
{ /*BASE::virtual_hook( id, data );*/ }
#include "klibloader.moc"
KLibLoader::globalLibrary
KLibrary * globalLibrary(const char *name)
Loads and initializes a library.
Definition: klibloader.cpp:374
KLibFactory
If you develop a library that is to be loaded dynamically at runtime, then you should return a pointe...
Definition: klibloader.h:333
KLibLoader::lastErrorMessage
QString lastErrorMessage() const
Returns an error message that can be useful to debug the problem.
Definition: klibloader.cpp:454
klocale.h
KLibLoader::unloadLibrary
virtual void unloadLibrary(const char *libname)
Unloads the library with the given name.
Definition: klibloader.cpp:459
KLibLoader::~KLibLoader
~KLibLoader()
You should NEVER destruct an instance of KLibLoader until you know what you are doing.
Definition: klibloader.cpp:316
KLibrary::KLibrary
KLibrary(const QString &libname, const QString &filename, void *handle)
Don't create KLibrary objects on your own.
Definition: klibloader.cpp:98
KLibrary::unload
void unload() const
Unloads the library.
Definition: klibloader.cpp:198
KLibrary::name
QString name() const
Returns the name of the library.
Definition: klibloader.cpp:136
KLibrary
Represents a dynamically loaded library.
Definition: klibloader.h:50
KInstance
Access to KDE global objects for use in shared libraries.
Definition: kinstance.h:43
KLibrary::factory
KLibFactory * factory()
Returns the factory of the library.
Definition: klibloader.cpp:146
KLibrary::fileName
QString fileName() const
Returns the file name of the library.
Definition: klibloader.cpp:141
KLibrary::hasSymbol
bool hasSymbol(const char *name) const
Looks up a symbol from the library.
Definition: klibloader.cpp:192
KLibLoader::library
virtual KLibrary * library(const char *libname)
Loads and initializes a library.
Definition: klibloader.cpp:390
KStdAction::name
const char * name(StdAction id)
KLibFactory::objectCreated
void objectCreated(QObject *obj)
Emitted in create.
KLibLoader::findLibrary
static QString findLibrary(const char *name, const KInstance *instance=KGlobal::instance())
Helper method which looks for a library in the standard paths ("module" and "lib" resources)...
Definition: klibloader.cpp:349
KLibLoader::self
static KLibLoader * self()
Returns a pointer to the factory.
Definition: klibloader.cpp:286
KLibLoader
The KLibLoader allows you to load libraries dynamically at runtime.
Definition: klibloader.h:142
KLibFactory::KLibFactory
KLibFactory(QObject *parent=0, const char *name=0)
Create a new factory.
Definition: klibloader.cpp:71
KInstance::dirs
KStandardDirs * dirs() const
Returns the application standard dirs object.
Definition: kinstance.cpp:159
KLibLoader::factory
KLibFactory * factory(const char *libname)
Loads and initializes a library.
Definition: klibloader.cpp:476
KLibFactory::createObject
virtual QObject * createObject(QObject *parent=0, const char *name=0, const char *className="QObject", const QStringList &args=QStringList())=0
Creates a new object.
Definition: klibloader.cpp:90
KStandardDirs::findResource
QString findResource(const char *type, const QString &filename) const
Tries to find a resource in the following order:
Definition: kstandarddirs.cpp:318
KLibrary::symbol
void * symbol(const char *name) const
Looks up a symbol from the library.
Definition: klibloader.cpp:179
KLibFactory::create
QObject * create(QObject *parent=0, const char *name=0, const char *classname="QObject", const QStringList &args=QStringList())
Creates a new object.
Definition: klibloader.cpp:81
endl
kndbgstream & endl(kndbgstream &s)
Does nothing.
Definition: kdebug.h:583

KDE Home | KDE Accessibility Home | Description of Access Keys