Struct handlebars::template::Template
source · pub struct Template {
pub name: Option<String>,
pub elements: Vec<TemplateElement>,
pub mapping: Vec<TemplateMapping>,
}
Expand description
A handlebars template
Fields§
§name: Option<String>
§elements: Vec<TemplateElement>
§mapping: Vec<TemplateMapping>
Implementations§
source§impl Template
impl Template
sourcepub fn new() -> Template
pub fn new() -> Template
Examples found in repository?
src/template.rs (line 562)
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 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
pub(crate) fn compile2(
source: &str,
options: TemplateOptions,
) -> Result<Template, TemplateError> {
let mut helper_stack: VecDeque<HelperTemplate> = VecDeque::new();
let mut decorator_stack: VecDeque<DecoratorTemplate> = VecDeque::new();
let mut template_stack: VecDeque<Template> = VecDeque::new();
let mut omit_pro_ws = false;
// flag for newline removal of standalone statements
// this option is marked as true when standalone statement is detected
// then the leading whitespaces and newline of next rawstring will be trimed
let mut trim_line_required = false;
let parser_queue = HandlebarsParser::parse(Rule::handlebars, source).map_err(|e| {
let (line_no, col_no) = match e.line_col {
LineColLocation::Pos(line_col) => line_col,
LineColLocation::Span(line_col, _) => line_col,
};
TemplateError::of(TemplateErrorReason::InvalidSyntax)
.at(source, line_no, col_no)
.in_template(options.name())
})?;
// dbg!(parser_queue.clone().flatten());
// remove escape from our pair queue
let mut it = parser_queue
.flatten()
.filter(|p| {
// remove rules that should be silent but not for now due to pest limitation
!matches!(p.as_rule(), Rule::escape)
})
.peekable();
let mut end_pos: Option<Position<'_>> = None;
loop {
if let Some(pair) = it.next() {
let prev_end = end_pos.as_ref().map(|p| p.pos()).unwrap_or(0);
let rule = pair.as_rule();
let span = pair.as_span();
let is_trailing_string = rule != Rule::template
&& span.start() != prev_end
&& !omit_pro_ws
&& rule != Rule::raw_text
&& rule != Rule::raw_block_text;
if is_trailing_string {
// trailing string check
let (line_no, col_no) = span.start_pos().line_col();
if rule == Rule::raw_block_end {
let mut t = Template::new();
t.push_element(
Template::raw_string(
&source[prev_end..span.start()],
None,
false,
trim_line_required,
),
line_no,
col_no,
);
template_stack.push_front(t);
} else {
let t = template_stack.front_mut().unwrap();
t.push_element(
Template::raw_string(
&source[prev_end..span.start()],
None,
false,
trim_line_required,
),
line_no,
col_no,
);
}
// reset standalone statement marker
trim_line_required = false;
}
let (line_no, col_no) = span.start_pos().line_col();
match rule {
Rule::template => {
template_stack.push_front(Template::new());
}
Rule::raw_text => {
// leading space fix
let start = if span.start() != prev_end {
prev_end
} else {
span.start()
};
let t = template_stack.front_mut().unwrap();
t.push_element(
Template::raw_string(
&source[start..span.end()],
Some(pair.clone()),
omit_pro_ws,
trim_line_required,
),
line_no,
col_no,
);
// reset standalone statement marker
trim_line_required = false;
}
Rule::helper_block_start
| Rule::raw_block_start
| Rule::decorator_block_start
| Rule::partial_block_start => {
let exp = Template::parse_expression(source, it.by_ref(), span.end())?;
match rule {
Rule::helper_block_start | Rule::raw_block_start => {
let helper_template = HelperTemplate::new(exp.clone(), true);
helper_stack.push_front(helper_template);
}
Rule::decorator_block_start | Rule::partial_block_start => {
let decorator = DecoratorTemplate::new(exp.clone());
decorator_stack.push_front(decorator);
}
_ => unreachable!(),
}
if exp.omit_pre_ws {
Template::remove_previous_whitespace(&mut template_stack);
}
omit_pro_ws = exp.omit_pro_ws;
// standalone statement check, it also removes leading whitespaces of
// previous rawstring when standalone statement detected
trim_line_required = Template::process_standalone_statement(
&mut template_stack,
source,
&span,
true,
);
let t = template_stack.front_mut().unwrap();
t.mapping.push(TemplateMapping(line_no, col_no));
}
Rule::invert_tag => {
// hack: invert_tag structure is similar to ExpressionSpec, so I
// use it here to represent the data
let exp = Template::parse_expression(source, it.by_ref(), span.end())?;
if exp.omit_pre_ws {
Template::remove_previous_whitespace(&mut template_stack);
}
omit_pro_ws = exp.omit_pro_ws;
// standalone statement check, it also removes leading whitespaces of
// previous rawstring when standalone statement detected
trim_line_required = Template::process_standalone_statement(
&mut template_stack,
source,
&span,
true,
);
let t = template_stack.pop_front().unwrap();
let h = helper_stack.front_mut().unwrap();
h.template = Some(t);
}
Rule::raw_block_text => {
let mut t = Template::new();
t.push_element(
Template::raw_string(
span.as_str(),
Some(pair.clone()),
omit_pro_ws,
trim_line_required,
),
line_no,
col_no,
);
template_stack.push_front(t);
}
Rule::expression
| Rule::html_expression
| Rule::decorator_expression
| Rule::partial_expression
| Rule::helper_block_end
| Rule::raw_block_end
| Rule::decorator_block_end
| Rule::partial_block_end => {
let exp = Template::parse_expression(source, it.by_ref(), span.end())?;
if exp.omit_pre_ws {
Template::remove_previous_whitespace(&mut template_stack);
}
omit_pro_ws = exp.omit_pro_ws;
match rule {
Rule::expression | Rule::html_expression => {
let helper_template = HelperTemplate::new(exp.clone(), false);
let el = if rule == Rule::expression {
Expression(Box::new(helper_template))
} else {
HtmlExpression(Box::new(helper_template))
};
let t = template_stack.front_mut().unwrap();
t.push_element(el, line_no, col_no);
}
Rule::decorator_expression | Rule::partial_expression => {
// do not auto trim ident spaces for
// partial_expression(>)
let prevent_indent = rule != Rule::partial_expression;
trim_line_required = Template::process_standalone_statement(
&mut template_stack,
source,
&span,
prevent_indent,
);
// indent for partial expression >
let mut indent = None;
if rule == Rule::partial_expression
&& !options.prevent_indent
&& !exp.omit_pre_ws
{
indent = support::str::find_trailing_whitespace_chars(
&source[..span.start()],
);
}
let mut decorator = DecoratorTemplate::new(exp.clone());
decorator.indent = indent.map(|s| s.to_owned());
let el = if rule == Rule::decorator_expression {
DecoratorExpression(Box::new(decorator))
} else {
PartialExpression(Box::new(decorator))
};
let t = template_stack.front_mut().unwrap();
t.push_element(el, line_no, col_no);
}
Rule::helper_block_end | Rule::raw_block_end => {
// standalone statement check, it also removes leading whitespaces of
// previous rawstring when standalone statement detected
trim_line_required = Template::process_standalone_statement(
&mut template_stack,
source,
&span,
true,
);
let mut h = helper_stack.pop_front().unwrap();
let close_tag_name = exp.name.as_name();
if h.name.as_name() == close_tag_name {
let prev_t = template_stack.pop_front().unwrap();
if h.template.is_some() {
h.inverse = Some(prev_t);
} else {
h.template = Some(prev_t);
}
let t = template_stack.front_mut().unwrap();
t.elements.push(HelperBlock(Box::new(h)));
} else {
return Err(TemplateError::of(
TemplateErrorReason::MismatchingClosedHelper(
h.name.debug_name(),
exp.name.debug_name(),
),
)
.at(source, line_no, col_no)
.in_template(options.name()));
}
}
Rule::decorator_block_end | Rule::partial_block_end => {
// standalone statement check, it also removes leading whitespaces of
// previous rawstring when standalone statement detected
trim_line_required = Template::process_standalone_statement(
&mut template_stack,
source,
&span,
true,
);
let mut d = decorator_stack.pop_front().unwrap();
let close_tag_name = exp.name.as_name();
if d.name.as_name() == close_tag_name {
let prev_t = template_stack.pop_front().unwrap();
d.template = Some(prev_t);
let t = template_stack.front_mut().unwrap();
if rule == Rule::decorator_block_end {
t.elements.push(DecoratorBlock(Box::new(d)));
} else {
t.elements.push(PartialBlock(Box::new(d)));
}
} else {
return Err(TemplateError::of(
TemplateErrorReason::MismatchingClosedDecorator(
d.name.debug_name(),
exp.name.debug_name(),
),
)
.at(source, line_no, col_no)
.in_template(options.name()));
}
}
_ => unreachable!(),
}
}
Rule::hbs_comment_compact => {
trim_line_required = Template::process_standalone_statement(
&mut template_stack,
source,
&span,
true,
);
let text = span
.as_str()
.trim_start_matches("{{!")
.trim_end_matches("}}");
let t = template_stack.front_mut().unwrap();
t.push_element(Comment(text.to_owned()), line_no, col_no);
}
Rule::hbs_comment => {
trim_line_required = Template::process_standalone_statement(
&mut template_stack,
source,
&span,
true,
);
let text = span
.as_str()
.trim_start_matches("{{!--")
.trim_end_matches("--}}");
let t = template_stack.front_mut().unwrap();
t.push_element(Comment(text.to_owned()), line_no, col_no);
}
_ => {}
}
if rule != Rule::template {
end_pos = Some(span.end_pos());
}
} else {
let prev_end = end_pos.as_ref().map(|e| e.pos()).unwrap_or(0);
if prev_end < source.len() {
let text = &source[prev_end..source.len()];
// is some called in if check
let (line_no, col_no) = end_pos.unwrap().line_col();
let t = template_stack.front_mut().unwrap();
t.push_element(RawString(text.to_owned()), line_no, col_no);
}
let mut root_template = template_stack.pop_front().unwrap();
root_template.name = options.name;
return Ok(root_template);
}
}
}
pub fn compile(source: &str) -> Result<Template, TemplateError>
pub fn compile_with_name<S: AsRef<str>>(
source: S,
name: String
) -> Result<Template, TemplateError>
Trait Implementations§
source§impl Evaluable for Template
impl Evaluable for Template
fn eval<'reg: 'rc, 'rc>(
&'reg self,
registry: &'reg Registry<'reg>,
ctx: &'rc Context,
rc: &mut RenderContext<'reg, 'rc>
) -> Result<(), RenderError>
source§impl PartialEq<Template> for Template
impl PartialEq<Template> for Template
source§impl Renderable for Template
impl Renderable for Template
source§fn render<'reg: 'rc, 'rc>(
&'reg self,
registry: &'reg Registry<'reg>,
ctx: &'rc Context,
rc: &mut RenderContext<'reg, 'rc>,
out: &mut dyn Output
) -> Result<(), RenderError>
fn render<'reg: 'rc, 'rc>(
&'reg self,
registry: &'reg Registry<'reg>,
ctx: &'rc Context,
rc: &mut RenderContext<'reg, 'rc>,
out: &mut dyn Output
) -> Result<(), RenderError>
render into RenderContext’s
writer
source§fn renders<'reg: 'rc, 'rc>(
&'reg self,
registry: &'reg Registry<'reg>,
ctx: &'rc Context,
rc: &mut RenderContext<'reg, 'rc>
) -> Result<String, RenderError>
fn renders<'reg: 'rc, 'rc>(
&'reg self,
registry: &'reg Registry<'reg>,
ctx: &'rc Context,
rc: &mut RenderContext<'reg, 'rc>
) -> Result<String, RenderError>
render into string