Provide option -m for markdown help dump, -h for text dump
[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 {
57c69556
MHS
25 if(Commands[i].Offline)
26 {
27 PrintAndLog("%-16s \t%s", Commands[i].Name, Commands[i].Help);
28 }else
29 {
30 PrintAndLog("%-16s @\t%s", Commands[i].Name, Commands[i].Help);
31 }
7fe9b0b7 32 ++i;
33 }
34}
35
9cb00f30 36void CmdsParse(const command_t Commands[], const char *Cmd)
7fe9b0b7 37{
57c69556 38 if(strcmp( Cmd, "XX_internal_command_dump_XX") == 0)
dec8e8bd
PT
39 {// Help dump children
40 dumpCommandsRecursive(Commands, 0);
41 return;
42 }
43 if(strcmp( Cmd, "XX_internal_command_dump_markdown_XX") == 0)
44 {// Markdown help dump children
45 dumpCommandsRecursive(Commands, 1);
57c69556
MHS
46 return;
47 }
7fe9b0b7 48 char cmd_name[32];
49 int len = 0;
50 memset(cmd_name, 0, 32);
51 sscanf(Cmd, "%31s%n", cmd_name, &len);
52 int i = 0;
53 while (Commands[i].Name && strcmp(Commands[i].Name, cmd_name))
54 ++i;
5d5311a2 55
56 /* try to find exactly one prefix-match */
57 if(!Commands[i].Name) {
58 int last_match = 0;
59 int matches = 0;
60
61 for(i=0;Commands[i].Name;i++) {
83819845 62 if( !strncmp(Commands[i].Name, cmd_name, strlen(cmd_name)) ) {
63 last_match = i;
64 matches++;
65 }
5d5311a2 66 }
67 if(matches == 1) i=last_match;
68 }
69
035303ac 70 if (Commands[i].Name) {
71 while (Cmd[len] == ' ')
72 ++len;
7fe9b0b7 73 Commands[i].Parse(Cmd + len);
035303ac 74 } else {
fcdfc43e 75 // show help for selected hierarchy or if command not recognised
040a7baa 76 CmdsHelp(Commands);
035303ac 77 }
7fe9b0b7 78}
57c69556
MHS
79
80char pparent[512] = {0};
81char *parent = pparent;
82
dec8e8bd 83void dumpCommandsRecursive(const command_t cmds[], int markdown)
57c69556 84{
dec8e8bd 85 if (cmds[0].Name == NULL)
57c69556
MHS
86 return;
87
88 int i = 0;
dec8e8bd
PT
89 int w_cmd=25;
90 int w_off=8;
57c69556
MHS
91 // First, dump all single commands, which are not a container for
92 // other commands
dec8e8bd
PT
93 if (markdown) {
94 printf("command|offline|description\n");
95 printf("-------|-------|-----------\n");
96 } else {
97 printf("%-*s|%-*s|%s\n",w_cmd,"command",w_off,"offline","description");
98 printf("%-*s|%-*s|%s\n",w_cmd,"-------",w_off,"-------","-----------");
99 }
57c69556
MHS
100
101 while (cmds[i].Name)
102 {
dec8e8bd 103 char* cmd_offline = "N";
57c69556
MHS
104 if(cmds[i].Help[0] == '{' && ++i) continue;
105
dec8e8bd
PT
106 if ( cmds[i].Offline) cmd_offline = "Y";
107 if (markdown)
108 printf("|`%s%s`|%s|`%s`|\n", parent, cmds[i].Name,cmd_offline, cmds[i].Help);
109 else
110 printf("%s%-*s|%-*s|%s\n", parent, w_cmd-(int)strlen(parent), cmds[i].Name, w_off, cmd_offline, cmds[i].Help);
57c69556
MHS
111 ++i;
112 }
113 printf("\n\n");
114 i=0;
115 // Then, print the categories. These will go into subsections with their own tables
116
117 while (cmds[i].Name)
118 {
119 if(cmds[i].Help[0] != '{' && ++i) continue;
120
dec8e8bd 121 printf("### %s%s\n\n %s\n\n", parent, cmds[i].Name, cmds[i].Help);
57c69556
MHS
122
123 char currentparent[512] = {0};
124 snprintf(currentparent, sizeof currentparent, "%s%s ", parent, cmds[i].Name);
125 char *old_parent = parent;
126 parent = currentparent;
57c69556
MHS
127 // This is what causes the recursion, since commands Parse-implementation
128 // in turn calls the CmdsParse above.
dec8e8bd
PT
129 if (markdown)
130 cmds[i].Parse("XX_internal_command_dump_markdown_XX");
131 else
132 cmds[i].Parse("XX_internal_command_dump_XX");
57c69556
MHS
133 parent = old_parent;
134 ++i;
135 }
136
137}
Impressum, Datenschutz