summaryrefslogtreecommitdiff
path: root/helix-term/src/commands.rs
blob: bbd78092fef7b65a674cc41c959e0b7d0eb7ec35 (plain) (blame)
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
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
use helix_core::{
    comment, graphemes,
    indent::TAB_WIDTH,
    object,
    regex::{self, Regex},
    register, selection,
    state::{Direction, Granularity, State},
    Change, ChangeSet, Range, Selection, Tendril, Transaction,
};

use once_cell::sync::Lazy;

use crate::compositor::Compositor;
use crate::ui::{self, Popup, Prompt, PromptEvent};

use helix_view::{
    document::Mode,
    view::{View, PADDING},
    Document, Editor,
};

pub struct Context<'a> {
    pub count: usize,
    pub editor: &'a mut Editor,
    pub executor: &'static smol::Executor<'static>,

    pub callback: Option<crate::compositor::Callback>,
}

impl<'a> Context<'a> {
    #[inline]
    pub fn view(&mut self) -> &mut View {
        self.editor.view_mut()
    }

    #[inline]
    pub fn doc(&mut self) -> &mut Document {
        &mut self.editor.view_mut().doc
    }

    /// Push a new component onto the compositor.
    pub fn push_layer(&mut self, component: Box<dyn crate::compositor::Component>) {
        self.callback = Some(Box::new(
            |compositor: &mut Compositor, editor: &mut Editor| {
                compositor.push(component);
            },
        ));
    }
}

/// A command is a function that takes the current state and a count, and does a side-effect on the
/// state (usually by creating and applying a transaction).
pub type Command = fn(cx: &mut Context);

pub fn move_char_left(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc
        .state
        .move_selection(Direction::Backward, Granularity::Character, count);
    doc.set_selection(selection);
}

pub fn move_char_right(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc
        .state
        .move_selection(Direction::Forward, Granularity::Character, count);
    doc.set_selection(selection);
}

pub fn move_line_up(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc
        .state
        .move_selection(Direction::Backward, Granularity::Line, count);
    doc.set_selection(selection);
}

pub fn move_line_down(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc
        .state
        .move_selection(Direction::Forward, Granularity::Line, count);
    doc.set_selection(selection);
}

pub fn move_line_end(cx: &mut Context) {
    let doc = cx.doc();
    let lines = selection_lines(&doc.state);

    let positions = lines
        .into_iter()
        .map(|index| {
            // adjust all positions to the end of the line.

            // Line end is pos at the start of next line - 1
            // subtract another 1 because the line ends with \n
            doc.text().line_to_char(index + 1).saturating_sub(2)
        })
        .map(|pos| Range::new(pos, pos));

    let selection = Selection::new(positions.collect(), 0);

    doc.set_selection(selection);
}

pub fn move_line_start(cx: &mut Context) {
    let doc = cx.doc();
    let lines = selection_lines(&doc.state);

    let positions = lines
        .into_iter()
        .map(|index| {
            // adjust all positions to the start of the line.
            doc.text().line_to_char(index)
        })
        .map(|pos| Range::new(pos, pos));

    let selection = Selection::new(positions.collect(), 0);

    doc.set_selection(selection);
}

pub fn move_next_word_start(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let pos = State::move_next_word_start(doc.text().slice(..), doc.selection().cursor(), count);

    doc.set_selection(Selection::point(pos));
}

pub fn move_prev_word_start(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let pos = State::move_prev_word_start(doc.text().slice(..), doc.selection().cursor(), count);

    doc.set_selection(Selection::point(pos));
}

pub fn move_next_word_end(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let pos = State::move_next_word_end(doc.text().slice(..), doc.selection().cursor(), count);

    doc.set_selection(Selection::point(pos));
}

pub fn move_file_start(cx: &mut Context) {
    let doc = cx.doc();
    doc.set_selection(Selection::point(0));

    doc.mode = Mode::Normal;
}

pub fn move_file_end(cx: &mut Context) {
    let doc = cx.doc();
    let text = doc.text();
    let last_line = text.line_to_char(text.len_lines().saturating_sub(2));
    doc.set_selection(Selection::point(last_line));

    doc.mode = Mode::Normal;
}

