a2kit 4.4.0

Retro disk image and language utility
Documentation 
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

//! Module to format lines of Merlin code
//! 
//! There are three tasks here:
//! * format a line of code for beauty
//! * format a line of code for pasting into Merlin emulators
//! * format as the user types into an editor
//! 
//! In some cases the tokenizer is passed as an argument, because one
//! formatting strategy is to tokenize then detokenize.

use std::sync::Arc;
use lsp_types as lsp;
use crate::lang::{self, lsp_range, range_contains_pos, translate_pos, node_text};
use crate::lang::{Navigate,Navigation,Document};
use crate::DYNERR;

const RCH: &str = "unreachable was reached";

pub enum ColumnStyle {
    Pasteable,
    Variable,
    Tabs
}

/// Format line of code using given style.
/// This relies on being able to split the line on COLUMN_SEPARATOR, as is the
/// case after detokenization or disassembly. 
pub fn format_tokens(line: &str, style: &ColumnStyle, widths: [usize;3]) -> String {
	let cols = line.split(super::COLUMN_SEPARATOR);
	let mut ans = String::new();
	let mut col_idx = 0;
    match style {
        ColumnStyle::Pasteable => {
            for col in cols {
                ans += col;
                ans += " ";
            }
        },
        ColumnStyle::Tabs => {
            for col in cols {
                ans += col;
                ans += "\t";
            }
        },
        _ => {
            for col in cols {
                let mut prepadding = 0;
                if let Some(c) = col.chars().next() {
                    if c==';' {
                        for j in col_idx..3 {
                            prepadding += widths[j];
                        }
                    }
                }
                let w = match col_idx {
                    i if i<3 => widths[i],
                    _ => 1
                };
                let padding = match w as i32 - col.len() as i32 {
                    x if x<1 => 1,
                    x => x as usize
                };
                ans += &" ".repeat(prepadding);
                ans += col;
                ans += &" ".repeat(padding);
                col_idx += 1;
            }
        }
    }
    ans.trim_end().to_string()
}

pub fn format_for_paste(program: String, tokenizer: &mut super::tokenizer::Tokenizer) -> Result<String,DYNERR> {
    tokenizer.set_style(ColumnStyle::Pasteable);
    let img = tokenizer.tokenize(program)?;
    tokenizer.detokenize(&img)
}

pub fn format_range(program: String, sel: lsp::Range, tokenizer: &mut super::tokenizer::Tokenizer) -> Result<Vec<lsp::TextEdit>,DYNERR> {
    let mut formatted_range = String::new();
    let line_count = program.lines().count() as u32;
    tokenizer.set_style(ColumnStyle::Variable);
    let mut row = 0;
    for line in program.lines() {
        if sel.start==sel.end || (row >= sel.start.line && row <= sel.end.line) {
            let img = tokenizer.tokenize(line.to_string())?;
            formatted_range += &tokenizer.detokenize(&img)?;
        }
        row += 1;
    }
    let (start,end) = match sel.start==sel.end {
        true => (lsp::Position::new(0,0), lsp::Position::new(line_count,0)),
        false => (lsp::Position::new(sel.start.line,0),lsp::Position::new(sel.end.line+1,0))
    };
    Ok(vec![lsp::TextEdit::new(lsp::Range::new(start,end), formatted_range)])
}

/// Handles format on type only, other formatting is handled by module level functions, which
/// delegate parsing to the tokenizer.
pub struct Formatter
{
	parser: super::MerlinParser,
    normalized_line: String,
    search_pos: lsp::Position,
    verbatim: bool,
	widths: [usize;3],
	symbols: Arc<super::Symbols>,
    c2_regex: regex::Regex,
    c3_regex: regex::Regex,
    c4_regex: regex::Regex,
}

