src/cavernlog.h

   1 /* cavernlog.h
   2  * Run cavern inside an Aven window
   3  *
   4  * Copyright (C) 2005-2024 Olly Betts
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef SURVEX_CAVERNLOG_H
  22 #define SURVEX_CAVERNLOG_H
  23
  24 #include "wx.h"
  25 #include <wx/process.h>
  26
  27 #include <string>
  28 #include <vector>
  29
  30 class MainFrm;
  31
  32 class CavernLogWindow : public wxScrolledWindow {
  33     wxString filename;
  34
  35     MainFrm * mainfrm;
  36
  37     wxProcess * cavern_out = nullptr;
  38     size_t ptr = 0;
  39     bool expecting_caret_line = false;
  40     int info_count = 0;
  41     int link_count = 0;
  42
  43     bool init_done = false;
  44
  45     wxString survey;
  46
  47     wxTimer timer;
  48
  49     std::string log_txt;
  50
  51     enum { LOG_NONE, LOG_ERROR, LOG_WARNING, LOG_INFO };
  52
  53     class LineInfo {
  54       public:
  55         unsigned start_offset = 0;
  56         unsigned len = 0;
  57         unsigned link_len = 0;
  58         unsigned link_pixel_width = 0;
  59         unsigned colour = LOG_NONE;
  60         unsigned colour_start = 0;
  61         unsigned colour_len = 0;
  62
  63         LineInfo() { }
  64
  65         explicit LineInfo(unsigned start_offset_)
  66             : start_offset(start_offset_) { }
  67     };
  68
  69     std::vector<LineInfo> line_info;
  70
  71     wxButton* save_button = nullptr;
  72     wxButton* reprocess_button = nullptr;
  73     wxButton* ok_button = nullptr;
  74
  75   public:
  76     CavernLogWindow(MainFrm * mainfrm_, const wxString & survey_, wxWindow * parent);
  77
  78     ~CavernLogWindow();
  79
  80     /** Start to process survey data in file. */
  81     void process(const wxString &file);
  82
  83     void OnMouseMove(wxMouseEvent& e);
  84
  85     void OnLinkClicked(wxMouseEvent& e);
  86
  87     void OnReprocess(wxCommandEvent &);
  88
  89     void OnSave(wxCommandEvent &);
  90
  91     void OnOK(wxCommandEvent &);
  92
  93     void ProcessCavernOutput();
  94
  95     void OnCavernOutput(wxCommandEvent&) {
  96         ProcessCavernOutput();
  97         Update();
  98         timer.StartOnce();
  99     }
 100
 101     void CheckForOutput(bool immediate = false);
 102
 103     void OnIdle(wxIdleEvent&) { CheckForOutput(); }
 104
 105     void OnTimer(wxTimerEvent&) { CheckForOutput(); }
 106
 107     int OnPaintButton(wxButton* b, int x);
 108
 109     void OnPaint(wxPaintEvent&);
 110
 111     void OnEndProcess(wxProcessEvent & e);
 112
 113     DECLARE_EVENT_TABLE()
 114 };
 115
 116 wxString escape_for_shell(wxString s, bool protect_dash = false);
 117 wxString get_command_path(const wxChar * command_name);
 118
 119 #endif