pub fn extend_next_word_start(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc.selection().transform(|mut range| {
        let pos =
            State::move_next_word_start(doc.text().slice(..), doc.selection().cursor(), count);
        range.head = pos;
        range
    });

    doc.set_selection(selection);
}

pub fn extend_prev_word_start(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc.selection().transform(|mut range| {
        let pos =
            State::move_prev_word_start(doc.text().slice(..), doc.selection().cursor(), count);
        range.head = pos;
        range
    });
    doc.set_selection(selection);
}

pub fn extend_next_word_end(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc.selection().transform(|mut range| {
        let pos = State::move_next_word_end(doc.text().slice(..), doc.selection().cursor(), count);
        range.head = pos;
        range
    });

    doc.set_selection(selection);
}

pub fn page_up(cx: &mut Context) {
    let view = cx.view();
    if view.first_line < PADDING {
        return;
    }

    view.first_line = view.first_line.saturating_sub(view.area.height as usize);

    if !view.check_cursor_in_view() {
        let text = view.doc.text();
        let pos = text.line_to_char(view.last_line().saturating_sub(PADDING));
        view.doc.set_selection(Selection::point(pos));
    }
}

pub fn page_down(cx: &mut Context) {
    let view = cx.view();
    view.first_line += view.area.height as usize + PADDING;

    if view.first_line < view.doc.text().len_lines() {
        let text = view.doc.text();
        let pos = text.line_to_char(view.first_line as usize);
        view.doc.set_selection(Selection::point(pos));
    }
}

pub fn half_page_up(cx: &mut Context) {
    let view = cx.view();
    if view.first_line < PADDING {
        return;
    }

    view.first_line = view
        .first_line
        .saturating_sub(view.area.height as usize / 2);

    if !view.check_cursor_in_view() {
        let text = &view.doc.text();
        let pos = text.line_to_char(view.last_line() - PADDING);
        view.doc.set_selection(Selection::point(pos));
    }
}

pub fn half_page_down(cx: &mut Context) {
    let view = cx.view();
    let lines = view.doc.text().len_lines();
    if view.first_line < lines.saturating_sub(view.area.height as usize) {
        view.first_line += view.area.height as usize / 2;
    }
    if !view.check_cursor_in_view() {
        let text = view.doc.text();
        let pos = text.line_to_char(view.first_line as usize);
        view.doc.set_selection(Selection::point(pos));
    }
}
// avoid select by default by having a visual mode switch that makes movements into selects

pub fn extend_char_left(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc
        .state
        .extend_selection(Direction::Backward, Granularity::Character, count);
    doc.set_selection(selection);
}

pub fn extend_char_right(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc
        .state
        .extend_selection(Direction::Forward, Granularity::Character, count);
    doc.set_selection(selection);
}

pub fn extend_line_up(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc
        .state
        .extend_selection(Direction::Backward, Granularity::Line, count);
    doc.set_selection(selection);
}

pub fn extend_line_down(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let selection = doc
        .state
        .extend_selection(Direction::Forward, Granularity::Line, count);
    doc.set_selection(selection);
}

pub fn select_all(cx: &mut Context) {
    let doc = cx.doc();

    doc.set_selection(Selection::single(
        0,
        doc.text().len_chars().saturating_sub(1),
    ))
}

pub fn select_regex(cx: &mut Context) {
    let prompt = ui::regex_prompt(cx, "select:".to_string(), |doc, regex| {
        let text = doc.text().slice(..);
        // TODO: if select on matches returns empty range, we need to abort
        // if regex empty or no matches, return
        let selection =
            selection::select_on_matches(text, doc.selection(), &regex).expect("no matches");
        doc.set_selection(selection);
    });

    cx.push_layer(Box::new(prompt));
}

pub fn split_selection(cx: &mut Context) {
    // TODO: this needs to store initial selection state, revert on esc, confirm on enter
    // needs to also call the callback function per input change, not just final time.
    // could cheat and put it into completion_fn
    //
    // kakoune does it like this:
    // # save state to register
    // {
    //  # restore state from register
    //  # if event == abort, return early
    //  # add to history if enabled
    //  # update state
    // }

    let prompt = ui::regex_prompt(cx, "split:".to_string(), |doc, regex| {
        let text = doc.text().slice(..);
        let selection = selection::split_on_matches(text, doc.selection(), &regex);
        doc.set_selection(selection);
    });

    cx.push_layer(Box::new(prompt));
}

