library_loader.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2011-06-30
 * Last modified : 2013-04-19
 *
 * Copyright (C) 2014 Ben Morgan <Ben.Morgan@warwick.ac.uk>
 * Copyright (C) 2011-2013 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *  A shared library loader facility (based on kwsys).
 *
 */

#ifndef DATATOOLS_LIBRARY_LOADER_H
#define DATATOOLS_LIBRARY_LOADER_H

// Standard Library:
#include <iostream>
#include <string>
#include <memory>

// Third Party:
// - Boost:
#include <boost/cstdint.hpp>
#include <boost/utility.hpp>

// This Project:
#include <datatools/datatools_config.h>
#include <datatools/bit_mask.h>
#include <datatools/detail/DynamicLoader.h>
#include <datatools/multi_properties.h>

namespace datatools {

  class library_loader
    : boost::noncopyable
  {
  public:
    typedef datatools::detail::DynamicLoader::SymbolPointer symbol_ptr;

    library_loader();

    explicit library_loader(const std::string & config_file_);

    library_loader(const datatools::multi_properties & config_);

    virtual ~library_loader();

    bool has(const std::string & name_) const;

    bool is_loaded(const std::string & name_) const;

    int registration(const std::string & name_,
                     const std::string & directory_ = "",
                     const std::string & filename_  = "",
                     const std::string & full_path_ = "",
                     const std::string & version_   = "",
                     bool autoload_ = false);


    int load(const std::string & name_,
             const std::string & directory_ = "",
             const std::string & filename_  = "",
             const std::string & full_path_ = "",
             const std::string & version_   = "");

    int close(const std::string & name_);

    int close_all();

    void print(std::ostream & out_ = std::clog) const;

    symbol_ptr get_symbol_address(const std::string & name_,
                                  const std::string & symbol_);

  protected:

    void _init();

  private:

    datatools::multi_properties _config_; 
    class LibraryCollection;
    std::unique_ptr<LibraryCollection> _lib_entries_; 

  };

} // end of namespace datatools

#endif // DATATOOLS_LIBRARY_LOADER_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --