Update WinBoard RTF docs

Update WinBoard html help

Allow adjustment of clocks in any mode with shift+click

In practice changing to edit-game mode during a game was very
cumbersome. In WinBoard shift+click is now offered as an alternative.
Make sure a right-click in the clock area is not also counted for other
purposes.

Allow loading of PGN variations in XBoard

Right-clicking variation comments in the comment-window was implemented
through a translation. The right button is now bound to routines that
set both the end and start of the selection, as setting a new start does
not seem to work if the previous select-start was not completed by a
select-end or extend-end. Finally the main handler uses the selection
cursors to know what was clicked.

Update XBoard docs

Added a descripton of the new ICS options (seek graph, back-ground
observe) and menus (Upload) to the texi file. Also added a description
of the variation (Annotate menu item and PGN variation comments) and PV
walking (clicking engine-output). Describe the -shuffleOpenings option.

Paint highlights on dual board (WB)

The highlight info is hidden in the partner board to pass it to the
front-end.

Fix handling username change during game

The title bar and gameInfo (going into the PGN) were not adapted when
the username was changed through the menu, so that the change became
only effective on the next game. Requires SetGameInfo to be called from
the front-end, and thus a prototype for it in backend.c.

Fix window-position upset on failing engine start in WinBoard

The main window was only positoned according to the settings-file data
after the engine was started up from InitBackend2(), so that if the
latter gave a fatal error, and Save Settings on Exit was on, a wrong
position for the main window would be saved. The call to InitBackend2()
is now moved until after setting the main-window position.

Display PV from Engine-Output window (XBoard)

Translations are added to bind button 3 to the PV walk for the memo
widgets, and the corresponding handlers are ported from wengineoutput.c.

Set keyboard focus at startup to board window

This makes XBoard sensitive to the keybindings also when the cursor is
outside the board window. This focus seems to persist indefinitely: each
time the board window gets selected, the key bindings become activem
wherever the mouse pointer is. Downside: the mouse pointer is no longer
an arrow outside the board window, but becomes a text-insert tool there.

added logo files for xboard

logos are installed in the hicolor theme [1] using $datadir as the basedir.
Added both png and svg logo.

[1] http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html

Remake programVersion string after receiving engine features

The engine could have sent a more accurate version of its own name
than the one derived from the exe filename in a myname feature, and we
better use that in the programVersion string, which will be sent as
interface name to the ICS.

Revert "Repair settings-file name"

This reverts commit a02042ef83ce1f3632f0cf3e0a2a4ce9a3ac5d85.

Add -autokibitz checkbox to UCI-options menu dialog

Also capture (numeric) whispers of players for -autoKibitz

Add kibitzes and c-shouts Chat Box

A box dedicated to c-shouts will snatch any c-shout before it is
diverted to a normal shouts box. The kibitzes box can capture the
left-overs of -autoKibitz, if the latter is active.

Mark non-compliant lines of engine in debug file

The option -engineDebugOutput is extended to accept value 3 for printing
a cear indication of non-compliancy in the debug file.

Redraw second board on expose events

The -dualBoard option now does refresh the second board after another
window uncovers it. To acheive this, some data structures remembering
what is displayed had to be duplicated. (lastBoard and damage for XB,
lastReq, lastDrawn, lastReqValid and lastDrawnValid for WB.)
WinBoard now uses clipping also for second board. This required the
clips for the destination to be translated horizontally!

Print seconds with 2 digits in backgroundObserve status line

Do not recognize non-ICS variants from PGN event tag

These variants were introduced after supporting the variant tag, so if
the variant tag is missing, their recognition from the event tag will be
a false match. (Mainly to prevent events with 'super' in the name being
recognized as Superchess.)

Fix display of uninitialized boards in background observe

A variable partnerBoardValid is cleared on starting our own game, and
set when a board from the background game comes in during it. At the end
of our own game, a valid partner board now is put in the display.

Add option Display Logo in WB general-options menu

