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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
// Copyright (c) 2021-2022 René Kijewski <crates.io@k6i.de>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// --- LLVM Exceptions to the Apache 2.0 License ----
//
// As an exception, if, as a result of your compiling your source code, portions
// of this Software are embedded into an Object form of such source code, you
// may redistribute such embedded portions in such Object form without complying
// with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
//
// In addition, if you combine or link compiled forms of this Software with
// software that is licensed under the GPLv2 ("Combined Software") and if a
// court of competent jurisdiction determines that the patent provision (Section
// 3), the indemnity provision (Section 9) or other Section of the License
// conflicts with the conditions of the GPLv2, you may retroactively and
// prospectively choose to deem waived or otherwise exclude such Section(s) of
// the License, but only in their entirety and only with respect to the Combined
// Software.

#![forbid(unsafe_code)]
#![allow(unused_attributes)]
#![warn(absolute_paths_not_starting_with_crate)]
#![warn(elided_lifetimes_in_paths)]
#![warn(explicit_outlives_requirements)]
#![warn(meta_variable_misuse)]
#![warn(missing_copy_implementations)]
#![warn(missing_debug_implementations)]
#![warn(missing_docs)]
#![warn(non_ascii_idents)]
#![warn(noop_method_call)]
#![warn(single_use_lifetimes)]
#![warn(trivial_casts)]
#![warn(unreachable_pub)]
#![warn(unused_crate_dependencies)]
#![warn(unused_extern_crates)]
#![warn(unused_lifetimes)]
#![warn(unused_results)]
#![allow(clippy::many_single_char_names)]

//! ## `NaTE` — Not a Template Engine
//!
//! [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Kijewski/nate/ci.yml?branch=main)](https://github.com/Kijewski/nate/actions/workflows/ci.yml)
//! [![Crates.io](https://img.shields.io/crates/v/nate-derive?logo=rust)](https://crates.io/crates/nate)
//! ![Minimum supported Rust version](https://img.shields.io/badge/rustc-1.56+-important?logo=rust "Minimum Supported Rust Version")
//! [![License](https://img.shields.io/badge/license-Apache--2.0%20WITH%20LLVM--exception-informational?logo=apache)](https://github.com/Kijewski/nate/blob/v0.2.2/LICENSE "Apache-2.0 WITH LLVM-exception")
//!
//! Proc-macros for [`NaTE`](https://crates.io/crates/nate).
//!
//! This libary implements the `#![derive(Nate)]` annotation.
//!

mod compile_error;
mod generate;
mod nate_span;
mod parse;
mod strip;

use std::convert::TryInto;
use std::fs::OpenOptions;
use std::io::Read;
use std::path::Path;

use blake2::{Blake2s256, Digest};
use compile_error::IoOp;
use darling::FromDeriveInput;
use proc_macro::TokenStream;
use quote::quote;

use crate::compile_error::CompileError;
use crate::generate::generate;
use crate::strip::Strip;

/// Implement [`fmt::Display`](core::fmt::Display) for a struct or enum
///
/// Usage:
///
/// ```ignore
/// #[derive(Nate)]
/// #[template(
///     path = "…",
///     generated = "…",
/// )]
/// struct Template { /* … */ }
/// ```
///
/// The path is relative to the cargo manifest dir (where you find Cargo.toml) of the calling
/// project.
///
/// The optional debug output path `generated` is relative to the cargo manifest dir.
/// If supplied the generated code will be written into this file.
/// An existing file fill be replaced!
#[proc_macro_derive(Nate, attributes(template))]
pub fn derive_nate(input: TokenStream) -> TokenStream {
    let err = match generate(input) {
        Ok(ts) => return ts,
        Err(err) => err,
    };

    let err = format!("{}", err);
    Into::into(quote!(
        const _: () = {
            ::nate::details::core::compile_error!(#err);
        };
    ))
}

#[derive(Debug, Default, FromDeriveInput)]
#[darling(attributes(template))]
struct Settings {
    path: String,
    #[darling(default)]
    generated: Option<String>,
    #[darling(default)]
    #[allow(unused)] // TODO
    strip: Strip,
}

#[derive(Debug, Default)]
struct Context {
    settings: Settings,
    strings_hash: Blake2s256,
}

impl Context {
    fn load_file(&mut self, path: &Path) -> Result<String, CompileError> {
        let mut f = OpenOptions::new()
            .read(true)
            .open(path)
            .map_err(|err| CompileError::IoError(IoOp::Open, path.to_owned(), err))?;
        let len = f
            .metadata()
            .map_err(|err| CompileError::IoError(IoOp::Metadata, path.to_owned(), err))?
            .len();
        let mut s = String::with_capacity(len.try_into().unwrap_or_default());
        let _ = f
            .read_to_string(&mut s)
            .map_err(|err| CompileError::IoError(IoOp::Read, path.to_owned(), err))?;
        self.strings_hash.update((s.len() as u128).to_be_bytes());
        self.strings_hash.update(s.as_bytes());
        self.strings_hash.update([0xff_u8]);
        Ok(s)
    }
}

#[doc(hidden)]
#[proc_macro_attribute]
pub fn addr(_attr: TokenStream, item: TokenStream) -> TokenStream {
    item
}