////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2011-2024 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_terminal_dock_widget_h)
#define octave_terminal_dock_widget_h 1

#include <QString>

#include "octave-dock-widget.h"

class QTerminal;

OCTAVE_BEGIN_NAMESPACE(octave)

class command_widget;

class terminal_dock_widget : public octave_dock_widget
{
  Q_OBJECT

public:

  terminal_dock_widget (QWidget *parent,
                        bool experimental_terminal_widget = false);

  ~terminal_dock_widget () = default;

  bool has_focus () const;

  void init_command_prompt ();

  void init_control_d_shortcut_behavior ();

  // FIXME: The next two functions could be eliminated (or combined)
  // if we had a common interface for the old and new terminal
  // widgets.

  // Only valid if using the old terminal widget.
  QTerminal * get_qterminal ();

#if defined (HAVE_QSCINTILLA)
  // Only valid if using the new terminal widget.
  command_widget * get_command_widget ();
#endif

signals:

  void settings_changed ();

  // Note: the following four signals are
  // currently only used by the new experimental terminal widget.

  void update_prompt_signal (const QString&);

  void interpreter_output_signal (const QString&);

  void new_command_line_signal (const QString& = QString ());

  void execute_command_signal (const QString&);

  void interpreter_event (const fcn_callback& fcn);
  void interpreter_event (const meth_callback& meth);

public slots:

  void notice_settings ();

private:

  bool m_experimental_terminal_widget;

  // FIXME!!!  Maybe my_term should just be derived from QTerminal?
  QWidget *m_terminal;
};

OCTAVE_END_NAMESPACE(octave)

#endif