Changing the option requires InitDrawingSizes to be called for
re-formatting the board window. Switching it off requires clearing of
the cps->programLogo fields to take effect immediately. Switching it on
only takes effect the next session, as we will need some refactoring to
redo the figuring out what logos to display.

Group Chat Boxes with console in stead of board window

They now open and close with the console, which seems more natural, and
prevents the console from covering them.

Put new options in WB ICS-options dialog

The Seek-Graph, background-observe and Chat-Box options are added to the
ICS options dialog. They only control the appData settings, there are no
special actions yet on switching the settings.

Create space in WinBoard ICS-options dialog

Use side-by-side boards to display background game

A game observed in the background (i.e. if -backgroundObserve true) will
be displayed right of the normal board in the same window if the new
(persistent) Boolean option -dualBoard is also set.
Very flakey hack, especially in XBoard, where clocks and messsage
field all get the wrong width (and resist adjustment in the strangest
ways). The clocks of the partner game are not yet displayed, and
disaster happens when the background and foreground games do not have
the same board format.

Repair background-observe patch

Apparently a commit was lost that I collapsed with 3018a6 while the
latter was already pushed to savannah. Here I recreated this commit from
a diff between the respective commits in the savannah & nubati gits.

Repair settings-file name

The default name is put back to /etc/xboard/xboard.conf, so that XBoard
can again find its settings file. "make install" will still install it
in the wrong place.

new developer release

fixed compiler warning for file-browser code

missing "void"s in the function declaration and missing returns showed up when trying to build on the opensuse build server. fixed now.

Put newly opened Chat Box on top

Dialogs always pop up in front, so set the onTop variable that prevents
highighting the button to navigate to it from other Chat Boxes
to reflect that a newly opened Chat Box is in view.

Fix copying of kibitzed info in Engine-Output window

Make sure all lines end with "\r\n" to not lose line breaks on
copy-paste from the memo. (XBoard would strip those again.)

Allow walking a kibitzed PV

If no tabs are found in te 'thinking output' we assume it is a captured
kibitz message, and look for "PV=" to locate the start of a PV in it.
Also try to include any continuation lines below the selected line.

Insert autoKibitz continuation lines at end of line

In the engine-output window lines that start with the ICS continuation
sequence "\   " are inserted behind the line they belong to, in stead of
at the top. This required keeping thrack of the length of the currently
active line in OutputKibitz().

Don't disturb background observe when receiving new piece

When new holdings are sent when the background game is displayed, we now
ignore this, as presumably we are peeking at our partners game, and thus
should be well aware of what is captured there.

Newly lexed parser in XBoard directory

Let yy_text determine progress of PV parsing

The parsed unit yy_text was not available after ParseOneMove(), because
the buffer switch in yylexstr() apparently destroys it. To solve that,
yylexstr() now is equiped with an extra buffer argument, where it copies
yy_text before the switch, so the caller, ParsePV(), can see what was
parsed in yy_textstr. This is used to update the PV pointer, but also to
save any parsed comments (when ParsePV is used for parsing a PGN variation).

Support playing through PGN variation comments

Right-clicking a variation line in the comment dialog will shelve the
current variation, and parse the comment to replace it. This uses
ParsePV() in an alternative way, for which the latter had to be
enhanced: it was made resistent to move numbers and comments inside
the PV. It now has an argument to indicate if such comments should be
stored with the moves. The Comment Popup is closed on revert, to
make sure no comments to moves that are destroyed, containing
variations on a non-valid line, can keep hanging around.

Add Annotate item in Step menu

This does the same as Revert, except that it adds the destroyed
variation as comment to the original movem in PGN variation format.
RevertEvent now has an argument to indicate if it should add the
comment, or not. Comments in the abandoned variation are included in the
varriation command to the main line. (The exact layout of the variation
comment that results leaves still to be desired.)

Add option -shuffleOpenings

This volatile option is added just to make the existing variable
available from the command line, not only from the menus.

