fortitude 0.3.0

A Fortran linter, written in Rust and installable with Python
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

use crate::ast::FortitudeNode;
use crate::settings::Settings;
use crate::{ASTRule, Rule, Violation};
use tree_sitter::Node;
/// Defines rules that require the user to explicitly specify the kinds of any reals.
pub struct ImplicitRealKind {}

impl Rule for ImplicitRealKind {
    fn new(_settings: &Settings) -> Self {
        ImplicitRealKind {}
    }

    fn explain(&self) -> &'static str {
        "
        Real variable declarations without an explicit kind will have a compiler/platform
        dependent precision, which hurts portability and may lead to surprising loss of
        precision in some cases.
        "
    }
}

impl ASTRule for ImplicitRealKind {
    fn check(&self, node: &Node, src: &str) -> Option<Vec<Violation>> {
        let dtype = node.child(0)?.to_text(src)?.to_lowercase();

        if !matches!(dtype.as_str(), "real" | "complex") {
            return None;
        }

        if node.child_by_field_name("kind").is_some() {
            return None;
        }

        let msg = format!("{dtype} has implicit kind");
        some_vec![Violation::from_node(msg, node)]
    }

    fn entrypoints(&self) -> Vec<&'static str> {
        vec!["intrinsic_type"]
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::settings::default_settings;
    use crate::violation;
    use pretty_assertions::assert_eq;
    use textwrap::dedent;

    #[test]
    fn test_implicit_real_kind() -> anyhow::Result<()> {
        let source = dedent(
            "
            real function my_func(a, b, c, d, e)       ! catch
              real, intent(in) :: a                    ! catch
              real(4), intent(in) :: b                 ! ignore
              integer, intent(in) :: c                 ! ignore
              complex, intent(in) :: d                 ! catch
              complex(8), intent(in) :: e              ! ignore

              myfunc = a
            end function my_func
            ",
        );

        let expected: Vec<Violation> = [(2, 1, "real"), (3, 3, "real"), (6, 3, "complex")]
            .iter()
            .map(|(line, col, dtype)| {
                let msg = format!("{dtype} has implicit kind");
                violation!(&msg, *line, *col)
            })
            .collect();

        let rule = ImplicitRealKind::new(&default_settings());
        let actual = rule.apply(source.as_str())?;
        assert_eq!(actual, expected);

        Ok(())
    }
}