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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
//! Utilities for parsing X11 display strings.
#![cfg(feature = "std")]
mod connect_instruction;
pub use connect_instruction::ConnectAddress;
use alloc::string::{String, ToString};
/// A parsed X11 display string.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParsedDisplay {
/// The hostname of the computer we nned to connect to.
///
/// This is an empty string if we are connecting to the
/// local host.
pub host: String,
/// The protocol we are communicating over.
///
/// This is `None` if the protocol may be determined
/// automatically.
pub protocol: Option<String>,
/// The index of the display we are connecting to.
pub display: u16,
/// The index of the screen that we are using as the
/// default screen.
pub screen: u16,
}
impl ParsedDisplay {
/// Get an iterator over `ConnectAddress`es from this parsed display for connecting
/// to the server.
pub fn connect_instruction(&self) -> impl Iterator<Item = ConnectAddress<'_>> {
connect_instruction::connect_addresses(self)
}
}
/// Parse an X11 display string.
///
/// If `dpy_name` is `None`, the display is parsed from the environment variable `DISPLAY`.
pub fn parse_display(dpy_name: Option<&str>) -> Option<ParsedDisplay> {
// If no dpy name was provided, use the env var. If no env var exists, return None.
match dpy_name {
Some(dpy_name) => parse_display_impl(dpy_name),
None => parse_display_impl(&std::env::var("DISPLAY").ok()?),
}
}
fn parse_display_impl(dpy_name: &str) -> Option<ParsedDisplay> {
// Everything up to the last '/' is the protocol. This part is optional.
let (protocol, remaining) = if let Some(pos) = dpy_name.rfind('/') {
(Some(&dpy_name[..pos]), &dpy_name[pos + 1..])
} else {
(None, dpy_name)
};
// Everything up to the last ':' is the host. This part is required.
let pos = remaining.rfind(':')?;
let (host, remaining) = (&remaining[..pos], &remaining[pos + 1..]);
// The remaining part is display.screen. The display is required and the screen optional.
let (display, screen) = match remaining.find('.') {
Some(pos) => (&remaining[..pos], &remaining[pos + 1..]),
None => (remaining, "0"),
};
// Parse the display and screen number
let (display, screen) = (display.parse().ok()?, screen.parse().ok()?);
let host = host.to_string();
let protocol = protocol.map(|p| p.to_string());
Some(ParsedDisplay {
host,
protocol,
display,
screen,
})
}
#[cfg(test)]
mod test {
use super::{parse_display, ParsedDisplay};
use alloc::string::ToString;
fn do_parse_display(input: &str) -> Option<ParsedDisplay> {
std::env::set_var("DISPLAY", input);
let result1 = parse_display(None);
std::env::remove_var("DISPLAY");
let result2 = parse_display(Some(input));
assert_eq!(result1, result2);
result1
}
// The tests modify environment variables. This is process-global. Thus, the tests in this
// module cannot be run concurrently. We achieve this by having only a single test functions
// that calls all other functions.
#[test]
fn test_parsing() {
test_missing_input();
xcb_good_cases();
xcb_bad_cases();
own_good_cases();
}
fn test_missing_input() {
std::env::remove_var("DISPLAY");
assert_eq!(parse_display(None), None);
}
fn own_good_cases() {
// The XCB test suite does not test protocol parsing
for (input, output) in &[
(
"foo/bar:1",
ParsedDisplay {
host: "bar".to_string(),
protocol: Some("foo".to_string()),
display: 1,
screen: 0,
},
),
(
"foo/bar:1.2",
ParsedDisplay {
host: "bar".to_string(),
protocol: Some("foo".to_string()),
display: 1,
screen: 2,
},
),
(
"a:b/c/foo:bar:1.2",
ParsedDisplay {
host: "foo:bar".to_string(),
protocol: Some("a:b/c".to_string()),
display: 1,
screen: 2,
},
),
] {
assert_eq!(
do_parse_display(input).as_ref(),
Some(output),
"Failed parsing correctly: {}",
input
);
}
}
// Based on libxcb's test suite; (C) 2001-2006 Bart Massey, Jamey Sharp, and Josh Triplett
fn xcb_good_cases() {
for (input, output) in &[
// unix
(
":0",
ParsedDisplay {
host: "".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
":1",
ParsedDisplay {
host: "".to_string(),
protocol: None,
display: 1,
screen: 0,
},
),
(
":0.1",
ParsedDisplay {
host: "".to_string(),
protocol: None,
display: 0,
screen: 1,
},
),
// ip
(
"x.org:0",
ParsedDisplay {
host: "x.org".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"expo:0",
ParsedDisplay {
host: "expo".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"bigmachine:1",
ParsedDisplay {
host: "bigmachine".to_string(),
protocol: None,
display: 1,
screen: 0,
},
),
(
"hydra:0.1",
ParsedDisplay {
host: "hydra".to_string(),
protocol: None,
display: 0,
screen: 1,
},
),
// ipv4
(
"198.112.45.11:0",
ParsedDisplay {
host: "198.112.45.11".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"198.112.45.11:0.1",
ParsedDisplay {
host: "198.112.45.11".to_string(),
protocol: None,
display: 0,
screen: 1,
},
),
// ipv6
(
":::0",
ParsedDisplay {
host: "::".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"1:::0",
ParsedDisplay {
host: "1::".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"::1:0",
ParsedDisplay {
host: "::1".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"::1:0.1",
ParsedDisplay {
host: "::1".to_string(),
protocol: None,
display: 0,
screen: 1,
},
),
(
"::127.0.0.1:0",
ParsedDisplay {
host: "::127.0.0.1".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"::ffff:127.0.0.1:0",
ParsedDisplay {
host: "::ffff:127.0.0.1".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"2002:83fc:3052::1:0",
ParsedDisplay {
host: "2002:83fc:3052::1".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"2002:83fc:3052::1:0.1",
ParsedDisplay {
host: "2002:83fc:3052::1".to_string(),
protocol: None,
display: 0,
screen: 1,
},
),
(
"[::]:0",
ParsedDisplay {
host: "[::]".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"[1::]:0",
ParsedDisplay {
host: "[1::]".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"[::1]:0",
ParsedDisplay {
host: "[::1]".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"[::1]:0.1",
ParsedDisplay {
host: "[::1]".to_string(),
protocol: None,
display: 0,
screen: 1,
},
),
(
"[::127.0.0.1]:0",
ParsedDisplay {
host: "[::127.0.0.1]".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"[2002:83fc:d052::1]:0",
ParsedDisplay {
host: "[2002:83fc:d052::1]".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"[2002:83fc:d052::1]:0.1",
ParsedDisplay {
host: "[2002:83fc:d052::1]".to_string(),
protocol: None,
display: 0,
screen: 1,
},
),
// decnet
(
"myws::0",
ParsedDisplay {
host: "myws:".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"big::0",
ParsedDisplay {
host: "big:".to_string(),
protocol: None,
display: 0,
screen: 0,
},
),
(
"hydra::0.1",
ParsedDisplay {
host: "hydra:".to_string(),
protocol: None,
display: 0,
screen: 1,
},
),
] {
assert_eq!(
do_parse_display(input).as_ref(),
Some(output),
"Failed parsing correctly: {}",
input
);
}
}
// Based on libxcb's test suite; (C) 2001-2006 Bart Massey, Jamey Sharp, and Josh Triplett
fn xcb_bad_cases() {
for input in &[
"",
":",
"::",
":::",
":.",
":a",
":a.",
":0.",
":.a",
":.0",
":0.a",
":0.0.",
"127.0.0.1",
"127.0.0.1:",
"127.0.0.1::",
"::127.0.0.1",
"::127.0.0.1:",
"::127.0.0.1::",
"::ffff:127.0.0.1",
"::ffff:127.0.0.1:",
"::ffff:127.0.0.1::",
"localhost",
"localhost:",
"localhost::",
] {
assert_eq!(
do_parse_display(input),
None,
"Unexpectedly parsed: {}",
input
);
}
}
}