Improve Eval Graph with -evalZoom and -evalThreshold
[xboard.git] / evalgraph.c
1 /*
2  * evalgraph.c - Evaluation graph back-end part
3  *
4  * Author: Alessandro Scotti (Dec 2005)
5  *
6  * Copyright 2005 Alessandro Scotti
7  *
8  * ------------------------------------------------------------------------
9  *
10  * GNU XBoard is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or (at
13  * your option) any later version.
14  *
15  * GNU XBoard is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see http://www.gnu.org/licenses/.  *
22  *
23  *------------------------------------------------------------------------
24  ** See the file ChangeLog for a revision history.  */
25
26 // code refactored by HGM to obtain front-end / back-end separation
27
28 #include "config.h"
29
30 #include <stdio.h>
31
32 #if STDC_HEADERS
33 # include <stdlib.h>
34 # include <string.h>
35 #else /* not STDC_HEADERS */
36 # if HAVE_STRING_H
37 #  include <string.h>
38 # else /* not HAVE_STRING_H */
39 #  include <strings.h>
40 # endif /* not HAVE_STRING_H */
41 #endif /* not STDC_HEADERS */
42
43 #include "common.h"
44 #include "frontend.h"
45 #include "backend.h"
46 #include "evalgraph.h"
47
48 /* Module globals */
49 ChessProgramStats_Move * currPvInfo;
50 int currFirst = 0;
51 int currLast = 0;
52 int currCurrent = -1;
53 int range = 1;
54
55 int nWidthPB = 0;
56 int nHeightPB = 0;
57
58 int MarginX = 18;
59 int MarginW = 4;
60 int MarginH = 4;
61
62 // back-end
63 static void DrawLine( int x1, int y1, int x2, int y2, int penType )
64 {
65     DrawSegment( x1, y1, NULL, NULL, PEN_NONE );
66     DrawSegment( x2, y2, NULL, NULL, penType );
67 }
68
69 // back-end
70 static void DrawLineEx( int x1, int y1, int x2, int y2, int penType )
71 {
72     int savX, savY;
73     DrawSegment( x1, y1, &savX, &savY, PEN_NONE );
74     DrawSegment( x2, y2, NULL, NULL, penType );
75     DrawSegment( savX, savY, NULL, NULL, PEN_NONE );
76 }
77
78 // back-end
79 static int GetPvScore( int index )
80 {
81     int score = currPvInfo[ index ].score;
82
83     if( index & 1 ) score = -score; /* Flip score for black */
84
85     return score;
86 }
87
88 char* MakeEvalTitle( char * title)
89 {
90     int score = currPvInfo[ currCurrent ].score;
91     int depth = currPvInfo[ currCurrent ].depth;
92     static char buf[MSG_SIZ];
93
94     if( depth <=0 ) return title;
95     if( currCurrent & 1 ) score = -score; /* Flip score for black */
96     snprintf(buf, MSG_SIZ, "%s {%s%.2f/%-2d %d}", title, score>0 ? "+" : " ", score/100., depth, (currPvInfo[currCurrent].time+50)/100);
97
98     return buf;
99 }
100
101 // back-end
102 /*
103     For a centipawn value, this function returns the height of the corresponding
104     histogram, centered on the reference axis.
105
106     Note: height can be negative!
107 */
108 static int GetValueY( int value )
109 {
110     if( value < -range*700 ) value = -range*700;
111     if( value > +range*700 ) value = +range*700;
112     if(value > 100*range)  value += appData.zoom * 100 - 100*range; else
113     if(value < -100*range) value -= appData.zoom * 100 - 100*range; else
114         value *= appData.zoom;
115     return (nHeightPB / 2) - (int)(value * (nHeightPB - 2*MarginH) / ((1200. + 200.*appData.zoom)*range));
116 }
117
118 // the brush selection is made part of the DrawLine, by passing a style argument
119 // the wrapper for doing the text output makes this back-end
120 static void DrawAxisSegmentHoriz( int value, Boolean drawValue )
121 {
122     int y = GetValueY( range*value*100 );
123
124     if( drawValue ) {
125         char buf[MSG_SIZ], *b = buf;
126
127         if( value > 0 ) *b++ = '+';
128         sprintf(b, "%d", range*value);
129
130         DrawEvalText(buf, strlen(buf), y);
131     }
132     // [HGM] counts on DrawEvalText to have select transparent background for dotted line!
133     DrawLine( MarginX, y, MarginX + MarginW, y, PEN_BLACK ); // Y-axis tick marks
134     DrawLine( MarginX + MarginW, y, nWidthPB - MarginW, y, PEN_DOTTED ); // hor grid
135 }
136
137 // The DrawLines again must select their own brush.
138 // the initial brush selection is useless? BkMode needed for dotted line and text
139 static void DrawAxis()
140 {
141     int cy = nHeightPB / 2;
142     
143 //    SelectObject( hdcPB, GetStockObject(NULL_BRUSH) );
144
145 //    SetBkMode( hdcPB, TRANSPARENT );
146
147     DrawAxisSegmentHoriz( +5, TRUE );
148     DrawAxisSegmentHoriz( +3, FALSE );
149     DrawAxisSegmentHoriz( +1, FALSE );
150     DrawAxisSegmentHoriz(  0, TRUE );
151     DrawAxisSegmentHoriz( -1, FALSE );
152     DrawAxisSegmentHoriz( -3, FALSE );
153     DrawAxisSegmentHoriz( -5, TRUE );
154
155     DrawLine( MarginX + MarginW, cy, nWidthPB - MarginW, cy, PEN_BLACK ); // x-axis
156     DrawLine( MarginX + MarginW, MarginH, MarginX + MarginW, nHeightPB - MarginH, PEN_BLACK ); // y-axis
157 }
158
159 // back-end
160 static void DrawHistogram( int x, int y, int width, int value, int side )
161 {
162     int left, top, right, bottom;
163
164     if( value > -appData.evalThreshold*range && value < +appData.evalThreshold*range ) return;
165
166     left = x;
167     right = left + width + 1;
168
169     if( value > 0 ) {
170         top = GetValueY( value );
171         bottom = y+1;
172     }
173     else {
174         top = y;
175         bottom = GetValueY( value ) + 1;
176     }
177
178
179     if( width == MIN_HIST_WIDTH ) {
180         right--;
181         DrawRectangle( left, top, right, bottom, side, FILLED );
182     }
183     else {
184         DrawRectangle( left, top, right, bottom, side, OPEN );
185     }
186 }
187
188 // back-end
189 static void DrawSeparator( int index, int x )
190 {
191     if( index > 0 ) {
192         if( index == currCurrent ) {
193             DrawLineEx( x, MarginH, x, nHeightPB - MarginH, PEN_BLUEDOTTED );
194         }
195         else if( (index % 20) == 0 ) {
196             DrawLineEx( x, MarginH, x, nHeightPB - MarginH, PEN_DOTTED );
197         }
198     }
199 }
200
201 // made back-end by replacing MoveToEx and LineTo by DrawSegment
202 /* Actually draw histogram as a diagram, cause there's too much data */
203 static void DrawHistogramAsDiagram( int cy, int paint_width, int hist_count )
204 {
205     double step;
206     int i;
207
208     /* Rescale the graph every few moves (as opposed to every move) */
209     hist_count -= hist_count % 8;
210     hist_count += 8;
211     hist_count /= 2;
212
213     step = (double) paint_width / (hist_count + 1);
214
215     for( i=0; i<2; i++ ) {
216         int index = currFirst;
217         int side = (currCurrent + i + 1) & 1; /* Draw current side last */
218         double x = MarginX + MarginW;
219
220         if( (index & 1) != side ) {
221             x += step / 2;
222             index++;
223         }
224
225         DrawSegment( (int) x, cy, NULL, NULL, PEN_NONE );
226
227         index += 2;
228
229         while( index < currLast ) {
230             x += step;
231
232             DrawSeparator( index, (int) x );
233
234             /* Extend line up to current point */
235             if( currPvInfo[index].depth > 0 ) {
236                 DrawSegment((int) x, GetValueY( GetPvScore(index) ), NULL, NULL, PEN_BOLD + side );
237             }
238
239             index += 2;
240         }
241     }
242 }
243
244 // back-end, delete pen selection
245 static void DrawHistogramFull( int cy, int hist_width, int hist_count )
246 {
247     int i;
248
249 //    SelectObject( hdcPB, GetStockObject(BLACK_PEN) );
250
251     for( i=0; i<hist_count; i++ ) {
252         int index = currFirst + i;
253         int x = MarginX + MarginW + index * hist_width;
254
255         /* Draw a separator every 10 moves */
256         DrawSeparator( index, x );
257
258         /* Draw histogram */
259         if( currPvInfo[i].depth > 0 ) {
260             DrawHistogram( x, cy, hist_width, GetPvScore(index), index & 1 );
261         }
262     }
263 }
264
265 typedef struct {
266     int cy;
267     int hist_width;
268     int hist_count;
269     int paint_width;
270 } VisualizationData;
271
272 // back-end
273 static Boolean InitVisualization( VisualizationData * vd )
274 {
275     Boolean result = FALSE;
276
277     vd->cy = nHeightPB / 2;
278     vd->hist_width = MIN_HIST_WIDTH;
279     vd->hist_count = currLast - currFirst;
280     vd->paint_width = nWidthPB - MarginX - 2*MarginW;
281
282     if( vd->hist_count > 0 ) {
283         result = TRUE;
284
285         /* Compute width */
286         vd->hist_width = vd->paint_width / vd->hist_count;
287
288         if( vd->hist_width > MAX_HIST_WIDTH ) vd->hist_width = MAX_HIST_WIDTH;
289
290         vd->hist_width -= vd->hist_width % 2;
291     }
292
293     return result;
294 }
295
296 // back-end
297 static void DrawHistograms()
298 {
299     VisualizationData vd;
300
301     if( InitVisualization( &vd ) ) {
302         if( vd.hist_width < MIN_HIST_WIDTH ) {
303             DrawHistogramAsDiagram( vd.cy, vd.paint_width, vd.hist_count );
304         }
305         else {
306             DrawHistogramFull( vd.cy, vd.hist_width, vd.hist_count );
307         }
308     }
309 }
310
311 // back-end
312 int GetMoveIndexFromPoint( int x, int y )
313 {
314     int result = -1;
315     int start_x = MarginX + MarginW;
316     VisualizationData vd;
317
318     if( x >= start_x && InitVisualization( &vd ) ) {
319         /* Almost an hack here... we duplicate some of the paint logic */
320         if( vd.hist_width < MIN_HIST_WIDTH ) {
321             double step;
322
323             vd.hist_count -= vd.hist_count % 8;
324             vd.hist_count += 8;
325             vd.hist_count /= 2;
326
327             step = (double) vd.paint_width / (vd.hist_count + 1);
328             step /= 2;
329
330             result = (int) (0.5 + (double) (x - start_x) / step);
331         }
332         else {
333             result = (x - start_x) / vd.hist_width;
334         }
335     }
336
337     if( result >= currLast ) {
338         result = -1;
339     }
340
341     return result;
342 }
343
344 // init and display part split of so they can be moved to front end
345 void PaintEvalGraph( void )
346 {
347     VariantClass v = gameInfo.variant;
348     range = (gameInfo.holdingsWidth && v != VariantSuper && v != VariantGreat && v != VariantSChess) ? 2 : 1; // [HGM] double range in drop games
349     /* Draw */
350     DrawRectangle(0, 0, nWidthPB, nHeightPB, 2, FILLED);
351     DrawAxis();
352     DrawHistograms();
353 }
354