common/fc_cmdhelp.h

   1 /*****************************************************************************
   2  Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   3    This program is free software; you can redistribute it and/or modify
   4    it under the terms of the GNU General Public License as published by
   5    the Free Software Foundation; either version 2, or (at your option)
   6    any later version.
   7
   8    This program is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11    GNU General Public License for more details.
  12 *****************************************************************************/
  13 #ifndef FC__FC_CMDHELP_H
  14 #define FC__FC_CMDHELP_H
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif /* __cplusplus */
  19
  20 struct cmdhelp;
  21
  22 struct cmdhelp *cmdhelp_new(const char *cmdname);
  23 void cmdhelp_destroy(struct cmdhelp *pcmdhelp);
  24 void cmdhelp_add(struct cmdhelp *pcmdhelp, const char *shortarg,
  25                  const char *longarg, const char *helpstr, ...)
  26                  fc__attribute((__format__(__printf__, 4, 5)));
  27 void cmdhelp_display(struct cmdhelp *pcmdhelp, bool sort, bool gui_options,
  28                      bool report_bugs);
  29
  30 #ifdef __cplusplus
  31 }
  32 #endif /* __cplusplus */
  33
  34 #endif  /* FC__FC_CMDHELP_H */