├── .gitignore
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md
├── examples
├── really-bad-code.py
└── similar-matches-in-same-group
│ ├── file1.txt
│ ├── file2.txt
│ └── file3.txt
├── scripts
└── populate-data.sh
├── src
├── cli.rs
├── comp.rs
├── lib.rs
├── main.rs
├── math.rs
├── printer.rs
├── threadpool.rs
└── types.rs
├── tests
├── expected
│ ├── similar_matches_in_1_group.json
│ └── terraria_clone_eq_b20.json
└── integration_test.rs
└── vim-superdiff
├── autoload
└── superdiff.vim
├── doc
├── superdiff.txt
└── tags
└── plugin
└── superdiff.vim
/.gitignore:
--------------------------------------------------------------------------------
1 | /target
2 | /examples/TerrariaClone
3 |
--------------------------------------------------------------------------------
/Cargo.lock:
--------------------------------------------------------------------------------
1 | # This file is automatically @generated by Cargo.
2 | # It is not intended for manual editing.
3 | version = 3
4 |
5 | [[package]]
6 | name = "atty"
7 | version = "0.2.14"
8 | source = "registry+https://github.com/rust-lang/crates.io-index"
9 | checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8"
10 | dependencies = [
11 | "hermit-abi",
12 | "libc",
13 | "winapi",
14 | ]
15 |
16 | [[package]]
17 | name = "bitflags"
18 | version = "1.3.2"
19 | source = "registry+https://github.com/rust-lang/crates.io-index"
20 | checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
21 |
22 | [[package]]
23 | name = "clap"
24 | version = "4.0.15"
25 | source = "registry+https://github.com/rust-lang/crates.io-index"
26 | checksum = "6bf8832993da70a4c6d13c581f4463c2bdda27b9bf1c5498dc4365543abe6d6f"
27 | dependencies = [
28 | "atty",
29 | "bitflags",
30 | "clap_derive",
31 | "clap_lex",
32 | "once_cell",
33 | "strsim",
34 | "termcolor",
35 | ]
36 |
37 | [[package]]
38 | name = "clap_derive"
39 | version = "4.0.13"
40 | source = "registry+https://github.com/rust-lang/crates.io-index"
41 | checksum = "c42f169caba89a7d512b5418b09864543eeb4d497416c917d7137863bd2076ad"
42 | dependencies = [
43 | "heck",
44 | "proc-macro-error",
45 | "proc-macro2",
46 | "quote",
47 | "syn",
48 | ]
49 |
50 | [[package]]
51 | name = "clap_lex"
52 | version = "0.3.0"
53 | source = "registry+https://github.com/rust-lang/crates.io-index"
54 | checksum = "0d4198f73e42b4936b35b5bb248d81d2b595ecb170da0bac7655c54eedfa8da8"
55 | dependencies = [
56 | "os_str_bytes",
57 | ]
58 |
59 | [[package]]
60 | name = "heck"
61 | version = "0.4.0"
62 | source = "registry+https://github.com/rust-lang/crates.io-index"
63 | checksum = "2540771e65fc8cb83cd6e8a237f70c319bd5c29f78ed1084ba5d50eeac86f7f9"
64 |
65 | [[package]]
66 | name = "hermit-abi"
67 | version = "0.1.19"
68 | source = "registry+https://github.com/rust-lang/crates.io-index"
69 | checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33"
70 | dependencies = [
71 | "libc",
72 | ]
73 |
74 | [[package]]
75 | name = "itoa"
76 | version = "1.0.4"
77 | source = "registry+https://github.com/rust-lang/crates.io-index"
78 | checksum = "4217ad341ebadf8d8e724e264f13e593e0648f5b3e94b3896a5df283be015ecc"
79 |
80 | [[package]]
81 | name = "libc"
82 | version = "0.2.135"
83 | source = "registry+https://github.com/rust-lang/crates.io-index"
84 | checksum = "68783febc7782c6c5cb401fbda4de5a9898be1762314da0bb2c10ced61f18b0c"
85 |
86 | [[package]]
87 | name = "once_cell"
88 | version = "1.15.0"
89 | source = "registry+https://github.com/rust-lang/crates.io-index"
90 | checksum = "e82dad04139b71a90c080c8463fe0dc7902db5192d939bd0950f074d014339e1"
91 |
92 | [[package]]
93 | name = "os_str_bytes"
94 | version = "6.3.0"
95 | source = "registry+https://github.com/rust-lang/crates.io-index"
96 | checksum = "9ff7415e9ae3fff1225851df9e0d9e4e5479f947619774677a63572e55e80eff"
97 |
98 | [[package]]
99 | name = "proc-macro-error"
100 | version = "1.0.4"
101 | source = "registry+https://github.com/rust-lang/crates.io-index"
102 | checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c"
103 | dependencies = [
104 | "proc-macro-error-attr",
105 | "proc-macro2",
106 | "quote",
107 | "syn",
108 | "version_check",
109 | ]
110 |
111 | [[package]]
112 | name = "proc-macro-error-attr"
113 | version = "1.0.4"
114 | source = "registry+https://github.com/rust-lang/crates.io-index"
115 | checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869"
116 | dependencies = [
117 | "proc-macro2",
118 | "quote",
119 | "version_check",
120 | ]
121 |
122 | [[package]]
123 | name = "proc-macro2"
124 | version = "1.0.47"
125 | source = "registry+https://github.com/rust-lang/crates.io-index"
126 | checksum = "5ea3d908b0e36316caf9e9e2c4625cdde190a7e6f440d794667ed17a1855e725"
127 | dependencies = [
128 | "unicode-ident",
129 | ]
130 |
131 | [[package]]
132 | name = "quote"
133 | version = "1.0.21"
134 | source = "registry+https://github.com/rust-lang/crates.io-index"
135 | checksum = "bbe448f377a7d6961e30f5955f9b8d106c3f5e449d493ee1b125c1d43c2b5179"
136 | dependencies = [
137 | "proc-macro2",
138 | ]
139 |
140 | [[package]]
141 | name = "ryu"
142 | version = "1.0.11"
143 | source = "registry+https://github.com/rust-lang/crates.io-index"
144 | checksum = "4501abdff3ae82a1c1b477a17252eb69cee9e66eb915c1abaa4f44d873df9f09"
145 |
146 | [[package]]
147 | name = "serde"
148 | version = "1.0.147"
149 | source = "registry+https://github.com/rust-lang/crates.io-index"
150 | checksum = "d193d69bae983fc11a79df82342761dfbf28a99fc8d203dca4c3c1b590948965"
151 | dependencies = [
152 | "serde_derive",
153 | ]
154 |
155 | [[package]]
156 | name = "serde_derive"
157 | version = "1.0.147"
158 | source = "registry+https://github.com/rust-lang/crates.io-index"
159 | checksum = "4f1d362ca8fc9c3e3a7484440752472d68a6caa98f1ab81d99b5dfe517cec852"
160 | dependencies = [
161 | "proc-macro2",
162 | "quote",
163 | "syn",
164 | ]
165 |
166 | [[package]]
167 | name = "serde_json"
168 | version = "1.0.87"
169 | source = "registry+https://github.com/rust-lang/crates.io-index"
170 | checksum = "6ce777b7b150d76b9cf60d28b55f5847135a003f7d7350c6be7a773508ce7d45"
171 | dependencies = [
172 | "itoa",
173 | "ryu",
174 | "serde",
175 | ]
176 |
177 | [[package]]
178 | name = "strsim"
179 | version = "0.10.0"
180 | source = "registry+https://github.com/rust-lang/crates.io-index"
181 | checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623"
182 |
183 | [[package]]
184 | name = "superdiff"
185 | version = "2.2.0"
186 | dependencies = [
187 | "clap",
188 | "serde",
189 | "serde_json",
190 | ]
191 |
192 | [[package]]
193 | name = "syn"
194 | version = "1.0.102"
195 | source = "registry+https://github.com/rust-lang/crates.io-index"
196 | checksum = "3fcd952facd492f9be3ef0d0b7032a6e442ee9b361d4acc2b1d0c4aaa5f613a1"
197 | dependencies = [
198 | "proc-macro2",
199 | "quote",
200 | "unicode-ident",
201 | ]
202 |
203 | [[package]]
204 | name = "termcolor"
205 | version = "1.1.3"
206 | source = "registry+https://github.com/rust-lang/crates.io-index"
207 | checksum = "bab24d30b911b2376f3a13cc2cd443142f0c81dda04c118693e35b3835757755"
208 | dependencies = [
209 | "winapi-util",
210 | ]
211 |
212 | [[package]]
213 | name = "unicode-ident"
214 | version = "1.0.5"
215 | source = "registry+https://github.com/rust-lang/crates.io-index"
216 | checksum = "6ceab39d59e4c9499d4e5a8ee0e2735b891bb7308ac83dfb4e80cad195c9f6f3"
217 |
218 | [[package]]
219 | name = "version_check"
220 | version = "0.9.4"
221 | source = "registry+https://github.com/rust-lang/crates.io-index"
222 | checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"
223 |
224 | [[package]]
225 | name = "winapi"
226 | version = "0.3.9"
227 | source = "registry+https://github.com/rust-lang/crates.io-index"
228 | checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
229 | dependencies = [
230 | "winapi-i686-pc-windows-gnu",
231 | "winapi-x86_64-pc-windows-gnu",
232 | ]
233 |
234 | [[package]]
235 | name = "winapi-i686-pc-windows-gnu"
236 | version = "0.4.0"
237 | source = "registry+https://github.com/rust-lang/crates.io-index"
238 | checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
239 |
240 | [[package]]
241 | name = "winapi-util"
242 | version = "0.1.5"
243 | source = "registry+https://github.com/rust-lang/crates.io-index"
244 | checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178"
245 | dependencies = [
246 | "winapi",
247 | ]
248 |
249 | [[package]]
250 | name = "winapi-x86_64-pc-windows-gnu"
251 | version = "0.4.0"
252 | source = "registry+https://github.com/rust-lang/crates.io-index"
253 | checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
254 |
--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | [package]
2 | name = "superdiff"
3 | version = "2.2.0"
4 | edition = "2021"
5 | license = "GPL-3.0"
6 | description = "Search your codebase for similar blocks"
7 | homepage = "https://github.com/chuck-sys/superdiff"
8 | repository = "https://github.com/chuck-sys/superdiff"
9 | readme = "README.md"
10 | categories = ["command-line-utilities"]
11 | keywords = ["code-analysis", "duplicate-finding"]
12 |
13 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
14 |
15 | [dependencies]
16 | clap = { version = "4.0", features = ["derive", "cargo"] }
17 | serde = { version = "1.0", features = ["derive"] }
18 | serde_json = "1.0"
19 |
20 | [profile.release]
21 | # size optimizations https://github.com/johnthagen/min-sized-rust
22 | strip = true
23 | lto = true
24 | codegen-units = 1
25 | panic = 'abort'
26 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # superdiff
2 |
3 | Are you working to eliminate similar/duplicate code from your files? Do you have a suspicion that chunks
4 | of code are copy-pasted, but are slightly different s.t. normal `diff` methods don't work? Are you tired
5 | of visually going through and inspecting your code for repeating chunks?
6 |
7 | If so, this might be the tool for you!
8 |
9 | ## Features
10 |
11 | - Finds duplicate code slices
12 | - Finds similar-enough code slices
13 | - `JSON` reporting for `jq` integeration
14 | - Fast enough (00:01:12 for a 17k LOC with block size 10 and Levenshtein threshold 10)
15 | - Can check for duplicate code across multiple files
16 | - Vim integration!
17 | - Multithreaded
18 |
19 | ## Limitations
20 |
21 | - Not instantaneous for large files
22 | - Multithreading only applies for multiple files (no difference when running on a single file)
23 |
24 | ## Short examples
25 |
26 | ```console
27 | $ superdiff -l 1 -b 5 examples/really-bad-code.py
28 | === MATCH ===
29 | File: examples/really-bad-code.py
30 | Lines: [5, 11]
31 | Size: 5
32 | $ find src vim-superdiff -type f | superdiff -l 1 -b 7 --worker-threads 4
33 | === MATCH ===
34 | File: src/types.rs
35 | Lines: [87, 185]
36 | Size: 7
37 |
38 | === MATCH ===
39 | File: vim-superdiff/autoload/superdiff.vim
40 | Lines: [136, 152]
41 | Size: 7
42 | ```
43 |
44 | ## Usage
45 |
46 | Say you have some file `examples/really-bad-code.py` that you want to inspect.
47 |
48 |
49 | examples/really-bad-code.py
50 |
51 | ```python
52 | #!/usr/bin/env python
53 |
54 | class SomeClass:
55 | def __init__(self):
56 | self.alpha = 12
57 | self.beta = 14
58 | self.gamma = 16
59 | self.is_bad = True
60 |
61 | def reset(self):
62 | self.alpha = 12
63 | self.beta = 14
64 | self.gamma = 16
65 | self.is_bad = True
66 |
67 | def do_something(self):
68 | d = {}
69 |
70 | import random
71 | for i in range(20):
72 | if i % 3 == 0: continue
73 | d[i] = random.randrange(1, 1001)
74 | d[i ** 2] = d[i] ** 2
75 | d[d[i]] = i
76 |
77 | def do_something_else(self):
78 | d = {}
79 |
80 | import random
81 | for i in range(21):
82 | if i % 3 == 1: continue
83 | d[i] = random.randrange(1, 1001)
84 | d[i ** 2] = d[i]
85 | d[d[i]] = i
86 |
87 | inst = SomeClass()
88 | inst.reset()
89 | ```
90 |
91 |
92 | You have a feeling that it might be bad, so you use the tool.
93 |
94 | ```console
95 | $ superdiff -b 4 examples/really-bad-code.py
96 | === MATCH ===
97 | File: "examples/really-bad-code.py"
98 | Lines: [5, 11]
99 | Size: 5
100 |
101 | A total of 1 unique match(es) were found in the 1 file(s).
102 | ```
103 |
104 | Wow! That's pretty nice that you found that! But maybe there are places in the file that aren't exact
105 | copies, but are similar enough.
106 |
107 | ```console
108 | $ superdiff -b 4 -t 5 examples/really-bad-code.py
109 | === MATCH ===
110 | File: "examples/really-bad-code.py"
111 | Lines: [16, 26]
112 | Size: 10
113 |
114 | === MATCH ===
115 | File: "examples/really-bad-code.py"
116 | Lines: [5, 11]
117 | Size: 5
118 | ```
119 |
120 | Huh, apparently there is a duplicate function that are pretty similar! And now (assuming that the output
121 | of the function is pretty long and not laughably short), you want to know if line 30 is involved in
122 | duplicate code, so you do the following:
123 |
124 | ```console
125 | $ superdiff --reporting-mode json -b 5 -t 5 examples/really-bad-code.py > output.json
126 | $ cat output.json | jq
127 | {
128 | "files": {
129 | "examples/really-bad-code.py": {
130 | "count_blocks": 4
131 | }
132 | },
133 | "matches": [
134 | {
135 | "blocks": {
136 | "examples/really-bad-code.py": [
137 | {
138 | "block_length": 5,
139 | "starting_line": 11
140 | },
141 | {
142 | "block_length": 5,
143 | "starting_line": 5
144 | }
145 | ]
146 | },
147 | "files": {
148 | "examples/really-bad-code.py": {
149 | "count_blocks": 2
150 | }
151 | }
152 | },
153 | {
154 | "blocks": {
155 | "examples/really-bad-code.py": [
156 | {
157 | "block_length": 10,
158 | "starting_line": 26
159 | },
160 | {
161 | "block_length": 10,
162 | "starting_line": 16
163 | }
164 | ]
165 | },
166 | "files": {
167 | "examples/really-bad-code.py": {
168 | "count_blocks": 2
169 | }
170 | }
171 | }
172 | ],
173 | "version": "2.1.2"
174 | }
175 | $ cat output.json | jq '.matches | map(select((.blocks."examples/really-bad-code.py" | any(.starting_line <= 30 and .starting_line + .block_length >= 30))))'
176 | [
177 | {
178 | "files": {
179 | "examples/really-bad-code.py": {
180 | "count_blocks": 2
181 | }
182 | },
183 | "blocks": {
184 | "examples/really-bad-code.py": [
185 | {
186 | "starting_line": 16,
187 | "block_length": 10
188 | },
189 | {
190 | "starting_line": 26,
191 | "block_length": 10
192 | }
193 | ]
194 | }
195 | }
196 | ]
197 | ```
198 |
199 | **Note:** If anyone finds a better way of making the `jq` query, please make a pull request and/or let me
200 | know.
201 |
202 | ## Vim integration
203 |
204 | It's kind of work-in-progress at the moment, but here's what we have:
205 |
206 | - Load JSON with `:SDLoad` (make sure you are in the same directory you ran `superdiff`)
207 | - Open a file to edit
208 | - Run `:SDLocal` to highlight matching blocks of code
209 | - Run `:SDQuery` on a matching block to find other blocks of similar code
210 |
211 | Check the vimdocs for more options and commands.
212 |
213 | [](https://asciinema.org/a/548069)
214 |
215 | ## Benchmark
216 |
217 | These numbers are here to give a ballpark estimate of how long something would take given some files. It
218 | is not scientific. I simply appended `time` to the beginning and copied the `real` time.
219 |
220 | The data used for this benchmark can be found in `scripts/populate-data.sh`.
221 |
222 | Version | Test name | Params | Time
223 | ---|---|---|---
224 | 2.0.3 | TerrariaClone | `-b 5 -t 5 json` | 40.284s
225 | 2.0.3 | TerrariaClone | `-b 5 json` | 0.489s
226 | 2.1.2 | TerrariaClone | `-b 5 -t 5 json` | 27.876s
227 | 2.1.2 | TerrariaClone | `-b 5 json` | 0.473s
228 | 2.2.0 | TerrariaClone | `-b 5 -t 5 --worker-threads 4 json` | 13.409s
229 | 2.2.0 | TerrariaClone | `-b 5 --worker-threads 4 json` | 0.348s
230 |
--------------------------------------------------------------------------------
/examples/really-bad-code.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 |
3 | class SomeClass:
4 | def __init__(self):
5 | self.alpha = 12
6 | self.beta = 14
7 | self.gamma = 16
8 | self.is_bad = True
9 |
10 | def reset(self):
11 | self.alpha = 12
12 | self.beta = 14
13 | self.gamma = 16
14 | self.is_bad = True
15 |
16 | def do_something(self):
17 | d = {}
18 |
19 | import random
20 | for i in range(20):
21 | if i % 3 == 0: continue
22 | d[i] = random.randrange(1, 1001)
23 | d[i ** 2] = d[i] ** 2
24 | d[d[i]] = i
25 |
26 | def do_something_else(self):
27 | d = {}
28 |
29 | import random
30 | for i in range(21):
31 | if i % 3 == 1: continue
32 | d[i] = random.randrange(1, 1001)
33 | d[i ** 2] = d[i]
34 | d[d[i]] = i
35 |
36 | inst = SomeClass()
37 | inst.reset()
38 |
--------------------------------------------------------------------------------
/examples/similar-matches-in-same-group/file1.txt:
--------------------------------------------------------------------------------
1 | aaaaaaaaaa
2 | aaaaaaaaaa
3 | aaaaaaaaaa
4 | aaaaaaaaaa
5 | aaaaaaaaaa
6 | aaaaaaaaaa
7 | aaaaaaaaaa
8 | aaaaaaaaaa
9 | aaaaaaaaaa
10 | aaaaaaaaaa
11 |
--------------------------------------------------------------------------------
/examples/similar-matches-in-same-group/file2.txt:
--------------------------------------------------------------------------------
1 | aaaaabbbbb
2 | aaaaabbbbb
3 | aaaaabbbbb
4 | aaaaabbbbb
5 | aaaaabbbbb
6 | aaaaabbbbb
7 | aaaaabbbbb
8 | aaaaabbbbb
9 | aaaaabbbbb
10 | aaaaabbbbb
11 |
--------------------------------------------------------------------------------
/examples/similar-matches-in-same-group/file3.txt:
--------------------------------------------------------------------------------
1 | bbbbbbbbbb
2 | bbbbbbbbbb
3 | bbbbbbbbbb
4 | bbbbbbbbbb
5 | bbbbbbbbbb
6 | bbbbbbbbbb
7 | bbbbbbbbbb
8 | bbbbbbbbbb
9 | bbbbbbbbbb
10 | bbbbbbbbbb
11 |
--------------------------------------------------------------------------------
/scripts/populate-data.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/bash
2 | # Download testing data into examples/ directory.
3 | # The data we download is a Terraria clone repository that is notorious for long files and bad code. Yes,
4 | # that one.
5 |
6 | git clone https://github.com/radian-software/TerrariaClone.git examples/TerrariaClone
7 |
--------------------------------------------------------------------------------
/src/cli.rs:
--------------------------------------------------------------------------------
1 | use clap::{Parser, ValueEnum};
2 | use std::io;
3 | use std::path::PathBuf;
4 |
5 | #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, ValueEnum, Default)]
6 | pub enum ReportingMode {
7 | /// Plain text
8 | #[default]
9 | Text,
10 | /// As a list of JSON objects
11 | ///
12 | /// Can be piped into `jq` for querying or loaded into `vim` with the plugin.
13 | Json,
14 | }
15 |
16 | #[derive(Parser, Clone)]
17 | #[command(author, version, about, long_about = None)]
18 | pub struct Cli {
19 | /// Levenshtein distance threshold (0 uses string comparison)
20 | #[arg(short = 't', long, default_value_t = 0)]
21 | pub lev_threshold: usize,
22 |
23 | /// Length of line before initial consideration
24 | ///
25 | /// If the length of the line does not reach this threshold, skip over it. For example, if you
26 | /// don't want a match to start on an empty line, use a positive integer. If you want the match
27 | /// to not start on lines that only have a single curly brace, use a positive integer that is
28 | /// greater than 1.
29 | ///
30 | /// Ignores whitespace.
31 | #[arg(short, long, default_value_t = 1)]
32 | pub line_threshold: usize,
33 |
34 | /// Minimum length of a matching block (cluster of lines)
35 | #[arg(short, long, default_value_t = 10)]
36 | pub block_threshold: usize,
37 |
38 | /// Set to increase the details that are output
39 | ///
40 | /// Output preamble on the command line options that are specified, as well as a progress bar.
41 | /// Also output a conclusion at the end.
42 | #[arg(short, long, default_value_t = false)]
43 | pub verbose: bool,
44 |
45 | /// Number of worker threads to spawn
46 | ///
47 | /// Comparisons between files are distributed evenly across all worker threads. This may not
48 | /// result in good caching efficiency because there is a possibility that all of the
49 | /// comparisons are on different files. It probably all comes down to your operating system.
50 | ///
51 | /// Thus, this option doesn't do anything substantial if you are only working with 1 file.
52 | #[arg(long, default_value_t = 1)]
53 | pub worker_threads: usize,
54 |
55 | /// Files to find the code blocks (leave empty to read from stdin)
56 | pub files: Vec,
57 |
58 | /// How you want the information to be delivered
59 | ///
60 | /// Anything other than `ReportingMode::Text` will disable metadata reporting (e.g. reporting file
61 | /// information, verbosity, and other command line arguments, as well as the concluding remarks).
62 | #[arg(value_enum, long, default_value_t = ReportingMode::Text)]
63 | pub reporting_mode: ReportingMode,
64 | }
65 |
66 | impl Cli {
67 | pub fn populate_files_from_stdin(&mut self) {
68 | let mut files: Vec = Vec::new();
69 |
70 | for line in io::stdin().lines() {
71 | match line {
72 | Ok(f) => files.push(f.into()),
73 | Err(e) => panic!("{e}"),
74 | }
75 | }
76 |
77 | self.files = files;
78 | }
79 |
80 | pub fn files_from_stdin(&self) -> bool {
81 | self.files.is_empty()
82 | }
83 |
84 | pub fn print(&self) {
85 | if !self.verbose {
86 | return;
87 | }
88 |
89 | eprint!("{} file(s)", self.files.len());
90 | if self.files.len() <= 10 {
91 | eprintln!(" {:?}", &self.files);
92 | } else {
93 | eprintln!(" {:?}...", &self.files[..10]);
94 | }
95 |
96 | eprintln!("Worker threads: {}", self.worker_threads);
97 | eprintln!("Verbosity (-v): {}", self.verbose);
98 | eprintln!(
99 | "Comparison threshold (-t): {} ({})",
100 | self.lev_threshold,
101 | if self.lev_threshold > 0 {
102 | "Levenshtein distance"
103 | } else {
104 | "Strict equality"
105 | }
106 | );
107 | eprintln!(
108 | "Minimum length of first line before block consideration (-l): {}",
109 | self.line_threshold
110 | );
111 | eprintln!(
112 | "Minimum length of block before consideration (-b): {}",
113 | self.block_threshold
114 | );
115 | }
116 | }
117 |
--------------------------------------------------------------------------------
/src/comp.rs:
--------------------------------------------------------------------------------
1 | use crate::cli::Cli;
2 | use crate::types::{CompFile, ComparisonFn, Match, Matches, MatchesLookup};
3 |
4 | use std::sync::mpsc;
5 |
6 | const INSERTION_COST: usize = 1;
7 | const DELETION_COST: usize = 1;
8 | const SUBSTITUTION_COST: usize = 1;
9 |
10 | /// Create a comparison function based on the given threshold.
11 | ///
12 | /// If the threshold is 0, we use string comparison. If not, we use Levenshtein distance.
13 | pub fn comparison_lambda(args: &Cli) -> ComparisonFn {
14 | let threshold = args.lev_threshold;
15 | if threshold == 0 {
16 | Box::new(move |x, y| x == y)
17 | } else {
18 | Box::new(move |x, y| levenshtein_distance(x, y, threshold) <= threshold)
19 | }
20 | }
21 |
22 | /// Find block length of the matching code block.
23 | ///
24 | /// Stops comparison when we reach the end of the file, or if the files are the same and the
25 | /// original index hits the occurrance index. This stops code blocks from "eating" the other code
26 | /// block (i.e. no nested overlapping blocks that are similar).
27 | fn get_max_block_size(comp: &ComparisonFn, f1: &CompFile, f2: &CompFile) -> usize {
28 | let mut block_length = 1;
29 |
30 | loop {
31 | let i1 = f1.start + block_length;
32 | let i2 = f2.start + block_length;
33 |
34 | if f1.file == f2.file && i1 == f2.start {
35 | return block_length;
36 | }
37 |
38 | if i1 >= f1.lines.len() || i2 >= f2.lines.len() {
39 | return block_length;
40 | }
41 |
42 | if comp(&f1.lines[i1], &f2.lines[i2]) {
43 | block_length += 1;
44 | } else {
45 | return block_length;
46 | }
47 | }
48 | }
49 |
50 | /// Add or remove entries from lookup and matches based on given pair of matches.
51 | ///
52 | /// There are 4 situations that we prepare for.
53 | ///
54 | /// 1. **The pair of matches both exist in the same bucket.** We don't need to do anything.
55 | /// 2. **The pair of matches both exist in different buckets.** We combine both buckets.
56 | /// 3. **One of the pair of matches exist in a bucket.** We put the other one in that bucket.
57 | /// 4. **None of the matches exist in any bucket.** We put one of them in a bucket labelled with
58 | /// the other.
59 | pub fn update_matches(
60 | (a, b): (Match, Match),
61 | (where_is_match, matches_hash): (&mut MatchesLookup, &mut Matches),
62 | ) {
63 | let mut where_is_match_to_insert = Vec::new();
64 | let (refa, refb) = (where_is_match.0.get(&a), where_is_match.0.get(&b));
65 | match (refa, refb, &a, &b) {
66 | (Some(refa), Some(refb), _, _) if refa != refb => {
67 | // Reassign all of refb references to refa
68 | let mut refb_v = matches_hash.0.remove(refb).unwrap();
69 | refb_v.push(refb.clone());
70 | for block in &refb_v {
71 | where_is_match_to_insert.push((block.clone(), refa.clone()));
72 | }
73 |
74 | // Append all of the refb into refa's bucket
75 | matches_hash
76 | .0
77 | .entry(refa.clone())
78 | .and_modify(|v| v.append(&mut refb_v));
79 | }
80 | (Some(refblock), None, _, b) | (None, Some(refblock), b, _) => {
81 | matches_hash
82 | .0
83 | .entry(refblock.clone())
84 | .and_modify(|v| v.push(b.clone()));
85 |
86 | where_is_match_to_insert.push((b.clone(), refblock.clone()));
87 | }
88 | (None, None, a, b) => {
89 | matches_hash.0.insert(b.clone(), vec![a.clone()]);
90 |
91 | where_is_match_to_insert.push((a.clone(), b.clone()));
92 | where_is_match_to_insert.push((b.clone(), b.clone()));
93 | }
94 | _ => {}
95 | }
96 |
97 | for (key, val) in where_is_match_to_insert {
98 | where_is_match.0.insert(key, val);
99 | }
100 | }
101 |
102 | pub fn get_matches_from_2_files(
103 | args: &Cli,
104 | tx: &mpsc::Sender<(Match, Match)>,
105 | comp: &ComparisonFn,
106 | (mut f1, mut f2): (CompFile, CompFile),
107 | ) {
108 | f1.start = 0;
109 |
110 | while f1.start < f1.lines.len() {
111 | // Don't consider line lengths below the threshold
112 | if f1.current_line().len() < args.line_threshold {
113 | f1.start += 1;
114 | continue;
115 | }
116 |
117 | f2.start = if f1.file == f2.file { f1.start + 1 } else { 0 };
118 | let mut max_block_length = 1;
119 |
120 | while f2.start < f2.lines.len() {
121 | if comp(f1.current_line(), f2.current_line()) {
122 | let block_length = get_max_block_size(comp, &f1, &f2);
123 |
124 | if block_length < args.block_threshold {
125 | f2.start += block_length;
126 | continue;
127 | }
128 |
129 | let matches = Match::from_compfiles(&f1, &f2, block_length);
130 | tx.send(matches).unwrap_or(());
131 |
132 | f2.start += block_length;
133 | max_block_length = std::cmp::max(max_block_length, block_length);
134 | } else {
135 | f2.start += 1;
136 | }
137 | }
138 |
139 | f1.start += max_block_length;
140 | }
141 | }
142 |
143 | /// Make a `Vec`.
144 | ///
145 | /// We use a preallocated `Vec` instead of `.collect()` to avoid allocation penalties.
146 | fn to_char_vec(s: &str) -> Vec {
147 | let mut v = Vec::with_capacity(s.len());
148 |
149 | for c in s.chars() {
150 | v.push(c);
151 | }
152 |
153 | v
154 | }
155 |
156 | /// Compute the edit distance of 2 strings, with shortcuts.
157 | ///
158 | /// Modified from wikipedia pseudocode for matrix approach (no recursion).
159 | ///
160 | /// For strings x and y with length m and n respectively, we create an m+1 by n+1 matrix
161 | /// (represented by 1d array) of costs where moving to the right constitutes as inserting a
162 | /// character from y; moving down constitutes as deleting a character from y; moving diagonally
163 | /// across constitutes as substituting a character from y into a.
164 | ///
165 | /// We stop computing if we find that nothing of our current row is under the threshold, in which
166 | /// case we would exit early.
167 | ///
168 | /// We can also stop computing if we know that the threshold is greater than m + n, which is the
169 | /// maximum.
170 | ///
171 | /// This algorithm runs at a time complexity of O(mn).
172 | #[allow(clippy::needless_range_loop)]
173 | pub fn levenshtein_distance(x: &str, y: &str, threshold: usize) -> usize {
174 | let (x, y) = (to_char_vec(x), to_char_vec(y));
175 | let (m, n) = (x.len(), y.len());
176 | let mut d = vec![0usize; (m + 1) * (n + 1)];
177 | let size = m + 1;
178 |
179 | // Distance is at most the length of the longer string
180 | if threshold >= std::cmp::max(m, n) {
181 | return threshold;
182 | }
183 |
184 | // Distance is at least the absolute value of the difference in sizes of the two strings
185 | if threshold < m.abs_diff(n) {
186 | return threshold + 1;
187 | }
188 |
189 | for i in 1..(m + 1) {
190 | d[i] = i;
191 | }
192 |
193 | for j in 1..(n + 1) {
194 | d[j * size] = j;
195 | }
196 |
197 | for j in 1..(n + 1) {
198 | let mut has_changed_row = false;
199 |
200 | for i in 1..(m + 1) {
201 | let sub_cost = if x[i - 1] == y[j - 1] {
202 | 0
203 | } else {
204 | SUBSTITUTION_COST
205 | };
206 | d[i + j * size] = std::cmp::min(
207 | d[(i - 1) + j * size] + INSERTION_COST,
208 | std::cmp::min(
209 | d[i + (j - 1) * size] + DELETION_COST,
210 | d[(i - 1) + (j - 1) * size] + sub_cost,
211 | ),
212 | );
213 |
214 | if d[i + j * size] <= threshold {
215 | has_changed_row = true;
216 | }
217 | }
218 |
219 | // Guarantee to not pass the threshold check
220 | if !has_changed_row {
221 | return threshold + 1;
222 | }
223 | }
224 |
225 | d[m + n * size]
226 | }
227 |
228 | #[cfg(test)]
229 | mod tests {
230 | use super::levenshtein_distance;
231 |
232 | macro_rules! check_lev {
233 | ( $a:literal, $b:literal, $t:literal ) => {{
234 | check_lev!($a, $b, $t, $t);
235 | }};
236 |
237 | ( $a:literal, $b:literal, $t:literal, $e:literal ) => {{
238 | let dist = levenshtein_distance($a, $b, $t);
239 | assert_eq!(
240 | dist, $e,
241 | "levenshtein_distance({}, {}, {}) = {}, expected {}",
242 | $a, $b, $t, dist, $e
243 | );
244 | }};
245 | }
246 |
247 | #[test]
248 | fn test_lev_distance() {
249 | // Normal use of function
250 | check_lev!("the same the same", "the same the same", 10, 0);
251 | check_lev!("kitten", "sitting", 3);
252 | check_lev!("train", "shine", 4);
253 | check_lev!("a", "aaa", 2);
254 | // Maximum threshold
255 | check_lev!("arst", "zxcv", 4);
256 | // Short circuit at the end
257 | check_lev!("ieanrstien", " ", 5, 6);
258 | // Short circuit at the start
259 | check_lev!("arstarst", "zxcv", 100, 100);
260 | // A bit tight
261 | check_lev!("the same", "the same", 0);
262 | }
263 | }
264 |
--------------------------------------------------------------------------------
/src/lib.rs:
--------------------------------------------------------------------------------
1 | pub mod cli;
2 | pub mod comp;
3 | pub mod math;
4 | pub mod printer;
5 | pub mod types;
6 | pub mod threadpool;
7 |
--------------------------------------------------------------------------------
/src/main.rs:
--------------------------------------------------------------------------------
1 | use clap::Parser;
2 | use superdiff::*;
3 |
4 | fn main() {
5 | let mut args = cli::Cli::parse();
6 | if args.files_from_stdin() {
7 | args.populate_files_from_stdin();
8 | }
9 | args.print();
10 |
11 | let mut pool = threadpool::ThreadPool::from(args.clone());
12 | let matches = pool.run_and_get_results();
13 |
14 | printer::matches(&args, &matches);
15 | printer::conclusion(&args, &matches);
16 | }
17 |
--------------------------------------------------------------------------------
/src/math.rs:
--------------------------------------------------------------------------------
1 | /// Calculate factorial from [stop, n].
2 | /// Equivalent to n! / (stop - 1)!
3 | pub fn factorial(n: usize, stop: usize) -> usize {
4 | let mut x = 1;
5 |
6 | for f in stop..=n {
7 | x *= f;
8 | }
9 |
10 | x
11 | }
12 |
13 | /// Calculate nCk
14 | pub fn combinations(n: usize, k: usize) -> usize {
15 | if n < k {
16 | 0
17 | } else {
18 | factorial(n, n - k + 1) / factorial(k, 2)
19 | }
20 | }
21 |
22 | #[cfg(test)]
23 | mod tests {
24 | use super::{combinations, factorial};
25 |
26 | #[test]
27 | fn test_factorial() {
28 | assert_eq!(factorial(1, 1), 1);
29 | assert_eq!(factorial(2, 1), 2);
30 | assert_eq!(factorial(10, 1), 3628800);
31 | assert_eq!(factorial(6, 3), 360);
32 | }
33 |
34 | #[test]
35 | fn test_combinations() {
36 | assert_eq!(combinations(9, 2), 36);
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/printer.rs:
--------------------------------------------------------------------------------
1 | use crate::cli::{Cli, ReportingMode};
2 | use crate::math::combinations;
3 | use crate::types::JsonRoot;
4 |
5 | use std::thread;
6 | use std::sync::mpsc;
7 |
8 | /// Spawn a thread that prints progress Text
9 | ///
10 | /// Will not spawn any thread at all if `verbose` is not set.
11 | pub fn spawn_processing_text(args: &Cli, rx: mpsc::Receiver) {
12 | if !args.verbose {
13 | return;
14 | }
15 |
16 | let total = combinations(args.files.len(), 2) + args.files.len();
17 | thread::spawn(move || {
18 | let mut i = 1usize;
19 | for _ in rx {
20 | let percentage = i * 100 / total;
21 | eprint!("{percentage}% completed\r");
22 |
23 | i += 1;
24 | }
25 | eprintln!();
26 | });
27 | }
28 |
29 | pub fn matches(args: &Cli, matches: &JsonRoot) {
30 | match args.reporting_mode {
31 | ReportingMode::Json => {
32 | println!("{}", matches.json());
33 | }
34 | ReportingMode::Text => {
35 | println!("{matches}");
36 | }
37 | }
38 | }
39 |
40 | pub fn conclusion(args: &Cli, matches: &JsonRoot) {
41 | if args.verbose {
42 | eprintln!(
43 | "A total of {} unique match(es) were found in the {} file(s).",
44 | matches.unique_matches(),
45 | args.files.len()
46 | );
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/src/threadpool.rs:
--------------------------------------------------------------------------------
1 | use std::thread;
2 | use std::sync::mpsc;
3 | use std::path::PathBuf;
4 | use std::collections::HashMap;
5 |
6 | use crate::cli::Cli;
7 | use crate::comp::{get_matches_from_2_files, comparison_lambda, update_matches};
8 | use crate::types::{MatchesLookup, Matches, CompFile, JsonRoot};
9 | use crate::printer;
10 |
11 | pub struct ThreadPool {
12 | where_is_match: MatchesLookup,
13 | matches_hash: Matches,
14 | args: Cli,
15 | }
16 |
17 | impl ThreadPool {
18 | /// Split the pairs of files (the task) evenly among the n threads.
19 | fn partition_file_combinations(&self) -> Vec> {
20 | let mut senders = Vec::with_capacity(self.args.worker_threads);
21 | let mut receivers = Vec::with_capacity(self.args.worker_threads);
22 |
23 | for _ in 0..self.args.worker_threads {
24 | let (tx, rx) = mpsc::channel();
25 | senders.push(tx);
26 | receivers.push(rx);
27 | }
28 |
29 | let mut sender_index = 0;
30 | for i in 0..self.args.files.len() {
31 | for j in i..self.args.files.len() {
32 | let two_files = (self.args.files[i].clone(), self.args.files[j].clone());
33 | senders[sender_index].send(two_files).unwrap();
34 |
35 | if sender_index == senders.len() - 1 {
36 | sender_index = 0;
37 | } else {
38 | sender_index += 1;
39 | }
40 | }
41 | }
42 |
43 | receivers
44 | }
45 |
46 | /// Run comparisons using the arguments from initialization.
47 | pub fn run_and_get_results(&mut self) -> JsonRoot {
48 | let (matches_transmitter, matches_receiver) = mpsc::channel();
49 | let (done_transmitter, done_receiver) = mpsc::channel();
50 |
51 | for two_file_rx in self.partition_file_combinations() {
52 | let matches_transmitter = matches_transmitter.clone();
53 | let done_transmitter = done_transmitter.clone();
54 | let args = self.args.clone();
55 | thread::spawn(move || {
56 | let comp = comparison_lambda(&args);
57 | for (f1, f2) in two_file_rx {
58 | if let Some(two_files) = CompFile::from_files(&f1, &f2) {
59 | get_matches_from_2_files(&args, &matches_transmitter, &comp, two_files);
60 | }
61 |
62 | done_transmitter.send(true).unwrap_or(());
63 | }
64 | });
65 | }
66 |
67 | // We have to drop this these otherwise rx won't know when to quit and will keep waiting
68 | drop(matches_transmitter);
69 | drop(done_transmitter);
70 |
71 | printer::spawn_processing_text(&self.args, done_receiver);
72 |
73 | for matches in matches_receiver {
74 | update_matches(matches, (&mut self.where_is_match, &mut self.matches_hash));
75 | }
76 |
77 | JsonRoot::from(&self.matches_hash)
78 | }
79 | }
80 |
81 | impl From for ThreadPool {
82 | fn from(item: Cli) -> Self {
83 | Self {
84 | where_is_match: MatchesLookup(HashMap::new()),
85 | matches_hash: Matches(HashMap::new()),
86 | args: item,
87 | }
88 | }
89 | }
90 |
--------------------------------------------------------------------------------
/src/types.rs:
--------------------------------------------------------------------------------
1 | use std::collections::{HashMap, HashSet};
2 | use std::fmt;
3 | use std::path::PathBuf;
4 |
5 | use serde::{Deserialize, Serialize};
6 |
7 | /// A structure to easily move parameters from one place to another.
8 | #[derive(Clone, Debug)]
9 | pub struct CompFile {
10 | pub file: PathBuf,
11 | pub lines: Vec,
12 | pub start: usize,
13 | }
14 |
15 | /// A matching block.
16 | ///
17 | /// Points to a single block of lines in some file.
18 | #[derive(Hash, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
19 | pub struct Match {
20 | pub file: PathBuf,
21 | pub line: usize,
22 | pub size: usize,
23 | }
24 |
25 | /// A bunch of Matches.
26 | ///
27 | /// Consists of an original match that is deemed similar to a list of other matches. The match that
28 | /// is the key is arbitrarily chosen and is fungible.
29 | pub struct Matches(pub HashMap>);
30 |
31 | /// A lookup that points some arbitrary match to the key match.
32 | ///
33 | /// Used to check which key some match belongs to, in order to insert into `Matches`.
34 | pub struct MatchesLookup(pub HashMap);
35 |
36 | #[derive(Serialize, Clone, Deserialize, PartialEq, Eq, Debug)]
37 | pub struct JsonFileInfo {
38 | pub count_blocks: usize,
39 | }
40 |
41 | #[derive(Serialize, Deserialize, PartialEq, Eq, Hash, Debug)]
42 | pub struct JsonBlockInfo {
43 | pub starting_line: usize,
44 | pub block_length: usize,
45 | }
46 |
47 | #[derive(Serialize, Deserialize, Eq, Debug)]
48 | pub struct JsonMatch {
49 | pub files: HashMap,
50 | pub blocks: HashMap>,
51 | }
52 |
53 | #[derive(Serialize, Deserialize, Eq, Debug)]
54 | pub struct JsonRoot {
55 | pub version: String,
56 | pub files: HashMap,
57 | pub matches: Vec,
58 | }
59 |
60 | impl From<&Match> for JsonBlockInfo {
61 | fn from(m: &Match) -> Self {
62 | Self {
63 | starting_line: m.line,
64 | block_length: m.size,
65 | }
66 | }
67 | }
68 |
69 | impl PartialEq for JsonMatch {
70 | fn eq(&self, other: &Self) -> bool {
71 | if self.files != other.files || self.blocks.len() != other.blocks.len() {
72 | return false;
73 | }
74 |
75 | for (k, v) in &self.blocks {
76 | match other.blocks.get(k) {
77 | Some(other_v) => {
78 | let (a_info, b_info): (HashSet<_>, HashSet<_>) =
79 | (v.iter().collect(), other_v.iter().collect());
80 | if a_info != b_info {
81 | return false;
82 | }
83 | }
84 | None => {
85 | return false;
86 | }
87 | }
88 | }
89 |
90 | true
91 | }
92 | }
93 |
94 | impl From<(&Match, &Vec)> for JsonMatch {
95 | fn from((initial_match, other_matches): (&Match, &Vec)) -> Self {
96 | let mut blocks = HashMap::new();
97 | let mut files = HashMap::new();
98 | files.insert(initial_match.file.clone(), JsonFileInfo { count_blocks: 1 });
99 | blocks.insert(
100 | initial_match.file.clone(),
101 | vec![JsonBlockInfo::from(initial_match)],
102 | );
103 |
104 | for m in other_matches {
105 | let f = m.clone().file;
106 | files
107 | .entry(f.clone())
108 | .and_modify(|info| info.count_blocks += 1)
109 | .or_insert(JsonFileInfo { count_blocks: 1 });
110 | blocks
111 | .entry(f)
112 | .and_modify(|v| v.push(JsonBlockInfo::from(m)))
113 | .or_insert(vec![JsonBlockInfo::from(m)]);
114 | }
115 |
116 | Self { files, blocks }
117 | }
118 | }
119 |
120 | impl fmt::Display for JsonMatch {
121 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
122 | write!(
123 | f,
124 | "=== MATCH ===\n{}\n",
125 | self.blocks
126 | .iter()
127 | .map(|(filename, infos)| format!(
128 | "File: {}\nLines: {:?}\nSize: {}",
129 | filename.display(),
130 | infos
131 | .iter()
132 | .map(|info| info.starting_line)
133 | .collect::>(),
134 | infos[0].block_length,
135 | ))
136 | .collect::>()
137 | .join("\n---\n")
138 | )
139 | }
140 | }
141 |
142 | impl From<&Matches> for JsonRoot {
143 | fn from(m: &Matches) -> Self {
144 | let version = clap::crate_version!().to_owned();
145 | let matches: Vec = m.0.iter().map(JsonMatch::from).collect();
146 | let jm_files = matches.iter().map(|jm| jm.files.clone());
147 | let mut files: HashMap = HashMap::new();
148 |
149 | for jmf in jm_files {
150 | for (filename, info) in jmf {
151 | files
152 | .entry(filename)
153 | .and_modify(|v| v.count_blocks += info.count_blocks)
154 | .or_insert(info);
155 | }
156 | }
157 |
158 | Self {
159 | version,
160 | files,
161 | matches,
162 | }
163 | }
164 | }
165 |
166 | impl JsonRoot {
167 | pub fn unique_matches(&self) -> usize {
168 | self.matches.len()
169 | }
170 |
171 | pub fn json(&self) -> String {
172 | serde_json::to_string(&self).unwrap_or("{}".to_owned())
173 | }
174 | }
175 |
176 | impl PartialEq for JsonRoot {
177 | fn eq(&self, other: &Self) -> bool {
178 | if self.matches.len() != other.matches.len() {
179 | return false;
180 | }
181 |
182 | for item in &self.matches {
183 | if !other.matches.contains(item) {
184 | return false;
185 | }
186 | }
187 |
188 | true
189 | }
190 | }
191 |
192 | impl fmt::Display for JsonRoot {
193 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
194 | write!(
195 | f,
196 | "{}",
197 | self.matches
198 | .iter()
199 | .map(|x| x.to_string())
200 | .collect::>()
201 | .join("\n")
202 | )
203 | }
204 | }
205 |
206 | pub type ComparisonFn = Box bool>;
207 | pub type FileCache = HashMap>;
208 |
209 | impl Match {
210 | pub fn from_compfiles(f1: &CompFile, f2: &CompFile, block_length: usize) -> (Self, Self) {
211 | (
212 | Self {
213 | file: f1.file.clone(),
214 | line: f1.start + 1,
215 | size: block_length,
216 | },
217 | Self {
218 | file: f2.file.clone(),
219 | line: f2.start + 1,
220 | size: block_length,
221 | },
222 | )
223 | }
224 | }
225 |
226 | fn get_lines_from_file(file: &PathBuf) -> std::io::Result> {
227 | Ok(std::fs::read_to_string(file)?
228 | .split('\n')
229 | .map(|line| line.trim().to_owned())
230 | .collect::>())
231 | }
232 |
233 | impl CompFile {
234 | pub fn current_line(&self) -> &String {
235 | &self.lines[self.start]
236 | }
237 |
238 | pub fn from_files(f1: &PathBuf, f2: &PathBuf) -> Option<(Self, Self)> {
239 | match (get_lines_from_file(f1), get_lines_from_file(f2)) {
240 | (Ok(lines1), Ok(lines2)) => Some((
241 | Self {
242 | file: f1.clone(),
243 | lines: lines1,
244 | start: 0,
245 | },
246 | Self {
247 | file: f2.clone(),
248 | lines: lines2,
249 | start: 0,
250 | },
251 | )),
252 | _ => None,
253 | }
254 | }
255 | }
256 |
--------------------------------------------------------------------------------
/tests/expected/similar_matches_in_1_group.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "2.1.0",
3 | "files": {
4 | "examples/similar-matches-in-same-group/file1.txt": {
5 | "count_blocks": 1
6 | },
7 | "examples/similar-matches-in-same-group/file2.txt": {
8 | "count_blocks": 1
9 | },
10 | "examples/similar-matches-in-same-group/file3.txt": {
11 | "count_blocks": 1
12 | }
13 | },
14 | "matches": [
15 | {
16 | "files": {
17 | "examples/similar-matches-in-same-group/file2.txt": {
18 | "count_blocks": 1
19 | },
20 | "examples/similar-matches-in-same-group/file1.txt": {
21 | "count_blocks": 1
22 | },
23 | "examples/similar-matches-in-same-group/file3.txt": {
24 | "count_blocks": 1
25 | }
26 | },
27 | "blocks": {
28 | "examples/similar-matches-in-same-group/file2.txt": [
29 | {
30 | "starting_line": 1,
31 | "block_length": 11
32 | }
33 | ],
34 | "examples/similar-matches-in-same-group/file3.txt": [
35 | {
36 | "starting_line": 1,
37 | "block_length": 11
38 | }
39 | ],
40 | "examples/similar-matches-in-same-group/file1.txt": [
41 | {
42 | "starting_line": 1,
43 | "block_length": 11
44 | }
45 | ]
46 | }
47 | }
48 | ]
49 | }
50 |
--------------------------------------------------------------------------------
/tests/expected/terraria_clone_eq_b20.json:
--------------------------------------------------------------------------------
1 | {"version":"2.0.3","files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":20},"examples/TerrariaClone/src/Player.java":{"count_blocks":2},"examples/TerrariaClone/src/Inventory.java":{"count_blocks":7},"examples/TerrariaClone/src/Entity.java":{"count_blocks":1},"examples/TerrariaClone/src/TextField.java":{"count_blocks":1},"examples/TerrariaClone/src/World.java":{"count_blocks":6}},"matches":[{"files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":4047,"block_length":55},{"starting_line":6124,"block_length":55}]}},{"files":{"examples/TerrariaClone/src/Inventory.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/Inventory.java":[{"starting_line":47,"block_length":30},{"starting_line":947,"block_length":30}]}},{"files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":4}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":2638,"block_length":29},{"starting_line":3690,"block_length":29},{"starting_line":4047,"block_length":29},{"starting_line":6124,"block_length":29}]}},{"files":{"examples/TerrariaClone/src/Entity.java":{"count_blocks":1},"examples/TerrariaClone/src/TextField.java":{"count_blocks":1},"examples/TerrariaClone/src/Player.java":{"count_blocks":1},"examples/TerrariaClone/src/Inventory.java":{"count_blocks":1},"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":1},"examples/TerrariaClone/src/World.java":{"count_blocks":1}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":6535,"block_length":27}],"examples/TerrariaClone/src/Player.java":[{"starting_line":328,"block_length":27}],"examples/TerrariaClone/src/Inventory.java":[{"starting_line":1675,"block_length":27}],"examples/TerrariaClone/src/Entity.java":[{"starting_line":621,"block_length":27}],"examples/TerrariaClone/src/TextField.java":[{"starting_line":57,"block_length":27}],"examples/TerrariaClone/src/World.java":[{"starting_line":1360,"block_length":27}]}},{"files":{"examples/TerrariaClone/src/Inventory.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/Inventory.java":[{"starting_line":1247,"block_length":23},{"starting_line":1369,"block_length":23}]}},{"files":{"examples/TerrariaClone/src/Inventory.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/Inventory.java":[{"starting_line":1339,"block_length":27},{"starting_line":1465,"block_length":27}]}},{"files":{"examples/TerrariaClone/src/World.java":{"count_blocks":1},"examples/TerrariaClone/src/Player.java":{"count_blocks":1}},"blocks":{"examples/TerrariaClone/src/World.java":[{"starting_line":1356,"block_length":31}],"examples/TerrariaClone/src/Player.java":[{"starting_line":324,"block_length":31}]}},{"files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":4363,"block_length":90},{"starting_line":4492,"block_length":90}]}},{"files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":1042,"block_length":28},{"starting_line":1072,"block_length":28}]}},{"files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":3}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":1927,"block_length":57},{"starting_line":1986,"block_length":57},{"starting_line":2045,"block_length":57}]}},{"files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":1985,"block_length":58},{"starting_line":2044,"block_length":58}]}},{"files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":4771,"block_length":49},{"starting_line":4904,"block_length":49}]}},{"files":{"examples/TerrariaClone/src/TerrariaClone.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/TerrariaClone.java":[{"starting_line":4820,"block_length":20},{"starting_line":4954,"block_length":20}]}},{"files":{"examples/TerrariaClone/src/World.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/World.java":[{"starting_line":568,"block_length":25},{"starting_line":640,"block_length":25}]}},{"files":{"examples/TerrariaClone/src/World.java":{"count_blocks":2}},"blocks":{"examples/TerrariaClone/src/World.java":[{"starting_line":743,"block_length":172},{"starting_line":924,"block_length":172}]}}]}
2 |
--------------------------------------------------------------------------------
/tests/integration_test.rs:
--------------------------------------------------------------------------------
1 | use superdiff::cli::{Cli, ReportingMode};
2 | use superdiff::types::JsonRoot;
3 | use superdiff::threadpool::ThreadPool;
4 |
5 | use std::fs::read_to_string;
6 | use std::path::PathBuf;
7 |
8 | macro_rules! vec_pathbuf {
9 | ( $( $x:expr ),* ) => {
10 | {
11 | vec![
12 | $(
13 | PathBuf::from($x),
14 | )*
15 | ]
16 | }
17 | };
18 | }
19 |
20 | fn terraria_clone_files() -> Vec {
21 | vec_pathbuf![
22 | "examples/TerrariaClone/src/Chunk.java",
23 | "examples/TerrariaClone/src/DoubleContainer.java",
24 | "examples/TerrariaClone/src/Entity.java",
25 | "examples/TerrariaClone/src/Inventory.java",
26 | "examples/TerrariaClone/src/ItemCollection.java",
27 | "examples/TerrariaClone/src/LightConverter.java",
28 | "examples/TerrariaClone/src/PerlinNoise.java",
29 | "examples/TerrariaClone/src/Player.java",
30 | "examples/TerrariaClone/src/RandConverter.java",
31 | "examples/TerrariaClone/src/TerrariaClone.java",
32 | "examples/TerrariaClone/src/TextField.java",
33 | "examples/TerrariaClone/src/World.java",
34 | "examples/TerrariaClone/src/WorldContainer.java"
35 | ]
36 | }
37 |
38 | fn similar_matches_files() -> Vec {
39 | vec_pathbuf![
40 | "examples/similar-matches-in-same-group/file1.txt",
41 | "examples/similar-matches-in-same-group/file3.txt",
42 | "examples/similar-matches-in-same-group/file2.txt"
43 | ]
44 | }
45 |
46 | #[test]
47 | fn it_outputs_correct_matches_for_terraria_clone() {
48 | let args = Cli {
49 | lev_threshold: 0,
50 | line_threshold: 1,
51 | block_threshold: 20,
52 | verbose: true,
53 | files: terraria_clone_files(),
54 | reporting_mode: ReportingMode::Json,
55 | worker_threads: 4,
56 | };
57 |
58 | let mut pool = ThreadPool::from(args);
59 | let matches = pool.run_and_get_results();
60 | let expected: JsonRoot =
61 | serde_json::from_str(&read_to_string("tests/expected/terraria_clone_eq_b20.json").unwrap())
62 | .unwrap();
63 |
64 | assert_eq!(matches, expected);
65 | }
66 |
67 | #[test]
68 | fn it_puts_all_matches_in_same_group() {
69 | let args = Cli {
70 | lev_threshold: 5,
71 | line_threshold: 10,
72 | block_threshold: 5,
73 | verbose: false,
74 | files: similar_matches_files(),
75 | reporting_mode: ReportingMode::Json,
76 | worker_threads: 1,
77 | };
78 |
79 | let mut pool = ThreadPool::from(args);
80 | let matches = pool.run_and_get_results();
81 | let expected: JsonRoot = serde_json::from_str(
82 | &read_to_string("tests/expected/similar_matches_in_1_group.json").unwrap(),
83 | )
84 | .unwrap();
85 |
86 | assert_eq!(matches, expected);
87 | }
88 |
89 | #[test]
90 | fn it_could_probably_check_stdin() {
91 | let args = Cli {
92 | lev_threshold: 0,
93 | line_threshold: 1,
94 | block_threshold: 20,
95 | verbose: true,
96 | files: vec![],
97 | reporting_mode: ReportingMode::Json,
98 | worker_threads: 1,
99 | };
100 |
101 | assert!(args.files_from_stdin());
102 | assert_eq!(args.files.len(), 0);
103 | }
104 |
--------------------------------------------------------------------------------
/vim-superdiff/autoload/superdiff.vim:
--------------------------------------------------------------------------------
1 | let s:json_loaded = v:false
2 | let s:json = {}
3 |
4 | function! superdiff#load(filename) abort
5 | let s:json = json_decode(readfile(a:filename))
6 | let s:json_loaded = v:true
7 |
8 | if empty(s:json.matches)
9 | echoerr 'superdiff: file loaded with zero matches'
10 | else
11 | echon 'superdiff: file loaded with ' len(s:json.matches) ' matches'
12 | endif
13 | endfunction
14 |
15 | function! superdiff#unload()
16 | let s:json = {}
17 | let s:json_loaded = v:false
18 |
19 | call sign_unplace('superdiff')
20 |
21 | echon 'superdiff: file unloaded from memory'
22 | endfunction
23 |
24 | function! superdiff#query_local_matches() abort
25 | if !s:json_loaded
26 | echoerr 'superdiff: no file loaded; did you forget to :SDLoad?'
27 | endif
28 |
29 | let bufnr = bufnr('%')
30 | let current_filename = expand('%')
31 | let loclist = s:collect_blocks_by_filename_to_loclist(current_filename, s:json.matches)
32 |
33 | if empty(loclist)
34 | echon 'superdiff: no matches found'
35 | return
36 | else
37 | echon 'superdiff: found ' len(loclist) ' matching elements'
38 | endif
39 |
40 | if g:superdiff_hl_on_call_local
41 | call s:hl_loclist(loclist)
42 | endif
43 |
44 | call sort(loclist, {i1, i2 -> i1.lnum - i2.lnum})
45 | call setloclist(bufnr, loclist)
46 |
47 | lopen
48 | endfunction
49 |
50 | function! superdiff#query_matches()
51 | if !s:json_loaded
52 | echoerr 'superdiff: no file loaded; did you forget to :SDLoad?'
53 | endif
54 |
55 | let lineno = line('.')
56 | let bufnr = bufnr('%')
57 | let current_filename = expand('%')
58 | let loclist = []
59 | for m in s:json.matches
60 | if !has_key(m.files, current_filename)
61 | continue
62 | endif
63 |
64 | let is_line_within_match = v:false
65 | for block_info in m.blocks[current_filename]
66 | if s:line_in_block(lineno, block_info.starting_line, block_info.block_length)
67 | let is_line_within_match = v:true
68 | break
69 | endif
70 | endfor
71 |
72 | if is_line_within_match
73 | let loclist = loclist + s:blocks_to_loclist(current_filename, m.blocks)
74 | endif
75 | endfor
76 |
77 | if empty(loclist)
78 | echoerr 'superdiff: no matches on current line; view local matches by running :SDLocal'
79 | else
80 | echon 'superdiff: found ' len(loclist) ' matching elements'
81 | endif
82 |
83 | call sort(loclist, {i1, i2 -> i1.lnum - i2.lnum})
84 | call sort(loclist, {i1, i2 -> i1.filename - i2.filename})
85 | call uniq(loclist)
86 | call setloclist(bufnr, loclist)
87 |
88 | lopen
89 | endfunction
90 |
91 | function! superdiff#hl_matches()
92 | if !s:json_loaded
93 | echoerr 'superdiff: no file loaded; did you forget to :SDLoad?'
94 | endif
95 |
96 | let current_filename = expand('%')
97 | let loclist = s:collect_blocks_by_filename_to_loclist(current_filename, s:json.matches)
98 |
99 | call s:hl_loclist(loclist)
100 | endfunction
101 |
102 | function! s:hl_loclist(loclist)
103 | let bufnr = bufnr('%')
104 | call sign_unplace('superdiff', { 'buffer': bufnr })
105 |
106 | for item in a:loclist
107 | for lineno in range(item.lnum, item.lnum + item.size)
108 | call sign_place(0, 'superdiff', 'SuperdiffMatch', bufnr, { 'lnum': lineno, 'priority': 5 })
109 | endfor
110 | endfor
111 | endfunction
112 |
113 | function! s:collect_blocks_by_filename_to_loclist(filename, matches)
114 | let bufnr = bufnr('%')
115 | let loclist = []
116 |
117 | for m in a:matches
118 | if !has_key(m.files, a:filename)
119 | continue
120 | endif
121 |
122 | for block_info in m.blocks[a:filename]
123 | let lnum = block_info.starting_line
124 | let size = block_info.block_length - 1
125 | if size > 0
126 | let text = s:truncate_line(lnum) . ' (' . l:size . ' more lines)'
127 | else
128 | let text = s:truncate_line(lnum)
129 | endif
130 |
131 | call add(loclist, {
132 | \ 'bufnr': bufnr,
133 | \ 'lnum': lnum,
134 | \ 'size': size,
135 | \ 'text': text,
136 | \ })
137 | endfor
138 | endfor
139 |
140 | return loclist
141 | endfunction
142 |
143 | function! s:blocks_to_loclist(current_filename, blocks)
144 | let loclist = []
145 | for [filename, block_infos] in items(a:blocks)
146 | for i in block_infos
147 | call add(loclist, {
148 | \ 'filename': filename,
149 | \ 'lnum': i.starting_line,
150 | \ 'size': i.block_length,
151 | \ 'text': i.block_length . ' line(s)',
152 | \ })
153 | endfor
154 | endfor
155 |
156 | return loclist
157 | endfunction
158 |
159 | function! s:line_in_block(lineno, startline, size)
160 | return a:startline <= a:lineno && a:lineno <= a:startline + a:size
161 | endfunction
162 |
163 | function! s:truncate_line(lineno)
164 | let original = getline(a:lineno)
165 | if strwidth(original) > g:superdiff_loctext_maxwidth
166 | return original[:g:superdiff_loctext_maxwidth] . '...'
167 | else
168 | return original
169 | endif
170 | endfunction
171 |
--------------------------------------------------------------------------------
/vim-superdiff/doc/superdiff.txt:
--------------------------------------------------------------------------------
1 | *superdiff.txt* Quickly navigate between similar code blocks.
2 |
3 | Author: Cheuk Yin Ng
4 | License: Same as the `superdiff` script itself
5 |
6 | INTRODUCTION *superdiff*
7 |
8 | Reading a long report from `superdiff` output takes some effort. This plugin
9 | reduces the effort required by putting everything into the Vim system (in
10 | terms of location lists and highlighting).
11 |
12 | TERMINOLOGY *superdiff-terms*
13 |
14 | Matching block(s)
15 |
16 | A set of blocks that are found by `superdiff` to be similar to other matching
17 | blocks.
18 |
19 | TYPICAL WORKFLOW *superdiff-workflow*
20 |
21 | We'll start from the terminal (not Vim yet).
22 |
23 | 1. Change directory to the project directory.
24 | 2. Run the `superdiff` script on relevant files. Remember to set
25 | `--reporting-mode` to `json`.
26 | 3. Open Vim in the project directory.
27 | 4. Run |:SDLoad| {json} to load the report into memory
28 | 5. Open a file to edit.
29 | 6. Run |:SDLocal| or |:SDHLLocal| to programmically or visually mark where
30 | matching blocks are.
31 | 7. Navigate the cursor until it is inside one of these matching blocks.
32 | 8. Run |:SDQuery| to programmically mark blocks that are similar to the one
33 | you are hovering over.
34 | 9. Navigate to these similar blocks using |location-list| functions such as
35 | |:lnext| or |:lopen|.
36 |
37 | COMMANDS *superdiff-commands*
38 |
39 | :SDLoad {json} *:SDLoad*
40 |
41 | Load the entire `JSON` report into memory. You must do this before
42 | running any other command.
43 |
44 | :SDLocal *:SDLocal*
45 |
46 | Populate location list with all matching blocks from the current file.
47 | If |g:superdiff_hl_on_call_local| is `1`, also highlights the
48 | lines that contain matching blocks in the gutter.
49 |
50 | You can navigate through the matches using |:lnext|, |:lprev|, and
51 | other |location-list| functions.
52 |
53 | :SDQuery *:SDQuery*
54 |
55 | Populate location list with all blocks that are a part of the current
56 | line. Does not highlight any of them.
57 |
58 | :SDHLLocal *:SDHLLocal*
59 |
60 | Highlights all matching blocks from the current file.
61 |
62 | :SDUnHL *:SDUnHL*
63 |
64 | Removes all highlighting of matching blocks from all files. Equivalent
65 | to the following:
66 | >
67 | sign unplace * group=superdiff
68 | <
69 |
70 | OPTIONS *superdiff-options*
71 |
72 | g:loaded_superdiff *g:loaded_superdiff*
73 |
74 | Automatically set when this plugin is loaded. If you want to not load
75 | this plugin, set this to `0` in your |vimrc|.
76 |
77 | Default: `1`
78 |
79 | g:superdiff_hl_on_call_local *g:superdiff_hl_on_call_local*
80 |
81 | Highlights matching line numbers like in |:SDHLLocal| whenever you
82 | call |:SDLocal|. Set to `0` if you don't want it to automatically
83 | highlight matching line numbers when you call that function.
84 |
85 | Default: `1`
86 |
87 | g:superdiff_loctext_maxwidth *g:superdiff_loctext_maxwidth*
88 |
89 | Max width of the line of text in |setloclist()| before truncation.
90 |
91 | Default: `60`
92 |
93 | vim:et:ft=help:norl:
94 |
--------------------------------------------------------------------------------
/vim-superdiff/doc/tags:
--------------------------------------------------------------------------------
1 | :SDHLLocal superdiff.txt /*:SDHLLocal*
2 | :SDLoad superdiff.txt /*:SDLoad*
3 | :SDLocal superdiff.txt /*:SDLocal*
4 | :SDQuery superdiff.txt /*:SDQuery*
5 | :SDUnHL superdiff.txt /*:SDUnHL*
6 | g:loaded_superdiff superdiff.txt /*g:loaded_superdiff*
7 | g:superdiff_hl_on_call_local superdiff.txt /*g:superdiff_hl_on_call_local*
8 | g:superdiff_loctext_maxwidth superdiff.txt /*g:superdiff_loctext_maxwidth*
9 | superdiff superdiff.txt /*superdiff*
10 | superdiff-commands superdiff.txt /*superdiff-commands*
11 | superdiff-options superdiff.txt /*superdiff-options*
12 | superdiff-terms superdiff.txt /*superdiff-terms*
13 | superdiff-workflow superdiff.txt /*superdiff-workflow*
14 | superdiff.txt superdiff.txt /*superdiff.txt*
15 |
--------------------------------------------------------------------------------
/vim-superdiff/plugin/superdiff.vim:
--------------------------------------------------------------------------------
1 | " superdiff.vim - Navigate around the JSON reports of the superdiff script
2 | " Maintainer: Cheuk Yin Ng
3 | " Version: 1.1
4 |
5 | if exists('g:loaded_superdiff')
6 | finish
7 | endif
8 |
9 | let g:loaded_superdiff = 1
10 |
11 | command! -nargs=1 -complete=file SDLoad call superdiff#load()
12 | command! -nargs=0 SDUnload call superdiff#unload()
13 | command! -nargs=0 SDLocal call superdiff#query_local_matches()
14 | command! -nargs=0 SDQuery call superdiff#query_matches()
15 | command! -nargs=0 SDHLLocal call superdiff#hl_matches()
16 | command! -nargs=0 SDUnHL sign unplace * group=superdiff
17 |
18 | if !exists('g:superdiff_loctext_maxwidth')
19 | let g:superdiff_loctext_maxwidth = 60
20 | endif
21 |
22 | if !exists('g:superdiff_hl_on_call_local')
23 | let g:superdiff_hl_on_call_local = 1
24 | endif
25 |
26 | sign define SuperdiffMatch numhl=Match numhl=ErrorMsg
27 |
--------------------------------------------------------------------------------