forked from helix-editor/helix
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This introduces a custom URI type in core meant to be extended later if we want to support other schemes. For now it's just a wrapper over a PathBuf. We use this new URI type to firewall `lsp::Url`. This was previously done in 8141a4a but using a custom URI type is more flexible and will improve the way Pickers handle paths for previews in the child commit(s). Co-authored-by: soqb <[email protected]>
- Loading branch information
1 parent
4082820
commit f4a433f
Showing
9 changed files
with
235 additions
and
64 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| use std::path::{Path, PathBuf}; | ||
|
|
||
| /// A generic pointer to a file location. | ||
| /// | ||
| /// Currently this type only supports paths to local files. | ||
| #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)] | ||
| #[non_exhaustive] | ||
| pub enum Uri { | ||
| File(PathBuf), | ||
| } | ||
|
|
||
| impl Uri { | ||
| // This clippy allow mirrors url::Url::from_file_path | ||
| #[allow(clippy::result_unit_err)] | ||
| pub fn to_url(&self) -> Result<url::Url, ()> { | ||
| match self { | ||
| Uri::File(path) => url::Url::from_file_path(path), | ||
| } | ||
| } | ||
|
|
||
| pub fn as_path(&self) -> Option<&Path> { | ||
| match self { | ||
| Self::File(path) => Some(path), | ||
| } | ||
| } | ||
|
|
||
| pub fn as_path_buf(self) -> Option<PathBuf> { | ||
| match self { | ||
| Self::File(path) => Some(path), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl From<PathBuf> for Uri { | ||
| fn from(path: PathBuf) -> Self { | ||
| Self::File(path) | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<Uri> for PathBuf { | ||
| type Error = (); | ||
|
|
||
| fn try_from(uri: Uri) -> Result<Self, Self::Error> { | ||
| match uri { | ||
| Uri::File(path) => Ok(path), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
| pub struct UrlConversionError { | ||
| source: url::Url, | ||
| kind: UrlConversionErrorKind, | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
| pub enum UrlConversionErrorKind { | ||
| UnsupportedScheme, | ||
| UnableToConvert, | ||
| } | ||
|
|
||
| impl std::fmt::Display for UrlConversionError { | ||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
| match self.kind { | ||
| UrlConversionErrorKind::UnsupportedScheme => { | ||
| write!(f, "unsupported scheme in URL: {}", self.source.scheme()) | ||
| } | ||
| UrlConversionErrorKind::UnableToConvert => { | ||
| write!(f, "unable to convert URL to file path: {}", self.source) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl std::error::Error for UrlConversionError {} | ||
|
|
||
| fn convert_url_to_uri(url: &url::Url) -> Result<Uri, UrlConversionErrorKind> { | ||
| if url.scheme() == "file" { | ||
| url.to_file_path() | ||
| .map(|path| Uri::File(helix_stdx::path::normalize(path))) | ||
| .map_err(|_| UrlConversionErrorKind::UnableToConvert) | ||
| } else { | ||
| Err(UrlConversionErrorKind::UnsupportedScheme) | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<url::Url> for Uri { | ||
| type Error = UrlConversionError; | ||
|
|
||
| fn try_from(url: url::Url) -> Result<Self, Self::Error> { | ||
| convert_url_to_uri(&url).map_err(|kind| Self::Error { source: url, kind }) | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<&url::Url> for Uri { | ||
| type Error = UrlConversionError; | ||
|
|
||
| fn try_from(url: &url::Url) -> Result<Self, Self::Error> { | ||
| convert_url_to_uri(url).map_err(|kind| Self::Error { | ||
| source: url.clone(), | ||
| kind, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test { | ||
| use super::*; | ||
| use url::Url; | ||
|
|
||
| #[test] | ||
| fn unknown_scheme() { | ||
| let url = Url::parse("csharp:/metadata/foo/bar/Baz.cs").unwrap(); | ||
| assert!(matches!( | ||
| Uri::try_from(url), | ||
| Err(UrlConversionError { | ||
| kind: UrlConversionErrorKind::UnsupportedScheme, | ||
| .. | ||
| }) | ||
| )); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.