tools/doc-gen.c

   1 /* Copyright (c) 2006-2015 Jonas Fonseca <jonas.fonseca@gmail.com>
   2  *
   3  * This program is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU General Public License as
   5  * published by the Free Software Foundation; either version 2 of
   6  * the License, or (at your option) 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
  14 #include "tig/tig.h"
  15 #include "tig/request.h"
  16 #include "tig/util.h"
  17
  18 struct doc_action_iterator {
  19         bool end_group;
  20         const char *group;
  21 };
  22
  23 static void
  24 doc_action_group_name_print(const char *group)
  25 {
  26         printf("%s\n", group);
  27         while (*group++)
  28                 printf("^");
  29         printf("\n\n");
  30 }
  31
  32 static void
  33 doc_action_table_print(bool start)
  34 {
  35         if (start)
  36                 printf("[frame=\"none\",grid=\"none\",cols=\"25<m,75<\"]\n");
  37         printf("|=============================================================================\n");
  38 }
  39
  40 static bool
  41 doc_action_print(void *data, const struct request_info *req_info, const char *group)
  42 {
  43         struct doc_action_iterator *iterator = data;
  44
  45         if (iterator->group != group) {
  46                 if (iterator->end_group) {
  47                         doc_action_table_print(false);
  48                         printf("\n");
  49                 }
  50
  51                 doc_action_group_name_print(group);
  52                 doc_action_table_print(true);
  53
  54                 iterator->group = group;
  55                 iterator->end_group = true;
  56         }
  57
  58         printf("|%-24s|%s\n", enum_name(req_info->name), req_info->help);
  59         return true;
  60 }
  61
  62 static void
  63 doc_actions_print(void)
  64 {
  65         struct doc_action_iterator iterator = { false };
  66
  67         foreach_request(doc_action_print, &iterator);
  68         doc_action_table_print(false);
  69 }
  70
  71 int
  72 main(int argc, const char *argv[])
  73 {
  74         int i;
  75
  76         for (i = 1; i < argc; i++) {
  77                 if (!strcmp(argv[i], "actions"))
  78                         doc_actions_print();
  79         }
  80
  81         return EXIT_SUCCESS;
  82 }
  83
  84 /* vim: set ts=8 sw=8 noexpandtab: */