tldr-cli 0.1.3

CLI binary for TLDR code analysis tool
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
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
//! Abstract Interpretation CLI command
//!
//! Performs abstract interpretation for range tracking, nullability analysis,
//! and safety checks (division-by-zero, null dereference detection).
//!
//! # Usage
//!
//! ```bash
//! tldr abstract-interp <file> <function> [-f json|text]
//! tldr abstract-interp src/main.py process_data --var x
//! tldr abstract-interp src/main.py process_data --line 42
//! tldr abstract-interp src/main.py process_data --check_zero divisor
//! tldr abstract-interp src/main.py process_data --check_null ptr
//! ```
//!
//! # Output
//!
//! - JSON: Full AbstractInterpInfo with state_in/state_out per block
//! - Text: Human-readable summary with safety warnings highlighted
//!
//! # Reference
//! - dataflow/spec.md (CAP-AI-01 through CAP-AI-22)

use std::path::PathBuf;

use anyhow::Result;
use clap::Args;

use tldr_core::dataflow::{compute_abstract_interp, AbstractInterpInfo, Nullability};
use tldr_core::{get_cfg_context, get_dfg_context, Language};

use crate::output::OutputFormat;

/// Analyze abstract values (ranges, nullability) for safety checks
#[derive(Debug, Args)]
pub struct AbstractInterpArgs {
    /// Source file to analyze
    pub file: PathBuf,

    /// Function name to analyze
    pub function: String,

    /// Programming language (auto-detected from file extension if not specified)
    #[arg(long, short = 'l')]
    pub lang: Option<Language>,

    /// Show abstract value for a specific variable
    #[arg(long)]
    pub var: Option<String>,

    /// Show abstract state at a specific line number
    #[arg(long)]
    pub line: Option<usize>,

    /// Check if a variable may be zero (potential division-by-zero)
    #[arg(long)]
    pub check_zero: Option<String>,

    /// Check if a variable may be null (potential null dereference)
    #[arg(long)]
    pub check_null: Option<String>,

    /// Show only safety warnings (division-by-zero, null dereference)
    #[arg(long)]
    pub warnings_only: bool,
}

impl AbstractInterpArgs {
    /// Run the abstract interpretation command
    pub fn run(&self, format: OutputFormat, quiet: bool) -> Result<()> {
        use crate::output::OutputWriter;

        let writer = OutputWriter::new(format, quiet);

        // Determine language from file extension or argument
        let language = self.lang.unwrap_or_else(|| {
            Language::from_path(&self.file).unwrap_or(Language::Python)
        });

        let lang_str = match language {
            Language::Python => "python",
            Language::TypeScript => "typescript",
            Language::Go => "go",
            Language::Rust => "rust",
            Language::JavaScript => "javascript",
            _ => "python", // Default fallback for other languages
        };

        writer.progress(&format!(
            "Analyzing abstract interpretation for {} in {}...",
            self.function,
            self.file.display()
        ));

        // Read source file - ensure it exists
        if !self.file.exists() {
            return Err(anyhow::anyhow!(
                "File not found: {}",
                self.file.display()
            ));
        }

        // Read source for line mapping
        let source = std::fs::read_to_string(&self.file)?;
        let source_lines: Vec<&str> = source.lines().collect();

        // Get CFG for the function
        let cfg = get_cfg_context(
            self.file.to_str().unwrap_or_default(),
            &self.function,
            language,
        )?;

        // Get DFG for variable references
        let dfg = get_dfg_context(
            self.file.to_str().unwrap_or_default(),
            &self.function,
            language,
        )?;

        // Compute abstract interpretation
        let result = compute_abstract_interp(&cfg, &dfg, Some(&source_lines), lang_str)?;

        // Handle specific queries
        if let Some(ref var) = self.var {
            return self.handle_var_query(&result, var, &writer);
        }

        if let Some(line) = self.line {
            return self.handle_line_query(&result, line, &writer);
        }

        if let Some(ref var) = self.check_zero {
            return self.handle_check_zero_query(&result, var, &writer);
        }

        if let Some(ref var) = self.check_null {
            return self.handle_check_null_query(&result, var, &writer);
        }

        if self.warnings_only {
            return self.handle_warnings_only(&result, &writer, format);
        }

        // Default: output full result
        match format {
            OutputFormat::Json => {
                let json_value = result.to_json();
                let json = serde_json::to_string_pretty(&json_value)
                    .map_err(|e| anyhow::anyhow!("JSON serialization failed: {}", e))?;
                writer.write_text(&json)?;
            }
            OutputFormat::Text => {
                let text = self.format_text_output(&result);
                writer.write_text(&text)?;
            }
            OutputFormat::Compact => {
                let json_value = result.to_json();
                let json = serde_json::to_string(&json_value)
                    .map_err(|e| anyhow::anyhow!("JSON serialization failed: {}", e))?;
                writer.write_text(&json)?;
            }
            _ => {
                let json_value = result.to_json();
                let json = serde_json::to_string_pretty(&json_value)
                    .map_err(|e| anyhow::anyhow!("JSON serialization failed: {}", e))?;
                writer.write_text(&json)?;
            }
        }

        Ok(())
    }

