File: output.c

package info (click to toggle)
pgn-extract 16.0-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny
  • size: 912 kB
  • ctags: 737
  • sloc: ansic: 8,857; makefile: 103
file content (1115 lines) | stat: -rw-r--r-- 38,396 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
/*
 *  Program: pgn-extract: a Portable Game Notation (PGN) extractor.
 *  Copyright (C) 1994-2005 David Barnes
 *  This program 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 1, or (at your option)
 *  any later version.
 *
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *  David Barnes may be contacted as D.J.Barnes@kent.ac.uk
 *  http://www.cs.kent.ac.uk/people/staff/djb/
 *
 */

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include "bool.h"
#include "defs.h"
#include "typedef.h"
#include "taglist.h"
#include "tokens.h"
#include "lex.h"
#include "grammar.h"
#include "apply.h"
#include "output.h"


            /* Functions for outputting games in the required format. */

/* Define the width in which to print a CM move and move number. */
#define MOVE_NUMBER_WIDTH 3
#define MOVE_WIDTH 15
#define CM_COMMENT_CHAR ';'
/* Define the width of the moves area before a comment. */
#define COMMENT_INDENT (MOVE_NUMBER_WIDTH+2+2*MOVE_WIDTH)

/* Define a macro to calculate an array's size. */
#define ARRAY_SIZE(arr) (sizeof(arr)/sizeof(*arr))

/* How much text we have output on the current line. */
static unsigned line_length = 0;
/* The buffer in which each output line of a game is built. */
static char *output_line = NULL;

static Boolean print_move(FILE *outputfile, unsigned move_number,
                          unsigned print_move_number, Boolean white_to_move,
                          const Move *move_details);
static void output_STR(FILE *outfp,char **Tags);
static void show_tags(FILE *outfp,char **Tags,int tags_length);
static char promoted_piece_letter(Piece piece);
static void build_FEN_string(const Board *board,char *fen);
static const char *build_FEN_comment(const Board *board);
static void print_algebraic_game(Game current_game,FILE *outputfile,
                           unsigned move_number,Boolean white_to_move,
                           Board *final_board);
static void print_epd_game(Game current_game,FILE *outputfile,
                           unsigned move_number,Boolean white_to_move,
                           Board *final_board);
static void print_epd_move_list(Game current_game,FILE *outputfile,
                                unsigned move_number, Boolean white_to_move,
                                Board *final_board);

        /* List, the order in which the tags should be output.
         * The first seven should be the Seven Tag Roster that should
         * be present in every game.
         * The order of the remainder is, I believe, a matter of taste.
         * PSEUDO_PLAYER_TAG and PSEUDO_ELO_TAG should not appear
         * in this list.
         */

    /* Give the array an int type, because a negative value is
     * used as a terminator.
     */
static int DefaultTagOrder[] = {
    EVENT_TAG, SITE_TAG, DATE_TAG, ROUND_TAG, WHITE_TAG, BLACK_TAG, RESULT_TAG,
#if 1
    /* @@@ Consider omitting some of these from the default ordering,
     * and allow the output order to be determined from the
     * input order.
     */
    WHITE_TITLE_TAG, BLACK_TITLE_TAG, WHITE_ELO_TAG, BLACK_ELO_TAG,
    WHITE_USCF_TAG, BLACK_USCF_TAG,
    WHITE_TYPE_TAG, BLACK_TYPE_TAG,
    WHITE_NA_TAG, BLACK_NA_TAG,
    ECO_TAG, NIC_TAG, OPENING_TAG, VARIATION_TAG, SUB_VARIATION_TAG, 
    LONG_ECO_TAG,
    TIME_CONTROL_TAG,
    ANNOTATOR_TAG,
    EVENT_DATE_TAG, EVENT_SPONSOR_TAG, SECTION_TAG, STAGE_TAG, BOARD_TAG,
    TIME_TAG, UTC_DATE_TAG, UTC_TIME_TAG,
    SETUP_TAG,
    FEN_TAG,
    TERMINATION_TAG, MODE_TAG, PLY_COUNT_TAG,
#endif
    /* The final value should be negative. */
    -1
};

        /* Provision for a user-defined tag ordering.
         * See add_to_output_tag_order().
         * Once allocated, the end of the list must be negative.
         */
static int *TagOrder = NULL;
static int tag_order_space = 0;

