teacat_lib 0.1.1

Tools for working with TeaCat files
Documentation 
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

//! # TeaCat
//! This crate contains basic tools for working with TeaCat files.
//!
//! ```rust
//! # fn hidden() -> anyhow::Result<()> {
//! use teacat_lib::prelude::*;
//!
//! let teacat_str = "
//! &title := :title[My Webpage];
//!
//! :head[
//! 	&title
//! ]
//!
//! :body[
//! 	:p[Hello, World!]
//! ]
//! "
//! .to_string();
//!
//! let tokenstream = TokenStream::lex(teacat_str);
//! let ast = Ast::parse(tokenstream)?;
//! let expanded = ExpandedAst::expand(ast)?;
//! let html = HtmlRenderer::render(expanded);
//!
//! assert_eq!(
//! 	html,
//! 	"<!DOCTYPE html><html><head><title>My Webpage</title></head><body><p>Hello, World!</p></body></html>".to_string()
//! );
//! # Ok(())
//! # }
//! # hidden().unwrap();
//! ```

#![allow(clippy::tabs_in_doc_comments)]

use prelude::*;

pub mod error;
pub mod expanded;
pub mod lexer;
pub mod parser;

/// Evaluates a TeaCat string.
/// # Examples
/// ```
/// use teacat_lib::prelude::*;
///
/// let teacat_string = ":head[]";
///
/// assert_eq!(
/// 	eval_teacat_string::<HtmlRenderer, String>(teacat_string).unwrap(),
/// 	"<!DOCTYPE html><html><head></head></html>".to_string(),
/// );
/// ```
pub fn eval_teacat_string<Rend: Renderer<Out>, Out>(
	teacat_string: impl AsRef<str>,
) -> CatResult<Out> {
	let tokenstream = TokenStream::lex(teacat_string);
	let ast = Ast::parse(tokenstream)?;
	let expanded = ExpandedAst::expand(ast)?;
	Ok(Rend::render(expanded))
}

/// Encodes a string so that it can be safely used in a TeaCat file.
/// # Examples
/// ```
/// use teacat_lib::prelude::*;
///
/// let teacat_string = ":head[]";
///
/// assert_eq!(
/// 	encode_str(teacat_string),
/// 	"\\:head\\[\\]".to_string(),
/// );
/// ```
pub fn encode_str(str: impl Into<String>) -> String {
	#[rustfmt::skip]
	const TOKENS: &[&str] = &[
		"\\", 
		"[", 
		"]", 
		"{", 
		"}", 
		"macr", 
		":=", 
		":", 
		";", 
		"&", 
		"@",
	];

	let mut str = str.into();

	for token in TOKENS {
		str = str
			.split(token)
			.collect::<Vec<&str>>()
			.join(&("\\".to_owned() + token));
	}

	str
}

/// A macro to create a [VecDeque](std::collections::VecDeque).
/// # Examples
/// ```
/// use teacat_lib::vecdeque;
///
/// assert_eq!(
/// 	vecdeque![1, 2, 3,],
/// 	std::collections::VecDeque::from([1, 2, 3,])
/// )
/// ```
#[macro_export]
macro_rules! vecdeque {
	( $( $x:expr ),* $(,)? ) => {
		std::collections::VecDeque::from(vec![ $( $x, )* ])
	};
}

pub mod prelude {
	pub use crate::error::TeaCatError;
	pub use crate::expanded::{
		ExpandedAst, ExpandedNode, ExpandedTag,
		renderer::{Renderer, html::HtmlRenderer, tcat::TeaCatRenderer},
	};
	pub use crate::lexer::TokenStream;
	pub use crate::parser::{Ast, Attributes};
	pub use crate::{encode_str, eval_teacat_string};

	// Meow
	pub(crate) use anyhow::Result as CatResult;
}