1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
use std::env::current_dir;
use std::fmt::Write;
use std::sync::mpsc::channel;
use std::time::Instant;
use std::{
fmt, fs, io,
iter::FromIterator,
path::{Path, PathBuf},
};
use rnix::{
types::{AttrSet, EntryHolder, Ident, TokenWrapper, TypedNode},
SmolStr,
SyntaxKind::*,
AST,
};
use walkdir::WalkDir;
use crate::threadpool::ThreadPool;
use crate::{is_ignored, is_searchable};
const DEBUG_TIMERS: bool = false;
struct Timer(Instant);
impl Timer {
fn new() -> Self {
Self(Instant::now())
}
fn debug_print(&self, name: &str) {
if DEBUG_TIMERS {
let time = self.0.elapsed();
eprintln!(
"{}: {:0.4} ms",
name,
time.as_millis() as f64 + time.subsec_millis() as f64 / 1000.
);
}
}
}
#[derive(Clone, Debug)]
enum MemoValue<T> {
Uncomputed,
Failed,
Value(T),
}
impl<T> Default for MemoValue<T> {
fn default() -> Self {
Self::Uncomputed
}
}
impl<T> MemoValue<T> {
fn get_or_compute<F>(&mut self, f: F) -> Option<&T>
where
F: FnOnce() -> Option<T>,
{
match self {
MemoValue::Uncomputed => {
*self = f().map(MemoValue::Value).unwrap_or(MemoValue::Failed);
if let MemoValue::Value(ref v) = self {
Some(v)
} else {
None
}
}
MemoValue::Failed => None,
MemoValue::Value(ref v) => Some(v),
}
}
}
enum Kind {
Function,
Member,
}
#[derive(Clone, Copy, Debug)]
struct InternedPath(usize);
macro_rules! impl_from {
($on:ty, $variant:ident, $ty:ty) => {
impl From<$ty> for $on {
fn from(f: $ty) -> $on {
<$on>::$variant(f)
}
}
};
}
#[derive(Debug)]
pub enum Error {
Io(io::Error),
}
impl_from!(Error, Io, io::Error);
struct Tag {
name: SmolStr,
path: InternedPath,
addr: SmolStr,
kind: Kind,
}
impl fmt::Display for Kind {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Kind::Function => write!(f, "f"),
Kind::Member => write!(f, "m"),
}
}
}
fn escape(a: &str) -> String {
let magics = ['\\', '/', '$', '^'];
let mut result = String::new();
for c in a.chars() {
if magics.contains(&c) {
result.push('\\');
}
result.push(c);
}
result
}
fn make_addr(a: &str) -> SmolStr {
SmolStr::from_iter(["/^", &escape(a), "$/"].iter().cloned())
}
impl Tag {
fn to_string_relative_to(
&self,
paths: &[PathBuf],
p: &Path,
memo: &mut Vec<MemoValue<PathBuf>>,
out: &mut String,
) -> Option<()> {
let relpath =
memo[self.path.0].get_or_compute(|| pathdiff::diff_paths(&paths[self.path.0], p))?;
write!(
out,
"{}\t{}\t{};\"\t{}",
self.name,
relpath.display(),
make_addr(&self.addr),
self.kind
)
.ok()?;
Some(())
}
}
struct FileJob<'a> {
file: InternedPath,
source: &'a str,
results: &'a mut Vec<Tag>,
}
impl<'a> FileJob<'a> {
fn visit_attrset(&mut self, set: &AttrSet) {
for ent in set.entries() {
let tag = (|| {
let val = ent.value()?;
let key = ent.key()?;
let kind = match val.kind() {
NODE_LAMBDA => Kind::Function,
_ => Kind::Member,
};
let defined_at_start = key.node().text_range().start().to_usize();
let prior = &self.source[..defined_at_start];
let line_start = prior.rfind('\n').unwrap_or(0);
let after = &self.source[defined_at_start..];
let line_end = after
.find('\n')
.unwrap_or(self.source.len() - defined_at_start);
let source_line = &self.source[line_start..defined_at_start + line_end];
let source_line = source_line.strip_prefix('\n').unwrap_or(source_line);
let ident = key.path().last().and_then(Ident::cast);
let ident_name = ident.as_ref().map(|id| id.as_str())?;
Some(Tag {
name: ident_name.into(),
path: self.file.clone(),
addr: source_line.into(),
kind,
})
})();
if let Some(tag) = tag {
self.results.push(tag);
}
}
}
fn exec(&mut self, ast: &AST) {
for evt in ast.node().preorder_with_tokens() {
match evt {
rnix::WalkEvent::Enter(ent) => {
if let Some(set) = ent.into_node().and_then(AttrSet::cast) {
self.visit_attrset(&set);
}
}
rnix::WalkEvent::Leave(_) => (),
}
}
}
pub fn run(p_interned: InternedPath, p: &Path) -> Result<Vec<Tag>, Error> {
assert!(p.is_absolute());
let contents = fs::read_to_string(p)?;
let parsed = rnix::parse(&contents);
let mut results = Vec::new();
let mut job = FileJob {
file: p_interned,
source: &contents,
results: &mut results,
};
job.exec(&parsed);
results.sort_unstable_by(|e1, e2| e1.name.as_str().cmp(e2.name.as_str()));
Ok(results)
}
}
fn write_header(mut writer: impl io::Write) -> Result<(), Error> {
writeln!(writer, "!_TAG_FILE_FORMAT\t2\t/extended format/")?;
writeln!(
writer,
"!_TAG_FILE_SORTED\t1\t/0=unsorted, 1=sorted, 2=foldcase/"
)?;
writeln!(writer, "!_TAG_FILE_ENCODING\tutf-8\t//")?;
writeln!(writer, "!_TAG_PROGRAM_NAME\tnix-doc tags\t//")?;
writeln!(
writer,
"!_TAG_PROGRAM_URL\thttps://github.com/lf-/nix-doc\t//"
)?;
Ok(())
}
pub fn run_on_dir(dir: &Path, mut writer: impl io::Write) -> Result<(), Error> {
let pool = ThreadPool::default();
let (tx, rx) = channel();
let mut paths_interned = Vec::new();
let curdir = current_dir()?;
let walk_t = Timer::new();
for direntry in WalkDir::new(dir)
.into_iter()
.filter_entry(|e| !is_ignored(e))
.filter_map(|e| e.ok())
.filter(|e| is_searchable(e.path()) && e.path().is_file())
{
let path = curdir.join(direntry.into_path());
let path_ = path.clone();
paths_interned.push(path);
let path_interned = InternedPath(paths_interned.len() - 1);
let my_tx = tx.clone();
pool.push(move || {
let results = FileJob::run(path_interned, &path_);
let results = match results {
Ok(v) => v,
Err(e) => {
eprintln!("Error processing {}: {:?}", &path_.display(), e);
return;
}
};
if !results.is_empty() {
my_tx.send(results).expect("failed to send tags");
}
});
}
drop(tx);
pool.done();
walk_t.debug_print("walk time");
let mut out = Vec::new();
while let Ok(set) = rx.recv() {
out.extend(set);
}
let sort_t = Timer::new();
out.sort_by(|e1, e2| e1.name.as_str().cmp(e2.name.as_str()));
sort_t.debug_print("final sort time");
let write_t = Timer::new();
write_header(&mut writer)?;
let mut memo = vec![MemoValue::Uncomputed; paths_interned.len()];
let mut out_s = String::new();
for tag in out {
out_s.clear();
match tag.to_string_relative_to(&paths_interned, &curdir, &mut memo, &mut out_s) {
Some(_) => (),
None => continue,
};
writer.write(out_s.as_bytes())?;
writer.write(b"\n")?;
}
write_t.debug_print("write time");
Ok(())
}
#[cfg(test)]
mod tests {
use std::{
env::{current_dir, set_current_dir},
path::PathBuf,
};
use super::*;
use expect_test::{expect, Expect};
fn check(dir: &str, expected: Expect) {
let dir = PathBuf::from(dir);
let curdir = current_dir().unwrap();
println!("datadir: {}", &dir.display());
set_current_dir(dir).unwrap();
let mut out = Vec::new();
run_on_dir(&PathBuf::from("."), &mut out).unwrap();
let out_s = std::str::from_utf8(&out).unwrap();
println!("{}", out_s);
expected.assert_eq(out_s.trim());
set_current_dir(curdir).unwrap();
}
#[test]
fn smoke() {
check(
"testdata",
expect![[r#"
!_TAG_FILE_FORMAT 2 /extended format/
!_TAG_FILE_SORTED 1 /0=unsorted, 1=sorted, 2=foldcase/
!_TAG_FILE_ENCODING utf-8 //
!_TAG_PROGRAM_NAME nix-doc tags //
!_TAG_PROGRAM_URL https://github.com/lf-/nix-doc //
c test.nix /^ a.b.c = a: 1;$/;" f
fixedWidthString regression-11.nix /^ fixedWidthString = width: filler: str:$/;" f
the-fn test.nix /^ the-fn = a: b: {z = a; y = b;};$/;" f
the-snd-fn test.nix /^ the-snd-fn = {b, \/* doc *\/ c}: {};$/;" f
withFeature regression-11.nix /^ withFeature = with_: feat: "--\${if with_ then "with" else "without"}-\${feat}";$/;" f
withFeatureAs regression-11.nix /^ withFeatureAs = with_: feat: value: withFeature with_ feat + optionalString with_ "=\${value}";$/;" f
y test.nix /^ the-fn = a: b: {z = a; y = b;};$/;" m
z test.nix /^ the-fn = a: b: {z = a; y = b;};$/;" m"#]],
);
}
}