home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / unix / volume13 / lit < prev    next >
Text File  |  1988-02-01  |  10KB  |  393 lines
  1. Subject:  v13i032:  Lit, a "better" echo
  2. Newsgroups: comp.sources.unix
  3. Sender: sources
  4. Approved: rsalz@uunet.UU.NET
  5.  
  6. Submitted-by: "Richard A. O'Keefe" <quintus!ok@SUN.COM>
  7. Posting-number: Volume 13, Issue 32
  8. Archive-name: lit
  9.  
  10. [  This program is like echo, except that it understands C-style \
  11.    escapes, reasonably writes field-type data, and a couple of
  12.    other things.  I spliced a Makefile into the shar.  --r$  ]
  13.  
  14. There are problems with the built-in echo(1) command:
  15. 4.2BSD:        If the first argument happens to be -n, tough luck.
  16. System V:    You can't switch off character escapes.
  17. Mixed (SUN):    There are two versions of echo around, and a
  18.         script may get either depending on the preference
  19.         of who calls it.
  20. The designers of echo(1) evidently thought that it was only useful
  21. for writing messages.  However, to get filename generation in the
  22. value assigned to a Bourne shell variable, it is necessary to write
  23.     variable=`echo ?pattern*`
  24. which doesn't quite work.  lit(1) provides everything that the
  25. 4.2BSD or System V echo(1) commands provides, and a little bit more.
  26. In particular,
  27.     variable=`lit -- ?pattern*`
  28. works correctly, even if the file names matched start with - or
  29. contain \ .
  30.  
  31. The following shell archive contains lit.1 and lit.c .
  32.  
  33. Just compile lit.c, there are no options to set.
  34.  
  35. #! /bin/sh
  36. cat >Makefile <<\SHAR_EOF
  37. all:        lit lit.1
  38. install:    all
  39.     @echo install according to local conventions
  40. lit:        lit.c
  41.     $(CC) $(CFLAGS) -o lit lit.c
  42. SHAR_EOF
  43. cat >lit.1 <<'------ EOF ------'
  44. .TH LIT 1 "5 December 1987"
  45. .SH NAME
  46. lit \- echo arguments
  47. .SH SYNOPSIS
  48. .B echo
  49. [
  50. .B \-n
  51. ]
  52. .B
  53. [
  54. \-d\fIlist\fB
  55. ]
  56. .B
  57. [
  58. \-e\fIchar\fB
  59. ]
  60. .B
  61. [
  62. \-\-
  63. ]
  64. [ 
  65. .I argument \fB.\|.\|.\fP 
  66. ]
  67. .SH DESCRIPTION
  68. .IX "lit command"  ""  "\fLlit\fP \(em echo arguments"
  69. .I lit
  70. writes its arguments on the standard output, as specified by
  71. the options.  Arguments are normally separated by blanks and
  72. terminated by a new-line, and written literally.
  73. .BR C -style
  74. character escapes are available
  75. .I if
  76. you want them.
  77. .PP
  78. .I lit
  79. is useful for writing messages in shell scripts,
  80. and for feeding short inputs into programs (this is sometimes
  81. clearer than using "here files").
  82. .PP
  83. .I lit
  84. is a close relative of the 4.2 BSD command
  85. .I echo
  86. and the System V command
  87. .IR echo .
  88. Both versions of
  89. .I echo
  90. have serious design flaws which were avoided in the design of
  91. .IR lit .
  92. .SH OPTIONS
  93. .IP \fB\-n\fP
  94. Don't add the \fBn\fPewline to the output.
  95. Note that the shell's back-quote mechanism strips a terminating
  96. newline, so the only time you need this is when writing a prompt
  97. to the terminal.
  98. .IP \fB\-d\fPlist
  99. Normally,
  100. .I lit
  101. inserts a space between its arguments.  You can over-ride this
  102. with the \-d option.  With a bare \-d, the tab character is used.
  103. With a list of characters, the characters are used circularly
  104. (as in paste(1)).  For example, \-dxy will insert x after the
  105. 1st, 3rd, 5th &c arguments and y after the 2nd, 4th, 6th &c.
  106. There is currently no way of specifying an empty or multi-
  107. character separator, but see the examples.
  108. .IP \fB\-e\fPchar
  109. .I lit
  110. normally copies its arguments to its standard output literally.
  111. If you want
  112. .BR C -style
  113. character escapes, use this option.  A bare \-e specifies the
  114. escape character to be \e as in C.  \-eX specifies the
  115. escape character to be X.  You may find \-e@ to be useful in
  116. shell script as a way of avoiding conflicts with the shell's
  117. use of \e .  Alphabetic case is ignored in the escapes, which are
  118. .PP
  119. .RS
  120. .PD 0
  121. .TP
  122. .B \ea
  123. audible alarm (bell)
  124. .TP
  125. .B \eb
  126. backspace
  127. .TP
  128. .B \ed
  129. delete
  130. .TP
  131. .TP
  132. .B \ee
  133. escape (ESC, not \e)
  134. .B \ef
  135. form-feed
  136. .TP
  137. .B \en
  138. new-line
  139. .TP
  140. .B \er
  141. carriage return
  142. .TP
  143. .B \es
  144. space
  145. .TP
  146. .B \et
  147. tab
  148. .TP
  149. .B \ev
  150. vertical tab
  151. .TP
  152. .B \e\e
  153. the escape character itself
  154. .TP
  155. .BI \ex n
  156. the 8-bit character whose \s-1ASCII\s0 code is
  157. the 1- or 2-digit hexadecimal number
  158. .IR n .
  159. .TP
  160. .BI \eo n
  161. the 8-bit character whose \s-1ASCII\s0 code is
  162. the 1-, 2- or 3-digit octal number
  163. .IR n ,
  164. which need not start with a zero.
  165. .TP
  166. .BI \e n
  167. the 8-bit character whose \s-1ASCII\s0 code is
  168. the 1-, 2- or 3-digit octal number
  169. .IR n ,
  170. which need not start with a zero.
  171. .RE
  172. .SH EXAMPLES
  173. .TP 15m
  174. lit \|\-n "Enter count: " ; read count
  175. To obtain prompted input in the Bourne shell.
  176. .TP
  177. lit -n foo ; lit -n baz ; lit ugh
  178. echo "foobazugh" to the terminal with no separators.
  179. .TP
  180. lit \|\-\- \-n \-e \-d
  181. echo "-n -e -d" to the standard output.
  182. .TP
  183. lit \|\-e@ "a@nb@nc" \|\(bv\| program
  184. run program with three lines of standard input.
  185. .TP
  186. variable=`lit \-d: \-\- *foo*`
  187. to assign to the shell variable "variable" a colon-separated
  188. list of file names matching *foo* .  The \-\- is needed in
  189. case the file such file name starts with a hyphen.  Note that
  190. you cannot do this with the System V
  191. .I echo
  192. command, because the file names might contain \e Characters, which 
  193. .I echo
  194. would (mis-)interpret.
  195. .SH SEE ALSO
  196. sh(1), echo(1)
  197. ------ EOF ------
  198. ls -l lit.1
  199. cat >lit.c <<'------ EOF ------'
  200. /*  File   : lit.c
  201.     Author : Richard A. O'Keefe
  202.     Updated: 5 December 1987
  203.     Purpose: Replacement for echo(1).
  204.  
  205.     There are two versions of the echo(1) command:
  206.     4.2 BSD
  207.         echo [-n] argument...
  208.         System V
  209.         echo argument...
  210.     Both are badly designed.  The 4.2 version has no way of printing
  211.     something which starts with -n.  The System V one has no way of
  212.     switching off the escape character interpretation which is its
  213.     great new feature, and lacks an equivalent of -n.
  214.  
  215.     The solution is to have a new command which does things RIGHT.
  216.  
  217.     SYNOPSIS
  218.     lit [-n] [-dlist] [-echar] [--] argument...
  219.  
  220.     OPTIONS
  221.     -n    suppress the new-line which is normally printed at the end.
  222.  
  223.     -dl    normally, a single space is written between the arguments.
  224.     With the option "-d" on its own, a tab is written instead.
  225.     When there are characters after the "-d", these characters
  226.     are used in turn, e.g. -d": , " would use ":" then " " then
  227.     "," then " " then ":" again.  The default is thus equivalent
  228.     to -d" ".
  229.  
  230.     -ex    normally, the arguments are copied literally.
  231.     With the option "-e" on its own, C-style character escapes
  232.     are interpreted.  In fact, rather more than most Cs.
  233.     With the option "-ex", the character "x" is used instead of
  234.     C's backslash;  this makes it easier to use in scripts.
  235.     For example,
  236.         lit -e@ a@tb@tc
  237.     writes out a, TAB, b, TAB, c, NEWLINE.
  238.  
  239.     --    indicates the end of the options.  This is only needed if the
  240.     first argument begins with a "-".
  241. */
  242.  
  243. #include <stdio.h>
  244.  
  245. char *program_name = "lit";
  246.  
  247. void OutputError()
  248.     {
  249.     (void) fprintf(stderr,
  250.         "%s: I/O error near byte %ld of output\n",
  251.         program_name, ftell(stdout));
  252.     exit(1);
  253.     }
  254.  
  255.  
  256. void WriteChar(c)
  257.     int c;
  258.     {
  259.     if (putchar(c) < 0) OutputError();
  260.     }
  261.  
  262.  
  263. void Display(string, escape_character)
  264.     char *string;
  265.     int escape_character;
  266.     {
  267.     register FILE *output = stdout;
  268.     register char *s;
  269.     register int c;
  270.     int i, n;
  271.  
  272.     for (s = string; c = *s++; ) {
  273.         if (c == escape_character) switch (c = *s++) {
  274.         case 'n': case 'N':        /* newline */
  275.             c = 10; break;
  276.         case 't': case 'T':        /* tab */
  277.             c =  9; break;
  278.         case 'r': case 'R':        /* return */
  279.             c = 13; break;
  280.         case 'v': case 'V':        /* vertical tab */
  281.             c = 11; break;
  282.         case 'b': case 'B':        /* backspace */
  283.             c =  8; break;
  284.         case 'f': case 'F':        /* formfeed */
  285.             c = 12; break;
  286.         case 'e': case 'E':        /* escape */
  287.             c = 27; break;
  288.         case 'd': case 'D':        /* delete */
  289.             c =127; break;
  290.         case 's': case 'S':        /* space */
  291.             c = 32; break;
  292.         case 'a': case 'A':        /* alarm */
  293.             c =  7; break;
  294.         case '^':            /* control */
  295.             c = *s++;
  296.             c = !c ? '^' : c == '?' ? 127 : c&31;
  297.             break;
  298.         case 'x': case 'X':        /* hexadecimal */
  299.             for (i = 2, n = 0; --i >= 0; s++) {
  300.             c = *s;
  301.             if (c >= '0' && c <= '9') {
  302.                 n = (n<<4) - '0' + c;
  303.             } else
  304.             if (c >= 'a' && c <= 'f') {
  305.                 n = (n<<4) - ('a'-10) + c;
  306.             } else
  307.             if (c >= 'A' && c <= 'F') {
  308.                 n = (n<<4) - ('A'-10) + c;
  309.             } else {
  310.                 break;
  311.             }
  312.             }
  313.             c = n&255;
  314.             break;
  315.         case 'o': case 'O':        /* octal */
  316.             c = *s++;
  317.             if (c < '0' || c > '7') {
  318.             c = s[-1];
  319.             break;
  320.             }
  321.         case '0': case '1': case '2': case '3':
  322.         case '4': case '5': case '6': case '7':
  323.             n = c-'0';
  324.             for (i = 2; --i >= 0 && (c = *s) >= '0' && c <= '7'; s++) {
  325.             n = (n<<3) - '0' + c;
  326.             }
  327.             c = n&255;
  328.             break;
  329.         default:
  330.             break;
  331.         }
  332.         if (putc(c, output) < 0) OutputError();
  333.     }
  334.     }
  335.  
  336.  
  337. main(argc, argv)
  338.     int argc;
  339.     char **argv;
  340.     {
  341.     int escape_character = -1;    /* no such character */
  342.     int write_trailing_newline = 1;    /* do it by default */
  343.     int options_done = 0;        /* options not completed yet */
  344.     char *separators = " ";        /* list of separators */
  345.     char *next_separator = "";
  346.     int argno;            /* argument number */
  347.  
  348.     if (argc > 0) program_name = argv[0];
  349.  
  350.     for (argno = 1; argno < argc && !options_done; argno++) {
  351.         if (argv[argno][0] != '-') {
  352.         break;
  353.         } else
  354.         switch (argv[argno][1]) {
  355.         case 'n': case 'N':    /* suppress trailing \n */
  356.             write_trailing_newline = 0;
  357.             break;
  358.         case 'd': case 'D':    /* delimiters */
  359.             separators = argv[argno][2] ? argv[argno]+2 : "\t";
  360.             break;
  361.         case 'e': case 'E':    /* escape */
  362.             escape_character = argv[argno][2];
  363.             if (!escape_character) escape_character = '\\';
  364.             break;
  365.         case '-':        /* end of options */
  366.             options_done = 1;
  367.             break;
  368.         default:
  369.             (void) fprintf(stderr,
  370.             "%s: unknown option: %s\n",
  371.             program_name, argv[argno]);
  372.             (void) fprintf(stderr,
  373.             "Usage: lit [-n] [-dlist] [-echar] [--] arg...\n");
  374.             exit(1);
  375.         }
  376.     }
  377.     while (argno < argc) {
  378.         Display(argv[argno], escape_character);
  379.         argno++;
  380.         if (argno != argc) {
  381.         if (!*next_separator) next_separator = separators;
  382.         WriteChar(*next_separator++);
  383.         }
  384.     }
  385.     if (write_trailing_newline) WriteChar('\n');
  386.     if (fflush(stdout) < 0) OutputError();
  387.     }
  388.  
  389.  
  390. ------ EOF ------
  391. ls -l lit.c
  392.  
  393.