     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

    // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! ncurses-compatible database discovery
    //!
    //! Does not support hashed database, only filesystem!

    use std::env;
    use std::fs;
    use std::path::PathBuf;

    /// Return path to database entry for `term`
    #[allow(deprecated)]
    pub fn get_dbpath_for_term(term: &str) -> Option<PathBuf> {
        let mut dirs_to_search = Vec::new();
        let first_char = term.chars().next()?;

        // Find search directory
        if let Some(dir) = env::var_os("TERMINFO") {
            dirs_to_search.push(PathBuf::from(dir));
        }

        if let Ok(dirs) = env::var("TERMINFO_DIRS") {
            for i in dirs.split(':') {
                if i == "" {
                    dirs_to_search.push(PathBuf::from("/usr/share/terminfo"));
                } else {
                    dirs_to_search.push(PathBuf::from(i));
                }
            }
        } else {
            // Found nothing in TERMINFO_DIRS, use the default paths:
            // According to  /etc/terminfo/README, after looking at
            // ~/.terminfo, ncurses will search /etc/terminfo, then
            // /lib/terminfo, and eventually /usr/share/terminfo.
            // On Haiku the database can be found at /boot/system/data/terminfo
            if let Some(mut homedir) = env::home_dir() {
                homedir.push(".terminfo");
                dirs_to_search.push(homedir)
            }

            dirs_to_search.push(PathBuf::from("/etc/terminfo"));
            dirs_to_search.push(PathBuf::from("/lib/terminfo"));
            dirs_to_search.push(PathBuf::from("/usr/share/terminfo"));
            dirs_to_search.push(PathBuf::from("/boot/system/data/terminfo"));
        }

        // Look for the terminal in all of the search directories
        for mut p in dirs_to_search {
            if fs::metadata(&p).is_ok() {
                p.push(&first_char.to_string());
                p.push(&term);
                if fs::metadata(&p).is_ok() {
                    return Some(p);
                }
                p.pop();
                p.pop();

                // on some installations the dir is named after the hex of the char
                // (e.g. macOS)
                p.push(&format!("{:x}", first_char as usize));
                p.push(term);
                if fs::metadata(&p).is_ok() {
                    return Some(p);
                }
            }
        }
        None
    }

    #[test]
    #[ignore(reason = "buildbots don't have ncurses installed and I can't mock everything I need")]
    fn test_get_dbpath_for_term() {
        // woefully inadequate test coverage
        // note: current tests won't work with non-standard terminfo hierarchies (e.g. macOS's)
        use std::env;
        // FIXME (#9639): This needs to handle non-utf8 paths
        fn x(t: &str) -> String {
            let p = get_dbpath_for_term(t).expect("no terminfo entry found");
            p.to_str().unwrap().to_string()
        }
        assert!(x("screen") == "/usr/share/terminfo/s/screen");
        assert!(get_dbpath_for_term("") == None);
        env::set_var("TERMINFO_DIRS", ":");
        assert!(x("screen") == "/usr/share/terminfo/s/screen");
        env::remove_var("TERMINFO_DIRS");
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)