diff options
author | bapt <bapt@FreeBSD.org> | 2015-07-26 11:21:36 +0000 |
---|---|---|
committer | bapt <bapt@FreeBSD.org> | 2015-07-26 11:21:36 +0000 |
commit | 58df5d4a5241ae6e8383a6787def0d6182a415e0 (patch) | |
tree | 2fd9cfca9282ae9a513f748e8348480e9776c79f /usr.bin | |
parent | 9407ae01ca4020a4fa13d96cc20a6ab7ff913a88 (diff) | |
download | FreeBSD-src-58df5d4a5241ae6e8383a6787def0d6182a415e0.zip FreeBSD-src-58df5d4a5241ae6e8383a6787def0d6182a415e0.tar.gz |
Replace GNU RCS ident with a BSD license ident
Rationale: ident(1) is useful out of RCS, lot of scripts are using ident(1) and
failing when base is built WITHOUT_RCS.
This version is:
- fully compatible with RCS 5.7 ident.
- fully compatible with RCS 5.9 ident.
- passes all ident test from GNU RCS 5.9 test suite
This version has support for: svn extension for the Keyword id (double colon and
# before last $)
Différences with GNU RCS ident:
- no long options as found in GNU RCS 5.9 (but not commented there).
- '-V' reports nothing but has been added for compatibility.
Differential Revision: https://reviews.freebsd.org/D3200
Reviewed by: pfg
Diffstat (limited to 'usr.bin')
-rw-r--r-- | usr.bin/Makefile | 1 | ||||
-rw-r--r-- | usr.bin/ident/Makefile | 13 | ||||
-rw-r--r-- | usr.bin/ident/ident.1 | 68 | ||||
-rw-r--r-- | usr.bin/ident/ident.c | 173 | ||||
-rw-r--r-- | usr.bin/ident/tests/Makefile | 11 | ||||
-rwxr-xr-x | usr.bin/ident/tests/ident.sh | 16 | ||||
-rw-r--r-- | usr.bin/ident/tests/test.in | 15 | ||||
-rw-r--r-- | usr.bin/ident/tests/test.out | 6 | ||||
-rw-r--r-- | usr.bin/ident/tests/testnoid | 0 |
9 files changed, 303 insertions, 0 deletions
diff --git a/usr.bin/Makefile b/usr.bin/Makefile index fd78602..cf5604c 100644 --- a/usr.bin/Makefile +++ b/usr.bin/Makefile @@ -64,6 +64,7 @@ SUBDIR= ${_addr2line} \ hexdump \ ${_iconv} \ id \ + ident \ ipcrm \ ipcs \ join \ diff --git a/usr.bin/ident/Makefile b/usr.bin/ident/Makefile new file mode 100644 index 0000000..49798e8 --- /dev/null +++ b/usr.bin/ident/Makefile @@ -0,0 +1,13 @@ +# $FreeBSD$ + +.include <src.opts.mk> + +PROG= ident + +LIBADD= sbuf + +.if ${MK_TESTS} != "no" +SUBDIR+= tests +.endif + +.include <bsd.prog.mk> diff --git a/usr.bin/ident/ident.1 b/usr.bin/ident/ident.1 new file mode 100644 index 0000000..183a578 --- /dev/null +++ b/usr.bin/ident/ident.1 @@ -0,0 +1,68 @@ +.\" Copyright (c) 2015 Baptiste Daroussin <bapt@FreeBSD.org> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd Jul 25, 2015 +.Dt IDENT 1 +.Os +.Sh NAME +.Nm ident +.Nd identify RCS keyword string in files +.Sh SYNOPSIS +.Nm +.Op Fl q +.Op Fl V +.Op Ar File Ns s +.Sh DESCRIPTION +The +.Nm +utility searches for all instances of the pattern +.Sq $keyword: text$ +in +.Ar files . +.Pp +If no arguments are passed, then +.Nm +parses the standard input. +.Pp +.Em keyword +must only be composed of alphanumeric values in the C locale, followed by +.Sq \&: +and a space. +.Pp +These options are supported: +.Bl -tag -width "XXX" +.It Fl q +Quiet mode: suppress warnings if no pattern found. +.It Fl V +Do nothing, added for compatibility with GNU ident. +.El +.Sh EXIT STATUS +.Ex -std ident +.Sh AUTHORS +This version of the +.Nm +utility was written by +.An Baptiste Daroussin Aq Mt bapt@FreeBSD.org . diff --git a/usr.bin/ident/ident.c b/usr.bin/ident/ident.c new file mode 100644 index 0000000..155148c --- /dev/null +++ b/usr.bin/ident/ident.c @@ -0,0 +1,173 @@ +/*- + * Copyright (c) 2015 Baptiste Daroussin <bapt@FreeBSD.org> + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer + * in this position and unchanged. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include <sys/cdefs.h> +__FBSDID("$FreeBSD$"); + +#include <sys/types.h> +#include <sys/sbuf.h> + +#include <ctype.h> +#include <err.h> +#include <stdbool.h> +#include <stdio.h> +#include <stdlib.h> +#include <unistd.h> +#include <xlocale.h> + +static bool +parse_id(FILE *fp, struct sbuf *buf, locale_t l) +{ + int c; + bool isid = false; + bool subversion = false; + + sbuf_putc(buf, '$'); + while ((c = fgetc(fp)) != EOF) { + sbuf_putc(buf, c); + if (!isid) { + if (c == '$') { + sbuf_clear(buf); + sbuf_putc(buf, '$'); + continue; + } + if (c == ':') { + c = fgetc(fp); + /* accept :: for subversion compatibility */ + if (c == ':') { + subversion = true; + sbuf_putc(buf, c); + c = fgetc(fp); + } + if (c == ' ') { + sbuf_putc(buf, c); + isid = true; + continue; + } + return (false); + } + + if (!isalpha_l(c, l)) + return (false); + } else { + if (c == '\n') + return (false); + if (c == '$') { + sbuf_finish(buf); + /* should end with a space */ + c = sbuf_data(buf)[sbuf_len(buf) - 2]; + if (!subversion) { + if (c != ' ') + return (0); + } else if (subversion) { + if (c != ' ' && c != '#') + return (0); + } + printf(" %s\n", sbuf_data(buf)); + return (true); + } + } + } + + return (false); +} + +static int +scan(FILE *fp, const char *name, bool quiet) +{ + int c; + bool hasid = false; + struct sbuf *id = sbuf_new_auto(); + locale_t l; + + l = newlocale(LC_ALL_MASK, "C", NULL); + + if (name != NULL) + printf("%s:\n", name); + + while ((c = fgetc(fp)) != EOF) { + if (c == '$') { + sbuf_clear(id); + if (parse_id(fp, id, l)) + hasid = true; + } + } + sbuf_delete(id); + freelocale(l); + + if (!hasid) { + if (!quiet) + fprintf(stderr, "%s warning: no id keywords in %s\n", + getprogname(), name ? name : "standard input"); + + return (EXIT_FAILURE); + } + + return (EXIT_SUCCESS); +} + +int +main(int argc, char **argv) +{ + bool quiet = false; + int ch, i; + int ret = EXIT_SUCCESS; + FILE *fp; + + while ((ch = getopt(argc, argv, "qV")) != -1) { + switch (ch) { + case 'q': + quiet = true; + break; + case 'V': + /* Do nothing, compat with GNU rcs's ident */ + return (EXIT_SUCCESS); + default: + errx(EXIT_FAILURE, "usage: %s [-q] [-V] [file...]", + getprogname()); + } + } + + argc -= optind; + argv += optind; + + if (argc == 0) + return (scan(stdin, NULL, quiet)); + + for (i = 0; i < argc; i++) { + fp = fopen(argv[i], "r"); + if (fp == NULL) { + warn("%s", argv[i]); + ret = EXIT_FAILURE; + continue; + } + if (scan(fp, argv[i], quiet) != EXIT_SUCCESS) + ret = EXIT_FAILURE; + fclose(fp); + } + + return (ret); +} diff --git a/usr.bin/ident/tests/Makefile b/usr.bin/ident/tests/Makefile new file mode 100644 index 0000000..cc29bb8 --- /dev/null +++ b/usr.bin/ident/tests/Makefile @@ -0,0 +1,11 @@ +# $FreeBSD$ + +TESTSDIR= ${TESTSBASE}/usr.bin/ident + +ATF_TESTS_SH= ident +FILES= test.in \ + test.out \ + testnoid +FILESDIR= ${TESTSDIR} + +.include <bsd.test.mk> diff --git a/usr.bin/ident/tests/ident.sh b/usr.bin/ident/tests/ident.sh new file mode 100755 index 0000000..5a31182 --- /dev/null +++ b/usr.bin/ident/tests/ident.sh @@ -0,0 +1,16 @@ +# $FreeBSD$ + +atf_test_case ident +ident_body() { + atf_check -o file:$(atf_get_srcdir)/test.out \ + ident < $(atf_get_srcdir)/test.in + atf_check -o match:'Foo.*' -s exit:1 \ + -e inline:"ident warning: no id keywords in $(atf_get_srcdir)/testnoid\n" \ + ident $(atf_get_srcdir)/test.in $(atf_get_srcdir)/testnoid + atf_check -o match:'Foo.*' -s exit:1 \ + ident -q $(atf_get_srcdir)/test.in $(atf_get_srcdir)/testnoid +} +atf_init_test_cases() +{ + atf_add_test_case ident +} diff --git a/usr.bin/ident/tests/test.in b/usr.bin/ident/tests/test.in new file mode 100644 index 0000000..6349438 --- /dev/null +++ b/usr.bin/ident/tests/test.in @@ -0,0 +1,15 @@ +# tranditional + $Foo: bar $ (OK traditional) + $$Foo: bar $ + $$Fo$o: bar $ + $Fo$o: bar $ + $ Foo : bar $ (WRONG -- NON ALPHANUM BEFORE :) + $ Foo : bar $ (WRONG -- NON ALPHANUM BEFORE :) + $Foo: bar $ (WRONG -- NO SPACE AFTER :) + $Foo:bar $ (WRONG -- NO SPACE AFTER :) + $Foo: bar$ (WRONG -- NO SPACE BEFORE $)) +# Subversion like + $Bar:: baz$ (WRONG -- NO SPACE BEFORE $) + $Bar:: baz $ (OK -- SPACE BEFORE $) + $Qux:: frobby zow#$ (OK -- HASH BEFORE $)' ' + diff --git a/usr.bin/ident/tests/test.out b/usr.bin/ident/tests/test.out new file mode 100644 index 0000000..36cccc9 --- /dev/null +++ b/usr.bin/ident/tests/test.out @@ -0,0 +1,6 @@ + $Foo: bar $ + $Foo: bar $ + $o: bar $ + $o: bar $ + $Bar:: baz $ + $Qux:: frobby zow#$ diff --git a/usr.bin/ident/tests/testnoid b/usr.bin/ident/tests/testnoid new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/usr.bin/ident/tests/testnoid |