src/bin/grepc: Use if/else instead of && and ||

Signed-off-by: Alejandro Colomar <alx@kernel.org>

src/bin/grepc: Quote variables

Signed-off-by: Alejandro Colomar <alx@kernel.org>

src/bin/grepc: Ignore shellcheck(1) diagnostics

Signed-off-by: Alejandro Colomar <alx@kernel.org>

src/bin/grepc: Use test(1) instead of [(1)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

man/man1/grepc.1, src/bin/grepc: Add copyright notice

Signed-off-by: Alejandro Colomar <alx@kernel.org>

src/bin/grepc: Handle errors

Signed-off-by: Alejandro Colomar <alx@kernel.org>

man/man1/grepc.1: Adapt to the Linux man-pages project

Signed-off-by: Alejandro Colomar <alx@kernel.org>

man/man1/grepc.1: Move manual page to man/man1/

Signed-off-by: Alejandro Colomar <alx@kernel.org>

src/bin/grepc: Move script to src/bin/

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Import grepc(1) (script and manual page) from separate project

It started as a script in the Linux man-pages project, under scripts/
within scripts/bash_aliases.

Eventually, I turned it into a large script, and moved it into a
separate project, to be able to work on it more freely.

The original scripts were removed from this project in commit
c3752af0549c (2022-11-22; "bash_aliases: Remove grep_syscall(),
grep_syscall_def(), and grep_glibc_prototype()").

Now, grepc(1) has stabilized, and I find it very useful for maintaining
this project (as well as others), so let's merge it back.  This will
allow distros to package it sooner than if it remained as a standalone
project.

I've imported the git history (ignoring files we don't care about) with
the help of git-filter-repo(1).

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: -tuf: Reuse grepc_c_f_decl_() for the function declarator

It's slightly different than the regex we were using, but I can't see a
reason for it.  It was probably due to forgetting to improve this regex.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: -tf: Factor out regex for function declarators

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: -tt: Add word boundary around the identifier

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Add robustness against non-portable pathnames

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Use <() instead of $()

Files are simpler to handle.  It results in less flags, and simpler
command invocations.  And it allows breaking the line more nicely,
without having to break in the middle of a quoted region.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: -tfp, -tfd: Add support for forward-declarations of parameters

This is currently a (very useful) GNU extension, and soon might become
standard in C2y.

Link: n3394 <https://www.open-std.org/jtc1/sc22/wg14/www/docs/n3394.pdf>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: -k: Remove flag

Just behave like grep(1) and pcre2grep(1).  If the user wants to see it
more nicely, they can do it themselves.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: bugfix: Pass options to grep(1) correctly

Fixes: 92dca8e97bfa ("bin/grepc: srcfix (Variables for options hold their '-')")
Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/, man/: -m: Add flag, and pass it to pcre2grep(1)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: -x: c, mk: Add support for Makefile code

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Ignore a shellcheck(1) warning

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Compact cases a little bit)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Remove unnecessary comment)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Use printf '%s\n' instead of echo)

Reported-by: terdon <https://linux.codidact.com/users/57088>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Use bash(1) array variable)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Remove grepc_search() and main())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Remove grepc_patterns())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Remove grepc_parse_cmd())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Simplify 'case's thanks to bash(1)'s ';;&')

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Escape '?' in bash(1) case following getopts(1))

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Compact single-line cases)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: -c: Add option to count matches

As in pcre2grep(1) and grep(1).

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: Rename option -c to -r

This leaves -c unused, so we can add -c with the same meaning of
grep(1): count.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

grepc.1: -c: Remove outdated sentence

Since 83cfbb6042d1 ("bin/grepc: Optimize"), we color also in ther types
of code.  Update the manual page.

Fixes: 83cfbb6042d1 ("bin/grepc: Optimize")
Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: Use 'l' instead of 's' for Linux system calls

To avoid confusion to users of other kernels.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Reorder some function definitions)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: -n: Add option to control printing of line numbers

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Actually create file with mktemp(1))

This ensures we own the file, removing any races.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Add some tabs, and remove a function)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: -A, -B, -C: Add flags for printing context.

These flags are passed to pcre2grep(1).

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Variables for options hold their '-')

This is to allow adding options that have arguments that are passed to
pcre2grep(1).

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: -h: Add option to suppress prefixing file names

Equivalent to grep(1)'s -h, except that we always default to -H behavior.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Add missing variable definition)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: Remove -h flag

There's already a manual page, and the short help from -h was quite
unhelpful.  I want to reuse -h for grep(1)'s meaning (don't print the
filename).

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: srcfix (Change variable names)

Use single-letter names for variables that hold command-line options.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: Always enable recursive mode; remove -r

The non-recursive behavior is so slow that it's quite useless.  It is
only useful when reading from standard input, but for several files it's
useless.  Make '-r' the default when any files are specified, and remove
the flag (since now it's always enabled).  This happens to bring back a
behavior close to what we had before
2fb22befdfb9 ("Don't find files recursively").

Non-seekable files can still be read, if redirected to standard input.

Update the example from the manual page to reflect current usage.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Add recursive search back in with -r

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Allow specifying several files

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Don't use pcre2grep(1)'s --label

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_search())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Compact code

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Optimize