Let the sounds sound on receiving a message in a Chat Box

Use Colorize() to the applicable color to trigger the sound, and then
restore the original color as 'continuation', to do it silently.

Allow WB Chat Box to be dedicated to shouts and 'it'

By putting 'shouts' in the handle field, a chat window will capture all
shouts and c-shouts, and send messages typed into it as shouts.
The bracketing of the shouter name now indicates the type of shout.
The handle for WHISPER Chat Boxes has been changed to 'whispers', to
make it easier to pop them up by clicking the console.

Add -chatBoxes option to open Chat Boxes at startup

This string option contains a semicolon-separated list of handles for
which Chat Boxes should be opened at startup. The value saved in the ini
file is the value that was read, not the actual chat boxes that were
open at the time of saving.

Make Chat Windows pseudo-tabbed

By adding buttons in every Chat Box to navigate directly to every other
Chat Box, a stacked set of Chat Windows behaves like a single tabbed
window, but can still be unstacked. The buttons turn grey to warn that
new text appeared in hidden boxes (i.e. not the one last brought to top).

Allow arrow keys in WB Chat Box to access command history

The history is shared between al boxes and the ICS console.

Make WB Chat Boxes wrap and handle URLs

Cloned the code for the console text field to hande URL. (Initialization
to recogize the link, and notifiction to open it when clicked.)
Removed the ES_AUTOHSCROLL style from the RichEdit in the resource.

Fix copying of WB Chat Window contents

All line breks were lost on copy-pasting the contents of a chat window.
Adding CR to each outputted line in the front-end (wchat.c) solves this.
(Tell messages sent to a handle (which are not echoed by the ICS, and
thus have to copied to the chat box directly) also need CR!)

Add upload of game to ICS for examining

New item "Upload to Examin" in Action menu, calls UploadGameEvent().
Use SAN moves to upload game to ICS, rather than long algebraic
(The ICS did not understand long-algebraic promotion moves)
Use bsetup within examine to set position onFICS, and also variant.
Castling rights do not work yet for FRC. Totally different set of
commands are needed on FICS and ICC.
 FICS does not understand w23 or wild/23, but needs 'crazyhouse' in the
besetup command that specifies the variant. XBoard variant names are
used, except for fischerandom, which is 'fr'. Things like nocastle will
probably still not work.

Handle display of PV that starts with other move than played

Insert the retraction of the played move, without premove highlighting.

Bugfix smart capture

Disambiguate was changed to make sure that for ambiguous moves, a
capture would always prevail in the closure, rather than the last move
that happened to be generated. Before, double-clicking a piece would
sometimes plsy a non-capture.

Fix XB crash on giving keyboard focus to non-text widget

In the Engine-Settings dialog SetFocus() could be called for non-text
widgets, and this made XawTextSetInsertionPoint() croak. Setting the
insertion point to the end in SetFocus() was a bad ide anyway, as it
interfered with copying from the engine-output window, which would
uncontrollably scroll on getting focus. It is solved now by setting the
insertion point already on creation of the text widgets.

Seek-Graph bugfix: disappearing output in ICS console

Suppression of output to the cosole was handled fundamentally wrong: it
was not enough to set next_out to after the unit that should be
suppressed, as there can be a backlog in printing of previous units that
came in the same packet. So this has to be flushed first, or it will be
lost. -autoKibitz probably got away with that, because it comes in a
separate packet. But seek ads are often suffixed to other output, and
then that output disappeared! Now we flush everywhere before suppressing.
We now totally rely on the prompt to restart the printing, so that
acknowledgements following the echo of the sent message are also
suppressed. Also suppress LF before diverted chat messages.
  Also fixed is the 'mamer bug' in Chat Boxes, due to false parsing of
a "* (*): " pattern in tell messages, because of a missing continue.

Pop up ICS text menu with default item under mouse pointer

