cargo-modules 0.26.0

A cargo plugin for showing a tree-like overview of a crate's modules.
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use std::{cmp::Ordering, fmt};

use hir::db::HirDatabase;
use ra_ap_hir::{self as hir, HasVisibility as _};
use ra_ap_ide::Edition;

#[derive(Clone, PartialEq, Eq, Debug)]
pub enum ItemVisibility {
    Crate,
    Module(String),
    Private,
    Public,
    Super,
}

impl ItemVisibility {
    pub fn new(hir: hir::ModuleDef, db: &dyn HirDatabase, edition: Edition) -> Self {
        let visibility = hir.visibility(db);

        let parent_module = match hir.module(db) {
            Some(module) => module,
            None => return Self::Public,
        };

        let grandparent_module = parent_module.parent(db);
        let krate_module = parent_module.krate(db).root_module(db);

        match visibility {
            hir::Visibility::Module(visibility_module_id, _visibility_explicity) => {
                let visibility_module = hir::Module::from(visibility_module_id);
                if visibility_module == krate_module {
                    Self::Crate
                } else if Some(visibility_module) == grandparent_module {
                    // For some reason we actually have to match against the grandparent.
                    Self::Super
                } else if visibility_module == parent_module {
                    // For some reason we actually have to match against the parent.
                    Self::Private
                } else {
                    let visibility_module_def_hir = hir::ModuleDef::Module(visibility_module);
                    let path = visibility_module_def_hir
                        .canonical_path(db, edition)
                        .unwrap();
                    Self::Module(path)
                }
            }
            hir::Visibility::PubCrate(_) => Self::Crate,
            hir::Visibility::Public => Self::Public,
        }
    }

    fn numerical_order(&self) -> isize {
        match self {
            ItemVisibility::Public => 0,
            ItemVisibility::Crate => 1,
            ItemVisibility::Module(_) => 2,
            ItemVisibility::Super => 3,
            ItemVisibility::Private => 4,
        }
    }
}

impl PartialOrd for ItemVisibility {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for ItemVisibility {
    fn cmp(&self, other: &Self) -> Ordering {
        match self.numerical_order().cmp(&other.numerical_order()) {
            ord @ Ordering::Less => ord,
            ord @ Ordering::Equal => match (self, other) {
                (ItemVisibility::Module(lhs), ItemVisibility::Module(rhs)) => lhs.cmp(rhs),
                _ => ord,
            },
            ord @ Ordering::Greater => ord,
        }
    }
}

impl fmt::Display for ItemVisibility {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ItemVisibility::Crate => write!(f, "pub(crate)"),
            ItemVisibility::Module(path) => write!(f, "pub(in crate::{path})"),
            ItemVisibility::Private => write!(f, "pub(self)"),
            ItemVisibility::Public => write!(f, "pub"),
            ItemVisibility::Super => write!(f, "pub(super)"),
        }
    }
}