    fn handle_var_query(
        &self,
        result: &AbstractInterpInfo,
        var: &str,
        writer: &crate::output::OutputWriter,
    ) -> Result<()> {
        // Find the abstract value for this variable across all blocks
        let mut values = Vec::new();

        for (block_id, state) in &result.state_out {
            let abstract_val = state.values.get(var);
            if let Some(val) = abstract_val {
                let range_str = val.range_.as_ref().map(|(low, high)| {
                    let l = low.map_or("?".to_string(), |v| v.to_string());
                    let h = high.map_or("?".to_string(), |v| v.to_string());
                    vec![l, h]
                });
                values.push(serde_json::json!({
                    "block": block_id,
                    "type": val.type_,
                    "range": range_str,
                    "nullable": format!("{:?}", val.nullable),
                    "constant": val.constant,
                }));
            }
        }

        let output = serde_json::json!({
            "variable": var,
            "abstract_values": values,
        });

        let json = serde_json::to_string_pretty(&output)
            .map_err(|e| anyhow::anyhow!("JSON serialization failed: {}", e))?;
        writer.write_text(&json)?;
        Ok(())
    }

    fn handle_line_query(
        &self,
        result: &AbstractInterpInfo,
        line: usize,
        writer: &crate::output::OutputWriter,
    ) -> Result<()> {
        // Find the abstract state at the given line
        let mut state_at_line = serde_json::Map::new();

        // Collect all variables and their values from all exit states
        for (_block_id, state) in &result.state_out {
            for (var, val) in &state.values {
                let range_str = val.range_.as_ref().map(|(low, high)| {
                    let l = low.map_or("?".to_string(), |v| v.to_string());
                    let h = high.map_or("?".to_string(), |v| v.to_string());
                    vec![l, h]
                });
                state_at_line.insert(
                    var.clone(),
                    serde_json::json!({
                        "type": val.type_,
                        "range": range_str,
                        "nullable": format!("{:?}", val.nullable),
                        "constant": val.constant,
                    }),
                );
            }
        }

        let output = serde_json::json!({
            "line": line,
            "state": state_at_line,
        });

        let json = serde_json::to_string_pretty(&output)
            .map_err(|e| anyhow::anyhow!("JSON serialization failed: {}", e))?;
        writer.write_text(&json)?;
        Ok(())
    }

    fn handle_check_zero_query(
        &self,
        result: &AbstractInterpInfo,
        var: &str,
        writer: &crate::output::OutputWriter,
    ) -> Result<()> {
        // Check if this variable may be zero
        let mut may_be_zero = false;
        let mut must_be_zero = false;
        let mut range_info: Option<Vec<String>> = None;

        for (_block_id, state) in &result.state_out {
            if let Some(abstract_val) = state.values.get(var) {
                if let Some(ref range) = abstract_val.range_ {
                    let low = range.0.unwrap_or(i64::MIN);
                    let high = range.1.unwrap_or(i64::MAX);
                    // Check if range includes zero
                    if low <= 0 && high >= 0 {
                        may_be_zero = true;
                    }
                    if low == 0 && high == 0 {
                        must_be_zero = true;
                    }
                    range_info = Some(vec![
                        range.0.map_or("?".to_string(), |v| v.to_string()),
                        range.1.map_or("?".to_string(), |v| v.to_string()),
                    ]);
                }
            }
        }

        // Also check if this var appears in potential_div_zero
        let in_warnings = result
            .potential_div_zero
            .iter()
            .any(|(_line, v)| v == var);

        let output = serde_json::json!({
            "variable": var,
            "may_be_zero": may_be_zero,
            "must_be_zero": must_be_zero,
            "range": range_info,
            "flagged_in_warnings": in_warnings,
            "safe_for_division": !may_be_zero,
        });

        let json = serde_json::to_string_pretty(&output)
            .map_err(|e| anyhow::anyhow!("JSON serialization failed: {}", e))?;
        writer.write_text(&json)?;
        Ok(())
    }