The menu popup is migrated to the down-click (was up-click), so the
up-click can select the item. Some trickery is needed to fool the menu
into thinking that the mouse moved, so that a moveless up-down click in
the ICS text field selects the default item (the upper-right one).
Also allow dummy item in ICS text menu: The command "none" in the ICS
text menu will now be treated as a grayed-out (disabled) entry, so it
can be defined in the position underthe mouse pointer to prevent the
up-click from doing anything, while keeping the menu open. Recommended
for use with an entry of spaces.

Allow ICS context menu to pop up a Chat Box on clicking handle

A command "chat" defined in the WinBoard icsMenu string will cause
ChatPopUp() to be called when it is clicked, with the clicked handle
(name) in the ChatPartner field, and focus on the input field.
ChatPopUp() had to get a parameter (the handle) to make this possible.
If that parameter is NULL (as when it is called from the Mode menu),
focus will still start on the (empty) ChatPartner field of the box.

Fix right-edge spillover of Seek-Graph dots in WinBoard

Rescale the X-axis to allow margin for dot size and color offset.

Interface XBoard to GhostView file-browser dialog

Note: The Ghostview dialog was using some deprecated variables for error
printing, and conditionally used getwd() on some systems that presumably
do not have getcwd(), but it did not assess the latter properly.

Allow recalling history in ICS input box with arrow keys

By adding translations for the Up and Down keys, and stealing some code
from winboard.c. Still needs some refactoring to move the duplicate code
to the back-end.

Start insertion point at end of text edits in XB dialogs

The function SetFocus now uses XawTextSetInsertionPoint to position the
end of the string it aready contains, rather than at the beginning.

Capture holdings of background observed game

Match handles with multiple titles for channel Chat Boxes

Only handles with at most one suffixed 'title', such as (U), (C), (IM)
or (TD), followed by the parenthesized channel number, were recognized,
so tells by people with more titles always went to the ICS console window.
Patterns are added to recognize handles with upto three such qualifiers.

Do not pop down Seek Graph on on-dot click

Leave the graph up, and let the incoming board of a started game cause
the pop-down. This in case the clicked ad is no longer vailable, or
manuay refused, and fails to start a game.

Observe a game in the background while playing

A new (persistent) option -backgroundObserve true|false is added. When
set, observed boards received while playing a game will not trigger a
game switch, but will be ignored except for storing in a dedicated board
buffer. Pressing the right mouse button will cause the board to be
displayed, until we release it. Time, strength and stm are always
displayed in the message window.

Remove race condition in clock switching

The move number is now incremented inside SwitchClock, when no timer
interrupt is scheduled, so the interrupt cannot occur at the wrong side
of the increment, and decrement the wrong clock.

Let second click on piece make only capture, with -oneClickMove

Normally this would clear the highlighting of that piece.
Required new field in DisambiguateClosure to count nr of captures.

Bugfix stale first-click

When the opponent resigned after the user had cicked a from-square,
clicking the from-square for the first move in the next game would
produce an "illegal move" message, because it was considered a to-click!
We now set fromX and fromY to invalid in GameEnds().
Should we also reset them on mode changes?

Add promotions and e.p. to oneClickMove

For e.p. the to-Square of the Pawn has to be clicked. Promotions are
always to Queen when you click the to-square, but use the promotion
pop-up when you click the from-square.

Fix error that compiler does not notice

Boolean GLT_GetFromList did not return a value. But no error on Ubuntu!

new developer release

updated year in copyright info

One-click moves

Playing on ICS or against engine, clicking a square from or to which
only a single move can be made causes the move to be done, when the new
option -oneClickMove is set to true.

Use squares for computer seek ads

Shape indication passed in sign bit of color (char) variable.

Use right mouse button to view seek ads

Right down-click does the same as left down-click, right up-click
simulates a left up-click off board (so it misses all dots).

Use right-click miss to refresh Seek Graph

The 'moving' parameter had to be made into an int for this, to indicate
right clicks with code 2. Right press now already pushes the clicked ad
to the back, so that the up-click will display an underlying one.

