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 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
use lsp_types::{Position, Range, TextDocumentContentChangeEvent};
#[derive(Debug)]
pub struct FullTextDocument {
language_id: String,
version: i32,
content: String,
/// The value at index `i` in `line_offsets` is the index into `content`
/// that is the start of line `i`. As such, the first element of
/// `line_offsets` is always 0.
line_offsets: Vec<u32>,
}
fn computed_line_offsets(text: &str, is_at_line_start: bool, text_offset: Option<u32>) -> Vec<u32> {
let text_offset = text_offset.unwrap_or(0);
let mut line_offsets = if is_at_line_start {
vec![text_offset]
} else {
vec![]
};
let mut chars = text.char_indices().peekable();
while let Some((idx, char)) = chars.next() {
let idx: u32 = idx
.try_into()
.expect("The length of the text involved in the calculation is too long");
if char == '\r' && chars.peek() == Some(&(idx as usize + 1, '\n')) {
chars.next();
line_offsets.push(text_offset + idx + 2);
} else if char == '\n' || char == '\r' {
line_offsets.push(text_offset + idx + 1);
}
}
line_offsets
}
/// given a string (in UTF-8) and a byte offset, returns the offset in UTF-16 code units
///
/// for example, consider a string containing a single 4-byte emoji. 4-byte characters
/// in UTF-8 are supplementary plane characters that require two UTF-16 code units
/// (surrogate pairs).
///
/// in this example:
/// - offset 4 returns 2;
/// - offsets 1, 2 or 3 return 0, because they are not on a character boundary and round down;
/// - offset 5+ will return 2, the length of the string in UTF-16
fn line_offset_utf16(line: &str, offset: u32) -> u32 {
let mut c = 0;
for (idx, char) in line.char_indices() {
if idx + char.len_utf8() > offset as usize || idx == offset as usize {
break;
}
c += char.len_utf16() as u32;
}
c
}
impl FullTextDocument {
pub fn new(language_id: String, version: i32, content: String) -> Self {
let line_offsets = computed_line_offsets(&content, true, None);
Self {
language_id,
version,
content,
line_offsets,
}
}
pub fn update(&mut self, changes: &[TextDocumentContentChangeEvent], version: i32) {
for change in changes {
let TextDocumentContentChangeEvent { range, text, .. } = change;
match range {
Some(range) => {
// update content
let Range { start, end } = range;
let (start, start_offset) = self.find_canonical_position(start);
let (end, end_offset) = self.find_canonical_position(end);
assert!(
start_offset <= end_offset,
"Start offset must be less than end offset. {}:{} (offset {}) is not <= {}:{} (offset {})",
start.line, start.character, start_offset,
end.line, end.character, end_offset
);
self.content
.replace_range((start_offset as usize)..(end_offset as usize), text);
let (start_line, end_line) = (start.line, end.line);
assert!(start_line <= end_line);
let added_line_offsets = computed_line_offsets(text, false, Some(start_offset));
let num_added_line_offsets = added_line_offsets.len();
let splice_start = start_line as usize + 1;
self.line_offsets
.splice(splice_start..=end_line as usize, added_line_offsets);
let diff =
(text.len() as i32).saturating_sub_unsigned(end_offset - start_offset);
if diff != 0 {
for i in
(splice_start + num_added_line_offsets)..(self.line_count() as usize)
{
self.line_offsets[i] = self.line_offsets[i].saturating_add_signed(diff);
}
}
}
None => {
// Full Text
// update line_offsets
self.line_offsets = computed_line_offsets(text, true, None);
// update content
self.content = text.to_owned();
}
}
}
self.version = version;
}
/// As demonstrated by test_multiple_position_same_offset(), in some cases,
/// there are multiple ways to reference the same Position. We map to a
/// "canonical Position" so we can avoid worrying about edge cases all over
/// the place.
fn find_canonical_position(&self, position: &Position) -> (Position, u32) {
let offset = self.offset_at(*position);
if offset == 0 {
(
Position {
line: 0,
character: 0,
},
0,
)
} else if self.content.as_bytes().get(offset as usize - 1) == Some(&b'\n') {
if self.line_offsets[position.line as usize] == offset {
(*position, offset)
} else if self.line_offsets[position.line as usize + 1] == offset {
(
Position {
line: position.line + 1,
character: 0,
},
offset,
)
} else {
panic!(
"Could not determine canonical value for {position:?} in {:?}",
self.content
)
}
} else {
(*position, offset)
}
}
/// Document's language id
pub fn language_id(&self) -> &str {
&self.language_id
}
/// Document's version
pub fn version(&self) -> i32 {
self.version
}
/// Get document content
///
/// # Examples
///
/// Basic usage:
/// ```
/// use lsp_textdocument::FullTextDocument;
/// use lsp_types::{Range, Position};
///
/// let text_documents = FullTextDocument::new("plain_text".to_string(), 1, "hello rust!".to_string());
///
/// // get document all content
/// let content = text_documents.get_content(None);
/// assert_eq!(content, "hello rust!");
///
/// // get document specify content by range
/// let (start, end) = (Position::new(0, 1), Position::new(0, 9));
/// let range = Range::new(start, end);
/// let sub_content = text_documents.get_content(Some(range));
/// assert_eq!(sub_content, "ello rus");
/// ```
pub fn get_content(&self, range: Option<Range>) -> &str {
match range {
Some(Range { start, end }) => {
let start = self.offset_at(start);
let end = self.offset_at(end).min(self.content_len());
self.content.get(start as usize..end as usize).unwrap()
}
None => &self.content,
}
}
fn get_line_and_offset(&self, line: u32) -> Option<(&str, u32)> {
self.line_offsets.get(line as usize).map(|&line_offset| {
let len: u32 = self.content_len();
let eol_offset = self.line_offsets.get((line + 1) as usize).unwrap_or(&len);
let line = &self.content[line_offset as usize..*eol_offset as usize];
(line, line_offset)
})
}
fn get_line(&self, line: u32) -> Option<&str> {
self.get_line_and_offset(line).map(|(line, _)| line)
}
/// A amount of document content line
pub fn line_count(&self) -> u32 {
self.line_offsets
.len()
.try_into()
.expect("The number of lines of text passed in is too long")
}
/// The length of the document content in UTF-8 bytes
pub fn content_len(&self) -> u32 {
self.content
.len()
.try_into()
.expect("The length of the text passed in is too long")
}
/// Converts a zero-based byte offset in the UTF8-encoded content to a position
///
/// the offset is in bytes, the position is in UTF16 code units. rounds down if
/// the offset is not on a code unit boundary, or is beyond the end of the
/// content.
pub fn position_at(&self, offset: u32) -> Position {
let offset = offset.min(self.content_len());
let line_count = self.line_count();
if line_count == 1 {
// only one line
return Position {
line: 0,
character: line_offset_utf16(self.get_line(0).unwrap(), offset),
};
}
let (mut low, mut high) = (0, line_count);
while low < high {
let mid = (low + high) / 2;
if offset
> *self
.line_offsets
.get(mid as usize)
.expect("Unknown mid value")
{
low = mid + 1;
} else {
high = mid;
}
}
if low == 0 {
// offset is on the first line
return Position {
line: 0,
character: line_offset_utf16(self.get_line(0).unwrap(), offset),
};
}
let line = low - 1;
Position {
line,
character: line_offset_utf16(
self.get_line(line).unwrap(),
offset - self.line_offsets[line as usize],
),
}
}
/// Converts a position to a zero-based byte offset, suitable for slicing the
/// UTF-8 encoded content.
pub fn offset_at(&self, position: Position) -> u32 {
let Position { line, character } = position;
match self.get_line_and_offset(line) {
Some((line, offset)) => {
let mut c = 0;
let iter = line.char_indices();
for (idx, char) in iter {
if c == character {
return offset + idx as u32;
}
c += char.len_utf16() as u32;
}
offset + line.len() as u32
}
None => {
if line >= self.line_count() {
self.content_len()
} else {
0
}
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
fn full_text_document() -> FullTextDocument {
FullTextDocument::new(
"js".to_string(),
2,
"he\nllo\nworld\r\nfoo\rbar".to_string(),
)
}
#[test]
fn test_offset_at() {
let text_document = full_text_document();
let offset = text_document.offset_at(Position {
line: 1,
character: 1,
});
assert_eq!(offset, 4);
let offset = text_document.offset_at(Position {
line: 2,
character: 3,
});
assert_eq!(offset, 10);
// the `f` in `foo` (\r\n is a single line terminator)
let offset = text_document.offset_at(Position {
line: 3,
character: 1,
});
assert_eq!(offset, 15);
}
/// basic multilingual plane
#[test]
fn test_offset_at_bmp() {
// Euro symbol
let text_document = FullTextDocument::new("js".to_string(), 2, "\u{20AC} euro".to_string());
let offset = text_document.offset_at(Position {
line: 0,
// E euro
// ^
character: 2,
});
assert_eq!(offset, 4);
}
/// supplementary multilingual plane, aka surrogate pair
#[test]
fn test_offset_at_smp() {
// Deseret Small Letter Yee
let text_document = FullTextDocument::new("js".to_string(), 2, "\u{10437} yee".to_string());
let offset = text_document.offset_at(Position {
line: 0,
// HL yee
// ^
character: 3,
});
assert_eq!(offset, 5);
}
/// a character beyond the end of the line should clamp to the end of the line
#[test]
fn test_offset_at_beyond_end_of_line() {
let text_document =
FullTextDocument::new("js".to_string(), 2, "\u{20AC} abc\nline 2".to_string());
// "\u{20AC} abc\nline 2" in UTF-8:
// \xE2 \x82 \xAC \x20 \x61 \x62 \x63 \x0A \x6C \x69 \x6E \x65 \x20 \x32
// ^ line 1 == 0 ^ line 2 == 8
assert_eq!(text_document.line_offsets, vec![0, 8]);
let offset = text_document.offset_at(Position {
line: 0,
character: 100,
});
assert_eq!(offset, 8);
}
#[test]
fn test_position_at() {
let text_document = full_text_document();
let position = text_document.position_at(5);
assert_eq!(
position,
Position {
line: 1,
character: 2
}
);
let position = text_document.position_at(11);
assert_eq!(
position,
Position {
line: 2,
character: 4,
}
);
let position = text_document.position_at(15);
assert_eq!(
position,
Position {
line: 3,
character: 1,
}
);
let position = text_document.position_at(0);
assert_eq!(
position,
Position {
line: 0,
character: 0,
}
);
}
/// basic multilingual plane
#[test]
fn test_position_at_bmp() {
// Euro symbol
let text_document = FullTextDocument::new("js".to_string(), 2, "\u{20AC} euro".to_string());
let position = text_document.position_at(4);
assert_eq!(
position,
Position {
line: 0,
// E euro
// ^
character: 2,
}
);
// multi-line content
let text_document =
FullTextDocument::new("js".to_string(), 2, "\n\n\u{20AC} euro\n\n".to_string());
let position = text_document.position_at(6);
assert_eq!(
position,
Position {
line: 2,
// E euro
// ^
character: 2,
}
);
}
/// supplementary multilingual plane, aka surrogate pair
#[test]
fn test_position_at_smp() {
// Deseret Small Letter Yee
let text_document = FullTextDocument::new("js".to_string(), 2, "\u{10437} yee".to_string());
assert_eq!(
text_document.position_at(5),
Position {
line: 0,
// HL yee
// ^
character: 3,
}
);
// \u{10437} is 4 bytes wide. if not on a char boundary, round down
assert_eq!(
text_document.position_at(2),
Position {
line: 0,
character: 0,
}
);
// multi-line content
let text_document =
FullTextDocument::new("js".to_string(), 2, "\n\n\u{10437} yee\n\n".to_string());
let position = text_document.position_at(7);
assert_eq!(
position,
Position {
line: 2,
// HL yee
// ^
character: 3,
}
);
}
#[test]
fn test_get_content() {
let text_document = full_text_document();
let start = Position {
line: 0,
character: 0,
};
let end = Position {
line: 1,
character: 2,
};
let range = Range { start, end };
let content = text_document.get_content(Some(range));
assert_eq!(content, "he\nll");
let end = Position {
line: 100,
character: 100,
};
let range = Range { start, end };
let content = text_document.get_content(Some(range));
assert_eq!(content, text_document.content);
let range = Range {
start: Position {
line: 1,
character: 0,
},
end: Position {
line: 2,
character: 3,
},
};
let content = text_document.get_content(Some(range));
assert_eq!(content, "llo\nwor");
}
/// basic multilingual plane
#[test]
fn test_get_content_bmp() {
// Euro symbol
let text_document = FullTextDocument::new("js".to_string(), 2, "\u{20AC} euro".to_string());
// Euro symbol is 1 UTF16 code unit wide
let range = Range {
start: Position {
line: 0,
character: 0,
},
end: Position {
line: 0,
character: 1,
},
};
let content = text_document.get_content(Some(range));
assert_eq!(content, "\u{20AC}");
// E euro
// ^
let range = Range {
start: Position {
line: 0,
character: 2,
},
end: Position {
line: 0,
character: 3,
},
};
let content = text_document.get_content(Some(range));
assert_eq!(content, "e");
}
/// supplementary multilingual plane, aka surrogate pairs
#[test]
fn test_get_content_smp() {
// Deseret Small Letter Yee
let text_document = FullTextDocument::new("js".to_string(), 2, "\u{10437} yee".to_string());
// surrogate pairs are 2 UTF16 code units wide
let range = Range {
start: Position {
line: 0,
character: 0,
},
end: Position {
line: 0,
character: 2,
},
};
let content = text_document.get_content(Some(range));
assert_eq!(content, "\u{10437}");
}
#[test]
fn test_update_full_content() {
let mut text_document = full_text_document();
let new_text = "hello\n js!";
text_document.update(
&[TextDocumentContentChangeEvent {
text: new_text.to_string(),
range: None,
range_length: None,
}],
1,
);
assert_eq!(&text_document.content, new_text);
assert_eq!(text_document.line_offsets, vec![0, 6]);
}
#[test]
fn test_update_part_content() {
let mut text_document = full_text_document();
assert_eq!(text_document.version(), 2);
let new_text = String::from("xx\ny");
let range = Range {
start: Position {
line: 1,
character: 0,
},
end: Position {
line: 1,
character: 3,
},
};
text_document.update(
&[TextDocumentContentChangeEvent {
range: Some(range),
range_length: None,
text: new_text,
}],
1,
);
assert_eq!(&text_document.content, "he\nxx\ny\nworld\r\nfoo\rbar");
assert_eq!(text_document.line_offsets, vec![0, 3, 6, 8, 15, 19]);
assert_eq!(text_document.version(), 1)
}
#[test]
#[should_panic(
expected = "Start offset must be less than end offset. 2:0 (offset 7) is not <= 1:0 (offset 3)"
)]
fn test_update_invalid_range() {
let mut text_document = full_text_document();
// start is after end
let range = Range {
start: Position {
line: 2,
character: 0,
},
end: Position {
line: 1,
character: 0,
},
};
text_document.update(
&[TextDocumentContentChangeEvent {
text: String::from(""),
range: Some(range),
range_length: Some(0),
}],
1,
);
}
/// It turns out that there are multiple values for Position that can map to
/// the same offset following a newline.
#[test]
fn test_multiple_position_same_offset() {
let text_document = full_text_document();
let end_of_first_line = Position {
line: 0,
character: 3,
};
let start_of_second_line = Position {
line: 1,
character: 0,
};
assert_eq!(
text_document.offset_at(end_of_first_line),
text_document.offset_at(start_of_second_line)
);
let beyond_end_of_first_line = Position {
line: 0,
character: 10_000,
};
assert_eq!(
text_document.offset_at(beyond_end_of_first_line),
text_document.offset_at(start_of_second_line)
);
}
#[test]
fn test_insert_using_positions_after_newline_at_end_of_line() {
let mut doc = FullTextDocument::new(
"text".to_string(),
0,
"0:1332533\n0:1332534\n0:1332535\n0:1332536\n".to_string(),
);
doc.update(
&[TextDocumentContentChangeEvent {
range: Some(Range {
// After \n at the end of line 1.
start: Position {
line: 1,
character: 10,
},
// After \n at the end of line 2.
end: Position {
line: 2,
character: 10,
},
}),
range_length: None,
text: "1:6188912\n1:6188913\n1:6188914\n".to_string(),
}],
1,
);
assert_eq!(
doc.get_content(None),
concat!(
"0:1332533\n0:1332534\n",
"1:6188912\n1:6188913\n1:6188914\n",
"0:1332536\n",
),
);
assert_eq!(doc.line_offsets, vec!(0, 10, 20, 30, 40, 50, 60));
}
#[test]
fn test_line_offsets() {
let mut doc =
FullTextDocument::new("text".to_string(), 0, "123456789\n123456789\n".to_string());
assert_eq!(doc.line_offsets, vec!(0, 10, 20));
doc.update(
&[TextDocumentContentChangeEvent {
range: Some(Range {
start: Position {
line: 1,
character: 5,
},
end: Position {
line: 1,
character: 5,
},
}),
range_length: None,
text: "\nA\nB\nC\n".to_string(),
}],
1,
);
assert_eq!(doc.get_content(None), "123456789\n12345\nA\nB\nC\n6789\n",);
assert_eq!(doc.line_offsets, vec!(0, 10, 16, 18, 20, 22, 27));
}
/// This tests a regression caused by confusing byte and character offsets.
/// When [update] was called on a position whose offset points just after a
/// non-newline when interpreted as bytes, but pointed just after at a
/// newline when interpreted as chars, it led to a crash.
#[test]
fn test_find_canonical_position_regression() {
// \u{20AC} is a single character in utf-16 but 3 bytes in utf-8,
// so the offsets in bytes of everything after it is +2 their offsets
// in characters.
let str = "\u{20AC}456789\n123456789\n";
let mut doc = FullTextDocument::new("text".to_string(), 0, str.to_string());
let pos = Position {
line: 0,
character: 6,
};
let offset = doc.offset_at(pos) as usize;
assert_ne!(str.as_bytes().get(offset - 1), Some(&b'\n'));
assert_eq!(str.chars().nth(offset - 1), Some('\n'));
doc.update(
&[TextDocumentContentChangeEvent {
range: Some(Range {
start: pos,
end: Position {
line: 0,
character: 7,
},
}),
range_length: None,
text: "X".to_string(),
}],
1,
);
assert_eq!(doc.get_content(None), "\u{20AC}45678X\n123456789\n",);
assert_eq!(doc.line_offsets, vec!(0, 10, 20));
}
}