// This script file is licensed under a Creative Commons
// Attribution 4.0 International License (cc by 4.0):
// http://creativecommons.org/licenses/by/4.0/
// You may adapt and/or share this script file for any purpose,
// provided you give credit to http://bridgecomposer.com
//
//  Solve boards using the Double Dummy Solver.
//
//  Usage: SolveBoard.wsf path options
//    path: the PBN file to solve. If omitted or "-", prompt for a file.
//    options: zero or more of the following letters:
//      a:  solve all boards. If omitted, solve currently selected board, or first board.
//      f:  full solve (all hands, all strains). If omitted, hand and strain as per contract, or 1NT by S.
//      d:  debug (raw form of DDS results displayed)
//      c:  results shown in the board commentary. If omitted, results shown in a message box.
//      p:  analyze play (each card played). If omitted, analyze current position.
//
//  When called from the BridgeComposer Script menu, BridgeComposer provides the path, and options
//  may be specified using the Script Favorites dialog "Arguments" button.
//  Different Script favorites items may specify this same script but with different options.

//  $Id: SolveBoard.wsf 64 2021-09-16 13:08:11Z Ray $

<job>
<script language="JScript" src="BCConst.js" />
<script language="JScript">
function IsOption(ch)
{
  return WScript.Arguments.length > 1 && WScript.Arguments(1).indexOf(ch) >= 0;
}

//  Change "bAllBoards" to adjust script behavior:
//    If "true", all boards in the document will be solved.
//    If "false", only the one selected board will be solved.
var bAllBoards = IsOption('a');

//  Change "bFullSolve" to adjust script behavior:
//    If "true", results for all hands in all strains are computed.
//    If "false", results for only one hand and strain (based on
//    the contract, if it is set) is computed.
var bFullSolve = IsOption('f');

//  Change "bDebug" to adjust script behavior:
//    If "true", the raw form of each DDS result is displayed for your info.
var bDebug = IsOption('d');

//  Change bSetCommentary to adjust script behavior:
//    If "true", the results are appended to the Diagram Commentary in your document.
//    If "false", the results are displayed in a message box, and your document
//    is not modified.
var bSetCommentary = IsOption('c');

//  Change bAnalyzePlay to adjust script behavior:
//    If "false", perform DDSStart (solve board) function.
//    If "true", perform DDSStartAnalyzePlay function.
var bAnalyzePlay = IsOption('p');


if (bAnalyzePlay) bDebug = true;    // debug is currently the only output for this

var bc = GetBC('5.84');
bc.SetFont(14);
if (WScript.Arguments.length > 0 && WScript.Arguments(0) !== '-') {
  bc.Open(WScript.Arguments(0));
} else {
  if (!bc.Open()) WScript.Quit();
  bSetCommentary = false; // avoid inadvertant document modification
}

var RETURN_NO_FAULT = 1;
var NHANDS = 4;
var NSTRAINS = 5;

function StartSolve2(bd, iStrain, iLeaders)
{
  if (bAnalyzePlay)
    var rc = bd.DDSStartAnalyzePlay();
  else
    var rc = bd.DDSStart(iStrain, iLeaders, -1, 3);
  
  if (rc != RETURN_NO_FAULT) {
    bc.alert('DDS Error: ' + bc.DDSErrorMessage(rc));
    WScript.Quit(1);
  }
}

function StartSolve(bd) {
  if (bFullSolve) {
    for (var iStrain = 0; iStrain < NSTRAINS; ++iStrain) {
      StartSolve2(bd, iStrain, 0xf);
    }
  } else {
    StartSolve2(bd, -1, -1);
  }
}

if (bAllBoards) {
  for (var iBoard = 0; iBoard < bc.Boards.Count; ++iBoard) {
    var bd = bc.Boards.Item(iBoard);
    StartSolve(bd);
  }
} else {
	var bd = bc.PlayPosBoard;
  if (!bd)
  {
    var ix = bc.SelectedBoard;
    bd = bc.Boards.Item(ix);
  }
  
  StartSolve(bd);
}

var arrStrain = (bSetCommentary) ?
  ['\\s', '\\h', '\\d', '\\c', 'NT'] :
  ['\u2660', '\u2665', '\u2666', '\u2663', 'NT'];
var arrRank = ['2', '3', '4', '5', '6', '7', '8', '9', '10', 'J', 'Q', 'K', 'A'];
var newline = (bSetCommentary) ? '\\n\n' : '\n';

function SafeIndex(array, index)
{
  if (index >= 0 && index < array.length)
    return array[index];
  
  return index;
}

function ScoreCard(nScore, iSuit, iRank)
{
  if (!arrScore[nScore])
    arrScore[nScore] = [];
  
  var nCard = (iSuit << 4) | iRank; // encode card as suit * 16 + rank
  arrScore[nScore].push(nCard);
}