void
set_output_line_length(unsigned max)
{
    if(output_line != NULL) {
	(void) free((void *) output_line);
    }
    output_line = (char *) MallocOrDie(max + 1);
}

    /* Which output format does the user require, based upon the
     * given command line argument?
     */
OutputFormat
which_output_format(const char *arg)
{   int i;
    struct {
        const char *arg;
        OutputFormat format;
    } formats[] = {
        { "san", SAN },
        { "SAN", SAN },
        { "epd", EPD },
        { "EPD", EPD },
        { "lalg", LALG },
        { "halg", HALG },
        { "CM", CM },
        { "LALG", LALG },
        { "HALG", HALG },
        { "ELALG", ELALG },
        { "elalg", ELALG },
        { "cm", CM },
        { "", SOURCE },
        /* Add others before the terminating NULL. */
        { (const char *) NULL, SAN }
    };

    for(i = 0; formats[i].arg != NULL; i++){
      const char *format_prefix = formats[i].arg;
      const int format_prefix_len = strlen(format_prefix);
      if(strncmp(arg,format_prefix,format_prefix_len) == 0){
            OutputFormat format = formats[i].format;
            /* If the format is SAN, it is possible to supply
             * a 6-piece suffix listing language-specific
             * letters to use in the output.
             */
            if((format == SAN || format == ELALG) &&
	           (strlen(arg) > format_prefix_len)){
                set_output_piece_characters(&arg[format_prefix_len]);
            }
            return format;
      }
  }
  fprintf(GlobalState.logfile,"Unknown output format %s.\n",arg);
  return SAN;
}

        /* Which file suffix should be used for this output format. */
const char *
output_file_suffix(OutputFormat format)
{
    /* Define a suffix for the output files. */
    static const char PGN_suffix[] = ".pgn";
    static const char EPD_suffix[] = ".epd";
    static const char CM_suffix[] = ".cm";

    switch(format){
        case SOURCE:
        case SAN:
        case LALG:
        case HALG:
        case ELALG:
            return PGN_suffix;
        case EPD:
            return EPD_suffix;
        case CM:
            return CM_suffix;
        default:
            return PGN_suffix;
    }
}

static const char *
select_tag_string(TagName tag)
{   const char *tag_string;

    if((tag == PSEUDO_PLAYER_TAG) || (tag == PSEUDO_ELO_TAG)){
        tag_string = NULL;
    }
    else{
        tag_string = tag_header_string(tag);
    }
    return tag_string;
}

static Boolean
is_STR(TagName tag)
{
    switch(tag){
        case EVENT_TAG:
        case SITE_TAG:
        case DATE_TAG:
        case ROUND_TAG:
        case WHITE_TAG:
        case BLACK_TAG:
        case RESULT_TAG:
            return TRUE;
        default:
            return FALSE;
    }
}

        /* Output the tags held in the Tags structure.
         * At least the full Seven Tag Roster is printed.
         */
static void
output_tag(TagName tag, char **Tags, FILE *outfp)
{   const char *tag_string;

    /* Must print STR elements and other non-NULL tags. */
    if((is_STR(tag)) || (Tags[tag] != NULL)){
        tag_string = select_tag_string(tag);

        if(tag_string != NULL){
            fprintf(outfp,"[%s \"",tag_string);
            if(Tags[tag] != NULL){
                fwrite(Tags[tag],sizeof(char),strlen(Tags[tag]),outfp);
            }
            else{
                if(tag == DATE_TAG){
                    fprintf(outfp,"????.??.??");
                }
                else{
                    fprintf(outfp,"?");
                }
            }
            fprintf(outfp,"\"]\n");
        }
    }
}

        /* Output the Seven Tag Roster. */
static void
output_STR(FILE *outfp,char **Tags)
{   unsigned tag_index;

    /* Use the default ordering to ensure that STR is output
     * in the way it should be.
     */
    for(tag_index = 0; tag_index < 7; tag_index++){
        output_tag(DefaultTagOrder[tag_index],Tags,outfp);
    }
}

        /* Print out on outfp the current details.
         * These can be used in the case of an error.
         */
