print: How duat prints files

The print module has a bunch of simple functions to change how duat should print File widgets:

#![allow(unused)]
fn main() {
setup_duat!(setup);
use duat::prelude::*;

fn setup() {
    print::no_wrapping();
    print::indent_wraps(true);
    print::tabstop(4);
    print::scrolloff(3, 3);
    print::word_chars!("A-Za-z0-9_-_");
    print::new_line(' ');
}
}

These are the default options (for Files). One thing to note about this module, is that it is for Files and Files only. That is, nothing in here will affect other widgets, like LineNumbers or StatusLine. If you want to modify those, you can head over to the hook chapter.

The functions in this module will affect all files unconditionally, if you want to do that on a File by File basis, again, see the hook chapter.

This is the current list of options in this module:

• print::no_wrapping: The default, don't wrap text at all;
• print::wrap_on_edge: Wraps the text on the edge of its area;
• print::wrap_on_cap: Wraps at a distance from the left edge, can go over the right edge;
• print::wrap_on_words: Wraps on word termination, instead of any character;
• print::indent_wraps: Copies the indentation on wrapped lines, can be used with the other options;
• print::tabstop: The width of tabs, is also used to determine how many spaces a \t should add. Is 4 by default;
• print::new_line: What character to print when printing '\n's. Is ' ' by default;
• print::trailing_new_line: What character to print when printing '\n's that are preceeded by spaces. Is not set by default;

print::word_chars!

print::word_chars! is a macro that determines which characters should be part of a word. This is used by wrap_on_words and tends to also be used to modify text (in the <Ctrl-Backspace> key in most editors, for example).

This macro is evaluated at compile time, so you don't have to worry about it being correct or not, and the syntax is the same as in regex, like this:

#![allow(unused)]
fn main() {
setup_duat!(setup);
use duat::prelude::*;

fn setup() {
    print::word_chars!("A-Za-z0-9---_-_");
}
}

In this case, every sequence of lowercase and capital letters, numbers, dashes and underscores would be considered part of a word.