// 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

//  BridgeComposer provides a pop-up evaluation window when you hover the mouse
//  over a hand in the Diagram section. This script places a copy of this information in the
//  Diagram Commentary section of each board so that it is always visible.
//
//  Caveats:
//
//  1. Running this script to completion replaces the Diagram Commentary section of all boards:
//     the existing contents of all Diagram Commentary sections is discarded.
//     (However, I believe that the Diagram Commentary section, which appears between the
//     Diagram section and the Auction section, is not often used.)
//
//  2. If the card holdings for any board are subsequently modified,
//     this script must be run again to update the evaluation information.

//  $Id: EvaluateHands.wsf 149 2023-07-20 10:35:45Z Ray $

<job>
<script language="JScript" src="BCConst.js" />
<script language="JScript" src="BCDeal.js" />
<script language="JScript">

var bc = GetBC('5.104');    // BridgeComposer object (global)
var bDebug = false;

function linewidth(str)
{
  //  Returns the char count of a string excepting any markup (e.g. <b>, </b>)

  var cch = 0;
  var bSkip = false;
  for (var i = 0; i < str.length; ++i) {
    var ch = str.charAt(i);
    if (bSkip) {
      if (ch === '>')
        bSkip = false;
    } else {
      if (ch === '<') {
        bSkip = true;
      } else {
        ++cch;
      }
    }
  }

  return cch;
}

function ShowWarning(vWarn)
{
  //  List boards that will have their Diagram Commentary replaced,
  //  and prompt for confirmation

  if (vWarn.length > 0) {
    var str = 'OK to replace the Diagram Commentary section in the following board';
    if (vWarn.length > 1)
      str += 's';
    
    str += '?\n\n';
    for (var i in vWarn) {
      str += vWarn[i] + '\n';
    }

    if (!bc.confirm(str, MB_ICONWARNING | MB_DEFBUTTON2))
      WScript.Quit();
  }
}

function GetBoardData(bd, vstrMethod, vData)
{
  //  Retrieve evaluation data

  for (var iHand = 0; iHand < NHANDS; ++iHand) {
    var hand = [WEST, NORTH, EAST, SOUTH][iHand];
    var vHandData = [];
    var nMethods = 0;
    for (var method = 0; method < 33; ++method) {
      var str = bd.EvaluateHand(hand, method);
      if (bDebug)
        if (!bc.confirm('hand=' + hand + ' method=' + method + ': ' + str))
          WScript.Quit();

      var v = str.split('\u00a6');  // split fields at broken bar char

      // save translated hand direction

      if (vHandData.length === 0 && v.length >= 2 && v[1].length > 0)
        vHandData.push('<b>' + v[1] + '</b>');  // hand direction

      if (v.length >= 1 && v[0].length === 0) {
        // error notification
        // expecting eventual 104: Invalid evaluation method
        break;
      }

      if (v.length >= 4) {

        //  evaluation

        if (v[3].length === 0) {
          // Not disabled or hidden
          var vm = v[2].match(/\s?(\S*)\s(.*)/);
          if (vm.length === 3) {
            vHandData.push(vm[1]);     // evaluation
            if (vstrMethod.length === nMethods) {
              vstrMethod.push(vm[2]); // method
            } else {
              if (vm[2].length > vstrMethod[nMethods].length)
                vstrMethod[nMethods] = vm[2]; // method plural
            }

            ++nMethods;
          }
        }
      }
    }

    vData.push(vHandData);
  }
}

function FormatData(vstrMethod, vData)
{
  var strSection = '';
  if (vstrMethod.length > 0) {    // check for non-empty board

    //  Compute column widths

    var vWidth = [];
    var width = 0;
    for (var iLine in vstrMethod) {
      var len = vstrMethod[iLine].length;
      if (len > width)
        width = len;
    }
    vWidth.push(width + 1);

    for (var iHand = 0; iHand < NHANDS; ++iHand) {
      var width = 0;
      for (var iLine in vData[iHand]) {
        var len = linewidth(vData[iHand][iLine]);
        if (len > width)
          width = len;
      }
      vWidth.push(width + 1);
    }

    //  Arrange the data into columns

    strSection = '\u00a0\\n\r\n';  // non-breaking space, newline
    var nDone = 0;
    for (var iLine = 0; nDone !== 0xf; ++iLine) {
      for (var iHand = 0; iHand < NHANDS; ++iHand) {
        if (iLine >= vData[iHand].length)
          nDone |= (1 << iHand);
      }

      if (nDone === 0xf)
        break;

      var nPos = 0;
      if (iLine > 0 &&  iLine <= vstrMethod.length) {
        strSection += vstrMethod[iLine - 1];
        nPos = vstrMethod[iLine - 1].length;
      }

      while (nPos++ < vWidth[0])
        strSection += ' ';

      for (var iHand = 0; iHand < NHANDS; ++iHand) {
        var nPos = 0;
        if (iLine < vData[iHand].length) {
          strSection += vData[iHand][iLine];
          nPos = linewidth(vData[iHand][iLine]);
        }

        if (iHand < NHANDS - 1) {
          while (nPos++ < vWidth[iHand + 1])
            strSection += ' ';
        } else {
          strSection += '\\n\r\n';
        }
      }
    }
  }

  return strSection;
}

function EvalBoard(bd)
{
  var vstrMethod = [];
  var vData = [];
  GetBoardData(bd, vstrMethod, vData);
  var strSection = FormatData(vstrMethod, vData);
  return strSection;
}

var TB_CHECKCHANGE = 1;
var TB_MAKECHANGE = 2;

function TraverseBoards(func, vstrSection)
{
  var vWarn = [];
  var bds = bc.Boards;
  for (var iBoard = 0; iBoard < bds.Count; ++iBoard) {
    var bd = bds.Item(iBoard);
    var s1 = bd.Commentary(CMTY_DIAGRAM);
    var s2 = vstrSection[iBoard];
    if (s1 !== s2) {
      if (s1.length)
        vWarn.push(bd.UniqueBoard);

      if (func === TB_MAKECHANGE) {
        bd.Commentary(CMTY_DIAGRAM) = s2;
        if (s2.length) {
          var flags = parseInt(bd.TagValue('BCFlags'), 16);
          flags |= 0x2040;      // show diagram commentary, preformatted
          bd.TagValue('BCFlags') = flags.toString(16);
        }
      }
    }
  }

  return vWarn;
}

function SetCommentary(vstrSection)
{
  var vWarn = TraverseBoards(TB_CHECKCHANGE, vstrSection);
  ShowWarning(vWarn);
  TraverseBoards(TB_MAKECHANGE, vstrSection);
}

(function ()
{
  if (WScript.Arguments.length > 0 && WScript.Arguments(0) !== '-')
    bc.Open(WScript.Arguments(0));
  else
    if (!bc.Open()) WScript.Quit();

  var vstrSection = [];
  var bds = bc.Boards;
  while (bds.MoveNext()) {
    var bd = bds.Current;
    var strSection = EvalBoard(bd);
    vstrSection.push(strSection);
  }

  SetCommentary(vstrSection)
  bc.Save();
})();
</script>
</job>