static void
show_tags(FILE *outfp,char **Tags,int tags_length)
{   int tag_index;
    /* Take a copy of the Tags data, so that we can keep
     * track of what has been printed. This will make
     * it possible to print tags that were identified
     * in the source but are not defined with _TAG values.
     * See lex.c for how these extra tags are handled.
     */
    char **copy_of_tags =
            (char **) MallocOrDie(tags_length*sizeof(*copy_of_tags));
    int i;
    for(i = 0; i < tags_length; i++){
        copy_of_tags[i] = Tags[i];
    }

    /* Ensure that a tag ordering is available. */
    if(TagOrder == NULL){
        /* None set by the user - use the default. */
        /* Handle the standard tags.
         * The end of the list is marked with a negative value.
         */
        for(tag_index = 0; DefaultTagOrder[tag_index] >= 0; tag_index++){
            TagName tag = DefaultTagOrder[tag_index];
            output_tag(tag,copy_of_tags,outfp);
            copy_of_tags[tag] = (char *)NULL;
        }
        /* Handle the extra tags. */
        for(tag_index = 0; tag_index < tags_length; tag_index++){
            if(copy_of_tags[tag_index] != NULL){
                output_tag(tag_index,copy_of_tags,outfp);
            }
        }
    }
    else{
        for(tag_index = 0; TagOrder[tag_index] >= 0; tag_index++){
            TagName tag = TagOrder[tag_index];
            output_tag(tag,copy_of_tags,outfp);
            copy_of_tags[tag] = (char *)NULL;
        }
    }
    (void) free(copy_of_tags);
    putc('\n',outfp);
}

        /* Ensure that there is room for len more characters on the
         * current line.
         */
static void
check_line_length(FILE *fp,unsigned len)
{
    if((line_length + len) > GlobalState.max_line_length){
	terminate_line(fp);
    }
}

        /* Print ch to fp and update how much of the line
         * has been printed on.
         */
static void
single_char(FILE *fp, char ch)
{
    check_line_length(fp,1);
    output_line[line_length] = ch;
    line_length++;
}

        /* Print a space, unless at the beginning of a line. */
static void
print_separator(FILE *fp)
{
    /* Lines shouldn't have trailing spaces, so ensure that there
     * will be room for at least one more character after the space.
     */
    check_line_length(fp,2);
    if(line_length != 0){
	output_line[line_length] = ' ';
        line_length++;
    }
}

        /* Ensure that what comes next starts on a fresh line. */
void
terminate_line(FILE *fp)
{
    /* Delete any trailing space(s). */
    while(line_length >= 1 && output_line[line_length - 1] == ' ') {
	line_length--;
    }
    if(line_length > 0) {
	output_line[line_length] = '\0';
	fprintf(fp, "%s\n", output_line);
	line_length = 0;
    }
}

        /* Print str to fp and update how much of the line
         * has been printed on.
         */
void
print_str(FILE *fp, const char *str)
{   unsigned len = strlen(str);

    check_line_length(fp,len);
    sprintf(&(output_line[line_length]),"%s",str);
    line_length += len;
}

static void
print_comment_list(FILE *fp, CommentList *comment_list)
{   CommentList *next_comment;

    for(next_comment = comment_list ; next_comment != NULL;
                next_comment = next_comment->next){
        StringList *comment = next_comment->Comment;

        if(comment != NULL){
            /* We will use strtok to break up the comment string,
             * with chunk to point to each bit in turn.
             */
            char *chunk;
            
            single_char(fp,'{');
            for( ; comment != NULL; comment = comment->next){
                chunk = strtok(comment->str," ");
                while(chunk != NULL){
                    print_separator(fp);
                    print_str(fp,chunk);
                    chunk = strtok((char *)NULL," ");
                }
            }
            print_separator(fp);
            single_char(fp,'}');
            if(next_comment->next != NULL){
                print_separator(fp);
            }
        }
    }
}