pub fn split_selection_on_newline(cx: &mut Context) {
    let doc = cx.doc();
    let text = doc.text().slice(..);
    // only compile the regex once
    #[allow(clippy::trivial_regex)]
    static REGEX: Lazy<Regex> = Lazy::new(|| Regex::new(r"\n").unwrap());
    let selection = selection::split_on_matches(text, doc.selection(), &REGEX);
    doc.set_selection(selection);
}

// search: searches for the first occurence in file, provides a prompt
// search_next: reuses the last search regex and searches for the next match. The next match becomes the main selection.
// -> we always search from after the cursor.head
// TODO: be able to use selection as search query (*/alt *)
// I'd probably collect all the matches right now and store the current index. The cache needs
// wiping if input happens.

fn _search(doc: &mut Document, contents: &str, regex: &Regex) {
    let text = doc.text();
    let start = doc.selection().cursor();

    // TODO: use find_at to find the next match after the cursor, loop around the end
    if let Some(mat) = regex.find_at(&contents, start) {
        let start = text.byte_to_char(mat.start());
        let end = text.byte_to_char(mat.end());
        let selection = Selection::single(start, end - 1);
        // TODO: (first_match, regex) stuff in register?
        doc.set_selection(selection);
    };
}

// TODO: use one function for search vs extend
pub fn search(cx: &mut Context) {
    let doc = cx.doc();

    // TODO: could probably share with select_on_matches?

    // HAXX: sadly we can't avoid allocating a single string for the whole buffer since we can't
    // feed chunks into the regex yet
    let contents = doc.text().slice(..).to_string();

    let prompt = ui::regex_prompt(cx, "search:".to_string(), move |doc, regex| {
        let text = doc.text();
        let start = doc.selection().cursor();
        _search(doc, &contents, &regex);

        // TODO: only store on enter (accept), not update
        register::set('\\', vec![regex.as_str().to_string()]);
    });

    cx.push_layer(Box::new(prompt));
}

pub fn search_next(cx: &mut Context) {
    if let Some(query) = register::get('\\') {
        let query = query.first().unwrap();
        let doc = cx.doc();
        let contents = doc.text().slice(..).to_string();
        let regex = Regex::new(&query).unwrap();
        _search(doc, &contents, &regex);
    }
}

pub fn search_selection(cx: &mut Context) {
    let doc = cx.doc();
    let contents = doc.text().slice(..);
    let query = doc.selection().primary().fragment(contents);
    let regex = regex::escape(&query);
    register::set('\\', vec![regex]);
    search_next(cx);
}

// TODO: N -> search_prev
// need to loop around buffer also and show a message
// same for no matches

//

pub fn select_line(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    let pos = doc.selection().primary();
    let text = doc.text();
    let line = text.char_to_line(pos.head);
    let start = text.line_to_char(line);
    let end = text.line_to_char(line + count).saturating_sub(1);

    doc.set_selection(Selection::single(start, end));
}
pub fn extend_line(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();

    let pos = doc.selection().primary();
    let text = doc.text();

    let line_start = text.char_to_line(pos.anchor);
    let mut line = text.char_to_line(pos.head);
    let line_end = text.line_to_char(line + 1).saturating_sub(1);
    if line_start <= pos.anchor && pos.head == line_end && line != text.len_lines() {
        line += 1;
    }

    let start = text.line_to_char(line_start);
    let end = text.line_to_char(line + 1).saturating_sub(1);

    doc.set_selection(Selection::single(start, end));
}

// heuristic: append changes to history after each command, unless we're in insert mode

fn _delete_selection(doc: &mut Document) {
    let transaction =
        Transaction::change_by_selection(&doc.state, |range| (range.from(), range.to() + 1, None));
    doc.apply(&transaction);
}

