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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
|
use bash_builtins::{
builtin_metadata, Args, Builtin, Error, Result
};
use std::ffi::{CString, OsStr};
use std::sync::{Arc, Mutex, OnceLock};
use std::io::{stdout, stderr, Seek, Read, Write};
use std::path::PathBuf;
#[cfg(target_family="unix")]
use std::os::unix::ffi::OsStrExt;
mod shared;
use shared::{Project, DbCtx};
static QROJECT: OnceLock<Arc<Mutex<core::result::Result<QrojectInner, i32>>>> = OnceLock::new();
struct QrojectGo {
inner: Arc<Mutex<core::result::Result<QrojectInner, i32>>>,
}
struct QrojectInfo {
inner: Arc<Mutex<core::result::Result<QrojectInner, i32>>>,
}
struct QrojectDir {
inner: Arc<Mutex<core::result::Result<QrojectInner, i32>>>,
}
struct Qroject {
inner: Arc<Mutex<core::result::Result<QrojectInner, i32>>>
}
impl QrojectGo {
fn new() -> Self {
Self {
inner: QrojectInner::new(),
}
}
}
impl Builtin for QrojectGo {
fn call(&mut self, args: &mut Args) -> Result<()> {
args.no_options()?;
let mut arg_iter = args.raw_arguments();
let projname = arg_iter.next()
.ok_or(Error::ExitCode(1))?
.to_str()
.map_err(|_| Error::ExitCode(2))?
.to_owned();
drop(arg_iter);
args.finished()?;
let mut guard = self.inner.lock().unwrap();
let handle = guard.as_mut()
.map_err(|c| Error::ExitCode(*c))?;
handle.op_go(&projname)
}
}
impl QrojectInfo {
fn new() -> Self {
Self {
inner: QrojectInner::new(),
}
}
}
impl Builtin for QrojectInfo {
fn call(&mut self, args: &mut Args) -> Result<()> {
args.no_options()?;
let mut arg_iter = args.raw_arguments();
let projname = arg_iter.next()
.ok_or(Error::ExitCode(1))?
.to_str()
.map_err(|_| Error::ExitCode(2))?
.to_owned();
drop(arg_iter);
args.finished()?;
let mut guard = self.inner.lock().unwrap();
let handle = guard.as_mut()
.map_err(|c| Error::ExitCode(*c))?;
handle.op_info(&projname)
}
}
impl QrojectDir {
fn new() -> Self {
Self {
inner: QrojectInner::new(),
}
}
}
impl Builtin for QrojectDir {
fn call(&mut self, args: &mut Args) -> Result<()> {
args.no_options()?;
let mut arg_iter = args.raw_arguments();
let projname = arg_iter.next()
.ok_or(Error::ExitCode(1))?
.to_str()
.map_err(|_| Error::ExitCode(2))?
.to_owned();
drop(arg_iter);
args.finished()?;
let mut guard = self.inner.lock().unwrap();
let handle = guard.as_mut()
.map_err(|c| Error::ExitCode(*c))?;
handle.op_dir(&projname)
}
}
impl Qroject {
fn new() -> Self {
Self {
inner: QrojectInner::new(),
}
}
}
unsafe extern "C" {
// from libc. no rustix binding..
fn mkstemp(template: *mut std::ffi::c_char) -> std::ffi::c_int;
fn perror(msg: *const std::ffi::c_char);
// from bash
fn evalstring(
cmd: *const std::ffi::c_char,
from_file: *const std::ffi::c_char,
flags: std::ffi::c_int
) -> std::ffi::c_int;
fn set_working_directory(path: *const std::ffi::c_char);
}
fn project_go_chdir(path: &OsStr) -> Result<()> {
// do the same mechanics as `cd` as in bash/builtins/cd.def, ish.
// that is:
// * `chdir()`,
// * then set_working_directory,
// * then set OLDPWD and PWD.
let prev_pwd = bash_builtins::variables::find_as_string("PWD");
rustix::process::chdir(path).map_err(|e| {
let _ = writeln!(stderr(), "chdir fail: {e}");
Error::ExitCode(5)
})?;
unsafe {
set_working_directory(path.as_bytes().as_ptr() as *const std::ffi::c_char);
}
bash_builtins::variables::set("PWD", path.as_bytes())?;
if let Some(prev_pwd) = prev_pwd {
bash_builtins::variables::set("OLDPWD", prev_pwd.as_bytes())?;
}
Ok(())
}
fn project_go_ssh(host: &str, p: Project) -> Result<()> {
let command = format!(
"ssh {} -t 'cd {}; bash'",
host,
p.dir.display()
);
let cstr = CString::new(command).expect("TODO: it's valid though!");
// from `builtins/common.h`
const SEVAL_NOHIST: std::ffi::c_int = 0x004;
const SEVAL_NOFREE: std::ffi::c_int = 0x008;
let res = unsafe {
evalstring(
cstr.as_bytes().as_ptr() as *const _,
std::ptr::null(),
SEVAL_NOHIST | SEVAL_NOFREE,
)
};
if res != 0 {
let _ = writeln!(stderr(), "could not eval");
return Err(Error::ExitCode(2));
}
Ok(())
}
impl Builtin for Qroject {
fn call(&mut self, args: &mut Args) -> Result<()> {
args.no_options()?;
let mut arg_iter = args.raw_arguments();
let command = arg_iter.next()
.ok_or(Error::ExitCode(1))?
.to_str()
.map_err(|_| Error::ExitCode(2))?
.to_owned();
if command == "init" {
let path = QrojectInner::dbpath();
let Some(path) = path else {
let _ = writeln!(stderr(), "no home dir?");
return Err(Error::ExitCode(2));
};
return match DbCtx::init(path) {
Ok(()) => Ok(()),
Err(e) => {
eprintln!("could not init db: {e}");
Err(Error::ExitCode(3))
}
};
}
let mut guard = self.inner.lock().unwrap();
let handle = guard.as_mut()
.map_err(|c| Error::ExitCode(*c))?;
let maybe_projname = arg_iter.next()
.map(|arg| match arg.to_str() {
Ok(arg) => Ok(arg),
Err(e) => {
let _ = writeln!(stderr(), "failed to read project name: {e:?}");
Err(Error::ExitCode(2))
}
})
.transpose()?;
match command.as_str() {
"info" => {
let projname = maybe_projname
.ok_or(Error::ExitCode(1))?
.to_owned();
// TODO: check per-command remaining arglists..
drop(arg_iter);
args.finished()?;
handle.op_info(&projname)
}
"upstream" => {
let projname = maybe_projname
.ok_or(Error::ExitCode(1))?
.to_owned();
// TODO: check per-command remaining arglists..
drop(arg_iter);
args.finished()?;
handle.op_upstream(&projname)
}
"go" => {
let projname = maybe_projname
.ok_or(Error::ExitCode(1))?
.to_owned();
// TODO: check per-command remaining arglists..
drop(arg_iter);
args.finished()?;
handle.op_go(&projname)
}
"dir" => {
let projname = maybe_projname
.ok_or(Error::ExitCode(1))?
.to_owned();
// TODO: check per-command remaining arglists..
drop(arg_iter);
args.finished()?;
handle.op_dir(&projname)
}
"add" => {
let projname = maybe_projname
.ok_or_else(|| {
let _ = writeln!(stderr(), "q add: q add [project] [projdir]");
Error::ExitCode(1)
})?
.to_owned();
let projdir = arg_iter.next()
.ok_or_else(|| {
let _ = writeln!(stderr(), "q add: q add [project] [projdir]");
Error::ExitCode(1)
})?
.to_str()
.map_err(|_| Error::ExitCode(2))?
.to_owned();
handle.op_add(&projname, &projdir)
}
"edit" => {
let projname = maybe_projname
.ok_or(Error::ExitCode(1))?
.to_owned();
handle.op_edit(&projname)
}
"forget" => {
let projname = maybe_projname
.ok_or(Error::ExitCode(1))?
.to_owned();
handle.op_forget(&projname)
}
"list" => {
let prefix = if let Some(prefix) = maybe_projname {
Some(prefix.to_owned())
} else {
None
};
// TODO: check per-command remaining arglists..
drop(arg_iter);
args.finished()?;
handle.op_list(prefix.as_ref().map(|s| s.as_str()))
}
other => {
let _ = writeln!(stderr(), "unknown command: {}", other);
Err(Error::ExitCode(127))
}
}
}
}
struct QrojectInner {
// can be None if there's no ~/.config/qroject/
db: Option<DbCtx>,
}
impl QrojectInner {
fn dbpath() -> Option<PathBuf> {
let home = std::env::home_dir();
home.map(|mut homedir| {
homedir.push(".config");
homedir.push("qroject");
homedir.push("projects.db");
homedir
})
}
fn new() -> Arc<Mutex<core::result::Result<Self, i32>>> {
let r = QROJECT.get_or_init(|| {
let conn = Self::dbpath().as_ref().map(|p| DbCtx::new(p)).transpose();
let inner = match conn {
Ok(db) => Ok(QrojectInner { db }),
Err(e) => {
eprintln!("{e}");
Err(126)
}
};
Arc::new(Mutex::new(inner))
});
Arc::clone(r)
}
fn op_go(&mut self, projname: &str) -> Result<()> {
let Some(db) = self.db.as_ref() else {
return Err(Error::ExitCode(16));
};
let project = db.project_by_name(&projname)
.map_err(|e| {
let _ = writeln!(stderr(), "could not find project: {e}");
Error::ExitCode(17)
})?;
let Some(p) = project else {
let _ = writeln!(stderr(), "no such project: {}", projname)?;
return Err(Error::ExitCode(4));
};
if p.is_here() {
project_go_chdir(&p.dir)
} else if let Some(host) = p.host.clone().as_ref() {
project_go_ssh(host, p)
} else {
let _ = writeln!(stderr(), "don't know how to get to: {}", projname);
return Err(Error::ExitCode(5));
}
}
fn op_info(&mut self, projname: &str) -> Result<()> {
let Some(db) = self.db.as_ref() else {
return Err(Error::ExitCode(16));
};
let project = db.project_by_name(&projname)
.map_err(|e| {
let _ = writeln!(stderr(), "could not find project: {e}");
Error::ExitCode(17)
})?;
let Some(p) = project else {
let _ = writeln!(stderr(), "no such project: {}", projname)?;
return Err(Error::ExitCode(4));
};
let mut w = stdout();
let _ = writeln!(w, "{}", p.name)?;
let _ = writeln!(w, " {: <8}: {}", "path", p.dir.display())?;
if let Some(info) = p.info.as_ref() {
let _ = writeln!(w, " {: <8}: {}", "info", info)?;
}
if let Some(upstream) = p.upstream.as_ref() {
let _ = writeln!(w, " {: <8}: {}", "upstream", upstream)?;
}
Ok(())
}
fn op_upstream(&mut self, projname: &str) -> Result<()> {
let Some(db) = self.db.as_ref() else {
return Err(Error::ExitCode(16));
};
let project = db.project_by_name(&projname)
.map_err(|e| {
let _ = writeln!(stderr(), "could not find project: {e}");
Error::ExitCode(17)
})?;
let Some(p) = project else {
let _ = writeln!(stderr(), "no such project: {}", projname)?;
return Err(Error::ExitCode(4));
};
let Some(upstream) = p.upstream.as_ref() else {
return Err(Error::ExitCode(1));
};
let mut w = stdout();
let _ = writeln!(w, "{}", upstream)?;
Ok(())
}
fn op_list(&mut self, prefix: Option<&str>) -> Result<()> {
let Some(db) = self.db.as_ref() else {
return Err(Error::ExitCode(16));
};
let print_project_name = |p: Project| {
if let Some(prefix) = prefix {
if !p.name.starts_with(prefix) {
return;
}
}
let _ = writeln!(stdout(), "{}", p.name);
};
db.for_each_project(print_project_name)
.map_err(|e| {
let _ = writeln!(stderr(), "could not list projects: {e}");
Error::ExitCode(2)
})
}
fn op_dir(&mut self, projname: &str) -> Result<()> {
let Some(db) = self.db.as_ref() else {
return Err(Error::ExitCode(16));
};
let project = db.project_by_name(&projname)
.map_err(|e| {
let _ = writeln!(stderr(), "could not find project: {e}");
Error::ExitCode(17)
})?;
let Some(p) = project else {
let _ = writeln!(stderr(), "no such project: {}", projname)?;
return Err(Error::ExitCode(4));
};
if let Some(host) = p.host.as_ref() {
let _ = writeln!(stderr(), "project is at {}, not local", host)?;
return Err(Error::ExitCode(5));
}
let mut w = stdout();
let _ = writeln!(w, "{}", p.dir.display())?;
Ok(())
}
fn op_forget(&mut self, projname: &str) -> Result<()> {
let Some(db) = self.db.as_ref() else {
return Err(Error::ExitCode(16));
};
db.project_forget(&projname)
.map_err(|e| {
let _ = writeln!(stderr(), "could not forget {}: {}", projname, e);
Error::ExitCode(2)
})?;
Ok(())
}
fn op_edit(&mut self, projname: &str) -> Result<()> {
let Some(db) = self.db.as_ref() else {
return Err(Error::ExitCode(16));
};
let project = db.project_by_name(&projname)
.map_err(|e| {
let _ = writeln!(stderr(), "could not find project: {e}");
Error::ExitCode(17)
})?;
let Some(mut p) = project else {
let _ = writeln!(stderr(), "no such project: {}", projname)?;
return Err(Error::ExitCode(4));
};
let mut existing = String::new();
use std::fmt::{Write as FmtWrite};
use std::os::fd::FromRawFd;
writeln!(existing, "name:{}", p.name)
.map_err(|_| Error::ExitCode(5))?;
writeln!(existing, "dir:{}", p.dir.display())
.map_err(|_| Error::ExitCode(5))?;
if let Some(host) = p.host.as_ref() {
writeln!(existing, "host:{}", host)
.map_err(|_| Error::ExitCode(5))?;
}
if let Some(info) = p.info.as_ref() {
writeln!(existing, "info:{}", info)
.map_err(|_| Error::ExitCode(5))?;
}
if let Some(upstream) = p.upstream.as_ref() {
writeln!(existing, "upstream:{}", upstream)
.map_err(|_| Error::ExitCode(5))?;
}
let mut template: [u8; 18] = *b"/tmp/qrojectXXXXXX";
let tmpfd = unsafe { mkstemp(template.as_mut_ptr() as *mut std::ffi::c_char) };
if tmpfd == -1 {
unsafe { perror(b"mkstemp\0".as_ptr() as *const _); }
return Err(Error::ExitCode(5));
}
let mut file = unsafe { std::fs::File::from_raw_fd(tmpfd) };
let res = file.write_all(existing.as_bytes());
if let Err(e) = res {
writeln!(stderr(), "could not write: {:?}", e)?;
return Err(Error::ExitCode(6));
}
let command = format!(
"vim {}",
str::from_utf8(&template[..]).expect("valid")
);
let cstr = CString::new(command).expect("TODO: it's valid though!");
// from `builtins/common.h`
const SEVAL_NOHIST: std::ffi::c_int = 0x004;
const SEVAL_NOFREE: std::ffi::c_int = 0x008;
let res = unsafe {
evalstring(
cstr.as_bytes().as_ptr() as *const _,
std::ptr::null(),
SEVAL_NOHIST | SEVAL_NOFREE,
)
};
if res != 0 {
let _ = writeln!(stderr(), "could not eval");
return Err(Error::ExitCode(2));
}
let mut edited = String::new();
file.rewind()
.map_err(|_e| Error::ExitCode(5))?;
file.read_to_string(&mut edited)
.map_err(|_e| Error::ExitCode(5))?;
let lines = edited.split("\n");
let mut new_name = None;
let mut new_dir = None;
p.host = None;
p.info = None;
p.upstream = None;
for line in lines {
if line.trim().is_empty() {
continue;
}
let Some((field, value)) = line.split_once(":") else {
writeln!(stderr(), "bogus line: {line}")?;
return Err(Error::ExitCode(7));
};
let value = value.to_owned();
if field == "name" {
new_name = Some(value);
} else if field == "dir" {
new_dir = Some(value);
} else if field == "host" {
p.host = Some(value);
} else if field == "info" {
p.info = Some(value);
} else if field == "upstream" {
p.upstream = Some(value);
}
}
let (Some(name), Some(dir)) = (new_name, new_dir) else {
writeln!(stderr(), "missing name or dir")?;
return Err(Error::ExitCode(8));
};
p.name = name;
let dir: &[u8] = dir.as_bytes();
let dir: &std::ffi::OsStr = OsStrExt::from_bytes(dir);
p.dir = dir.to_os_string();
db.project_update(&p)
.map_err(|e| {
let _ = writeln!(stderr(), "failed to update project: {}", e);
Error::ExitCode(9)
})?;
std::fs::remove_file(OsStr::from_bytes(&template))
.map_err(|e| {
let _ = writeln!(stderr(), "couldn't unlink tempfile? {}", e);
Error::ExitCode(10)
})?;
Ok(())
}
fn op_add(&mut self, projname: &str, projdir: &str) -> Result<()> {
let abspath = std::path::absolute(projdir)
.map_err(|_| Error::ExitCode(8))?;
let Some(db) = self.db.as_ref() else {
return Err(Error::ExitCode(16));
};
let new = Project {
id: 0,
name: projname.to_string(),
dir: abspath.into_os_string(),
info: None,
upstream: None,
host: None,
};
db.project_add(new)
.map_err(|e| {
let _ = writeln!(stderr(), "failed to add project: {}", e);
Error::ExitCode(9)
})?;
Ok(())
}
}
builtin_metadata!(
name = "q",
create = Qroject::new,
short_doc = "q {add,go,edit,dir,forget, upstream,info,list} [project]",
long_doc = "project switcher.\n\
\n\
switch to, edit, or print information about, a project. all operations\n\
are either shell built-ins of their own (qg, qi, qd), or subcommands\n\
of this program, \"q\".\n\
\n\
COMMANDS:\n\
\n \
add [projname] [projdir]: add a project named \"projname\" at \n \
\"projdir\" to the project database. if this project should \n \
have additional fields (like info, upstream, ..) it can be edited\n \
after adding.\n \
go [projname]: change directory to \"projname\".\n \
edit [projname]: edit a project definition in vim (not $EDITOR yet, sorry)\n \
dir [projname]: print the directory for \"projname\"\n \
upstream [projname]: print the upstream for \"projname\"\n \
info [projname]: print all info for \"projname\"\n \
forget [projname]: forget about \"projname\". this deletes the row\n \
from the database, does not change any other files. still, be careful.\n \
list [prefix]: list projects, optionally restricting print all info for \"projname\"\n\
",
);
builtin_metadata!(
name = "qg",
create = QrojectGo::new,
short_doc = "qg [project]",
long_doc = "go to [project]",
);
builtin_metadata!(
name = "qi",
create = QrojectInfo::new,
short_doc = "qi [project]",
long_doc = "info for [project]",
);
builtin_metadata!(
name = "qd",
create = QrojectDir::new,
short_doc = "qd [project]",
long_doc = "print directory for [project], if local",
);
// this is probably the kind of software that, circa 2026, you'd ask an LLM to cough up.
// probably would do an ok job of it too, even. see `shoutouts` in the readme for a sense of why i
// didn't. someone put in the work for `bash_builtins`, complete with rather nice docs! i
// appreciate that! in the spirit of collaboration, i wanted to build on that.
//
// stamping out a few thousand lines of emdashful code would not have known about "related
// bindings". try it if you want. there's no love of the game in it. fully spiritless. it's very
// easy to simply Not Care about our peers and neighbors in open source. don't do that. it's
// important to exist, and we only exist if we see each other.
//
// i had fun learning how to put this together and hope you have a bit of fun reading this too. or
// maybe it's just useful, and you never read this; that's ok too.
//
// it's wartful, because of course it is, because *i* coughed this up in basically a day.
// hope you appreciate those too.
|