Subversion Repositories HelenOS

Rev

Rev 3810 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
3265 post 1
#!/bin/sh
2
# Copyright (C) 2008 Tim Post - All Rights Reserved
3
# Redistribution and use in source and binary forms, with or without
4
# modification, are permitted provided that the following conditions are met:
5
#
6
# Redistributions of source code must retain the above copyright notice, this
7
# list of conditions and the following disclaimer.
8
#
9
# Redistributions in binary form must reproduce the above copyright notice,
10
# this list of conditions and the following disclaimer in the documentation
11
# and/or other materials provided with the distribution.
12
#
13
# Neither the name of the original program's authors nor the names of its
14
# contributors may be used to endorse or promote products derived from this
15
# software without specific prior written permission.
16
#
17
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
# POSSIBILITY OF SUCH DAMAGE.
28
 
29
# Script to generate skeletal files for a new command
30
# Uses `getopt', not quite a bash-ism but might be
31
# lacking on some legacy systems.
32
 
33
# If your shell does not support eval, shift (x) or
34
# here-now documents, sorry :) 
35
 
36
usage()
37
{
38
	def="$DEFAULT_COMMAND"
39
	cat << EOF
40
\`$PROGNAME' generates skeletal command files to simplify adding commands
41
Usage: $PROGNAME [options] <location>
42
Options:
43
  -n, --name         Name of the command (default: ${def})
44
  -d, --desc         Short (20 30 chars) description of the command
45
                     (def: "The $def command")
46
  -e, --entry        Entry function of the command (def: cmd_${def})
47
  -h, --help-entry   Entry function for command help (def: help_cmd_${def})
48
  -a, --alias        Alias (nickname) for this command (def: none)
49
  -t, --type         Type of command (module or builtin) (def: module)
50
  -H, --help         This help summary
51
  -V, --version      Print $PROGNAME version and exit normally
52
 
53
Notes:
54
  You must supply at least the name of the command.
55
 
56
  If you do not specify a location (i.e. modules/foo), the command will be
57
  created in modules/command_name or builtins/command_name depending on your
58
  selection.
59
 
60
  This script will only create skeletal files and inform you what headers
61
  need to be modified to incorporate the command. You will also have to
62
  manually update the main Makefile.
63
 
64
  This script is intended only to be a convenience for developers. Example use:
65
    $PROGNAME -n foo -d "Foo power" -a bar -r both -t module modules/foo
66
 
67
  The example would generate a modular command named 'foo', which is also
3810 post 68
  reached by typing 'bar'.
3265 post 69
 
70
  Skeletal files do *not* depend on the autoconf generated "config.h" unless you
71
  include it. This may or may not be desirable depending on your use.
72
 
73
Report bugs to $PROGMAINT
74
 
75
EOF
76
}
77
 
78
# Convert a string to all uppercase
79
toupper()
80
{
81
	local str="$1"
82
 
83
	echo "${str}" | tr 'a-z' 'A-Z'
84
}
85
 
86
# Template stored `here-now' style, this generates all files needed
87
# for a new command according to arguments passed.
88
generate_code()
89
{
3373 post 90
	echo "Creating ${OUTDIR}/${CMDNAME}_def.h ..."
91
	cat << EOF > ${OUTDIR}/${CMDNAME}_def.h
3265 post 92
{
93
	"${CMDNAME}",
94
	"${CMDDESC}",
95
	&${CMDENTRY},
96
	&${HELPENTRY},
97
},
98
 
99
EOF
3373 post 100
	[ -n "${CMDALIAS}" ] && cat << EOF >> ${OUTDIR}/${CMDNAME}_def.h
3265 post 101
{
102
	"${CMDALIAS}",
103
	NULL,
104
	&${CMDENTRY},
105
	&${HELPENTRY},
106
},
107
 
108
EOF
109
	local defname=$(toupper "${CMDNAME}")
110
	echo "Creating ${OUTDIR}/entry.h ..."
111
	cat << EOF > ${OUTDIR}/entry.h
112
#ifndef ${defname}_ENTRY_H
113
#define ${defname}_ENTRY_H
114
 
115
EOF
116
	[ "${CMDTYPE}" = "module" ] && cat << EOF >> ${OUTDIR}/entry.h
117
/* Entry points for the ${CMDNAME} command */
3419 post 118
extern int ${CMDENTRY}(char **);
119
extern void ${HELPENTRY}(unsigned int);
3265 post 120
 
121
#endif /* ${defname}_ENTRY_H */
122
 
123
EOF
124
	[ "${CMDTYPE}" = "builtin" ] && cat << EOF >> ${OUTDIR}/entry.h
125
/* Pick up cliuser_t */
126
#include "scli.h"
127
 
128
/* Entry points for the ${CMDNAME} command */
129
extern int * ${CMDENTRY}(char **, cliuser_t *);
130
extern void * ${HELPENTRY}(unsigned int);
131
 
132
#endif /* ${defname}_ENTRY_H */
133
 
134
EOF
135
	echo "Creating ${OUTDIR}/${CMDNAME}.h ..."
136
	cat << EOF > ${OUTDIR}/${CMDNAME}.h
137
#ifndef ${defname}_H
138
#define ${defname}_H
139
 
140
/* Prototypes for the ${CMDNAME} command, excluding entry points */
141
 
142
 
143
#endif /* ${defname}_H */
144
 
145
EOF
146
	echo "Creating ${OUTDIR}/${CMDNAME}.c ..."
147
	cat << EOF > ${OUTDIR}/${CMDNAME}.c
148
/* Automatically generated by ${PROGNAME} on ${TIMESTAMP}
149
 * This is machine generated output. The author of ${PROGNAME} claims no
150
 * copyright over the contents of this file. Where legally permitted, the
151
 * contents herein are donated to the public domain.
152
 *
153
 * You should apply any license and copyright that you wish to this file,
154
 * replacing this header in its entirety. */
155
 
156
#include <stdio.h>
157
#include <stdlib.h>
3284 post 158
#include "config.h"
3301 post 159
#include "util.h"
3284 post 160
#include "errors.h"
3265 post 161
#include "entry.h"
162
#include "${CMDNAME}.h"
163
#include "cmds.h"
164
 
3810 post 165
static const char *cmdname = "${CMDNAME}";
3265 post 166
 
167
/* Dispays help for ${CMDNAME} in various levels */
3414 post 168
void ${HELPENTRY}(unsigned int level)
3265 post 169
{
170
	printf("This is the %s help for '%s'.\n",
171
		level ? EXT_HELP : SHORT_HELP, cmdname);
3414 post 172
	return;
3265 post 173
}
174
 
175
EOF
176
	[ "${CMDTYPE}" = "module" ] && cat << EOF >> ${OUTDIR}/${CMDNAME}.c
177
/* Main entry point for ${CMDNAME}, accepts an array of arguments */
3414 post 178
int ${CMDENTRY}(char **argv)
3265 post 179
EOF
180
	[ "${CMDTYPE}" = "builtin" ] && cat << EOF >> ${OUTDIR}/${CMDNAME}.c
181
/* Main entry point for ${CMDNAME}, accepts an array of arguments and a
182
 * pointer to the cliuser_t structure */
3414 post 183
int ${CMDENTRY}(char **argv, cliuser_t *usr)
3265 post 184
EOF
185
	cat << EOF >> ${OUTDIR}/${CMDNAME}.c
186
{
187
	unsigned int argc;
188
	unsigned int i;
189
 
190
	/* Count the arguments */
191
	for (argc = 0; argv[argc] != NULL; argc ++);
192
 
193
	printf("%s %s\n", TEST_ANNOUNCE, cmdname);
194
	printf("%d arguments passed to %s", argc - 1, cmdname);
195
 
196
	if (argc < 2) {
197
		printf("\n");
3283 post 198
		return CMD_SUCCESS;
3265 post 199
	}
200
 
201
	printf(":\n");
202
	for (i = 1; i < argc; i++)
203
		printf("[%d] -> %s\n", i, argv[i]);
204
 
3283 post 205
	return CMD_SUCCESS;
3265 post 206
}
207
 
208
EOF
3276 post 209
	printf "Done.\n\nYou should now modify %ss/%ss.h and ../Makefile" \
3265 post 210
		"${CMDTYPE}" "${CMDTYPE}"
211
	printf " to include your new command.\n"
212
	[ -n "$CMDALIAS" ] &&  {
213
		printf "\nYou should also modify %ss/%s_aliases.h and " \
214
			"${CMDTYPE}" "${CMDTYPE}"
215
		printf "add %s as an alias for %s\n" \
216
			"${CMDALIAS}" "${CMDNAME}"
217
	}
3276 post 218
	printf "\nOnce completed, re-run make\n\n"
3265 post 219
}
220
 
221
# Main program
222
 
223
TIMESTAMP="$(date)"
224
PROGNAME=$(basename $0)
225
PROGVER="0.0.1"
226
PROGMAINT="Tim Post <echo@echoreply.us>"
227
DEFAULT_COMMAND="cmdname"
228
 
229
# We need at least one
230
[ $# = 0 ] && usage && exit 1;
231
 
3810 post 232
TEMP=$(getopt -o n:d:e:h:a:t:HV \
233
--long name:,desc:,entry:,help-entry:,alias:,type:,help,version \
3265 post 234
-- "$@") || {
235
	echo "Try $PROGNAME --help for help"
236
}
237
 
238
eval set -- "$TEMP"
239
 
240
while true; do
241
	case "$1" in
242
	-n | --name)
243
		CMDNAME="$2"
244
		shift 2
245
		continue
246
	;;
247
	-d | --desc)