    fn handle_check_null_query(
        &self,
        result: &AbstractInterpInfo,
        var: &str,
        writer: &crate::output::OutputWriter,
    ) -> Result<()> {
        // Check if this variable may be null
        let mut nullability = Nullability::Never;

        for (_block_id, state) in &result.state_out {
            if let Some(abstract_val) = state.values.get(var) {
                // Take the "worst" nullability
                match abstract_val.nullable {
                    Nullability::Always => nullability = Nullability::Always,
                    Nullability::Maybe if nullability != Nullability::Always => {
                        nullability = Nullability::Maybe
                    }
                    _ => {}
                }
            }
        }

        // Also check if this var appears in potential_null_deref
        let in_warnings = result
            .potential_null_deref
            .iter()
            .any(|(_line, v)| v == var);

        let output = serde_json::json!({
            "variable": var,
            "nullability": format!("{:?}", nullability),
            "may_be_null": matches!(nullability, Nullability::Maybe | Nullability::Always),
            "must_be_null": matches!(nullability, Nullability::Always),
            "flagged_in_warnings": in_warnings,
            "safe_for_dereference": matches!(nullability, Nullability::Never),
        });

        let json = serde_json::to_string_pretty(&output)
            .map_err(|e| anyhow::anyhow!("JSON serialization failed: {}", e))?;
        writer.write_text(&json)?;
        Ok(())
    }

    fn handle_warnings_only(
        &self,
        result: &AbstractInterpInfo,
        writer: &crate::output::OutputWriter,
        format: OutputFormat,
    ) -> Result<()> {
        let output = serde_json::json!({
            "potential_division_by_zero": result.potential_div_zero,
            "potential_null_dereference": result.potential_null_deref,
            "total_warnings": result.potential_div_zero.len() + result.potential_null_deref.len(),
        });

        match format {
            OutputFormat::Text => {
                let mut text = String::from("Safety Warnings:\n\n");

                if result.potential_div_zero.is_empty() && result.potential_null_deref.is_empty() {
                    text.push_str("  No warnings detected.\n");
                } else {
                    if !result.potential_div_zero.is_empty() {
                        text.push_str("  Division by zero risks:\n");
                        for (line, var) in &result.potential_div_zero {
                            text.push_str(&format!("    - Line {}: variable '{}' may be zero\n", line, var));
                        }
                    }

                    if !result.potential_null_deref.is_empty() {
                        text.push_str("  Null dereference risks:\n");
                        for (line, var) in &result.potential_null_deref {
                            text.push_str(&format!("    - Line {}: variable '{}' may be null\n", line, var));
                        }
                    }
                }
                writer.write_text(&text)?;
                Ok(())
            }
            _ => {
                let json = serde_json::to_string_pretty(&output)
                    .map_err(|e| anyhow::anyhow!("JSON serialization failed: {}", e))?;
                writer.write_text(&json)?;
                Ok(())
            }
        }
    }

    fn format_text_output(&self, result: &AbstractInterpInfo) -> String {
        let mut output = String::new();

        output.push_str(&format!(
            "Abstract Interpretation: {} in {}\n\n",
            self.function,
            self.file.display()
        ));

        // Show safety warnings first
        let total_warnings = result.potential_div_zero.len() + result.potential_null_deref.len();
        if total_warnings > 0 {
            output.push_str(&format!("Safety Warnings ({}):\n", total_warnings));

            for (line, var) in &result.potential_div_zero {
                output.push_str(&format!("  [DIV0] Line {}: '{}' may be zero\n", line, var));
            }

            for (line, var) in &result.potential_null_deref {
                output.push_str(&format!("  [NULL] Line {}: '{}' may be null\n", line, var));
            }
            output.push('\n');
        } else {
            output.push_str("No safety warnings detected.\n\n");
        }

        // Show variable states per block
        output.push_str("Variable states by block:\n");
        let mut blocks: Vec<_> = result.state_out.keys().collect();
        blocks.sort();

        for block_id in blocks {
            if let Some(state) = result.state_out.get(block_id) {
                if !state.values.is_empty() {
                    output.push_str(&format!("  Block {}:\n", block_id));
                    for (var, val) in &state.values {
                        let range_str = val
                            .range_
                            .as_ref()
                            .map(|(low, high)| {
                                let l = low.map_or("?".to_string(), |v| v.to_string());
                                let h = high.map_or("?".to_string(), |v| v.to_string());
                                format!("[{}, {}]", l, h)
                            })
                            .unwrap_or_else(|| "?".to_string());
                        let null_str = match val.nullable {
                            Nullability::Never => "non-null",
                            Nullability::Maybe => "nullable",
                            Nullability::Always => "null",
                        };
                        output.push_str(&format!("    {}: {} {}\n", var, range_str, null_str));
                    }
                }
            }
        }

        output
    }
}