impl Formatter {
    pub fn new() -> Self {
        Self {
            parser: super::MerlinParser::new(),
            normalized_line: String::new(),
            search_pos: lsp::Position::new(0,0),
            verbatim: false,
            widths: [9,6,11],
            symbols: Arc::new(super::Symbols::new()),
            c2_regex: regex::Regex::new(r"^\S*\s+$").expect(RCH),
            c3_regex: regex::Regex::new(r"^\S*\s+\S+\s*$").expect(RCH),
            c4_regex: regex::Regex::new(r"^\S*\s+\S+\s+\S+\s*$").expect(RCH)
        }
    }
	pub fn set_config(&mut self,settings: &super::settings::Settings) {
		let c1: usize = settings.columns.c1.try_into().or::<usize>(Ok(9)).unwrap();
		let c2: usize = settings.columns.c2.try_into().or::<usize>(Ok(6)).unwrap();
		let c3: usize = settings.columns.c3.try_into().or::<usize>(Ok(11)).unwrap();
		self.widths = [c1,c2,c3];
	}
	pub fn use_shared_symbols(&mut self,sym: Arc<super::Symbols>) {
        self.symbols = sym;
    }
	fn set_verbatim(&mut self, doc: &Document, position: lsp::Position)
	{
		self.search_pos = position;
        self.verbatim = false;
        if let Some(line) = doc.text.lines().nth(position.line as usize) {
            if let Ok(tree) = self.parser.parse(line,&self.symbols) {
                self.normalized_line = self.parser.line().to_string();
                if let Ok(()) = self.walk(&tree) {
                    return;
                }
            }
        }
	}
    pub fn format_typing(&mut self, doc: &Document, position: lsp::Position, ch: &str) -> Vec<lsp::TextEdit> {
        let stop1 = self.widths[0];
        let stop2 = self.widths[0] + self.widths[1];
        let stop3 = self.widths[0] + self.widths[1] + self.widths[2];
        match ch {
            ";" => self.set_verbatim(doc, translate_pos(&position,0,-1)),
            _ => self.set_verbatim(doc, position.clone())
        };
        if self.normalized_line.starts_with(super::CALL_TOK) {
            self.normalized_line = self.normalized_line[super::CALL_TOK.len_utf8()..].to_string();
        }
        if self.normalized_line.len() < position.character as usize {
            return Vec::new();
        }
        if self.verbatim {
            return Vec::new();
        }
        if ch == ";" && (position.character<2 || self.normalized_line[position.character as usize-2..position.character as usize-1]==*" ") {
            if position.character as usize <= stop3 {
                let new_text = " ".repeat(stop3 - position.character as usize + 1) + ";";
                let rng = lsp::Range::new(translate_pos(&position, 0, -1),position);
                return vec![lsp::TextEdit::new(rng, new_text)];
            }
        }
        // Now that persistent spaces are in place we can safely use regex
        if ch == " " {
            let txt = &self.normalized_line[0..position.character as usize];
            let rng = lsp::Range::new(position.clone(),position.clone());
            if self.c2_regex.is_match(txt) && (position.character as usize) < stop1 {
                return vec![lsp::TextEdit::new(rng," ".repeat(stop1 - position.character as usize))];
            }
            if self.c3_regex.is_match(txt) && (position.character as usize) < stop2 {
                return vec![lsp::TextEdit::new(rng," ".repeat(stop2 - position.character as usize))];
            }
            if self.c4_regex.is_match(txt) && (position.character as usize) < stop3 {
                return vec![lsp::TextEdit::new(rng," ".repeat(stop3 - position.character as usize))];
            }
        }
        return Vec::new();
    }    
}

impl lang::Navigate for Formatter
{
    fn visit(&mut self, curs: &tree_sitter::TreeCursor) -> Result<Navigation,DYNERR>
    {
        // go down as deep as possible and see if we are in a verbatim node,
        // and also replace persistent white space with any non white space ASCII.
        if ["dstring","txt","literal","macro_ref"].contains(&curs.node().kind()) {
            let mut include_end = 0;
            if curs.node().kind()=="macro_ref" {
                if let Some(parent) = curs.node().parent() {
                    if parent.kind() == "arg_pmc" {
                        include_end = 1;
                    } else {
                        return Ok(Navigation::GotoChild);
                    }
                }
            }
            let rng = lsp_range(curs.node().range(), self.search_pos.line as isize, self.parser.col_offset() + include_end);
            let replacement = node_text(&curs.node(),self.parser.line()).replace(" ","A").replace("\t","A");
            self.normalized_line.replace_range(rng.start.character as usize..rng.end.character as usize,&replacement);
            if range_contains_pos(&rng, &self.search_pos) {
                self.verbatim = true;
            }
        }
		return Ok(Navigation::GotoChild);
    }
}