xaizek / zograscope (License: AGPLv3 only) (since 2018-12-07)
Mainly a syntax-aware diff that also provides a number of additional tools.
<root> / docs / zs-find.md (ab00a5a4020fa097074c90b8d7c705bb9016e7f0) (2,263B) (mode 100644) [raw]

*zs-find* is a tool for searching in code.  Applications include things like
collecting crude statistics about the code, looking for certain nested
configurations or sequences of tokens.

The syntax and matching abilities are relatively basic and are subject to
significant changes in the future.


`zs-find` `[options...]` _[paths...]_ : _matchers..._

`zs-find` `[options...]` _[paths...]_ : _[matchers...]_ : _[expressions...]_

`zs-find` `[options...]` _[paths...]_ :: _expressions..._

Paths can specify both files and directories.  When no path is specified, "." is

Either _matchers..._, _expressions..._ or both must be specified.

Tool-specific Options

`-c`, `--count` \
only count matches and report statistics

`--lang` \
here this common option also limits set of files to process


| Matcher | Description
| `decl`  | Any sort of declaration
| `stmt`  | Statements
| `func`  | Functions (their definitions only)
| `call`  | Function invocations
| `param` | Parameters of a function
| `comm`  | Comments of any kind
| `dir`   | Preprocessor-alike directives
| `block` | Containers of statements


Each expressions matches a single token.

| Expr    | What it matches
| `x`     | Exactly `x`
| `/^x/`  | Any token that starts with `x`
| `/x$/`  | Any token that ends with `x`
| `/^x$/` | Exactly `x`
| `/x/`   | Any token that contains `x` as a substring
| `//x/`  | Regular expression `x`
| `//`    | Any token


List all comments in C files:

zs-find --lang c : dir

Count number of preprocessor directives inside functions in all supported

zs-find --count src/ : func dir

Print functions of a specific file if they contain `return` statement:

zs-find src/utils/time.hpp : func : return

List all statements containing uses of `exec()` family of functions:

zs-find : stmt : '//^(execl[pe]?|execvp?e?)$/'

List all invocations of `snprintf` which have single token as the first

zs-find ../src : call : snprintf '(' // ,


**zograscope**(7) for common options and list of all tools there.

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/zograscope

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/zograscope

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master