fennec-common 0.1.8

Fennec Programming Language
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

// Copyright 2023 Gregory Petrosyan <pgregory@pgregory.net>
//
// 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::{
    ffi::OsStr,
    path::{Component, Path, PathBuf},
};

use crate::{import_path::PACKAGE_RE, SOURCE_EXTENSION};

// https://docs.microsoft.com/en-us/windows/desktop/fileio/naming-a-file
const RESERVED_WINDOWS_NAMES: &[&str] = &[
    "CON", "PRN", "AUX", "NUL", //
    "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", //
    "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9",
];

#[must_use]
pub fn is_reserved_windows_filename(file_name: &str) -> bool {
    RESERVED_WINDOWS_NAMES
        .iter()
        .any(|r| file_name.eq_ignore_ascii_case(r))
}

#[must_use]
pub fn is_valid_utf8_visible(file_name: &OsStr) -> bool {
    file_name // windows: WTF-8, unix: byte slice, usually UTF-8
        .to_str() // maybe UTF-8
        .map_or(false, |s| !s.starts_with('.'))
}

#[must_use]
pub fn valid_package_name(file_name: &str) -> bool {
    PACKAGE_RE.is_match(file_name) && !is_reserved_windows_filename(file_name)
}

#[must_use]
pub fn valid_source_file_name(file_name: &str) -> bool {
    match file_name.rsplit_once('.') {
        Some((name, SOURCE_EXTENSION)) => valid_package_name(name),
        _ => false,
    }
}

// Adapted from the normalize-path crate, MIT license.
#[must_use]
pub fn normalize_path(path: &Path) -> PathBuf {
    let mut components = path.components().peekable();
    let mut ret = if let Some(c @ Component::Prefix(..)) = components.peek() {
        let buf = PathBuf::from(c.as_os_str());
        components.next();
        buf
    } else {
        PathBuf::new()
    };

    for component in components {
        match component {
            Component::Prefix(..) => unreachable!(),
            Component::RootDir => {
                ret.push(component.as_os_str());
            }
            Component::CurDir => {}
            Component::ParentDir => {
                ret.pop();
            }
            Component::Normal(c) => {
                ret.push(c);
            }
        }
    }

    ret
}