pub fn delete_selection(cx: &mut Context) {
    let doc = cx.doc();
    _delete_selection(doc);

    doc.append_changes_to_history();
}

pub fn change_selection(cx: &mut Context) {
    let doc = cx.doc();
    _delete_selection(doc);
    insert_mode(cx);
}

pub fn collapse_selection(cx: &mut Context) {
    let doc = cx.doc();
    let selection = doc
        .selection()
        .transform(|range| Range::new(range.head, range.head));

    doc.set_selection(selection);
}

pub fn flip_selections(cx: &mut Context) {
    let doc = cx.doc();
    let selection = doc
        .selection()
        .transform(|range| Range::new(range.head, range.anchor));

    doc.set_selection(selection);
}

fn enter_insert_mode(doc: &mut Document) {
    doc.mode = Mode::Insert;
}

// inserts at the start of each selection
pub fn insert_mode(cx: &mut Context) {
    let doc = cx.doc();
    enter_insert_mode(doc);

    let selection = doc
        .selection()
        .transform(|range| Range::new(range.to(), range.from()));
    doc.set_selection(selection);
}

// inserts at the end of each selection
pub fn append_mode(cx: &mut Context) {
    let doc = cx.doc();
    enter_insert_mode(doc);
    doc.restore_cursor = true;

    let text = doc.text().slice(..);
    let selection = doc.selection().transform(|range| {
        Range::new(
            range.from(),
            graphemes::next_grapheme_boundary(text, range.to()), // to() + next char
        )
    });
    doc.set_selection(selection);
}

const COMMAND_LIST: &[&str] = &["write", "open", "quit"];

// TODO: I, A, o and O can share a lot of the primitives.
pub fn command_mode(cx: &mut Context) {
    let executor = cx.executor;
    let prompt = Prompt::new(
        ":".to_owned(),
        |input: &str| {
            // we use .this over split_ascii_whitespace() because we care about empty segments
            let parts = input.split(' ').collect::<Vec<&str>>();

            // simple heuristic: if there's no space, complete command.
            // if there's a space, file completion kicks in. We should specialize by command later.
            if parts.len() <= 1 {
                COMMAND_LIST
                    .iter()
                    .filter(|command| command.contains(input))
                    .map(|command| std::borrow::Cow::Borrowed(*command))
                    .collect()
            } else {
                let part = parts.last().unwrap();
                ui::completers::filename(part)

                // TODO
                // completion needs to be more advanced: need to return starting index for replace
                // for example, "src/" completion application.rs needs to insert after /, but "hx"
                // completion helix-core needs to replace the text.
                //
                // additionally, completion items could have a info section that would get
                // displayed in a popup above the prompt when items are tabbed over
            }
        }, // completion
        move |editor: &mut Editor, input: &str, event: PromptEvent| {
            if event != PromptEvent::Validate {
                return;
            }

            let parts = input.split_ascii_whitespace().collect::<Vec<&str>>();

            match *parts.as_slice() {
                ["q"] | ["quit"] => {
                    editor.tree.remove(editor.view().id);
                    // editor.should_close = true,
                }
                ["o", path] | ["open", path] => {
                    editor.open(path.into(), executor);
                }
                ["w"] | ["write"] => {
                    // TODO: non-blocking via save() command
                    smol::block_on(editor.view_mut().doc.save());
                }

                _ => (),
            }
        },
    );
    cx.push_layer(Box::new(prompt));
}
pub fn file_picker(cx: &mut Context) {
    let picker = ui::file_picker("./", cx.executor);
    cx.push_layer(Box::new(picker));
}

pub fn buffer_picker(cx: &mut Context) {
    unimplemented!()
    // let picker = ui::buffer_picker(&editor.views, editor.focus);
    // cx.push_layer(Box::new(picker));
}

// calculate line numbers for each selection range
fn selection_lines(state: &State) -> Vec<usize> {
    let mut lines = state
        .selection
        .ranges()
        .iter()
        .map(|range| state.doc.char_to_line(range.head))
        .collect::<Vec<_>>();

    lines.sort_unstable(); // sorting by usize so _unstable is preferred
    lines.dedup();

    lines
}

