TroubleshootingRunner.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2026 Gunter Königsmann <wxMaxima@physikbuch.de>
//
//  This program 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 2 of the License, or
//  (at your option) any later version.
//
//  This program 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 this program; if not, write to the Free Software
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef TROUBLESHOOTINGRUNNER_H
#define TROUBLESHOOTINGRUNNER_H
 
#include "TroubleshootingChecks.h"
#include <wx/event.h>
#include <wx/process.h>
#include <wx/socket.h>
#include <wx/timer.h>
#include <wx/utils.h>
#include <functional>
#include <memory>
#include <set>
#include <string>
 
class TroubleshootingRunner : public wxEvtHandler
{
public:
  struct Settings {
    wxString maximaExecutable;
    wxString maximaConfigured;
    wxString maximaCommand;
    wxEnvVariableHashMap environment;
    wxString setupCommand;
    wxString setupCheckFunction = wxS("wx-define-unicode-aliases");
    wxString gnuplotCommand;
    long connectTimeoutMs = 30000;
    long promptTimeoutMs = 60000;
    long setupTimeoutMs = 60000;
    long queryTimeoutMs = 90000;
    long stopTimeoutMs = 10000;
    long gnuplotTimeoutMs = 30000;
  };
 
  using ResultCallback = std::function<void (const wxm::TroubleshootingResult &)>;
 
  TroubleshootingRunner(const Settings &settings, ResultCallback onResult,
                        std::function<void ()> onFinished = {});
  ~TroubleshootingRunner() override;
 
  void Start();
  void Poll();
  bool IsFinished() const { return m_stage == Stage::finished; }
 
  static const std::set<wxm::TroubleshootingCheck> &Checks();
 
private:
  class Process;
  friend class Process;
 
  enum class Stage {
    notStarted,
    waitConnect,
    waitPrompt,
    waitSetup,
    waitAnswers,
    waitStop,
    gnuplotPng,
    gnuplotPngCairo,
    finished
  };
 
  void Report(wxm::TroubleshootingCheck check, wxm::TroubleshootingStatus status,
              const wxString &details, const wxString &hint = wxEmptyString);
  void SkipRemainingMaximaChecks(const wxString &reason);
  void StartMaxima();
  void PumpIO();
  void ProcessEnded(Process *process, int status);
  void PollConnect();
  void PollPrompt();
  void PollSetup();
  void PollAnswers();
  void SendQuestions();
  void EvaluateAnswers(bool timedOut);
  void StopMaxima();
  void PollStop();
  void StartGnuplot(const wxString &terminal);
  void PollGnuplot();
  wxString FindGnuplot();
  void EnterStage(Stage stage);
  long StageAge() const;
  wxString MaximaOutputTail() const;
  void SendToMaxima(const wxString &text);
 
  Settings m_settings;
  ResultCallback m_onResult;
  std::function<void ()> m_onFinished;
  std::set<wxm::TroubleshootingCheck> m_reported;
  Stage m_stage = Stage::notStarted;
  wxLongLong m_stageStart;
  wxTimer m_timer;
 
  std::unique_ptr<wxSocketServer> m_server;
  int m_port = 0;
  std::unique_ptr<wxSocketBase> m_socket;
  wxString m_secret;
  wxString m_fromMaxima;
  std::string m_undecoded;
  std::string m_toMaxima;
  bool m_gotPrompt = false;
  bool m_authenticated = false;
 
  Process *m_maxima = nullptr;
  long m_maximaPid = 0;
  bool m_maximaEnded = false;
  int m_maximaExitCode = 0;
  bool m_killedMaxima = false;
  wxString m_maximaConsole;
 
  Process *m_gnuplot = nullptr;
  bool m_gnuplotEnded = false;
  int m_gnuplotExitCode = 0;
  wxString m_gnuplotErrors;
  wxString m_gnuplotTerminal;
  wxString m_gnuplotScript;
  wxString m_gnuplotOutput;
  wxString m_gnuplotBinary;
 
  wxString m_tempDir;
  wxString m_gnuplotFromMaxima;
};
 
#endif // TROUBLESHOOTINGRUNNER_H