src/libstd/sys/windows/path.rs

   1 use crate::ffi::OsStr;
   2 use crate::mem;
   3 use crate::path::Prefix;
   4
   5 #[cfg(test)]
   6 mod tests;
   7
   8 pub const MAIN_SEP_STR: &str = "\\";
   9 pub const MAIN_SEP: char = '\\';
  10
  11 // The unsafety here stems from converting between `&OsStr` and `&[u8]`
  12 // and back. This is safe to do because (1) we only look at ASCII
  13 // contents of the encoding and (2) new &OsStr values are produced
  14 // only from ASCII-bounded slices of existing &OsStr values.
  15 fn os_str_as_u8_slice(s: &OsStr) -> &[u8] {
  16     unsafe { mem::transmute(s) }
  17 }
  18 unsafe fn u8_slice_as_os_str(s: &[u8]) -> &OsStr {
  19     mem::transmute(s)
  20 }
  21
  22 #[inline]
  23 pub fn is_sep_byte(b: u8) -> bool {
  24     b == b'/' || b == b'\\'
  25 }
  26
  27 #[inline]
  28 pub fn is_verbatim_sep(b: u8) -> bool {
  29     b == b'\\'
  30 }
  31
  32 // In most DOS systems, it is not possible to have more than 26 drive letters.
  33 // See <https://en.wikipedia.org/wiki/Drive_letter_assignment#Common_assignments>.
  34 pub fn is_valid_drive_letter(disk: u8) -> bool {
  35     disk.is_ascii_alphabetic()
  36 }
  37
  38 pub fn parse_prefix(path: &OsStr) -> Option<Prefix<'_>> {
  39     use Prefix::{DeviceNS, Disk, Verbatim, VerbatimDisk, VerbatimUNC, UNC};
  40
  41     let path = os_str_as_u8_slice(path);
  42
  43     // \\
  44     if let Some(path) = path.strip_prefix(br"\\") {
  45         // \\?\
  46         if let Some(path) = path.strip_prefix(br"?\") {
  47             // \\?\UNC\server\share
  48             if let Some(path) = path.strip_prefix(br"UNC\") {
  49                 let (server, share) = match get_first_two_components(path, is_verbatim_sep) {
  50                     Some((server, share)) => unsafe {
  51                         (u8_slice_as_os_str(server), u8_slice_as_os_str(share))
  52                     },
  53                     None => (unsafe { u8_slice_as_os_str(path) }, OsStr::new("")),
  54                 };
  55                 return Some(VerbatimUNC(server, share));
  56             } else {
  57                 // \\?\path
  58                 match path {
  59                     // \\?\C:\path
  60                     [c, b':', b'\\', ..] if is_valid_drive_letter(*c) => {
  61                         return Some(VerbatimDisk(c.to_ascii_uppercase()));
  62                     }
  63                     // \\?\cat_pics
  64                     _ => {
  65                         let idx = path.iter().position(|&b| b == b'\\').unwrap_or(path.len());
  66                         let slice = &path[..idx];
  67                         return Some(Verbatim(unsafe { u8_slice_as_os_str(slice) }));
  68                     }
  69                 }
  70             }
  71         } else if let Some(path) = path.strip_prefix(b".\\") {
  72             // \\.\COM42
  73             let idx = path.iter().position(|&b| b == b'\\').unwrap_or(path.len());
  74             let slice = &path[..idx];
  75             return Some(DeviceNS(unsafe { u8_slice_as_os_str(slice) }));
  76         }
  77         match get_first_two_components(path, is_sep_byte) {
  78             Some((server, share)) if !server.is_empty() && !share.is_empty() => {
  79                 // \\server\share
  80                 return Some(unsafe { UNC(u8_slice_as_os_str(server), u8_slice_as_os_str(share)) });
  81             }
  82             _ => {}
  83         }
  84     } else if let [c, b':', ..] = path {
  85         // C:
  86         if is_valid_drive_letter(*c) {
  87             return Some(Disk(c.to_ascii_uppercase()));
  88         }
  89     }
  90     None
  91 }
  92
  93 /// Returns the first two path components with predicate `f`.
  94 ///
  95 /// The two components returned will be use by caller
  96 /// to construct `VerbatimUNC` or `UNC` Windows path prefix.
  97 ///
  98 /// Returns [`None`] if there are no separators in path.
  99 fn get_first_two_components(path: &[u8], f: fn(u8) -> bool) -> Option<(&[u8], &[u8])> {
 100     let idx = path.iter().position(|&x| f(x))?;
 101     // Panic safe
 102     // The max `idx+1` is `path.len()` and `path[path.len()..]` is a valid index.
 103     let (first, path) = (&path[..idx], &path[idx + 1..]);
 104     let idx = path.iter().position(|&x| f(x)).unwrap_or(path.len());
 105     let second = &path[..idx];
 106     Some((first, second))
 107 }