// I inserts at the start of each line with a selection
pub fn prepend_to_line(cx: &mut Context) {
    let doc = cx.doc();
    enter_insert_mode(doc);

    move_line_start(cx);
}

// A inserts at the end of each line with a selection
pub fn append_to_line(cx: &mut Context) {
    let doc = cx.doc();
    enter_insert_mode(doc);

    move_line_end(cx);
}

// o inserts a new line after each line with a selection
pub fn open_below(cx: &mut Context) {
    let count = cx.count;
    let doc = cx.doc();
    enter_insert_mode(doc);

    let lines = selection_lines(&doc.state);

    let positions = lines.into_iter().map(|index| {
        // adjust all positions to the end of the line (next line minus one)
        doc.text().line_to_char(index + 1).saturating_sub(1)
    });

    let changes: Vec<Change> = positions
        .map(|index| {
            // TODO: share logic with insert_newline for indentation
            let indent_level = helix_core::indent::suggested_indent_for_pos(
                doc.syntax.as_ref(),
                &doc.state,
                index,
                true,
            );
            let indent = " ".repeat(TAB_WIDTH).repeat(indent_level);
            let mut text = String::with_capacity(1 + indent.len());
            text.push('\n');
            text.push_str(&indent);
            let text = text.repeat(count);

            // TODO: ideally we want to run a hook over the transactions to figure out and reindent all
            // \n's as a post-processing step?
            // behaviors:
            // - on insert mode enter: we add newline + indent and position cursor at the end
            // - on 3o/3O: we insert 3 newlines + indents each and position cursors at ends

            // generate changes
            (index, index, Some(text.into()))
        })
        .collect();

    // TODO: count actually inserts "n" new lines and starts editing on all of them.
    // TODO: append "count" newlines and modify cursors to those lines

    let selection = Selection::new(
        changes
            .iter()
            .map(|(start, _end, text): &Change| {
                let len = text.as_ref().map(|text| text.len()).unwrap(); // minus newline
                let pos = start + len;
                Range::new(pos, pos)
            })
            .collect(),
        0,
    );

    let transaction =
        Transaction::change(&doc.state, changes.into_iter()).with_selection(selection);

    doc.apply(&transaction);
}

// O inserts a new line before each line with a selection

pub fn normal_mode(cx: &mut Context) {
    let doc = cx.doc();

    doc.mode = Mode::Normal;

    doc.append_changes_to_history();

    // if leaving append mode, move cursor back by 1
    if doc.restore_cursor {
        let text = doc.text().slice(..);
        let selection = doc.selection().transform(|range| {
            Range::new(
                range.from(),
                graphemes::prev_grapheme_boundary(text, range.to()),
            )
        });
        doc.set_selection(selection);

        doc.restore_cursor = false;
    }
}

pub fn goto_mode(cx: &mut Context) {
    cx.doc().mode = Mode::Goto;
}

pub fn select_mode(cx: &mut Context) {
    cx.doc().mode = Mode::Select;
}

pub fn exit_select_mode(cx: &mut Context) {
    cx.doc().mode = Mode::Normal;
}

// NOTE: Transactions in this module get appended to history when we switch back to normal mode.
pub mod insert {
    use super::*;
    // TODO: insert means add text just before cursor, on exit we should be on the last letter.
    pub fn insert_char(cx: &mut Context, c: char) {
        let doc = cx.doc();
        let c = Tendril::from_char(c);
        let transaction = Transaction::insert(&doc.state, c);

        doc.apply(&transaction);
    }

    pub fn insert_tab(cx: &mut Context) {
        insert_char(cx, '\t');
    }

    pub fn insert_newline(cx: &mut Context) {
        let doc = cx.doc();
        let transaction = Transaction::change_by_selection(&doc.state, |range| {
            let indent_level = helix_core::indent::suggested_indent_for_pos(
                doc.syntax.as_ref(),
                &doc.state,
                range.head,
                true,
            );
            let indent = " ".repeat(TAB_WIDTH).repeat(indent_level);
            let mut text = String::with_capacity(1 + indent.len());
            text.push('\n');
            text.push_str(&indent);
            (range.head, range.head, Some(text.into()))
        });
        doc.apply(&transaction);
    }

