file-editor-tab.h

Go to the documentation of this file.

/*

Copyright (C) 2011-2018 Jacob Dawid

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_file_editor_tab_h)
#define octave_file_editor_tab_h 1

#include <QWidget>
#include <QCloseEvent>
#include <QFileSystemWatcher>
#include <QSettings>
#include <QFileInfo>
#include <Qsci/qsciapis.h>
#include <QStatusBar>
#include <QLabel>
#include <QComboBox>

#include "find-dialog.h"
#include "octave-qscintilla.h"
#include "builtin-defun-decls.h"

#include "marker.h" /* Only needed for typedef of "QIntList", which may be
                       typedefed elsewhere.  Could use common location. */

class octave_value_list;

namespace octave
{
  class file_editor;

  class file_editor_tab : public QWidget
  {
    Q_OBJECT

  public:

    file_editor_tab (const QString& directory = "");

    ~file_editor_tab (void);

    octave_qscintilla * qsci_edit_area (void) { return _edit_area; }

    // Will initiate close if associated with the identifier tag.
    bool conditional_close (void);

    static void reset_cancel (void) {_cancelled = false;}
    static bool was_cancelled (void) {return _cancelled;}

  public slots:

    void update_window_title (bool modified);
    void handle_copy_available (bool enableCopy);
    void handle_margin_clicked (int line, int margin,
                                Qt::KeyboardModifiers state);

    // Tells the editor tab to react on changed settings.
    void notice_settings (const QSettings *settings, bool init = false);

    // Change to a different editor tab by identifier tag.
    void change_editor_state (const QWidget *ID);

    // Simply transmit filename.
    void file_name_query (const QWidget *ID);

    void set_focus (const QWidget *ID);
    void set_current_directory (const QString& dir);
    void context_help (const QWidget *ID, bool);
    void context_edit (const QWidget *ID);
    void check_modified_file (void);
    void save_file (const QWidget *ID);
    void save_file (const QWidget *ID, const QString& fileName,
                    bool remove_on_success);
    void save_file_as (const QWidget *ID);
    void print_file (const QWidget *ID);
    void run_file (const QWidget *ID);
    void context_run (const QWidget *ID);
    void toggle_bookmark (const QWidget *ID);
    void next_bookmark (const QWidget *ID);
    void previous_bookmark (const QWidget *ID);
    void remove_bookmark (const QWidget *ID);

    void toggle_breakpoint (const QWidget *ID);
    void next_breakpoint (const QWidget *ID);
    void previous_breakpoint (const QWidget *ID);
    void remove_all_breakpoints (const QWidget *ID);

    void scintilla_command (const QWidget *, unsigned int);

    void comment_selected_text (const QWidget *ID, bool input_str);
    void uncomment_selected_text (const QWidget *ID);

    void indent_selected_text (const QWidget *ID);
    void unindent_selected_text (const QWidget *ID);
    void smart_indent_line_or_selected_text (const QWidget *ID);
    void convert_eol (const QWidget *ID, QsciScintilla::EolMode);

    void zoom_in (const QWidget *ID);
    void zoom_out (const QWidget *ID);
    void zoom_normal (const QWidget *ID);

    void find (const QWidget *ID, QList<QAction *>);
    void find_next (const QWidget *ID);
    void find_previous (const QWidget *ID);
    void goto_line (const QWidget *ID, int line = -1);
    void move_match_brace (const QWidget *ID, bool select);
    void show_auto_completion (const QWidget *ID);

    void insert_debugger_pointer (const QWidget *ID, int line = -1);
    void delete_debugger_pointer (const QWidget *ID, int line = -1);

    void do_breakpoint_marker (bool insert, const QWidget *ID, int line = -1,
                               const QString& cond = "");

    void recover_from_exit (void);
    void set_modified (bool modified = true);

    void set_encoding (const QString& new_encoding);

    QString load_file (const QString& fileName);

    void new_file (const QString& commands = QString ());

    void file_has_changed (const QString& path, bool do_close = false);

    void handle_context_menu_edit (const QString&);
    void handle_context_menu_break_condition (int linenr);

    void handle_request_add_breakpoint (int line, const QString& cond);
    void handle_request_remove_breakpoint (int line);

    void handle_octave_result (QObject *requester, QString& command,
                               octave_value_list& result);

  signals:

    void file_name_changed (const QString& fileName, const QString& toolTip);
    void editor_state_changed (bool copy_available, bool is_octave_file);
    void set_focus_editor_signal (QWidget *);
    void tab_remove_request (void);
    void add_filename_to_list (const QString&, const QString&, QWidget *);
    void mru_add_file (const QString& file_name, const QString& encoding);
    void editor_check_conflict_save (const QString& saveFileName,
                                     bool remove_on_success);
    void run_file_signal (const QFileInfo& info);
    void request_open_file (const QString&);
    void edit_mfile_request (const QString&, const QString&,
                             const QString&, int);