static void
print_move_list(FILE *outputfile, unsigned move_number, Boolean white_to_move,
                const Move *move_details,const Board *final_board)
{   unsigned print_move_number = 1;
    const Move *move = move_details;

    while(move != NULL){
        /* Reset print_move number if a variation was printed. */
        print_move_number = print_move(outputfile,move_number,
                                       print_move_number,
                                       white_to_move,move);
        /* See if there is a result attached.  This may be attached either
         * to a move or a comment.
         */
        if(!GlobalState.check_only && (move != NULL) &&
                                (move->terminating_result != NULL)){
            if(GlobalState.output_FEN_string && final_board != NULL){
                print_separator(outputfile);
                print_str(outputfile,build_FEN_comment(final_board));
            }
            print_separator(outputfile);
            print_str(outputfile,move->terminating_result);
        }
        if(move->move[0] != '\0'){
            /* A genuine move was just printed, rather than a comment. */
            if(white_to_move){
              white_to_move = FALSE;
            }
            else{
               move_number++;
               white_to_move = TRUE;
            }
        }
        move = move->next;
        /* The following is slightly inaccurate.
         * If the previous value of move was a comment and
         * we aren't printing comments, then this results in two
         * separators being printed after the move preceding the comment.
         * Not sure how to cleanly fix it, because there might have
         * been nags attached to the comment that were printed, for instance!
         */
        if(move != NULL){
            print_separator(outputfile);
        }
    }
}

        /* Output the current move along with associated information.
         * Return TRUE if either a variation or comment was printed,
         * FALSE otherwise.
         * This is needed to determine whether a new move number
         * is to be printed after a variation.
         */
static Boolean
print_move(FILE *outputfile, unsigned move_number, unsigned print_move_number,
                Boolean white_to_move, const Move *move_details)
{   Boolean something_printed = FALSE;

    if(move_details == NULL){
        /* Shouldn't happen. */
        fprintf(GlobalState.logfile,
                "Internal error: NULL move in print_move.\n");
        report_details(GlobalState.logfile);
    }
    else{
        if(GlobalState.check_only){
            /* Nothing to be output. */
        }
        else{
            StringList *nags = move_details->Nags;
            Variation *variants = move_details->Variants;
            const unsigned char *move_text = move_details->move;

            if(*move_text != '\0'){
                if(white_to_move || print_move_number){
                    static char small_number[] = "99999...";

                    /* @@@ Should 1... be written as 1. ... ? */
                    sprintf(small_number,"%u.%s",move_number, white_to_move?"":"..");
                    print_str(outputfile,small_number);
                    print_separator(outputfile);
                }
                switch(GlobalState.output_format){
                    case SAN:
                    case SOURCE:
                        /* @@@ move_text should be handled as unsigned
                         * char text, as the source may be 8-bit rather
                         * than 7-bit.
                         */
                        print_str(outputfile, (const char *) move_text);
                        break;
                    case HALG:
                        {  char algebraic[MAX_MOVE_LEN+1];

                           *algebraic = '\0';
                           switch(move_details->class){
                               case PAWN_MOVE:
                               case ENPASSANT_PAWN_MOVE:
                               case KINGSIDE_CASTLE:
                               case QUEENSIDE_CASTLE:
                               case PIECE_MOVE:
                                   sprintf(algebraic,"%c%c-%c%c",
                                       move_details->from_col,
                                       move_details->from_rank,
                                       move_details->to_col,
                                       move_details->to_rank);
                                   break;
                               case PAWN_MOVE_WITH_PROMOTION:
                                   sprintf(algebraic,"%c%c-%c%c%c",
                                       move_details->from_col,
                                       move_details->from_rank,
                                       move_details->to_col,
                                       move_details->to_rank,
                                       promoted_piece_letter(move_details->promoted_piece));
                                   break;
                               case UNKNOWN_MOVE:
                                   strcpy(algebraic,"???");
                                   break;
                           }
                           switch(move_details->check_status){
                               case NOCHECK:
                                 break;
                               case CHECK:
                                   strcat(algebraic,"+");
                                 break;
                               case CHECKMATE:
                                   strcat(algebraic,"#");
                                 break;
                           }
                            print_str(outputfile,algebraic);
                        }
                        break;
                    case LALG:
                    case ELALG:
                        {  char algebraic[MAX_MOVE_LEN+1];
                           int ind = 0;

                           /* Prefix with a piece name if ELALG. */
                           if(GlobalState.output_format == ELALG &&
                                        move_details->class == PIECE_MOVE){
                               strcpy(algebraic,
				      piece_str(move_details->piece_to_move));
                               ind = strlen(algebraic);
                           }
                           /* Format the basics. */
                           sprintf(&algebraic[ind],"%c%c%c%c",
                                       move_details->from_col,
                                       move_details->from_rank,
                                       move_details->to_col,
                                       move_details->to_rank);
                           ind += 4;
                           switch(move_details->class){
                               case PAWN_MOVE:
                               case KINGSIDE_CASTLE:
                               case QUEENSIDE_CASTLE:
                               case PIECE_MOVE:
                                   /* Nothing more to do at this stage. */
                                   break;
                               case ENPASSANT_PAWN_MOVE:
                                   if(GlobalState.output_format == ELALG){
                                       strcat(algebraic,"ep");
                                       ind += 2;
                                   }
                                   break;
                               case PAWN_MOVE_WITH_PROMOTION:
                                   sprintf(&algebraic[ind],"%s",
                                           piece_str(move_details->promoted_piece));
                                   ind = strlen(algebraic);
                                   break;
                               case UNKNOWN_MOVE:
                                   strcpy(algebraic,"???");
                                   ind += 3;
                                   break;
                           }
                           switch(move_details->check_status){
                               case NOCHECK:
                                 break;
                               case CHECK:
                                   strcat(algebraic,"+");
                                   ind++;
                                   break;
                               case CHECKMATE:
                                   strcat(algebraic,"#");
                                   ind++;
                                   break;
                           }
                           print_str(outputfile,algebraic);
                        }
                        break;
                    default:
                        fprintf(GlobalState.logfile,
                                "Unknown output format %d in print_move()\n",
                                GlobalState.output_format);
                                exit(1);
                        break;
                }
            }
            else{
                /* An empty move. */
                fprintf(GlobalState.logfile,
                                "Internal error: Empty move in print_move.\n");
                report_details(GlobalState.logfile);
            }
            /* Print further information, that may be attached to moves
             * and comments.
             */
            if(GlobalState.keep_NAGs){
                while(nags != NULL){
                    print_separator(outputfile);
                    print_str(outputfile,nags->str);
                    nags = nags->next;
                }
                /* We don't need to output move numbers after just
                 * NAGs, so don't set something_printed.
                 */
            }
            if(GlobalState.keep_comments){
                if(move_details->Comment != NULL){
                    print_separator(outputfile);
                    print_comment_list(outputfile,move_details->Comment);
                    something_printed = TRUE;
                }
            }
            if((GlobalState.keep_variations) && (variants != NULL)){
                while(variants != NULL){
                    print_separator(outputfile);
                    single_char(outputfile,'(');
                    if(GlobalState.keep_comments &&
                            (variants->prefix_comment != NULL)){
                        print_comment_list(outputfile,variants->prefix_comment);
                        print_separator(outputfile);
                    }
                    /* Always start with a move number.
                     * The final board position is not needed.
                     */
                    print_move_list(outputfile,move_number,
                                    white_to_move,variants->moves,
                                    (const Board *)NULL);
                    single_char(outputfile,')');
                    if(GlobalState.keep_comments &&
                            (variants->suffix_comment != NULL)){
                        print_separator(outputfile);
                        print_comment_list(outputfile,variants->suffix_comment);
                    }
                    variants = variants->next;
                }
                something_printed = TRUE;
            }
        }
    }
    return something_printed;
}

        /* Return the letter associated with the given piece. */