    // TODO: handle indent-aware delete
    pub fn delete_char_backward(cx: &mut Context) {
        let count = cx.count;
        let doc = cx.doc();
        let text = doc.text().slice(..);
        let transaction = Transaction::change_by_selection(&doc.state, |range| {
            (
                graphemes::nth_prev_grapheme_boundary(text, range.head, count),
                range.head,
                None,
            )
        });
        doc.apply(&transaction);
    }

    pub fn delete_char_forward(cx: &mut Context) {
        let count = cx.count;
        let doc = cx.doc();
        let text = doc.text().slice(..);
        let transaction = Transaction::change_by_selection(&doc.state, |range| {
            (
                range.head,
                graphemes::nth_next_grapheme_boundary(text, range.head, count),
                None,
            )
        });
        doc.apply(&transaction);
    }
}

pub fn insert_char_prompt(prompt: &mut Prompt, c: char) {
    prompt.insert_char(c);
}

// Undo / Redo

// TODO: each command could simply return a Option<transaction>, then the higher level handles
// storing it?

pub fn undo(cx: &mut Context) {
    cx.doc().undo();
}

pub fn redo(cx: &mut Context) {
    cx.doc().redo();
}

// Yank / Paste

pub fn yank(cx: &mut Context) {
    // TODO: should selections be made end inclusive?
    let doc = cx.doc();
    let values = doc
        .state
        .selection()
        .fragments(doc.text().slice(..))
        .map(|cow| cow.into_owned())
        .collect();

    // TODO: allow specifying reg
    let reg = '"';
    register::set(reg, values);
}

pub fn paste(cx: &mut Context) {
    // TODO: allow specifying reg
    let reg = '"';
    if let Some(values) = register::get(reg) {
        let repeat = std::iter::repeat(
            values
                .last()
                .map(|value| Tendril::from_slice(value))
                .unwrap(),
        );

        // TODO: if any of values ends \n it's linewise paste
        //
        // p => paste after
        // P => paste before
        // alt-p => paste every yanked selection after selected text
        // alt-P => paste every yanked selection before selected text
        // R => replace selected text with yanked text
        // alt-R => replace selected text with every yanked text
        //
        // append => insert at next line
        // insert => insert at start of line
        // replace => replace
        // default insert

        let linewise = values.iter().any(|value| value.ends_with('\n'));

        let mut values = values.into_iter().map(Tendril::from).chain(repeat);

        let doc = cx.doc();

        let transaction = if linewise {
            // paste on the next line
            // TODO: can simply take a range + modifier and compute the right pos without ifs
            let text = doc.text();
            Transaction::change_by_selection(&doc.state, |range| {
                let line_end = text.line_to_char(text.char_to_line(range.head) + 1);
                (line_end, line_end, Some(values.next().unwrap()))
            })
        } else {
            Transaction::change_by_selection(&doc.state, |range| {
                (range.head + 1, range.head + 1, Some(values.next().unwrap()))
            })
        };

        doc.apply(&transaction);
        doc.append_changes_to_history();
    }
}

fn get_lines(doc: &Document) -> Vec<usize> {
    let mut lines = Vec::new();

    // Get all line numbers
    for range in doc.selection().ranges() {
        let start = doc.text().char_to_line(range.from());
        let end = doc.text().char_to_line(range.to());

        for line in start..=end {
            lines.push(line)
        }
    }
    lines.sort_unstable(); // sorting by usize so _unstable is preferred
    lines.dedup();
    lines
}

pub fn indent(cx: &mut Context) {
    let doc = cx.doc();
    let lines = get_lines(doc);

    // Indent by one level
    let indent = Tendril::from(" ".repeat(TAB_WIDTH));

    let transaction = Transaction::change(
        &doc.state,
        lines.into_iter().map(|line| {
            let pos = doc.text().line_to_char(line);
            (pos, pos, Some(indent.clone()))
        }),
    );
    doc.apply(&transaction);
    doc.append_changes_to_history();
}