var str = '';
for (;;) {
  var ddsr = bc.DDSGetResult(true);
  if (!ddsr)
    break;

  if (bDebug) {
    var strdb = 'DEBUG: Raw result:\n\n';
    strdb += 'requestType=' + ddsr.requestType + '\n';
    strdb += 'board=' + ddsr.board + '\n';
    strdb += 'trump=' + ddsr.trump + '\n';
	  strdb += 'trick=' + ddsr.trick + '\n';
    strdb += 'first=0x' + ddsr.first.toString(16).toUpperCase() + '\n';
	  strdb += 'plays=' + ddsr.plays + '\n';
    strdb += 'returnCode=' + ddsr.returnCode + '\n';
    switch (ddsr.requestType) {
    case 0:
      for (var iHand = 0; iHand < NHANDS; ++iHand) {
        strdb += 'iHand=' + iHand + ' cards=' + ddsr.cards(iHand) + '\n';
        for (var iCard = 0; iCard < ddsr.cards(iHand); ++iCard) {
          strdb += 'iHand=' + iHand + ' iCard=' + iCard + ' suit(iHand, iCard)=' + ddsr.suit(iHand, iCard) + '\n';
          strdb += 'iHand=' + iHand + ' iCard=' + iCard + ' rank(iHand, iCard)=' + ddsr.rank(iHand, iCard) + '\n';
          strdb += 'iHand=' + iHand + ' iCard=' + iCard + ' equals(iHand, iCard)=0x' + 
            ddsr.equals(iHand, iCard).toString(16).toUpperCase() + '\n';
          strdb += 'iHand=' + iHand + ' iCard=' + iCard + ' score(iHand, iCard)=' + ddsr.score(iHand, iCard) + '\n';
          strdb += '\n';
        }
      }
      break;
      
    case 1:
      strdb += 'playTraceCount=' + ddsr.playTraceCount + '\n';
      for (var i = 0; i < ddsr.playTraceCount; ++i) {
        strdb += 'playTraceCard(' + i + ')=' + ddsr.playTraceCard(i) + '\n';
      }
      strdb += 'playAnalysisCount=' + ddsr.playAnalysisCount + '\n';
      for (var i = 0; i < ddsr.playAnalysisCount; ++i) {
        strdb += 'playAnalysis(' + i + ')=' + ddsr.playAnalysis(i) + '\n';
      }
      break;
    }
    if (!bc.confirm(strdb, 0))
      WScript.Quit();
  }

  var bix = ddsr.board;
  if (bix < 0)
    var b = bc.PlayPosBoard;
  else
    var b = bc.Boards.Item(bix);

  if (ddsr.returnCode !== RETURN_NO_FAULT) {
    var msg = 'Board ' + b.UniqueBoard;
    msg += ', Strain ' + SafeIndex(arrStrain, ddsr.trump);
    msg += '\nDDS Error: ' + bc.DDSErrorMessage(ddsr.returnCode);
    if (!bc.confirm(msg, MB_ICONERROR))
      WScript.Quit();
    
    continue;
  }
  
  if (ddsr.requestType !== 0) continue;
  
  if (!bSetCommentary)
    str += 'Board ' + b.UniqueBoard;
  
  str += ', Strain ' + SafeIndex(arrStrain, ddsr.trump);
  str += ', Trick ' + (ddsr.trick + 1);
  str += ', ' + SafeIndex(['Leader', '2nd hand', '3rd hand', '4th hand'], ddsr.plays);
  
  str += newline;

  for (var iHand = 0; iHand < NHANDS; ++iHand) {
    if ((ddsr.first & (1 << iHand)) == 0)
      continue;

    var iNext = (iHand + ddsr.plays) & 3;
    str += '  ' + SafeIndex(['North', 'East', 'South', 'West'], iNext) + ':';

    //  The result cards come sorted by score.
    //  However, to display nicely we must also sort by suit and rank.

    var arrScore = [];
    for (var iCard = 0; iCard < ddsr.cards(iHand); ++iCard) {
      var nScore = ddsr.score(iHand, iCard);
      var iSuit = 3 - ddsr.suit(iHand, iCard); // suit from clubs (0) to spades (3)
      ScoreCard(nScore, iSuit, ddsr.rank(iHand, iCard));
      for (var iRank = 2; iRank < 15; ++iRank) {
        if (ddsr.equals(iHand, iCard) & (1 << iRank)) {
          ScoreCard(nScore, iSuit, iRank);
        }
      }
    }

    for (var nScore = arrScore.length - 1; nScore >= 0; --nScore) {
      if (arrScore[nScore]) {
        arrScore[nScore].sort(function(a, b) {return b - a}); // sort numerically descending
        str += ' ';
        if (bSetCommentary)
          str += '<u>';
        
        str += nScore + ' trick';
        if (nScore !== 1)
          str += 's';
        
        if (bSetCommentary)
          str += '</u>';
        
        str += ' (';
        var nLast = -1;
        for (var ix in arrScore[nScore]) {
          var nCard = arrScore[nScore][ix];
          var iSuit = 3 - (nCard >> 4); // suit from spades (0) to clubs (3)
          var iRank = nCard & 0xf;      // rank from 2 to 14
          if (iSuit !== nLast) {
            if (ix > 0)
              str += ' ';
            
            str += arrStrain[iSuit];
            nLast = iSuit;
          }
          
          str += arrRank[iRank - 2];
        }
        
        str += ')';
      }     
    }
    
    str += newline;
  }
  
  if (bSetCommentary) {
    var cmt = b.Commentary(1);
    cmt += str;
    b.Commentary(1) = cmt;
    str = '';
    
    var flg = parseInt(b.TagValue('BCFlags'), 16);
    flg |= 0x40;  // show Diagram Commentary
    b.TagValue('BCFlags') = flg.toString(16);
  }
}

if (bSetCommentary)
  bc.Save();
else if (str)
  bc.alert(str, 0);
</script>
</job>