xref: /aosp_15_r20/external/cronet/third_party/re2/src/README (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1*6777b538SAndroid Build Coastguard WorkerThis is the source code repository for RE2, a regular expression library.
2*6777b538SAndroid Build Coastguard Worker
3*6777b538SAndroid Build Coastguard WorkerFor documentation about how to install and use RE2,
4*6777b538SAndroid Build Coastguard Workervisit https://github.com/google/re2/.
5*6777b538SAndroid Build Coastguard Worker
6*6777b538SAndroid Build Coastguard WorkerThe short version is:
7*6777b538SAndroid Build Coastguard Worker
8*6777b538SAndroid Build Coastguard Workermake
9*6777b538SAndroid Build Coastguard Workermake test
10*6777b538SAndroid Build Coastguard Workermake install
11*6777b538SAndroid Build Coastguard Workermake testinstall
12*6777b538SAndroid Build Coastguard Worker
13*6777b538SAndroid Build Coastguard WorkerBuilding RE2 requires Abseil (https://github.com/abseil/abseil-cpp)
14*6777b538SAndroid Build Coastguard Workerto be installed on your system. Building the testing for RE2 requires
15*6777b538SAndroid Build Coastguard WorkerGoogleTest (https://github.com/google/googletest) and Benchmark
16*6777b538SAndroid Build Coastguard Worker(https://github.com/google/benchmark) to be installed as well.
17*6777b538SAndroid Build Coastguard Worker
18*6777b538SAndroid Build Coastguard WorkerThere is a fair amount of documentation (including code snippets) in
19*6777b538SAndroid Build Coastguard Workerthe re2.h header file.
20*6777b538SAndroid Build Coastguard Worker
21*6777b538SAndroid Build Coastguard WorkerMore information can be found on the wiki:
22*6777b538SAndroid Build Coastguard Workerhttps://github.com/google/re2/wiki
23*6777b538SAndroid Build Coastguard Worker
24*6777b538SAndroid Build Coastguard WorkerIssue tracker:
25*6777b538SAndroid Build Coastguard Workerhttps://github.com/google/re2/issues
26*6777b538SAndroid Build Coastguard Worker
27*6777b538SAndroid Build Coastguard WorkerMailing list:
28*6777b538SAndroid Build Coastguard Workerhttps://groups.google.com/group/re2-dev
29*6777b538SAndroid Build Coastguard Worker
30*6777b538SAndroid Build Coastguard WorkerUnless otherwise noted, the RE2 source files are distributed
31*6777b538SAndroid Build Coastguard Workerunder the BSD-style license found in the LICENSE file.
32*6777b538SAndroid Build Coastguard Worker
33*6777b538SAndroid Build Coastguard WorkerRE2's native language is C++.
34*6777b538SAndroid Build Coastguard Worker
35*6777b538SAndroid Build Coastguard WorkerThe Python wrapper is at https://github.com/google/re2/tree/main/python
36*6777b538SAndroid Build Coastguard Workerand on PyPI (https://pypi.org/project/google-re2/).
37*6777b538SAndroid Build Coastguard Worker
38*6777b538SAndroid Build Coastguard WorkerA C wrapper is at https://github.com/marcomaggi/cre2/.
39*6777b538SAndroid Build Coastguard WorkerA D wrapper is at https://github.com/ShigekiKarita/re2d/ and on DUB (code.dlang.org).
40*6777b538SAndroid Build Coastguard WorkerAn Erlang wrapper is at https://github.com/dukesoferl/re2/ and on Hex (hex.pm).
41*6777b538SAndroid Build Coastguard WorkerAn Inferno wrapper is at https://github.com/powerman/inferno-re2/.
42*6777b538SAndroid Build Coastguard WorkerA Node.js wrapper is at https://github.com/uhop/node-re2/ and on NPM (npmjs.com).
43*6777b538SAndroid Build Coastguard WorkerAn OCaml wrapper is at https://github.com/janestreet/re2/ and on OPAM (opam.ocaml.org).
44*6777b538SAndroid Build Coastguard WorkerA Perl wrapper is at https://github.com/dgl/re-engine-RE2/ and on CPAN (cpan.org).
45*6777b538SAndroid Build Coastguard WorkerAn R wrapper is at https://github.com/girishji/re2/ and on CRAN (cran.r-project.org).
46*6777b538SAndroid Build Coastguard WorkerA Ruby wrapper is at https://github.com/mudge/re2/ and on RubyGems (rubygems.org).
47*6777b538SAndroid Build Coastguard WorkerA WebAssembly wrapper is at https://github.com/google/re2-wasm/ and on NPM (npmjs.com).
48