pub fn unindent(cx: &mut Context) {
    let doc = cx.doc();
    let lines = get_lines(doc);
    let mut changes = Vec::with_capacity(lines.len());

    for line_idx in lines {
        let line = doc.text().line(line_idx);
        let mut width = 0;

        for ch in line.chars() {
            match ch {
                ' ' => width += 1,
                '\t' => width = (width / TAB_WIDTH + 1) * TAB_WIDTH,
                _ => break,
            }

            if width >= TAB_WIDTH {
                break;
            }
        }

        if width > 0 {
            let start = doc.text().line_to_char(line_idx);
            changes.push((start, start + width, None))
        }
    }

    let transaction = Transaction::change(&doc.state, changes.into_iter());

    doc.apply(&transaction);
    doc.append_changes_to_history();
}

pub fn format_selections(cx: &mut Context) {
    use helix_lsp::lsp;
    let doc = cx.doc();

    // via lsp if available
    // else via tree-sitter indentation calculations

    // TODO: blocking here is not ideal

    let ranges: Vec<lsp::Range> = doc
        .selection()
        .ranges()
        .iter()
        .map(|range| {
            helix_lsp::util::range_to_lsp_range(doc.text().slice(..), doc.selection().primary())
        })
        .collect();

    for range in ranges {
        let language_server = match doc.language_server.as_ref() {
            Some(language_server) => language_server,
            None => return,
        };

        // TODO: handle fails
        // TODO: concurrent map
        let edits = smol::block_on(language_server.text_document_range_formatting(
            doc.identifier(),
            range,
            lsp::FormattingOptions::default(),
        ))
        .unwrap_or_default();

        let transaction = helix_lsp::util::generate_transaction_from_edits(&doc.state, edits);

        doc.apply(&transaction);
    }

    doc.append_changes_to_history();
}

pub fn join_selections(cx: &mut Context) {
    use helix_core::state::skip_over_next;
    let doc = cx.doc();
    let text = doc.text();
    let slice = doc.text().slice(..);

    let mut changes = Vec::new();
    let fragment = Tendril::from(" ");

    for selection in doc.selection().ranges() {
        let start = text.char_to_line(selection.from());
        let mut end = text.char_to_line(selection.to());
        if start == end {
            end += 1
        }
        let lines = start..end;

        changes.reserve(lines.len());

        for line in lines {
            let mut start = text.line_to_char(line + 1).saturating_sub(1);
            let mut end = start + 1;
            skip_over_next(slice, &mut end, |ch| matches!(ch, ' ' | '\t'));

            // need to skip from start, not end
            let change = (start, end, Some(fragment.clone()));
            changes.push(change);
        }
    }

    changes.sort_unstable_by_key(|(from, _to, _text)| *from);
    changes.dedup();

    // TODO: joining multiple empty lines should be replaced by a single space.
    // need to merge change ranges that touch

    let transaction = Transaction::change(&doc.state, changes.into_iter());
    // TODO: select inserted spaces
    // .with_selection(selection);

    doc.apply(&transaction);
    doc.append_changes_to_history();
}

pub fn keep_selections(cx: &mut Context) {
    let doc = cx.doc();
    // keep selections matching regex
    // and another method for inverse
}

//

pub fn save(cx: &mut Context) {
    // Spawns an async task to actually do the saving. This way we prevent blocking.

    // TODO: handle save errors somehow?
    cx.executor.spawn(cx.doc().save()).detach();
}

