TroubleshootingChecks.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 TROUBLESHOOTINGCHECKS_H
#define TROUBLESHOOTINGCHECKS_H
 
#include <wx/string.h>
#include <cstddef>
#include <vector>
 
namespace wxm {
 
enum class TroubleshootingCheck {
  maximaFound,        
  server,             
  maximaStarts,       
  maximaConnects,     
  firstPrompt,        
  authentication,     
  wxMathML,           
  loadPackage,        
  loadDraw,           
  tempDir,            
  gnuplotFound,       
  gnuplotPng,         
  gnuplotPngCairo,    
  maximaStops,        
  maximaHtmlManual,   
  maximaInfoManual,   
  wxMaximaHtmlManual, 
  helpKnowsManual,    
  helpSidebar,        
  externalBrowser,    
  translations,       
  bidiText,           
  svgText,            
  aiSidebar,          
  count               
};
 
enum class TroubleshootingStatus {
  pending, 
  running, 
  ok,      
  info,    
  warning, 
  failed,  
  skipped  
};
 
enum class TroubleshootingSection {
  maxima,    
  plots,     
  help,      
  userInterface, 
  count      
};
 
struct TroubleshootingResult {
  TroubleshootingCheck check = TroubleshootingCheck::maximaFound;
  TroubleshootingStatus status = TroubleshootingStatus::pending;
  wxString details;
  wxString hint;
};
 
std::vector<TroubleshootingCheck> AllTroubleshootingChecks();
 
wxString TroubleshootingCheckTitle(TroubleshootingCheck check);
 
wxString TroubleshootingStatusName(TroubleshootingStatus status);
 
wxString TroubleshootingStatusSymbol(TroubleshootingStatus status);
 
std::vector<TroubleshootingSection> AllTroubleshootingSections();
 
TroubleshootingSection TroubleshootingSectionOf(TroubleshootingCheck check);
 
wxString TroubleshootingSectionTitle(TroubleshootingSection section);
 
TroubleshootingStatus TroubleshootingSummaryStatus(const std::vector<TroubleshootingStatus> &statuses);
 
wxString TroubleshootingReport(const std::vector<TroubleshootingResult> &results);
 
wxString TroubleshootingProbeValue(const wxString &text, const wxString &key, bool *found);
 
bool PathHasQuote(const wxString &path);
 
bool IsPngData(const unsigned char *data, std::size_t size);
 
wxString GnuplotSingleQuoted(const wxString &path);
 
bool GnuplotLacksTerminal(const wxString &gnuplotErrors);
 
} // namespace wxm
 
#endif // TROUBLESHOOTINGCHECKS_H