Maxima.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2004-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//            (C) 2014-2018 Gunter Königsmann <wxMaxima@physikbuch.de>
//            (C) 2020      Kuba Ober <kuba@bertec.com>
//
//  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 WXMAXIMA_MAXIMA_H
#define WXMAXIMA_MAXIMA_H
 
#include "StreamUtils.h"
#include <wx/buffer.h>
#include <wx/event.h>
#include <wx/sckstrm.h>
#include <wx/socket.h>
#include <wx/string.h>
#include <wx/timer.h>
#include <memory>
 
class Maxima : public wxEvtHandler
{
public:
  explicit Maxima(wxSocketBase *socket);
  ~Maxima() override;
 
  wxSocketBase *Socket() const { return m_socket.get(); }
 
  bool IsConnected() const { return m_socket->IsConnected(); }
 
  void SetPipeToStdOut(bool pipe) { m_pipeToStdout = pipe; }
 
  bool Write(const void *buffer, size_t length);
 
  void ReadSocket();
 
  void ClearFirstPrompt() { m_first = false; }
 
private:
  UTF8Decoder::DecodeResult DecodeFromSocket(size_t maxRead);
 
  void SocketEvent(wxSocketEvent &event);
  void TimerEvent(wxTimerEvent &event);
 
  std::unique_ptr<wxSocketBase> m_socket;
  wxSocketInputStream m_socketInput{*m_socket};
  UTF8Decoder m_decoder;
  UTF8Decoder::State m_socketDecodeState;
  wxString m_socketInputData;
  wxMemoryBuffer m_socketOutputData;
 
  bool m_first = true;
  bool m_pipeToStdout = false;
 
  wxTimer m_stringEndTimer{this};
  wxTimer m_readIdleTimer{this};
};
 
class MaximaEvent : public wxEvent
{
public:
  enum Cause {
    READ_PENDING,
    READ_DATA,
    READ_TIMEOUT,
    DISCONNECTED,
    WRITE_PENDING,
    WRITE_ERROR,
  };
  MaximaEvent(Cause cause, Maxima *source);
  MaximaEvent(Cause cause, Maxima *source, wxString &&data);
  wxEvent *Clone() const override;
  Cause GetCause() const { return m_cause; }
  Maxima *GetSource() const { return m_source; }
  const wxString &GetData() const { return m_data; }
  wxString &GetData() { return m_data; }
  void SetData(const wxString &data) { m_data = data; }
private:
  Cause m_cause;
  Maxima *m_source;
  wxString m_data;
};
 
wxDECLARE_EVENT(EVT_MAXIMA, MaximaEvent);
 
#endif