pub fn completion(cx: &mut Context) {
    let doc = cx.doc();

    let language_server = match doc.language_server.as_ref() {
        Some(language_server) => language_server,
        None => return,
    };

    // TODO: blocking here is not ideal
    let pos = helix_lsp::util::pos_to_lsp_pos(doc.text().slice(..), doc.selection().cursor());

    // TODO: handle fails
    let res = smol::block_on(language_server.completion(doc.identifier(), pos)).unwrap_or_default();

    // TODO: if no completion, show some message or something
    if !res.is_empty() {
        let snapshot = doc.state.clone();
        let mut menu = ui::Menu::new(
            res,
            |item| {
                // format_fn
                item.label.as_str().into()

                // TODO: use item.filter_text for filtering
            },
            move |editor: &mut Editor, item, event| {
                match event {
                    PromptEvent::Abort => {
                        // revert state
                        let doc = &mut editor.view_mut().doc;
                        doc.state = snapshot.clone();
                    }
                    PromptEvent::Validate => {
                        let doc = &mut editor.view_mut().doc;

                        // revert state to what it was before the last update
                        doc.state = snapshot.clone();

                        // extract as fn(doc, item):

                        // TODO: need to apply without composing state...
                        // TODO: need to update lsp on accept/cancel by diffing the snapshot with
                        // the final state?
                        // -> on update simply update the snapshot, then on accept redo the call,
                        // finally updating doc.changes + notifying lsp.
                        //
                        // or we could simply use doc.undo + apply when changing between options

                        let item = item.unwrap();

                        use helix_lsp::{lsp, util};
                        // determine what to insert: text_edit | insert_text | label
                        let edit = if let Some(edit) = &item.text_edit {
                            match edit {
                                lsp::CompletionTextEdit::Edit(edit) => edit.clone(),
                                lsp::CompletionTextEdit::InsertAndReplace(item) => {
                                    unimplemented!("completion: insert_and_replace {:?}", item)
                                }
                            }
                        } else {
                            item.insert_text.as_ref().unwrap_or(&item.label);
                            unimplemented!();
                            // lsp::TextEdit::new(); TODO: calculate a TextEdit from insert_text
                            // and we insert at position.
                        };

                        // TODO: merge edit with additional_text_edits
                        if let Some(additional_edits) = &item.additional_text_edits {
                            if !additional_edits.is_empty() {
                                unimplemented!(
                                    "completion: additional_text_edits: {:?}",
                                    additional_edits
                                );
                            }
                        }

                        let transaction =
                            util::generate_transaction_from_edits(&doc.state, vec![edit]);
                        doc.apply(&transaction);
                        // TODO: doc.append_changes_to_history(); if not in insert mode?
                    }
                    _ => (),
                };
            },
        );

        let popup = Popup::new(Box::new(menu));
        cx.push_layer(Box::new(popup));

        // TODO!: when iterating over items, show the docs in popup

        // language server client needs to be accessible via a registry of some sort
    }
}

pub fn hover(cx: &mut Context) {
    use helix_lsp::lsp;

    let doc = cx.doc();

    let language_server = match doc.language_server.as_ref() {
        Some(language_server) => language_server,
        None => return,
    };

    // TODO: factor out a doc.position_identifier() that returns lsp::TextDocumentPositionIdentifier

    // TODO: blocking here is not ideal, make commands async fn?
    // not like we can process additional input meanwhile though
    let pos = helix_lsp::util::pos_to_lsp_pos(doc.text().slice(..), doc.selection().cursor());

    // TODO: handle fails
    let res = smol::block_on(language_server.text_document_hover(doc.identifier(), pos))
        .unwrap_or_default();

    if let Some(hover) = res {
        // hover.contents / .range <- used for visualizing
        let contents = match hover.contents {
            lsp::HoverContents::Scalar(contents) => {
                // markedstring(string/languagestring to be highlighted)
                // TODO
                unimplemented!("{:?}", contents)
            }
            lsp::HoverContents::Array(contents) => {
                unimplemented!("{:?}", contents)
            }
            // TODO: render markdown
            lsp::HoverContents::Markup(contents) => contents.value,
        };

        // skip if contents empty

        let contents = ui::Text::new(contents);
        let mut popup = Popup::new(Box::new(contents));
        cx.push_layer(Box::new(popup));
    }
}

// view movements
pub fn next_view(cx: &mut Context) {
    cx.editor.tree.focus_next()
}

// comments
pub fn toggle_comments(cx: &mut Context) {
    let doc = cx.doc();
    let transaction = comment::toggle_line_comments(&doc.state);

    doc.apply(&transaction);
}

// tree sitter node selection

pub fn expand_selection(cx: &mut Context) {
    let doc = cx.doc();

    if let Some(syntax) = &doc.syntax {
        let text = doc.text().slice(..);
        let selection = object::expand_selection(syntax, text, doc.selection());
        doc.set_selection(selection);
    }
}