static char
promoted_piece_letter(Piece piece)
{
    switch(piece){
        case QUEEN:
            return 'Q';
        case ROOK:
            return 'R';
        case BISHOP:
            return 'B';
        case KNIGHT:
            return 'N';
        default:
            return '?';
    }
}

    /* Build a FEN string from the given board.
     * Currently, the number of half moves since the
     * last pawn move or capture is not recorded.
     */
static void
build_FEN_string(const Board *board,char *fen)
{   int ix;
    build_basic_EPD_string(board,fen);
    /* Append the (pseudo) half move count and the full move count. */
    ix = strlen(fen);
    fen[ix] = ' '; ix++;

    /* Half moves since the last capture or pawn move.
     * @@@ Currently this is not set correctly.
     */
    fen[ix] = '0'; ix++;
    fen[ix] = ' '; ix++;

    /* The move number. */
    sprintf(&fen[ix],"%u",board->move_number);
}

static const
char *build_FEN_comment(const Board *board)
{
    static char fen[FEN_SPACE];
    strcpy(fen,"{ \"");
    build_FEN_string(board,&fen[strlen(fen)]);
    strcat(fen,"\" }");
    /* A belated sanity check. */
    if(strlen(fen) >= FEN_SPACE){
        fprintf(GlobalState.logfile,
                "Internal error: string overflow in build_FEN_string.\n");
    }
    return fen;
}

        /* Output a comment in CM format. */
