opponentjs.cpp

/**
 * \file opponentjs.cpp
 *
 * \section LICENSE
 *
 * Copyright (C) 2015-present Thorsten Roth
 *
 * This file is part of StackAndConquer.
 *
 * StackAndConquer 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 3 of the License, or
 * (at your option) any later version.
 *
 * StackAndConquer 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 StackAndConquer.  If not, see <https://www.gnu.org/licenses/>.
 *
 * \section DESCRIPTION
 * Interface to CPU script JS engine.
 */

#include "./opponentjs.h"

#include <QDebug>
#include <QFile>
#include <QJSEngine>
#include <QMessageBox>

OpponentJS::OpponentJS(QWidget *pParent, const quint8 nID,
                       const QPoint BoardDimensions,
                       const quint8 nHeightTowerWin, const quint8 nNumOfPlayers,
                       const QString &sOut, const QString &sPad,
                       QObject *pParentObj)
    : m_pParent(pParent),
      m_nID(nID),
      m_BoardDimensions(BoardDimensions),
      m_nHeightTowerWin(nHeightTowerWin),
      m_nNumOfPlayers(nNumOfPlayers),
      m_sOut(sOut),
      m_sPad(sPad),
      m_jsEngine(new QJSEngine(pParentObj)) {
  m_obj = m_jsEngine->globalObject();
  m_obj.setProperty(QStringLiteral("game"), m_jsEngine->newQObject(this));
}

// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------

auto OpponentJS::loadAndEvalCpuScript(const QString &sFilepath,
                                      const QJsonArray &emptyBoard) -> bool {
  QFile f(sFilepath);
  if (!f.open(QFile::ReadOnly)) {
    qWarning() << "Couldn't open JS file:" << sFilepath;
    return false;
  }
  QString source = QString::fromUtf8(f.readAll());
  f.close();
  this->log("Script: " + sFilepath);

  QJSValue result(m_jsEngine->evaluate(source, sFilepath));
  if (result.isError()) {
    qCritical().noquote()
        << "Error in CPU P" + QString::number(m_nID) + "script at line " +
               result.property(QStringLiteral("lineNumber")).toString() +
               "\n         " + result.toString();
    emit scriptError();
    return false;
  }

  // Check if callCPU() is available for calling the script
  if (!m_obj.hasProperty(QStringLiteral("callCPU")) ||
      !m_obj.property(QStringLiteral("callCPU")).isCallable()) {
    qCritical() << "Error in CPU P" + QString::number(m_nID) +
                       "script - function callCPU() not found or not callable!";
    emit scriptError();
    return false;
  }

  // Call (optional) init() function if available
  if (m_obj.hasProperty(QStringLiteral("initCPU")) &&
      m_obj.property(QStringLiteral("initCPU")).isCallable()) {
    QJsonDocument jsdoc(emptyBoard);
    QString sJsonEmptyBoard(
        QString::fromLatin1(jsdoc.toJson(QJsonDocument::Compact)));
    QJSValueList arguments;
    arguments << sJsonEmptyBoard;

    result = m_obj.property(QStringLiteral("initCPU")).call(arguments);
    if (result.isError()) {
      qCritical().noquote()
          << "CPU P" + QString::number(m_nID) +
                 "- Error calling \"initCPU\" function at line: " +
                 result.property(QStringLiteral("lineNumber")).toString() +
                 "\n         " + result.toString();
      QMessageBox::warning(m_pParent, tr("Warning"),
                           tr("CPU script execution error! "
                              "Please check the debug log."));
      emit scriptError();
      return false;
    }
  }

  return true;
}

// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------

void OpponentJS::callJsCpu(const QJsonArray &board,
                           const QJsonDocument &legalMoves,
                           const QJsonArray &towersNeededToWin,
                           const QJsonArray &stonesLeft,
                           const QJsonArray &lastMove) {
  QJsonDocument jsdoc(board);
  QString sJsonBoard(QString::fromLatin1(jsdoc.toJson(QJsonDocument::Compact)));
  QJSValueList arguments;
  arguments << sJsonBoard;
  m_legalMoves = legalMoves;
  m_TowersNeededToWin = towersNeededToWin;
  m_StonesLeft = stonesLeft;
  m_LastMove = lastMove;

  QJSValue result = m_obj.property(QStringLiteral("callCPU")).call(arguments);
  // qDebug() << "Result of callCPU(): " + result.toString();
  if (result.isError()) {
    qCritical().noquote()
        << "CPU P" + QString::number(m_nID) +
               "- Error calling \"callCPU\" function at line: " +
               result.property(QStringLiteral("lineNumber")).toString() +
               "\n         " + result.toString();
    QMessageBox::warning(m_pParent, tr("Warning"),
                         tr("CPU script execution error! "
                            "Please check the debug log."));
    emit scriptError();
    return;
  }

  // CPU has to return an int array with length 3
  QJsonArray move;
  if (result.isArray()) {
    if (3 == result.property(QStringLiteral("length")).toInt()) {
      if (result.property(0).isNumber() &&  // From (-1 --> set stone at "To")
          result.property(1).isNumber() &&  // Number of stones
          result.property(2).isNumber()) {  // To
        move << result.property(0).toInt() << result.property(1).toInt()
             << result.property(2).toInt();
        if (move.at(0).toInt() >= -1 && move.at(0).toInt() < board.size() &&
            move.at(1).toInt() > 0 && move.at(2).toInt() >= 0 &&
            move.at(2).toInt() < board.size()) {
          emit actionCPU(move);
          return;
        }
      }
    }
  }

  qCritical() << "CPU P" + QString::number(m_nID) +
                     "script invalid return from callCPU(): " +
                     result.toString();
  QMessageBox::warning(m_pParent, tr("Warning"),
                       tr("CPU script execution error! "
                          "Please check the debug log."));
  emit scriptError();
}

// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
// Functions accessible by external JavaScript

auto OpponentJS::getID() -> quint8 { return m_nID; }

auto OpponentJS::getNumOfPlayers() -> quint8 { return m_nNumOfPlayers; }

auto OpponentJS::getHeightToWin() -> quint8 { return m_nHeightTowerWin; }

auto OpponentJS::getTowersNeededToWin() -> QJsonArray {
  return m_TowersNeededToWin;
}

auto OpponentJS::getNumberOfStones() -> QJsonArray { return m_StonesLeft; }

auto OpponentJS::getLastMove() -> QJsonArray { return m_LastMove; }

auto OpponentJS::getLegalMoves() -> QString {
  QString sJsonMoves(
      QString::fromLatin1(m_legalMoves.toJson(QJsonDocument::Compact)));
  return sJsonMoves;
}

auto OpponentJS::getBoardDimensionX() -> int { return m_BoardDimensions.x(); }
auto OpponentJS::getBoardDimensionY() -> int { return m_BoardDimensions.y(); }

auto OpponentJS::getOutside() -> QString { return m_sOut; }
auto OpponentJS::getPadding() -> QString { return m_sPad; }

void OpponentJS::log(const QString &sMsg) {
  qDebug() << "CPU P" + QString::number(m_nID) + " - " + sMsg;
}