Markdown help: use fixed column width
[proxmark3-svn] / client / cmdparser.c
CommitLineData
a553f267 1//-----------------------------------------------------------------------------
2// Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
3//
4// This code is licensed to you under the terms of the GNU GPL, version 2 or,
5// at your option, any later version. See the LICENSE.txt file for the text of
6// the license.
7//-----------------------------------------------------------------------------
8// Command parser
9//-----------------------------------------------------------------------------
10
7fe9b0b7 11#include <stdio.h>
57c69556 12#include <stdlib.h>
7fe9b0b7 13#include <string.h>
14#include "ui.h"
15#include "cmdparser.h"
902cb3c0 16#include "proxmark3.h"
7fe9b0b7 17
18void CmdsHelp(const command_t Commands[])
19{
20 if (Commands[0].Name == NULL)
21 return;
22 int i = 0;
23 while (Commands[i].Name)
24 {
46782176
PT
25 if (!offline || Commands[i].Offline)
26 PrintAndLog("%-16s %s", Commands[i].Name, Commands[i].Help);
7fe9b0b7 27 ++i;
28 }
29}
30
9cb00f30 31void CmdsParse(const command_t Commands[], const char *Cmd)
7fe9b0b7 32{
57c69556 33 if(strcmp( Cmd, "XX_internal_command_dump_XX") == 0)
dec8e8bd
PT
34 {// Help dump children
35 dumpCommandsRecursive(Commands, 0);
36 return;
37 }
38 if(strcmp( Cmd, "XX_internal_command_dump_markdown_XX") == 0)
39 {// Markdown help dump children
40 dumpCommandsRecursive(Commands, 1);
57c69556
MHS
41 return;
42 }
7fe9b0b7 43 char cmd_name[32];
44 int len = 0;
45 memset(cmd_name, 0, 32);
46 sscanf(Cmd, "%31s%n", cmd_name, &len);
47 int i = 0;
48 while (Commands[i].Name && strcmp(Commands[i].Name, cmd_name))
49 ++i;
5d5311a2 50
51 /* try to find exactly one prefix-match */
52 if(!Commands[i].Name) {
53 int last_match = 0;
54 int matches = 0;
55
56 for(i=0;Commands[i].Name;i++) {
83819845 57 if( !strncmp(Commands[i].Name, cmd_name, strlen(cmd_name)) ) {
58 last_match = i;
59 matches++;
60 }
5d5311a2 61 }
62 if(matches == 1) i=last_match;
63 }
64
035303ac 65 if (Commands[i].Name) {
66 while (Cmd[len] == ' ')
67 ++len;
7fe9b0b7 68 Commands[i].Parse(Cmd + len);
035303ac 69 } else {
fcdfc43e 70 // show help for selected hierarchy or if command not recognised
040a7baa 71 CmdsHelp(Commands);
035303ac 72 }
7fe9b0b7 73}
57c69556
MHS
74
75char pparent[512] = {0};
76char *parent = pparent;
77
dec8e8bd 78void dumpCommandsRecursive(const command_t cmds[], int markdown)
57c69556 79{
dec8e8bd 80 if (cmds[0].Name == NULL)
57c69556
MHS
81 return;
82
83 int i = 0;
dec8e8bd
PT
84 int w_cmd=25;
85 int w_off=8;
57c69556
MHS
86 // First, dump all single commands, which are not a container for
87 // other commands
dec8e8bd 88 if (markdown) {
19e2a10d
PT
89 printf("|%-*s|%-*s|%s\n",w_cmd,"command",w_off,"offline","description");
90 printf("|%-*s|%-*s|%s\n",w_cmd,"-------",w_off,"-------","-----------");
dec8e8bd
PT
91 } else {
92 printf("%-*s|%-*s|%s\n",w_cmd,"command",w_off,"offline","description");
93 printf("%-*s|%-*s|%s\n",w_cmd,"-------",w_off,"-------","-----------");
94 }
57c69556
MHS
95
96 while (cmds[i].Name)
97 {
dec8e8bd 98 char* cmd_offline = "N";
57c69556
MHS
99 if(cmds[i].Help[0] == '{' && ++i) continue;
100
dec8e8bd
PT
101 if ( cmds[i].Offline) cmd_offline = "Y";
102 if (markdown)
19e2a10d 103 printf("|`%s%-*s`|%-*s|`%s`\n", parent, w_cmd-(int)strlen(parent)-2, cmds[i].Name, w_off, cmd_offline, cmds[i].Help);
dec8e8bd
PT
104 else
105 printf("%s%-*s|%-*s|%s\n", parent, w_cmd-(int)strlen(parent), cmds[i].Name, w_off, cmd_offline, cmds[i].Help);
57c69556
MHS
106 ++i;
107 }
108 printf("\n\n");
109 i=0;
110 // Then, print the categories. These will go into subsections with their own tables
111
112 while (cmds[i].Name)
113 {
114 if(cmds[i].Help[0] != '{' && ++i) continue;
115
dec8e8bd 116 printf("### %s%s\n\n %s\n\n", parent, cmds[i].Name, cmds[i].Help);
57c69556
MHS
117
118 char currentparent[512] = {0};
119 snprintf(currentparent, sizeof currentparent, "%s%s ", parent, cmds[i].Name);
120 char *old_parent = parent;
121 parent = currentparent;
57c69556
MHS
122 // This is what causes the recursion, since commands Parse-implementation
123 // in turn calls the CmdsParse above.
dec8e8bd
PT
124 if (markdown)
125 cmds[i].Parse("XX_internal_command_dump_markdown_XX");
126 else
127 cmds[i].Parse("XX_internal_command_dump_XX");
57c69556
MHS
128 parent = old_parent;
129 ++i;
130 }
131
132}
Impressum, Datenschutz