static void
output_cm_comment(CommentList *comment,FILE *outputfile,unsigned indent)
{   /* Don't indent for the first comment line, because
     * we should already be positioned at the correct spot.
     */
    unsigned indent_for_this_line = 0;

    putc(CM_COMMENT_CHAR,outputfile);
    line_length++;
    while(comment != NULL){
        /* We will use strtok to break up the comment string,
         * with chunk to point to each bit in turn.
         */
        char *chunk;
        StringList *comment_str = comment->Comment;
        
        for( ; comment_str != NULL; comment_str = comment_str->next){
            chunk = strtok(comment_str->str," ");
            while(chunk != NULL){
                unsigned len = strlen(chunk);

                if((line_length+1+len) > GlobalState.max_line_length){
                    /* Start a new line. */
                    indent_for_this_line = indent;
                    fprintf(outputfile,"\n%*s%c ",indent_for_this_line,"",
                                        CM_COMMENT_CHAR);
                    line_length = indent_for_this_line+2;
                }
                else{
                    putc(' ',outputfile);
                    line_length++;
                }
                fprintf(outputfile,"%s",chunk);
                line_length += len;
                chunk = strtok((char *)NULL," ");
            }
        }
        comment = comment->next;
    }
    putc('\n',outputfile);
    line_length = 0;
}

static void
output_cm_result(const char *result,FILE *outputfile)
{
    fprintf(outputfile,"%c ",CM_COMMENT_CHAR);
    if(strcmp(result,"1-0") == 0){
      fprintf(outputfile,"and black resigns");
    }
    else if(strcmp(result,"0-1") == 0){
      fprintf(outputfile,"and white resigns");
    }
    else if(strncmp(result,"1/2",3) == 0){
      fprintf(outputfile,"draw");
    }
    else{
      fprintf(outputfile,"incomplete result");
    }
}


        /* Output the game in Chess Master format. */
static void
output_cm_game(FILE *outputfile,unsigned move_number,
                Boolean white_to_move,const Game game)
{   const Move *move = game.moves;

    if((move_number != 1) || (!white_to_move)){
        fprintf(GlobalState.logfile,
            "Unable to output CM games other than from the starting position.\n");
        report_details(GlobalState.logfile);
    }
    fprintf(outputfile,"WHITE: %s\n",
                game.tags[WHITE_TAG] != NULL? game.tags[WHITE_TAG] : "");
    fprintf(outputfile,"BLACK: %s\n",
                game.tags[BLACK_TAG] != NULL? game.tags[BLACK_TAG] : "");
    putc('\n',outputfile);

    if(game.prefix_comment != NULL){
        line_length = 0;
        output_cm_comment(game.prefix_comment,outputfile,0);
    }
    while(move != NULL){
        if(move->move[0] != '\0'){
            /* A genuine move. */
            if(white_to_move){
                fprintf(outputfile,"%*u. ",MOVE_NUMBER_WIDTH,move_number);
                fprintf(outputfile,"%*s",-MOVE_WIDTH,move->move);
                white_to_move = FALSE;
            }
            else{
                fprintf(outputfile,"%*s",-MOVE_WIDTH,move->move);
                move_number++;
                white_to_move = TRUE;
            }
        }
        if((move->Comment != NULL) && GlobalState.keep_comments){
            const char *result = move->terminating_result;

            if(!white_to_move){
                fprintf(outputfile,"%*s",-MOVE_WIDTH,"...");
            }
            line_length = COMMENT_INDENT;
            output_cm_comment(move->Comment,outputfile,COMMENT_INDENT);
            if((result != NULL) && (move->check_status != CHECKMATE)){
                /* Give some information on the nature of the finish. */
                if(white_to_move){
                    fprintf(outputfile,"%*s",COMMENT_INDENT,"");
                }
                else{
                    /* Print out a string representing the result. */
                    fprintf(outputfile,"%*s %*s%*s",
                                    MOVE_NUMBER_WIDTH+1,"",-MOVE_WIDTH,"...",
                                    MOVE_WIDTH,"");
                }
                output_cm_result(result,outputfile);
                putc('\n',outputfile);
            }
            else{
                if(!white_to_move){
                    /* Indicate that the next move is Black's. */
                    fprintf(outputfile,"%*s %*s",
                                MOVE_NUMBER_WIDTH+1,"",-MOVE_WIDTH,"...");
                }
            }
        }
        else{
            if((move->terminating_result != NULL) &&
                        (move->check_status != CHECKMATE)){
                /* Give some information on the nature of the finish. */
                const char *result = move->terminating_result;

                if(!white_to_move){
                    fprintf(outputfile,"%*s",-MOVE_WIDTH,"...");
                }
                output_cm_result(result,outputfile);
                if(!white_to_move){
                    putc('\n',outputfile);
                    fprintf(outputfile,"%*s %*s",
                                    MOVE_NUMBER_WIDTH+1,"",-MOVE_WIDTH,"...");
                }
                putc('\n',outputfile);
            }
            else{
                if(white_to_move){
                    /* Terminate the move pair. */
                    putc('\n',outputfile);
                }
            }
        }
        move = move->next;
    }
    putc('\n',outputfile);
}


        /* Output the current game according to the required output format. */