    void request_find_next (void);
    void request_find_previous (void);

    void remove_breakpoint_via_debugger_linenr (int debugger_linenr);
    void request_remove_breakpoint_via_editor_linenr (int editor_linenr);
    void remove_all_breakpoints (void);
    void find_translated_line_number (int original_linenr,
                                      int& translated_linenr, marker*&);
    void find_linenr_just_before (int linenr, int& original_linenr,
                                  int& editor_linenr);
    void report_marker_linenr (QIntList& lines, QStringList& conditions);
    void remove_position_via_debugger_linenr (int debugger_linenr);
    void remove_all_positions (void);
    void execute_command_in_terminal_signal (const QString&);

    // FIXME: The following is similar to "process_octave_code"
    // signal.  However, currently that signal is connected to
    // something that simply focuses a window and not actually
    // communicate with Octave.
    //
    // void evaluate_octave_command (const QString& command);

  protected:

    void closeEvent (QCloseEvent *event);
    void set_file_name (const QString& fileName);

  private slots:

    // When user closes message box for reload question.
    void handle_file_reload_answer (int decision);

    // When user closes message box for resave question.
    void handle_file_resave_answer (int decision);

    // When user closes message box for modified question.
    void handle_file_modified_answer (int decision);

    // When user closes find_dialog box.
    void handle_find_dialog_finished (int decision);

    // When user closes QFileDialog box.
    void handle_save_file_as_answer (const QString& fileName);
    void handle_save_file_as_answer_close (const QString& fileName);
    void handle_save_file_as_answer_cancel (void);
    void handle_save_as_filter_selected (const QString& filter);
    void handle_combo_eol_current_index (int index);
    void handle_combo_enc_current_index (QString text);

    // When apis preparation has finished and is ready to save
    void save_apis_info (void);

    // When the numer of lines changes -> adapt width of margin
    void auto_margin_width (void);

    void handle_cursor_moved (int line, int col);
    void handle_char_added (int character);
    void handle_double_click (int p, int l, int modifier);
    void handle_lines_changed (void);

  private:

    struct bp_info
    {
      bp_info (const QString& fname, int l = 0, const QString& cond = "");

      int line;
      std::string file;
      std::string dir;
      std::string function_name;
      std::string condition;
    };

    bool valid_file_name (const QString& file = QString ());
    bool exit_debug_and_clear (const QString& full_name,
                               const QString& base_name);
    void save_file (const QString& saveFileName, bool remove_on_success = false,
                    bool restore_breakpoints = true);
    void save_file_as (bool remove_on_success = false);
    bool check_valid_identifier (QString file_name);
    bool check_valid_codec (QTextCodec *codec);

    bool unchanged_or_saved (void);

    void update_lexer (void);
    void update_lexer_settings (void);

    void show_dialog (QDialog *dlg, bool modal);
    int check_file_modified (void);
    void do_comment_selected_text (bool comment, bool input_str = false);
    void do_indent_selected_text (bool indent);
    void do_smart_indent_line_or_selected_text (void);

    void add_breakpoint_callback (const bp_info& info);
    void remove_breakpoint_callback (const bp_info& info);
    void remove_all_breakpoints_callback (const bp_info& info);
    void check_restore_breakpoints (void);
    void center_current_line (bool always=true);

    void add_octave_apis (octave_value_list key_ovl);
    QString get_function_name (void);

    QsciScintilla::EolMode detect_eol_mode (void);
    void update_eol_indicator (void);

    octave_qscintilla *_edit_area;

    QStatusBar *_status_bar;
    QLabel *_row_indicator;
    QLabel *_col_indicator;
    QLabel *_eol_indicator;
    QLabel *_enc_indicator;

    QsciScintilla::EolMode _save_as_desired_eol;

    QString _file_name;
    QString _file_name_short;
    QString _ced;
    QString _encoding;
    QString _new_encoding;

    bool _long_title;
    bool _copy_available;
    bool _is_octave_file;
    bool _always_reload_changed_files;
    bool _smart_indent;
    int _auto_endif;

    QFileSystemWatcher _file_system_watcher;

    QIntList _bp_lines;
    QStringList _bp_conditions;

    find_dialog *_find_dialog;
    bool _find_dialog_is_visible;
    QRect _find_dialog_geometry;

    QsciAPIs *_lexer_apis;
    QString _prep_apis_file;

    static bool _cancelled;

    int _line_break;
    bool _line_break_comments;
    int _line;
    int _col;
    bool _lines_changed;
    bool _highlight_all_occurrences;
    int m_bp_restore_count;
  };
}

#endif