source: mainline/uspace/app/bdsh/cmds/modules/cat/cat.c@ 8e3498b

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 8e3498b was 8e3498b, checked in by Jiri Svoboda <jiri@…>, 8 years ago

vfs_read/write() should return error code separately from number of bytes transferred.
  • Property mode set to 100644
File size: 10.0 KB
Line 
1/*
2 * Copyright (c) 2008 Tim Post
3 * Copyright (c) 2011, Martin Sucha
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30#include <stdio.h>
31#include <stdlib.h>
32#include <getopt.h>
33#include <str.h>
34#include <io/console.h>
35#include <io/color.h>
36#include <io/style.h>
37#include <io/keycode.h>
38#include <errno.h>
39#include <vfs/vfs.h>
40#include <assert.h>
41
42#include "config.h"
43#include "util.h"
44#include "errors.h"
45#include "entry.h"
46#include "cat.h"
47#include "cmds.h"
48
49static const char *cmdname = "cat";
50#define CAT_VERSION "0.0.1"
51#define CAT_DEFAULT_BUFLEN 1024
52#define CAT_FULL_FILE 0
53
54static const char *hexchars = "0123456789abcdef";
55
56static bool paging_enabled = false;
57static size_t chars_remaining = 0;
58static size_t lines_remaining = 0;
59static sysarg_t console_cols = 0;
60static sysarg_t console_rows = 0;
61static bool should_quit = false;
62static bool dash_represents_stdin = false;
63static unsigned int lineno = 0;
64static bool number = false;
65static bool last_char_was_newline = false;
66
67static console_ctrl_t *console = NULL;
68
69static struct option const long_options[] = {
70 { "help", no_argument, 0, 'h' },
71 { "version", no_argument, 0, 'v' },
72 { "head", required_argument, 0, 'H' },
73 { "tail", required_argument, 0, 't' },
74 { "buffer", required_argument, 0, 'b' },
75 { "more", no_argument, 0, 'm' },
76 { "hex", no_argument, 0, 'x' },
77 { "stdin", no_argument, 0, 's' },
78 { "number", no_argument, 0, 'n' },
79 { 0, 0, 0, 0 }
80};
81
82/* Dispays help for cat in various levels */
83void help_cmd_cat(unsigned int level)
84{
85 if (level == HELP_SHORT) {
86 printf("`%s' shows the contents of files\n", cmdname);
87 } else {
88 help_cmd_cat(HELP_SHORT);
89 printf(
90 "Usage: %s [options] <file1> [file2] [...]\n"
91 "Options:\n"
92 " -h, --help A short option summary\n"
93 " -v, --version Print version information and exit\n"
94 " -H, --head ## Print only the first ## bytes\n"
95 " -t, --tail ## Print only the last ## bytes\n"
96 " -b, --buffer ## Set the read buffer size to ##\n"
97 " -m, --more Pause after each screen full\n"
98 " -x, --hex Print bytes as hex values\n"
99 " -s, --stdin Treat `-' in file list as standard input\n"
100 " -n, --number Number all output lines\n"
101 "Currently, %s is under development, some options don't work.\n",
102 cmdname, cmdname);
103 }
104
105 return;
106}
107
108static void waitprompt(void)
109{
110 console_set_pos(console, 0, console_rows-1);
111 console_set_color(console, COLOR_WHITE, COLOR_BLUE, 0);
112
113 printf("ENTER/SPACE/PAGE DOWN - next page, "
114 "ESC/Q - quit, C - continue unpaged");
115 fflush(stdout);
116
117 console_set_style(console, STYLE_NORMAL);
118}
119
120static void waitkey(void)
121{
122 cons_event_t ev;
123 kbd_event_t *kev;
124
125 while (true) {
126 if (!console_get_event(console, &ev)) {
127 return;
128 }
129 if (ev.type == CEV_KEY && ev.ev.key.type == KEY_PRESS) {
130 kev = &ev.ev.key;
131
132 if (kev->key == KC_ESCAPE || kev->key == KC_Q) {
133 should_quit = true;
134 return;
135 }
136 if (kev->key == KC_C) {
137 paging_enabled = false;
138 return;
139 }
140 if (kev->key == KC_ENTER || kev->key == KC_SPACE ||
141 kev->key == KC_PAGE_DOWN) {
142 return;
143 }
144 }
145 }
146 assert(false);
147}
148
149static void newpage(void)
150{
151 console_clear(console);
152 chars_remaining = console_cols;
153 lines_remaining = console_rows - 1;
154}
155
156static void paged_char(wchar_t c)
157{
158 if (last_char_was_newline && number) {
159 lineno++;
160 printf("%6u ", lineno);
161 }
162 putchar(c);
163 last_char_was_newline = c == '\n';
164 if (paging_enabled) {
165 chars_remaining--;
166 if (c == '\n' || chars_remaining == 0) {
167 chars_remaining = console_cols;
168 lines_remaining--;
169 }
170 if (lines_remaining == 0) {
171 fflush(stdout);
172 waitprompt();
173 waitkey();
174 newpage();
175 }
176 }
177}
178
179static unsigned int cat_file(const char *fname, size_t blen, bool hex,
180 off64_t head, off64_t tail, bool tail_first)
181{
182 int fd, count = 0, reads = 0;
183 size_t bytes;
184 char *buff = NULL;
185 size_t i;
186 size_t offset = 0, copied_bytes = 0;
187 off64_t file_size = 0, length = 0;
188 aoff64_t pos = 0;
189 int rc;
190
191 bool reading_stdin = dash_represents_stdin && (str_cmp(fname, "-") == 0);
192
193 if (reading_stdin) {
194 fd = fileno(stdin);
195 /* Allow storing the whole UTF-8 character. */
196 blen = STR_BOUNDS(1);
197 } else
198 fd = vfs_lookup_open(fname, WALK_REGULAR, MODE_READ);
199
200 if (fd < 0) {
201 printf("Unable to open %s\n", fname);
202 return 1;
203 }
204
205 if (NULL == (buff = (char *) malloc(blen + 1))) {
206 vfs_put(fd);
207 printf("Unable to allocate enough memory to read %s\n",
208 fname);
209 return 1;
210 }
211
212 if (tail != CAT_FULL_FILE) {
213 struct stat st;
214
215 if (vfs_stat(fd, &st) != EOK) {
216 vfs_put(fd);
217 free(buff);
218 printf("Unable to vfs_stat %d\n", fd);
219 return 1;
220 }
221 file_size = st.size;
222 if (head == CAT_FULL_FILE) {
223 head = file_size;
224 length = tail;
225 } else if (tail_first) {
226 length = head;
227 } else {
228 if (tail > head)
229 tail = head;
230 length = tail;
231 }
232
233 if (tail_first) {
234 pos = (tail >= file_size) ? 0 : (file_size - tail);
235 } else {
236 pos = ((head - tail) >= file_size) ? 0 : (head - tail);
237 }
238 } else
239 length = head;
240
241 do {
242 size_t bytes_to_read;
243 if (reading_stdin) {
244 bytes_to_read = 1;
245 } else {
246 if ((length != CAT_FULL_FILE) &&
247 (length - (off64_t)count <= (off64_t)(blen - copied_bytes))) {
248 bytes_to_read = (size_t) (length - count);
249 } else {
250 bytes_to_read = blen - copied_bytes;
251 }
252 }
253
254 rc = vfs_read(fd, &pos, buff + copied_bytes, bytes_to_read,
255 &bytes);
256 copied_bytes = 0;
257
258 if (rc == EOK && bytes > 0) {
259 buff[bytes] = '\0';
260 offset = 0;
261 for (i = 0; i < bytes && !should_quit; i++) {
262 if (hex) {
263 paged_char(hexchars[((uint8_t)buff[i])/16]);
264 paged_char(hexchars[((uint8_t)buff[i])%16]);
265 paged_char(((count+i+1) & 0xf) == 0 ? '\n' : ' ');
266 }
267 else {
268 wchar_t c = str_decode(buff, &offset, bytes);
269 if (c == 0) {
270 /* Reached end of string */
271 break;
272 } else if (c == U_SPECIAL && offset + 2 >= (size_t)bytes) {
273 /* If an extended character is cut off due to the size of the buffer,
274 we will copy it over to the next buffer so it can be read correctly. */
275 copied_bytes = bytes - offset + 1;
276 memcpy(buff, buff + offset - 1, copied_bytes);
277 break;
278 }
279 paged_char(c);
280 }
281
282 }
283 count += bytes;
284 reads++;
285 }
286
287 if (reading_stdin)
288 fflush(stdout);
289 } while (rc == EOK && bytes > 0 && !should_quit && (count < length || length == CAT_FULL_FILE));
290
291 vfs_put(fd);
292 if (rc != EOK) {
293 printf("Error reading %s\n", fname);
294 free(buff);
295 return 1;
296 }
297
298 free(buff);
299
300 return 0;
301}
302
303/* Main entry point for cat, accepts an array of arguments */
304int cmd_cat(char **argv)
305{
306 unsigned int argc, i, ret = 0;
307 size_t buffer = 0;
308 int c, opt_ind;
309 aoff64_t head = CAT_FULL_FILE, tail = CAT_FULL_FILE;
310 bool hex = false;
311 bool more = false;
312 bool tailFirst = false;
313 sysarg_t rows, cols;
314 int rc;
315
316 /*
317 * reset global state
318 * TODO: move to structure?
319 */
320 paging_enabled = false;
321 chars_remaining = 0;
322 lines_remaining = 0;
323 console_cols = 0;
324 console_rows = 0;
325 should_quit = false;
326 console = console_init(stdin, stdout);
327 number = false;
328 lineno = 0;
329 /* This enables printing of the first number. */
330 last_char_was_newline = true;
331
332
333 argc = cli_count_args(argv);
334
335 for (c = 0, optreset = 1, optind = 0, opt_ind = 0; c != -1;) {
336 c = getopt_long(argc, argv, "xhvmH:t:b:s:n", long_options, &opt_ind);
337 switch (c) {
338 case 'h':
339 help_cmd_cat(HELP_LONG);
340 return CMD_SUCCESS;
341 case 'v':
342 printf("%s\n", CAT_VERSION);
343 return CMD_SUCCESS;
344 case 'H':
345 if (!optarg || str_uint64_t(optarg, NULL, 10, false, &head) != EOK ) {
346 puts("Invalid head size\n");
347 return CMD_FAILURE;
348 }
349 break;
350 case 't':
351 if (!optarg || str_uint64_t(optarg, NULL, 10, false, &tail) != EOK ) {
352 puts("Invalid tail size\n");
353 return CMD_FAILURE;
354 }
355 if (head == CAT_FULL_FILE)
356 tailFirst = true;
357 break;
358 case 'b':
359 if (!optarg || str_size_t(optarg, NULL, 10, false, &buffer) != EOK ) {
360 puts("Invalid buffer size\n");
361 return CMD_FAILURE;
362 }
363 break;
364 case 'm':
365 more = true;
366 break;
367 case 'x':
368 hex = true;
369 break;
370 case 's':
371 dash_represents_stdin = true;
372 break;
373 case 'n':
374 number = true;
375 break;
376 }
377 }
378
379 argc -= optind;
380
381 if (argc < 1) {
382 printf("%s - incorrect number of arguments. Try `%s --help'\n",
383 cmdname, cmdname);
384 return CMD_FAILURE;
385 }
386
387 if (buffer < 4)
388 buffer = CAT_DEFAULT_BUFLEN;
389
390 if (more) {
391 rc = console_get_size(console, &cols, &rows);
392 if (rc != EOK) {
393 printf("%s - cannot get console size\n", cmdname);
394 return CMD_FAILURE;
395 }
396 console_cols = cols;
397 console_rows = rows;
398 paging_enabled = true;
399 newpage();
400 }
401
402 for (i = optind; argv[i] != NULL && !should_quit; i++)
403 ret += cat_file(argv[i], buffer, hex, head, tail, tailFirst);
404
405 if (ret)
406 return CMD_FAILURE;
407 else
408 return CMD_SUCCESS;
409}
410
Note: See TracBrowser for help on using the repository browser.