void
output_game(Game current_game,FILE *outputfile)
{   Boolean white_to_move = TRUE;
    unsigned move_number = 1;
    /* The final board position, if available. */
    Board *final_board = NULL;

    /* If we aren't starting from the initial setup, then we
     * need to know the current move number and whose
     * move it is.
     */
    if(current_game.tags[FEN_TAG] != NULL){
        Board *board = new_fen_board(current_game.tags[FEN_TAG]);

        if(board != NULL){
            move_number = board->move_number;
            white_to_move = board->to_move == WHITE;
            (void) free((void *)board);
        }
    }

    /* Start at the beginning of a line. */
    line_length = 0;
    /* See if the moves should be rewritten into
     * standard form.
     */
    if(GlobalState.output_format != SOURCE){
        /* Rewrite the moves of the game into
         * SAN (Standard Algebraic Notation).
         */
        final_board = rewrite_game(current_game.moves,
                                   current_game.tags[FEN_TAG]);
    }
    switch(GlobalState.output_format){
        case SAN:
        case SOURCE:
        case LALG:
        case HALG:
        case ELALG:
	    print_algebraic_game(current_game,outputfile,move_number,white_to_move,
				 final_board);
            break;
        case EPD:
            print_epd_game(current_game,outputfile,move_number,white_to_move,
                           final_board);
            break;
        case CM:
            output_cm_game(outputfile,move_number,white_to_move,current_game);
            break;
        default:
            fprintf(GlobalState.logfile,
                        "Internal error: unknown output type %d in output_game().\n",
                        GlobalState.output_format);
            break;
    }
    if(final_board != NULL){
        (void) free((void *) final_board);
    }
}

        /* Add the given tag to the output ordering. */
void
add_to_output_tag_order(TagName tag)
{   int tag_index;

    if(TagOrder == NULL){
        tag_order_space = ARRAY_SIZE(DefaultTagOrder);
        TagOrder = (int *) MallocOrDie(tag_order_space*sizeof(*TagOrder));
        /* Always ensure that there is a negative value at the end. */
        TagOrder[0] = -1;
    }
    /* Check to ensure a position has not already been indicated
     * for this tag.
     */
    for(tag_index = 0; (TagOrder[tag_index] != -1) && 
                       (TagOrder[tag_index] != tag); tag_index++){
    }

    if(TagOrder[tag_index] == -1){
        /* Make sure there is enough space for another. */
        if(tag_index >= tag_order_space){
            /* Allocate some more. */
            tag_order_space += 10;
            TagOrder = (int *) ReallocOrDie((void *)TagOrder,
                                            tag_order_space*sizeof(*TagOrder));
        }
        TagOrder[tag_index] = tag;
        TagOrder[tag_index+1] = -1;
    }
    else{
        fprintf(GlobalState.logfile,"Duplicate position for tag: %s\n",
                select_tag_string(tag));
    }
}

