"Fossies" - the Fresh Open Source Software Archive

Member "rustc-1.72.1-src/src/librustdoc/visit_lib.rs" (13 Sep 2023, 2193 Bytes) of package /linux/misc/rustc-1.72.1-src.tar.xz:

As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Rust source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "visit_lib.rs": 1.68.2_vs_1.69.0.

    1 use crate::core::DocContext;
    2 use rustc_hir::def::DefKind;
    3 use rustc_hir::def_id::{DefId, DefIdSet};
    4 use rustc_middle::ty::TyCtxt;
    5 
    6 // FIXME: this may not be exhaustive, but is sufficient for rustdocs current uses
    7 
    8 #[derive(Default)]
    9 pub(crate) struct RustdocEffectiveVisibilities {
   10     extern_public: DefIdSet,
   11 }
   12 
   13 macro_rules! define_method {
   14     ($method:ident) => {
   15         pub(crate) fn $method(&self, tcx: TyCtxt<'_>, def_id: DefId) -> bool {
   16             match def_id.as_local() {
   17                 Some(def_id) => tcx.effective_visibilities(()).$method(def_id),
   18                 None => self.extern_public.contains(&def_id),
   19             }
   20         }
   21     };
   22 }
   23 
   24 impl RustdocEffectiveVisibilities {
   25     define_method!(is_directly_public);
   26     define_method!(is_exported);
   27     define_method!(is_reachable);
   28 }
   29 
   30 pub(crate) fn lib_embargo_visit_item(cx: &mut DocContext<'_>, def_id: DefId) {
   31     assert!(!def_id.is_local());
   32     LibEmbargoVisitor {
   33         tcx: cx.tcx,
   34         extern_public: &mut cx.cache.effective_visibilities.extern_public,
   35         visited_mods: Default::default(),
   36     }
   37     .visit_item(def_id)
   38 }
   39 
   40 /// Similar to `librustc_privacy::EmbargoVisitor`, but also takes
   41 /// specific rustdoc annotations into account (i.e., `doc(hidden)`)
   42 struct LibEmbargoVisitor<'a, 'tcx> {
   43     tcx: TyCtxt<'tcx>,
   44     // Effective visibilities for reachable nodes
   45     extern_public: &'a mut DefIdSet,
   46     // Keeps track of already visited modules, in case a module re-exports its parent
   47     visited_mods: DefIdSet,
   48 }
   49 
   50 impl LibEmbargoVisitor<'_, '_> {
   51     fn visit_mod(&mut self, def_id: DefId) {
   52         if !self.visited_mods.insert(def_id) {
   53             return;
   54         }
   55 
   56         for item in self.tcx.module_children(def_id).iter() {
   57             if let Some(def_id) = item.res.opt_def_id() {
   58                 if item.vis.is_public() {
   59                     self.visit_item(def_id);
   60                 }
   61             }
   62         }
   63     }
   64 
   65     fn visit_item(&mut self, def_id: DefId) {
   66         if !self.tcx.is_doc_hidden(def_id) {
   67             self.extern_public.insert(def_id);
   68             if self.tcx.def_kind(def_id) == DefKind::Mod {
   69                 self.visit_mod(def_id);
   70             }
   71         }
   72     }
   73 }