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

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

Fix vertical spacing with new Ccheck revision.
  • Property mode set to 100644
File size: 10.1 KB
RevLine 
[36ab7c7]1/*
2 * Copyright (c) 2008 Tim Post
[d553f81]3 * Copyright (c) 2011, Martin Sucha
[c9f5e24f]4 * All rights reserved.
[216d6fc]5 *
[c9f5e24f]6 * Redistribution and use in source and binary forms, with or without
[36ab7c7]7 * modification, are permitted provided that the following conditions
8 * are met:
[c9f5e24f]9 *
[36ab7c7]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.
[c9f5e24f]17 *
[36ab7c7]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.
[c9f5e24f]28 */
[216d6fc]29
30#include <stdio.h>
31#include <stdlib.h>
32#include <getopt.h>
[19f857a]33#include <str.h>
[d553f81]34#include <io/console.h>
35#include <io/color.h>
36#include <io/style.h>
[3cefd70]37#include <io/keycode.h>
[d553f81]38#include <errno.h>
39#include <vfs/vfs.h>
40#include <assert.h>
[216d6fc]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
[a000878c]49static const char *cmdname = "cat";
[c9f5e24f]50#define CAT_VERSION "0.0.1"
51#define CAT_DEFAULT_BUFLEN 1024
[cc9f314]52#define CAT_FULL_FILE 0
[c9f5e24f]53
[d553f81]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;
[3cefd70]61static bool should_quit = false;
[a33706e]62static bool dash_represents_stdin = false;
[0845589]63static unsigned int lineno = 0;
64static bool number = false;
65static bool last_char_was_newline = false;
[216d6fc]66
[79ae36dd]67static console_ctrl_t *console = NULL;
68
[3771a6e]69static struct option const long_options[] = {
[c9f5e24f]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' },
[d553f81]76 { "hex", no_argument, 0, 'x' },
[a33706e]77 { "stdin", no_argument, 0, 's' },
[0845589]78 { "number", no_argument, 0, 'n' },
[216d6fc]79 { 0, 0, 0, 0 }
80};
81
82/* Dispays help for cat in various levels */
[809813d]83void help_cmd_cat(unsigned int level)
[216d6fc]84{
[c9f5e24f]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(
[1433ecda]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);
[c9f5e24f]103 }
104
[809813d]105 return;
[216d6fc]106}
107
[193d280c]108static void waitprompt(void)
[d553f81]109{
[1433ecda]110 console_set_pos(console, 0, console_rows - 1);
[7c014d1]111 console_set_color(console, COLOR_WHITE, COLOR_BLUE, 0);
[a35b458]112
[3cefd70]113 printf("ENTER/SPACE/PAGE DOWN - next page, "
[1433ecda]114 "ESC/Q - quit, C - continue unpaged");
[d553f81]115 fflush(stdout);
[a35b458]116
[79ae36dd]117 console_set_style(console, STYLE_NORMAL);
[d553f81]118}
119
[193d280c]120static void waitkey(void)
[d553f81]121{
[07b7c48]122 cons_event_t ev;
123 kbd_event_t *kev;
[a35b458]124
[d553f81]125 while (true) {
[07b7c48]126 if (!console_get_event(console, &ev)) {
[d553f81]127 return;
128 }
[07b7c48]129 if (ev.type == CEV_KEY && ev.ev.key.type == KEY_PRESS) {
130 kev = &ev.ev.key;
[a35b458]131
[07b7c48]132 if (kev->key == KC_ESCAPE || kev->key == KC_Q) {
[3cefd70]133 should_quit = true;
134 return;
135 }
[07b7c48]136 if (kev->key == KC_C) {
[3cefd70]137 paging_enabled = false;
138 return;
139 }
[07b7c48]140 if (kev->key == KC_ENTER || kev->key == KC_SPACE ||
141 kev->key == KC_PAGE_DOWN) {
[3cefd70]142 return;
143 }
[d553f81]144 }
145 }
146 assert(false);
147}
148
[193d280c]149static void newpage(void)
[d553f81]150{
[79ae36dd]151 console_clear(console);
[d553f81]152 chars_remaining = console_cols;
[79ae36dd]153 lines_remaining = console_rows - 1;
[d553f81]154}
155
156static void paged_char(wchar_t c)
157{
[0845589]158 if (last_char_was_newline && number) {
159 lineno++;
160 printf("%6u ", lineno);
161 }
[ed88c8e]162 putwchar(c);
[0845589]163 last_char_was_newline = c == '\n';
[d553f81]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
[cc9f314]179static unsigned int cat_file(const char *fname, size_t blen, bool hex,
180 off64_t head, off64_t tail, bool tail_first)
[c9f5e24f]181{
[8e3498b]182 int fd, count = 0, reads = 0;
183 size_t bytes;
[c9f5e24f]184 char *buff = NULL;
[8e3498b]185 size_t i;
[cc9f314]186 size_t offset = 0, copied_bytes = 0;
187 off64_t file_size = 0, length = 0;
[58898d1d]188 aoff64_t pos = 0;
[b7fd2a0]189 errno_t rc;
[c9f5e24f]190
[a33706e]191 bool reading_stdin = dash_represents_stdin && (str_cmp(fname, "-") == 0);
[a35b458]192
[a33706e]193 if (reading_stdin) {
194 fd = fileno(stdin);
195 /* Allow storing the whole UTF-8 character. */
196 blen = STR_BOUNDS(1);
[f77c1c9]197 } else {
[b7fd2a0]198 errno_t rc = vfs_lookup_open(fname, WALK_REGULAR, MODE_READ, &fd);
[f77c1c9]199 if (rc != EOK) {
200 fd = -1;
201 }
202 }
[a35b458]203
[8bb129d]204 if (fd < 0) {
[c9f5e24f]205 printf("Unable to open %s\n", fname);
206 return 1;
207 }
208
209 if (NULL == (buff = (char *) malloc(blen + 1))) {
[9c4cf0d]210 vfs_put(fd);
[c9f5e24f]211 printf("Unable to allocate enough memory to read %s\n",
[58898d1d]212 fname);
[c9f5e24f]213 return 1;
214 }
215
[cc9f314]216 if (tail != CAT_FULL_FILE) {
[39330200]217 vfs_stat_t st;
[58898d1d]218
[23a0368]219 if (vfs_stat(fd, &st) != EOK) {
[9c4cf0d]220 vfs_put(fd);
[58898d1d]221 free(buff);
[23a0368]222 printf("Unable to vfs_stat %d\n", fd);
[58898d1d]223 return 1;
224 }
225 file_size = st.size;
[cc9f314]226 if (head == CAT_FULL_FILE) {
227 head = file_size;
228 length = tail;
229 } else if (tail_first) {
230 length = head;
231 } else {
232 if (tail > head)
233 tail = head;
234 length = tail;
235 }
236
237 if (tail_first) {
[58898d1d]238 pos = (tail >= file_size) ? 0 : (file_size - tail);
[cc9f314]239 } else {
[58898d1d]240 pos = ((head - tail) >= file_size) ? 0 : (head - tail);
[cc9f314]241 }
242 } else
243 length = head;
244
[c9f5e24f]245 do {
[a33706e]246 size_t bytes_to_read;
247 if (reading_stdin) {
248 bytes_to_read = 1;
249 } else {
[e435537]250 if ((length != CAT_FULL_FILE) &&
251 (length - (off64_t)count <= (off64_t)(blen - copied_bytes))) {
[a33706e]252 bytes_to_read = (size_t) (length - count);
253 } else {
254 bytes_to_read = blen - copied_bytes;
255 }
256 }
[a35b458]257
[8e3498b]258 rc = vfs_read(fd, &pos, buff + copied_bytes, bytes_to_read,
259 &bytes);
[cc9f314]260 copied_bytes = 0;
261
[8e3498b]262 if (rc == EOK && bytes > 0) {
[2953f9a]263 buff[bytes] = '\0';
[d553f81]264 offset = 0;
[3cefd70]265 for (i = 0; i < bytes && !should_quit; i++) {
[d553f81]266 if (hex) {
[1433ecda]267 paged_char(hexchars[((uint8_t)buff[i]) / 16]);
268 paged_char(hexchars[((uint8_t)buff[i]) % 16]);
269 paged_char(((count + i + 1) & 0xf) == 0 ? '\n' : ' ');
270 } else {
[d553f81]271 wchar_t c = str_decode(buff, &offset, bytes);
272 if (c == 0) {
[28a3e74]273 /* Reached end of string */
[d553f81]274 break;
[cc9f314]275 } else if (c == U_SPECIAL && offset + 2 >= (size_t)bytes) {
[7c3fb9b]276 /*
277 * If an extended character is cut off due to the size of the buffer,
278 * we will copy it over to the next buffer so it can be read correctly.
279 */
[cc9f314]280 copied_bytes = bytes - offset + 1;
281 memcpy(buff, buff + offset - 1, copied_bytes);
282 break;
[d553f81]283 }
284 paged_char(c);
285 }
[a35b458]286
[d553f81]287 }
[cc9f314]288 count += bytes;
[c9f5e24f]289 reads++;
290 }
[a35b458]291
[e435537]292 if (reading_stdin)
[a33706e]293 fflush(stdout);
[8e3498b]294 } while (rc == EOK && bytes > 0 && !should_quit && (count < length || length == CAT_FULL_FILE));
[c9f5e24f]295
[9c4cf0d]296 vfs_put(fd);
[8e3498b]297 if (rc != EOK) {
[c9f5e24f]298 printf("Error reading %s\n", fname);
299 free(buff);
300 return 1;
301 }
302
303 free(buff);
304
305 return 0;
306}
307
[216d6fc]308/* Main entry point for cat, accepts an array of arguments */
[809813d]309int cmd_cat(char **argv)
[216d6fc]310{
[cc9f314]311 unsigned int argc, i, ret = 0;
312 size_t buffer = 0;
[216d6fc]313 int c, opt_ind;
[cc9f314]314 aoff64_t head = CAT_FULL_FILE, tail = CAT_FULL_FILE;
[d553f81]315 bool hex = false;
316 bool more = false;
[cc9f314]317 bool tailFirst = false;
[d553f81]318 sysarg_t rows, cols;
[b7fd2a0]319 errno_t rc;
[a35b458]320
[28a3e74]321 /*
322 * reset global state
323 * TODO: move to structure?
324 */
[d553f81]325 paging_enabled = false;
326 chars_remaining = 0;
327 lines_remaining = 0;
328 console_cols = 0;
329 console_rows = 0;
[3cefd70]330 should_quit = false;
[4cca9a9]331 dash_represents_stdin = false;
[79ae36dd]332 console = console_init(stdin, stdout);
[0845589]333 number = false;
334 lineno = 0;
335 /* This enables printing of the first number. */
336 last_char_was_newline = true;
337
[43e02a6]338 argc = cli_count_args(argv);
[216d6fc]339
[948222e4]340 c = 0;
341 optreset = 1;
342 optind = 0;
343 opt_ind = 0;
344
345 while (c != -1) {
[4cca9a9]346 c = getopt_long(argc, argv, "xhvmH:t:b:sn", long_options, &opt_ind);
[216d6fc]347 switch (c) {
348 case 'h':
[c9f5e24f]349 help_cmd_cat(HELP_LONG);
350 return CMD_SUCCESS;
[216d6fc]351 case 'v':
[c9f5e24f]352 printf("%s\n", CAT_VERSION);
353 return CMD_SUCCESS;
354 case 'H':
[1433ecda]355 if (!optarg || str_uint64_t(optarg, NULL, 10, false, &head) != EOK) {
[1abcf1d]356 puts("Invalid head size");
[cc9f314]357 return CMD_FAILURE;
358 }
359 break;
[c9f5e24f]360 case 't':
[1433ecda]361 if (!optarg || str_uint64_t(optarg, NULL, 10, false, &tail) != EOK) {
[1abcf1d]362 puts("Invalid tail size");
[cc9f314]363 return CMD_FAILURE;
364 }
365 if (head == CAT_FULL_FILE)
366 tailFirst = true;
367 break;
[c9f5e24f]368 case 'b':
[1433ecda]369 if (!optarg || str_size_t(optarg, NULL, 10, false, &buffer) != EOK) {
[1abcf1d]370 puts("Invalid buffer size");
[cc9f314]371 return CMD_FAILURE;
372 }
[216d6fc]373 break;
[c9f5e24f]374 case 'm':
[d553f81]375 more = true;
376 break;
377 case 'x':
378 hex = true;
379 break;
[a33706e]380 case 's':
381 dash_represents_stdin = true;
382 break;
[0845589]383 case 'n':
384 number = true;
385 break;
[216d6fc]386 }
387 }
388
[c9f5e24f]389 argc -= optind;
390
391 if (argc < 1) {
392 printf("%s - incorrect number of arguments. Try `%s --help'\n",
[1433ecda]393 cmdname, cmdname);
[c9f5e24f]394 return CMD_FAILURE;
395 }
396
[cc9f314]397 if (buffer < 4)
[c9f5e24f]398 buffer = CAT_DEFAULT_BUFLEN;
[a35b458]399
[d553f81]400 if (more) {
[79ae36dd]401 rc = console_get_size(console, &cols, &rows);
[d553f81]402 if (rc != EOK) {
403 printf("%s - cannot get console size\n", cmdname);
404 return CMD_FAILURE;
405 }
406 console_cols = cols;
407 console_rows = rows;
408 paging_enabled = true;
409 newpage();
410 }
[c9f5e24f]411
[3cefd70]412 for (i = optind; argv[i] != NULL && !should_quit; i++)
[cc9f314]413 ret += cat_file(argv[i], buffer, hex, head, tail, tailFirst);
[216d6fc]414
[c9f5e24f]415 if (ret)
416 return CMD_FAILURE;
417 else
418 return CMD_SUCCESS;
[216d6fc]419}
Note: See TracBrowser for help on using the repository browser.