Bugfix pushing back seek ads on right-click

On a right button press the previous in stead of currently hit ad was
receiving the penalty.

Indicate seek-ad multiplicity

If more than one seek ad is inside the capture range of the mouse
pointer, an exclamation point is printed before the seek-ad text.

Some fixes to make seek-ad suppression work in WinBoard

In WinBoard the z-depth was immediately erased by redrawing the graph;
the clearing of zlist had to be moved from PlotSeekAd() to AddAd()
(where it really belongs). Also aging of z-depth is now suppressed on
mere pointer motion.

Dynamic Seek Graph

The new option -autoRefresh sets FICS and ICC to report removal of seek
ads, and then removes those from the Seek Graph. New seek ads are added
to the graph, as soon as the ICS reports them.

Implement SeekGraph in XBoard

For now only controlled by left mouse clicks on board. New options
-seekGraph true|false and -sg to switch this feature on.

Facilitate selection of coinciding seek ads

Seek-ads that are viewed but not answered get a distance penalty on the
up-click that makes their selection more difficult next time, so that
the ad they covered gets a (better) change. The penalty ages away in the
course of 5 clicks.

Slightly offset Seek-Graph dots of different color

Dots of different color are now displaced horizontally be 3 pixels, to
prevent them from completely covering each other. (Required the axis
labels to be moved a little too, to not be covered by the 1-min ads.)

Auto-show seek-ad texts in WinBoard

Hovering the mouse above a Seek-Graph dot will make the text belonging
to it appear in the message field without the need to press a button.
Required SeekGraphClick() to be called from the WB mouse event handler,
with an extra argument 'moving' to make the distinction with a real
click.

Show seek-ad text on mouse hovering (XBoard)

The Eventproc is also set to trigger on PointerMotion, and this event
then calls SeekGraphClick with motion=true to handle it.

Put poetic name of wilds in seek-ad text

Use XBoard variant names, except for 'loadable' and 'fischerandom'
(becomes 'setup' and 'chess960'), but leave number (to distinguish wilds
that transate to same XBoard variant).

Fix highlighting bug in XBoard

The from-square was drawn before the to-square was erased, which led to
a missing highlight line if they shared an edge or corner.

Shorten autoKibitz confirmation on FICS

Strip off the "players)", but leave the separatng space.

Repair damage to -autoKibitz done by FICS atomic zippy claim

The sending of -autoKibitz info was also moved back in that patch, but
unfortunately to after clearing of the programStats info. Now the
clearing has been moved also, to remain after it.

Send continuation lines to chat box they belong to

The variable savingComment is used as a kludge to remember where the
comment should go (i.e. which chatbox, or elsewhere), so that when a
continuation line is matched, chatPartner (which was reset at EOL) can
be restored to its original value. Also put space after handle of talker
in channel Chat Windows

Fix u64 format for cygwin

With a -mno-cygwin compile %llu and %lld are definitely not understood
by scanf and printf, although they are by the compiler. In stead, %I64u
seems to work. Put it in under control of a switch USE_I64, which is
defined only in the gcc makefile when MINGW is used.

Remove stray dot from WinBoard makefiles

There was a period suffixed to config.h in the wgamelist.o dependency.

Fix bug in display of logos

The logo continued to be drawn after a boardSize change to a tinyLayout
size, although there was no space reserved for it. Fixed by explicitly
resetting logoHeight when no logo space is reserved in InitDrawingSizes().

Right-click refactoring: step III

Let WinBoard call RightClick in back-end, and delete the duplicate code
it had for this, after rescuing the front-end bits, and let the letter
act depending on the result returned by RightClick.

Right-click refactoring: step II

Migrate the Right-click routine to the back-end. Let it communicate back
square coordinates through pointer arguments, to accomodate their
different naming in XBoard and WinBoard. Template added in frontend.h.

Right-click refactoring, step I

