dynamic-ld.h

Go to the documentation of this file.

/*

Copyright (C) 1993-2017 John W. Eaton

This file is part of Octave.

Octave 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.

Octave 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 Octave; see the file COPYING.  If not, see
<http://www.gnu.org/licenses/>.

*/

#if ! defined (octave_dynamic_ld_h)
#define octave_dynamic_ld_h 1

#include "octave-config.h"

#include <string>

#include "oct-shlib.h"

class octave_function;

class
octave_dynamic_loader
{
protected:

  octave_dynamic_loader (void) { }

public:

  virtual ~octave_dynamic_loader (void) { }

  static octave_function *
  load_oct (const std::string& fcn_name,
            const std::string& file_name = "",
            bool relative = false);

  static octave_function *
  load_mex (const std::string& fcn_name,
            const std::string& file_name = "",
            bool relative = false);

  static bool remove_oct (const std::string& fcn_name,
                          octave::dynamic_library& shl);

  static bool remove_mex (const std::string& fcn_name,
                          octave::dynamic_library& shl);

private:

  // No copying!

  octave_dynamic_loader (const octave_dynamic_loader&);

  octave_dynamic_loader& operator = (const octave_dynamic_loader&);

  static octave_dynamic_loader *instance;

  static void cleanup_instance (void) { delete instance; instance = 0; }

  static bool instance_ok (void);

  octave_function *
  do_load_oct (const std::string& fcn_name,
               const std::string& file_name = "",
               bool relative = false);

  octave_function *
  do_load_mex (const std::string& fcn_name,
               const std::string& file_name = "",
               bool relative = false);

  bool do_remove_oct (const std::string& fcn_name, octave::dynamic_library& shl);

  bool do_remove_mex (const std::string& fcn_name, octave::dynamic_library& shl);

  static bool doing_load;

protected:

  static std::string name_mangler (const std::string& name);

  static std::string name_uscore_mangler (const std::string& name);

  static std::string mex_mangler (const std::string& name);

  static std::string mex_uscore_mangler (const std::string& name);

  static std::string mex_f77_mangler (const std::string& name);
};

#endif