MagicSetEditor2/src/util/error.cpp

//+----------------------------------------------------------------------------+
//| Description:  Magic Set Editor - Program to make Magic (tm) cards          |
//| Copyright:    (C) Twan van Laarhoven and the other MSE developers          |
//| License:      GNU General Public License 2 or later (see file COPYING)     |
//+----------------------------------------------------------------------------+

// ----------------------------------------------------------------------------- : Includes

#include <util/prec.hpp>
#include <util/error.hpp>
#include <cli/text_io_handler.hpp>
#include <cli/text_io_handler.hpp>
#if wxUSE_STACKWALKER
  #include <wx/stackwalk.h>
#endif
#include <queue>

// ----------------------------------------------------------------------------- : Debug utilities

#if defined(_MSC_VER) && defined(_DEBUG) && defined(_CRT_WIDE)
  void msvc_assert(const wchar_t* msg, const wchar_t* expr, const wchar_t* file, unsigned line) {
    if (IsDebuggerPresent()) {
      wchar_t buffer[1024];
      if (msg) {
        wsprintf(buffer, L"Assertion failed: %s: %s, file %s, line %d\n", msg, expr, file, line);
      } else {
        wsprintf(buffer, L"Assertion failed: %s, file %s, line %d\n", expr, file, line);
      }
      OutputDebugStringW(buffer);
      DebugBreak();
    } else {
      _wassert(expr, file, line);
    }
  }
#endif

// ----------------------------------------------------------------------------- : Error types

Error::Error(const String& message)
  : message(message)
{}

Error::~Error() {}

String Error::what() const {
  return message;
}



// Stolen from wx/appbase.cpp
// we can't just call it, because of static linkage
#if wxUSE_STACKWALKER
  String get_stack_trace() {
    wxString stackTrace;

    class StackDumper : public wxStackWalker {
    public:
      StackDumper() {}

      const wxString& GetStackTrace() const { return m_stackTrace; }

    protected:
      void OnStackFrame(const wxStackFrame& frame) override {
        m_stackTrace << wxString::Format(_("[%02d] "), frame.GetLevel());

        wxString name = frame.GetName();
        if ( !name.empty() ) {
          m_stackTrace << wxString::Format(_("%-40s"), name.c_str());
        } else {
          m_stackTrace << wxString::Format(
                              _("%p"),
                              (void*)frame.GetAddress()
                          );
        }

        if ( frame.HasSourceLocation() ) {
            m_stackTrace << _('\t')
                          << frame.GetFileName()
                          << _(':')
                          << (unsigned int)frame.GetLine();
        }

        m_stackTrace << _('\n');
      }

    private:
      wxString m_stackTrace;
    };

    StackDumper dump;
    dump.Walk(2); // don't show InternalError() call itself
    stackTrace = dump.GetStackTrace();

    // don't show more than maxLines or we could get a dialog too tall to be
    // shown on screen: 20 should be ok everywhere as even with 15 pixel high
    // characters it is still only 300 pixels...
    static const int maxLines = 20;
    const int count = stackTrace.Freq(wxT('\n'));
    for ( int i = 0; i < count - maxLines; i++ )
        stackTrace = stackTrace.BeforeLast(wxT('\n'));

    return stackTrace;
  }
#else
  String get_stack_trace() {
    return _(""); // not supported
  }
#endif // wxUSE_STACKWALKER

InternalError::InternalError(const String& str)
  : Error(
    _("An internal error occured:\n\n") +
    str + _("\n")
    _("Please save your work (use 'save as' to so you don't overwrite things)\n")
    _("and restart Magic Set Editor.\n\n")
    _("You should leave a bug report on https://github.com/twanvl/MagicSetEditor2/issues/\n")
    _("Press Ctrl+C to copy this message to the clipboard.")
  )
{
  // add a stacktrace
  const String stack_trace = get_stack_trace();
  if (!stack_trace.empty()) {
    message << _("\n\nCall stack:\n") << stack_trace;
  }
}

// ----------------------------------------------------------------------------- : Parse errors

ScriptParseError::ScriptParseError(size_t pos, int line, const String& filename, const String& error)
  : ParseError(error)
  , start(pos), end(pos), line(line), filename(filename)
{}
ScriptParseError::ScriptParseError(size_t pos, int line, const String& filename, const String& exp, const String& found)
  : ParseError(_("Expected '") + exp + _("' instead of '") + found + _("'"))
  , start(pos), end(pos + found.size()), line(line), filename(filename)
{}
ScriptParseError::ScriptParseError(size_t pos1, size_t pos2, int line, const String& filename, const String& open, const String& close, const String& found)
  : ParseError(_("Expected closing '") + close + _("' for this '") + open + _("' instead of '") + found + _("'"))
  , start(pos1), end(pos2 + found.size()), line(line), filename(filename)
{}
String ScriptParseError::what() const {
  return String(_("(")) << (int)start << _("): ") << Error::what();
}

String concat(const vector<ScriptParseError>& errors) {
  String total;
  FOR_EACH_CONST(e, errors) {
    if (!total.empty()) total += _("\n");
    total += e.what();
  }
  return total;
}
ScriptParseErrors::ScriptParseErrors(const vector<ScriptParseError>& errors)
  : ParseError(concat(errors))
{}

// ----------------------------------------------------------------------------- : Error handling

// messages can be posted from other threads, this mutex protects the message list
wxMutex crit_error_handling;
typedef pair<MessageType,String> Message;
deque<Message> message_queue;
bool show_message_box_for_fatal_errors = true;
bool write_errors_to_cli = false;

void queue_message(MessageType type, String const& msg) {
  if (write_errors_to_cli && wxThread::IsMain()) {
    cli.show_message(type,msg);
    return; // TODO: is this the right thing to do?
  }
  if (show_message_box_for_fatal_errors && type == MESSAGE_FATAL_ERROR && wxThread::IsMain()) {
    // bring this to the user's attention right now!
    wxMessageBox(msg, _("Error"), wxOK | wxICON_ERROR);
  }
  // Thread safety
  wxMutexLocker lock(crit_error_handling);
  // Only show errors in the main thread
  message_queue.push_front(make_pair(type,msg));
}

void handle_error(const Error& e) {
  queue_message(e.is_fatal() ? MESSAGE_FATAL_ERROR : MESSAGE_ERROR, e.what());
}

void handle_error_now(const Error& e) {
  queue_message(MESSAGE_FATAL_ERROR, e.what());
}

bool have_queued_message() {
  wxMutexLocker lock(crit_error_handling);
  return !message_queue.empty();
}

bool get_queued_message(MessageType& type, String& msg) {
  wxMutexLocker lock(crit_error_handling);
  if (message_queue.empty()) {
    return false;
  } else {
    type = message_queue.back().first;
    msg  = message_queue.back().second;
    message_queue.pop_back();
    return true;
  }
}