Divorce front-end part from back-end part of PieceMenuPopup in XBoard
front-end, and forge the back-end part into a new routine RightClick.
The right up-click in XBoard, which called unLoadPV() directly, now
calls RightClick through PieceMenuPopUp().

Merge gamelistopt sources into gamelist source files

The files xgamelistopt.c and gamelistopt.c are merged with xgamelist.c
and gamelist.c, respectively. The WB front-end for the dialog already
resided in winboard.c, so there was little need to move it to wgameist.c
file. Makefiles adapted accordingly. Unsuitable key bindings were
removed. The low-level front-end prototypes are now defined in in
frontend.h.

Game-List options dialog for XBoard

A dialog similar to that of WinBoard was cloned from the game-list
window. The XBoard front-end is in a separate file xgamelistopt.c,
which in fact implements most of the low-level front-end as back-end.

Refactoring of game-list-options dialog

The back-end part is separated off, and moved to a file gamelistopt.c.
Front-end for now stays in winboard.c. No prototypes in frontend.h yet.

Fix of ancient WB bug: test integer option values for validity

Only a string of digits preceded by an optional sign is accepted now.
Before, any string was accepted, and leaving out a value could lead to
the next option being ignored (if it did not need a value) because it
was considered the value for the previous one!

Fix bug in edit-position of holdings

The holdings were effectivelly taken one too large, so that a promoted
shogi Pawn moved to, or created in the holdings was not demoted to Pawn,
but put in the dark (which you could see by the holding count if you did
it twice). The overflow tests in these two cases now have been corrected.

Save fonts in XBoard settings file per boardSize

Each -boardSize now can have its own font specified in the settings file
(and thus by a command-line option, although it would in general not be
very useful to specify a font for a size other than the selected). E.g.
a prefix "size33:" to the font name will apply it only to -size 33.
An unspecified-size font option (not normally in the settings file) will
always prevail over a font option specific for the current size.
A font of some size must have been used or specified in order to be
saved.

Fix width of filter field in XBoard GameList

An empirical dependence of the width of this text edit on the square
size now makes for an acceptable layout at any board size.

Use FICS atomic draw claim for sending move in zippy mode

For this the relaying of the move had to be moved until after the
adjudication, which again has to be done after MakeMove(), which is a
bit dubious, as MakeMove might take significant time when animating.

Send FICS atomic claim to ICS if move creates draw after offer

The FICS format "draw MOVE" is used to send the move to the ICS  when
the user enters a move that adjudicates as a claimable draw, and he
offered a draw before the move. For the benefit of ICS that do not
understand this format, the plain move is sent afterwards.

Also allow user to claim by offering draw before his move

Use the existing userOfferedDraw variable to test for such offers in
Adjudicate().

Also adjudicate after user move

Call Adjudicate() in FinishMove().

Refactoring of adjudication code

Put all the rule-based (as opposed to score-based) adjudications in a
separate routine, so they can also be called on user moves. This
requires sending the drawing move to the opponent engine to be made
conditional on existence of the latter. Execution of the code is no
longer dependent on the condition TwoMachinesPlay, but actual game
terminations are now all restricted by an alternative condition (no ICS
mode).

Use -keepAlive option to determine connection health

When there has been no ICS response since the previous 'ping', assume we
are disconnected and do a fatal-error exit. Also auto-start the ping
process in InitBackend3().

Use arrow keys in XBoard GameList for entry selection

Add translations for arrows and home/end, to call LoadSelectedProc with
argument to indicate the step, and let the latter perform the action.

Allow <Enter> to apply filter in XB GameList filter edit

Apply a translation to intercept the <Enter> key. Set focus back to the
list display afterwards.

Accept <Enter> for changing chat partner

A kludge stolen from Alessandro's GameList filter allowed to let the
typing of <Enter> while updating the chat-partner field of the WinBoard
chat windows to act as pressing the Change button. Gives focus to the
input field of the window afterwards.