248
		CMDDESC="$2"
249
		shift 2
250
		continue
251
	;;
252
	-e | --entry)
253
		CMDENTRY="$2"
254
		shift 2
255
		continue
256
	;;
257
	-h | --help-entry)
258
		HELPENTRY="$2"
259
		shift 2
260
		continue
261
	;;
262
	-a | --alias)
263
		CMDALIAS="$2"
264
		shift 2
265
		continue
266
	;;
267
	-t | --type)
268
		CMDTYPE="$2"
269
		shift 2
270
		continue
271
	;;
272
	-H | --help)
273
		usage
274
		exit 0
275
	;;
276
	-V | --version)
277
		echo "$PROGVER"
278
		exit 0
279
	;;
280
	--)
281
		break
282
	;;
283
	esac
284
done
285
 
286
# Pick up a location if one was specified
287
eval set -- "$*"
288
[ -n "$2" ] && OUTDIR="$2"
289
 
290
# Fill in defaults for whatever was not specified
291
[ -n "$CMDNAME" ] || CMDNAME="$DEFAULT_COMMAND"
292
[ -n "$CMDDESC" ] || CMDDESC="The $CMDNAME command"
293
[ -n "$CMDENTRY" ] || CMDENTRY="cmd_${CMDNAME}"
294
[ -n "$HELPENTRY" ] || HELPENTRY="help_cmd_${CMDNAME}"
295
[ -n "$CMDTYPE" ] || CMDTYPE="module"
296
[ -n "$OUTDIR" ] || OUTDIR="${CMDTYPE}s/${CMDNAME}"
297
 
298
 
299
# Do a little sanity
300
[ -d $OUTDIR ] && {
301
	echo "$OUTDIR already exists, remove it to proceed."
302
	exit 1
303
}
304
 
305
mkdir -p ${OUTDIR} >/dev/null 2>&1 || {
306
	echo "Could not create ${OUTDIR}, aborting!"
307
	exit 1
308
}
309
 
310
# Generate the files and inform on how to include them based on options
311
generate_code
312
 
313
exit 0
314