r4d 3.0.0-rc.2

Text oriented macro processor
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

//! # R4d(rad)
//! R4d is a text oriented macro processor that tries to solve inconveniences of well-known m4
//! macro processor.
//!
//! R4d is provided as both binary and library. Binary includes all features of optional
//! dependencies. Library doesn't provide any features by default so you can set them manually.
//!
//! # Features
//!
//! ```text
//! - evalexpr  : eval related macros
//! - chrono    : time related macros
//! - textwrap  : "wrap" macro
//! - cindex    : Query related macros
//! - full      : all features above
//!
//! - debug     : Enable debug method
//! - color     : Enable color prompt
//! - hook      : Enable hook macro
//! - signature : Enable signature option
//! ```
//!
//! # Simple usage
//!
//! **Binary**
//! ```text
//! # Read from file and print to stdout
//! rad input_file.txt
//! # Read from standard input and print to file
//! printf '...text...' | rad -o out_file.txt
//! ```
//!
//! **Library**
//! ```no_run
//! use r4d::{Processor, RadResult};
//! use std::path::Path;
//!
//! let mut processor = Processor::new()
//!     .purge(true)
//!     .write_to_file(Some(Path::new("cache.txt")))
//!     .expect("Failed to open a file");
//!
//! processor.process_file(Path::new("input.txt"))
//!     .expect("Failed to process file");
//! processor.print_result().expect("Failed to print result");
//! ```
//!
//! Detailed r4d usage is illustrated in [github
//! page](https://github.com/simhyeon/r4d/blob/master/docs/usage.md) or in
//! [Processor](crate::Processor)

mod error;
mod processor;

mod parser;
pub(crate) use parser::DefineParser;
pub(crate) use parser::{ArgParser, GreedyState};

mod map;
pub(crate) use map::deterred_map;
pub(crate) use map::function_map;
#[cfg(feature = "hook")]
pub(crate) use map::hookmap;
pub(crate) use map::runtime_map;
#[cfg(feature = "signature")]
pub(crate) use map::sigmap;

pub(crate) mod auth;
pub(crate) mod consts;
#[cfg(feature = "debug")]
pub(crate) mod debugger;
pub(crate) mod formatter;
pub(crate) mod lexor;
pub(crate) mod logger;
pub(crate) mod models;
pub(crate) mod utils;

pub use auth::AuthType;
pub use error::RadError;
#[cfg(feature = "hook")]
pub use hookmap::HookType;
pub use logger::WarningType;
pub use models::{CommentType, DiffOption, Hygiene, RadResult, WriteOption};
pub use models::{ExtMacroBuilder, MacroType, RadStorage, StorageOutput, StorageResult};
pub use processor::Processor;

// Optional

// User configurable script execution
#[cfg(feature = "template")]
mod script;

// Binary option
#[cfg(feature = "clap")]
mod cli;
#[cfg(feature = "clap")]
pub use cli::RadCli;
#[cfg(feature = "clap")]
pub use cli::RadoCli;

// Re-export macro
#[cfg(feature = "template")]
pub use rad_ext_template;

#[cfg(feature = "wasm")]
pub mod wasm;

mod test;