manual_uclass.c

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   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 2, 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.
***********************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif
 
/* utility */
#include "fcintl.h"
 
/* common */
#include "game.h"
#include "tech.h"
 
/* client */
#include "helpdata.h"
 
/* tools/manual */
#include "fc_manual.h"
 
/**********************************************************************/
bool manual_uclasses(struct tag_types *tag_info)
{
  FILE *doc;
 
  doc = manual_start(tag_info, MANUAL_UCLASS);
 
  if (doc == NULL) {
    return FALSE;
  }
 
  /* TRANS: markup ... Freeciv version ... ruleset name ... markup */
  fprintf(doc, _("%sFreeciv %s unit classes help (%s)%s\n\n"),
          tag_info->title_begin, VERSION_STRING, game.control.name,
          tag_info->title_end);
  unit_class_iterate(uclass) {
    char buf[64000];
 
    fprintf(doc, tag_info->item_begin, "uclass", uclass_index(uclass));
    fprintf(doc, "%s%s%s\n\n", tag_info->sect_title_begin,
            uclass_name_translation(uclass), tag_info->sect_title_end);
 
    fprintf(doc, tag_info->subitem_begin, "helptext");
    buf[0] = '\0';
    helptext_unitclass(uclass, buf, sizeof(buf));
    fprintf(doc, "%s", buf);
    fprintf(doc, "%s", tag_info->subitem_end);
 
    fprintf(doc, "%s", tag_info->item_end);
  } unit_class_iterate_end;
 
  manual_finalize(tag_info, doc, MANUAL_UCLASS);
 
  return TRUE;
}