Call pcre2grep(1) only once, which allows removing named pipes.  This is
an important optimization, and will also allow accepting several file
names in the command line (in a future commit).  The source code is also
significantly simplified.

It has a caveat: this single call to pcre2grep(1) will consume more
resources, and will crash on certain input files.  The workaround is to
restrict the search to just one or a few types of code.  Document this
in the manual page.  This caveat only applies to very specific files,
which so far I've only found in the Linux kernel source tree.

Don't find files recursively

grep only one file (or stdin).

The current implementation doesn't allow filterin standard input, which
I miss some times.  I'm removing this feature now, to be able to rewrite
most of the program in a way that allows filtering stdin, and then will
consider adding back a recursive mode if necessary.

Also, don't remove the two blanks at the start of the output, for
consistency when calling this program via xargs(1), which will become
more common now that it only handles single files.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Remove '-g' option

This program shouldn't know about file names.  If that is wanted, use
something like `find ... | grep ... | xargs grepc ...`.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Remove '-x' option

This program shouldn't know about file extensions.  If that is wanted,
use something like `find ... | grep ... | xargs grepc ...`.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc, grepc.1: -tmf, -tmo: Add options to find only function-like macros, or other macros

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Shorten function names

Also, use names consistent with the command-line option arguments.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Shorten variable names

Also, use names consistent with the command-line option arguments.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_use_func())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_use_type())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_type())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_type_typedef())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_macro())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Compact one-liner definitions

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_glibc_func_def())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Improve error messages

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Transform some if's to simpler test&&

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_use())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_glibc_func())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_linux_func())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_func())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

bin/grepc: Simplify (remove grepc_search_default())

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Use pcre2grep(1) instead of pcregrep(1)

PCRE are EOL.  Long live PCRE2.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Use recursion to improve matching of function parameter lists

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Support parenthesized function names

This creates some false positives, but with appropriate flags, those can
be removed.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

grepc, grepc.1: -tg, -tgp, -tgd: Add more support for glibc internal names of libc functions

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: -tm: Fix finding macros defined as empty

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc, grepc.1: -c: Add flag to color uses

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: Remove constraints in the file prefiltering

To make -tu work correctly, which doesn't have the word-boundary
constraint.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: -tut: Fix regex for braces in the same line as 'struct'

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: Read  in the helper

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: Don't search underlying structure of a typedef

In some cases it might be nice, but in some other cases, it might
cause a lot of code to be printed.  Let the user explicitly search
for it or not in a separate run.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: Fix glitch with incorrectly indented code

Avoid this glich from glibc:

./sysdeps/unix/sysv/linux/x86/sys/ucontext.h:133:
typedef struct
  {
    gregset_t __ctx(gregs);
    /* Note that fpregs is a pointer.  */
    fpregset_t __ctx(fpregs);
    __extension__ unsigned long long __reserved1 [8];
} mcontext_t;

/* Userlevel context.  */
typedef struct ucontext_t
  {
    unsigned long int __ctx(uc_flags);
    struct ucontext_t *uc_link;
    stack_t uc_stack;
    mcontext_t uc_mcontext;
    sigset_t uc_sigmask;
    struct _libc_fpstate __fpregs_mem;
    __extension__ unsigned long long int __ssp[4];
  } ucontext_t;

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: Fix some typedef corner cases

- Typedefs to arrays of structures.
- Typedefs to structures of the same name.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: Improve regexes

- Use the same ammount of spaces for the closing brace as for the
  opening brace.
- Fix position of attributes.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: bugfix

SC2068: Double quote array expansions to avoid re-splitting elements.

Reported-by: shellcheck(1)
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: srcfix

SC2124: Use $* instead of $@ to concatenate.

Reported-by: shellcheck(1)
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: srcfix

SC2004: $/${} is unnecessary on arithmetic variables.

Reported-by: shellcheck(1)
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc, grepc.1: Add -i flag as in grep(1)

Also, add some symmetry between ${iflag} and ${lflag}.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc, grepc.1: Remove -tu from the defaults

Normally, one either wants to see a declaration/definition, or its
uses, but not both at the same time.  Also, there are usually many
more use sites than than definitions, and therefore definitions
are shadowed between all the noise.  Restrict the default to
declarations and definitions, which in my experience seems to be
the most common use case.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc, grepc.1: -tu: Allow searching special characters

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: Fix grepc_type_typedef_underlying_struct_union_enum

When it calls grepc_type_struct_union_enum(), it needs to use a
different file list, since it's searching for an identifier
different from the one passed in the command line.

Also, while at it, improve the quoting of the pattern passed to
pcregrep(1).

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: -tt: Find typedefs to function pointers

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: tfix

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: srcfix

Sort alphabetically the optstring.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc: Allow a pattern to start with '-'

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc, grepc.1: -t...: Allow more granularity

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc.1: wfix

grepc, grepc.1: wfix

Rename functions to have different starting letters.  Also rename
the macro functions to more closely match ISO C nomenclature.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

grepc, grepc.1: -tu: Search also within enum and type definitions

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>