static const char *format_epd_game_comment(char **Tags)
{   
    static char comment_prefix[] = "c0 ";
    static char player_separator[] = "-";
    static int prefix_and_separator_len = sizeof(comment_prefix)+
                                          sizeof(player_separator);
    unsigned space_needed = prefix_and_separator_len;
    char *comment;

    if(Tags[WHITE_TAG] != NULL){
      space_needed += strlen(Tags[WHITE_TAG]);
    }
    if(Tags[BLACK_TAG] != NULL){
      space_needed += strlen(Tags[BLACK_TAG]);
    }
    /* Allow a space character before each of the remaining tags. */
    if(Tags[EVENT_TAG] != NULL){
      space_needed += 1+strlen(Tags[EVENT_TAG]);
    }
    if(Tags[SITE_TAG] != NULL){
      space_needed += 1+strlen(Tags[SITE_TAG]);
    }
    if(Tags[DATE_TAG] != NULL){
      space_needed += 1+strlen(Tags[DATE_TAG]);
    }
    /* Allow for a terminating semicolon. */
    space_needed++;

    comment = (char *) MallocOrDie(space_needed+1);

    strcpy(comment,comment_prefix);
    if(Tags[WHITE_TAG] != NULL){
      strcat(comment,Tags[WHITE_TAG]);
    }
    strcat(comment,player_separator);
    if(Tags[BLACK_TAG] != NULL){
      strcat(comment,Tags[BLACK_TAG]);
    }
    if(Tags[EVENT_TAG] != NULL){
      strcat(comment," ");
      strcat(comment,Tags[EVENT_TAG]);
    }
    if(Tags[SITE_TAG] != NULL){
      strcat(comment," ");
      strcat(comment,Tags[SITE_TAG]);
    }
    if(Tags[DATE_TAG] != NULL){
      strcat(comment," ");
      strcat(comment,Tags[DATE_TAG]);
    }
    strcat(comment,";");
    if(strlen(comment) >= space_needed){
        fprintf(GlobalState.logfile,
                "Internal error: overflow in format_epd_game_comment\n");
    }
    return comment;
}

static void
print_algebraic_game(Game current_game,FILE *outputfile,
		     unsigned move_number,Boolean white_to_move,
		     Board *final_board)
{
    /* Report details on the output. */
    if(GlobalState.seven_tag_roster){
      output_STR(outputfile,current_game.tags);
      if(GlobalState.add_ECO && !GlobalState.parsing_ECO_file){
		  /* If ECO classification has been requested, then assume
		   * that ECO tags are also required.
		   */
		  output_tag(ECO_TAG,current_game.tags,outputfile);
		  output_tag(OPENING_TAG,current_game.tags,outputfile);
		  output_tag(VARIATION_TAG,current_game.tags,outputfile);
		  output_tag(SUB_VARIATION_TAG,current_game.tags,outputfile);
      }

      /* Output any FEN that there might be. */
      output_tag(FEN_TAG,current_game.tags,outputfile);
      putc('\n',outputfile);
    }
    else{
      show_tags(outputfile,current_game.tags,current_game.tags_length);
    }
    if((GlobalState.keep_comments) &&
		    (current_game.prefix_comment != NULL)){
      print_comment_list(outputfile,
			 current_game.prefix_comment);
      terminate_line(outputfile);
      putc('\n',outputfile);
    }
    print_move_list(outputfile,move_number,white_to_move,
		    current_game.moves,final_board);
    /* Take account of a possible zero move game. */
    if(current_game.moves == NULL) {
	if(current_game.tags[RESULT_TAG] != NULL) {
	    print_str(outputfile,current_game.tags[RESULT_TAG]);
	}
        else{
            fprintf(GlobalState.logfile,
		    "Internal error: Zero move game with no result\n");
        }
    }
    terminate_line(outputfile);
    putc('\n',outputfile);
}

static void
print_epd_move_list(Game current_game,FILE *outputfile,
                    unsigned move_number, Boolean white_to_move,
                    Board *final_board)
{   const Move *move = current_game.moves;
    const char *game_comment = format_epd_game_comment(current_game.tags);
    static char epd[FEN_SPACE];

    while(move != NULL){
        if(move->epd != NULL){
            fprintf(outputfile,"%s",move->epd);
        }
        else{
            fprintf(GlobalState.logfile,"Internal error: Missing EPD\n");
        }
        fprintf(outputfile," %s",game_comment);
        putc('\n',outputfile);
        move = move->next;
    }
    build_basic_EPD_string(final_board,epd);
    fprintf(outputfile,"%s %s",epd,game_comment);
    putc('\n',outputfile);
    (void) free((void *)game_comment);
}

static void
print_epd_game(Game current_game,FILE *outputfile,
               unsigned move_number,Boolean white_to_move,
               Board *final_board)
{
    if(!GlobalState.check_only){
        print_epd_move_list(current_game,outputfile,move_number,white_to_move,
                            final_board);
        putc('\n',outputfile);
    }
}