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

//! A model for text documents.
//!
//! This model is thought as a backend for a text UI. [`TextDocument`] can't be modified directly by the user, only for setting the whole document with `set_plain_text(...)`.
//! The user must use a [`TextCursor`] using `document.create_cursor()` to make any change.
//!  
//! # Document structure
//!
//! ## Elements
//!
//! - [`Frame`]: contains Block elements and other Frame elements, formatable with FrameFormat
//! - [`Block`]: contains Text elements or Image elements, formatable with BlockFormat
//! - [`Text`]: contains the actuel text, formatable with TextFormat
//! - [`Image`]: represent the position of an image, formatable with ImageFormat
//!
//! All these items are encapsulated in its corresponding [`Element`] for ease of storage.
//!
//! ## The simpler plain text
//!
//! ```raw
//! Frame
//! |- Block
//!    |- Text
//! |- Block
//!    |- Text
//! ```
//!
//! ## The more complex rich text
//!
//! ```raw
//! Frame
//! |- Block
//!    |- Text  --> I really lo
//!    |- Text  --> ve (imagine it Formatted in bold)
//!    |- Text  --> Rust
//!    |- Image
//!    |- Text
//! |- Frame
//!    |- Block
//!       |- Text
//!       |- Text
//!       |- Text
//!    |- Block
//!       |- Text
//!       |- Text
//!       |- Text
//! |- Block
//!    |- Image
//! ```
//!
//! # Signaling changes
//!
//! Each modification is signaled using callbacks. [`TextDocument`] offers different ways to make your code aware of any change:
//!- [`TextDocument::add_text_change_callback()`]
//!
//!   Give the  number of removed characters and number of added characters with the reference of a cursor position.
//!
//!- [`TextDocument::add_element_change_callback()`]
//!
//!   Give the modified element with the reason. If two direct children elements changed at the same time.
//!
//! # Examples
//!
//!  ```rust
//!  use text_document::{TextDocument, ChangeReason, MoveMode};
//!
//!  let mut document = TextDocument::new();
//!
//!  document.add_text_change_callback(|position, removed_characters, added_characters|{
//!    println!("position: {}, removed_characters: {}, added_characters: {}", position, removed_characters, added_characters);
//!  } );
//!
//!  document.add_element_change_callback(|element, reason|{
//!    assert_eq!(element.uuid(), 0);
//!    assert_eq!(reason, ChangeReason::ChildrenChanged );
//!  } );
//!  document.set_plain_text("beginningend").unwrap();
//!
//!  let mut cursor = document.create_cursor();
//!  cursor.set_position(9, MoveMode::MoveAnchor);
//!  cursor.insert_plain_text("new\nplain_text\ntest");
//!
//!  
//!  ```

pub mod block;
pub mod font;
pub mod format;
pub mod frame;
pub mod image;
pub mod text;
pub mod text_cursor;
pub mod text_document;

pub use crate::text_document::*;
pub use block::*;
pub use frame::*;
pub use image::*;
pub use text::*;
pub use text_cursor::*;

// Not public API.
#[doc(hidden)]
pub mod private {}