////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2023 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// 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
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////

#if ! defined (octave_ov_dld_fcn_h)
#define octave_ov_dld_fcn_h 1

#include "octave-config.h"

#include <string>

#include "oct-shlib.h"

#include "ov-fcn.h"
#include "ov-builtin.h"
#include "ov-typeinfo.h"

class octave_value;
class octave_value_list;

// Dynamically-linked functions.

class
OCTINTERP_API
octave_dld_function : public octave_builtin
{
public:

  octave_dld_function ()
    : m_sh_lib (), m_time_checked (), m_system_fcn_file ()
  { }

  octave_dld_function (octave_builtin::fcn ff,
                       const octave::dynamic_library& shl,
                       const std::string& nm = "",
                       const std::string& ds = "");

  octave_dld_function (octave_builtin::meth mm,
                       const octave::dynamic_library& shl,
                       const std::string& nm = "",
                       const std::string& ds = "");

  OCTAVE_DISABLE_COPY_MOVE (octave_dld_function)

  ~octave_dld_function ();

  void mark_fcn_file_up_to_date (const octave::sys::time& t)
  { m_time_checked = t; }

  std::string fcn_file_name () const;

  octave::sys::time time_parsed () const;

  octave::sys::time time_checked () const { return m_time_checked; }

  bool is_system_fcn_file () const { return m_system_fcn_file; }

  bool is_builtin_function () const { return false; }

  bool is_dld_function () const { return true; }

  static octave_dld_function * create (octave_builtin::fcn ff,
                                      const octave::dynamic_library& shl,
                                      const std::string& nm = "",
                                      const std::string& ds = "");

  static octave_dld_function * create (octave_builtin::meth mm,
                                      const octave::dynamic_library& shl,
                                      const std::string& nm = "",
                                      const std::string& ds = "");

  octave::dynamic_library get_shlib () const
  { return m_sh_lib; }

private:

  octave::dynamic_library m_sh_lib;

  // The time the file was last checked to see if it needs to be
  // parsed again.
  octave::sys::time m_time_checked;

  // True if this function came from a file that is considered to be a
  // system function.  This affects whether we check the time stamp
  // on the file to see if it has changed.
  bool m_system_fcn_file;

  DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
};

#endif