| commit | aafd86b80c43686faf4ec5286f36c36ebc56f264 | [log] [tgz] |
|---|---|---|
| author | Ludek Vodicka <ludek.vodicka@orm-designer.com> | Mon Feb 26 12:43:51 2018 +0100 |
| committer | GitHub <noreply@github.com> | Mon Feb 26 12:43:51 2018 +0100 |
| tree | e367ac84001fdb17ee26bc5f8e48feb67b01ab51 | |
| parent | f7e0fa1c684ca5a7800470f79d124a3e3117c076 [diff] |
Fixed typo set_line_statements vs set_line_statement
Inja is a template engine for modern C++, loosely inspired by jinja for python. It has an easy and yet powerful template syntax with all variables, loops, conditions, includes, callbacks, comments you need, nested and combined as you like. Inja uses the wonderful json library by nlohmann for data input and handling. Most importantly, inja needs only two header files, which is (nearly) as trivial as integration in C++ can get. Of course, everything is tested on all relevant compilers. Have a look what it looks like:
json data; data["name"] = "world"; inja::render("Hello {{ name }}!", data); // Returns "Hello world!"
Inja is a headers only library, which can be downloaded from the releases or directly from the src/ folder. Inja uses json by nlohmann as its single dependency, so make sure that it is included before inja. json can be found here.
#include "json.hpp" #include "inja.hpp" // For convenience using namespace inja; using json = nlohmann::json;
You can also integrate inja in your project using Hunter, a package manager for C++.
If you are using the Meson Build System, then you can wrap this repository as a subproject.
This tutorial will give you an idea how to use inja. It will explain the most important concepts and give practical advices using examples and executable code.
The basic template rendering takes a template as a std::string and a json object for all data. It returns the rendered template as an std::string.
json data; data["name"] = "world"; render("Hello {{ name }}!", data); // "Hello world!" // For more advanced usage, an environment is recommended Environment env = Environment(); // Render a string with json data std::string result = env.render("Hello {{ name }}!", data); // "Hello world!" // Or directly read a template file Template temp = env.parse_template("./template.txt"); std::string result = env.render_template(temp, data); // "Hello world!" data["name"] = "Inja"; std::string result = env.render_template(temp, data); // "Hello Inja!" // Or read a json file for data directly from the environment result = env.render_file("./template.txt", "./data.json"); // Or write a rendered template file env.write(temp, data, "./result.txt") env.write("./template.txt", "./data.json", "./result.txt")
The environment class can be configured to your needs.
// With default settings Environment env_default = Environment(); // With global path to template files Environment env = Environment("../path/templates/"); // With global path where to save rendered files Environment env = Environment("../path/templates/", "../path/results/"); // Choose between JSON pointer or dot notation to access elements env.set_element_notation(ElementNotation::Pointer); // (default) e.g. time/start env.set_element_notation(ElementNotation::Dot); // e.g. time.start // With other opening and closing strings (here the defaults, as regex) env.set_variables("\\{\\{", "\\}\\}"); // Variables {{ }} env.set_comments("\\{#", "#\\}"); // Comments {# #} env.set_statements("\\{\\%", "\\%\\}"); // Statements {% %} for many things, see below env.set_line_statement("##"); // Line statement ## (just an opener)
Variables are rendered within the {{ ... }} expressions.
json data; data["neighbour"] = "Peter"; data["guests"] = {"Jeff", "Tom", "Patrick"}; data["time"]["start"] = 16; data["time"]["end"] = 22; // Indexing in array render("{{ guests/1 }}", data); // "Tom" // Objects render("{{ time/start }} to {{ time/end }}pm", data); // "16 to 22pm"
In general, the variables can be fetched using the JSON Pointer syntax. For convenience, the leading / can be ommited. If no variable is found, valid JSON is printed directly, otherwise an error is thrown.
Statements can be written either with the {% ... %} syntax or the ## syntax for entire lines. The most important statements are loops, conditions and file includes. All statements can be nested.
// Combining loops and line statements render(R"(Guest List: ## for guest in guests {{ index1 }}: {{ guest }} ## endfor )", data) /* Guest List: 1: Jeff 2: Tom 3: Patrick */
In a loop, the special variables index (number), index1 (number), is_first (boolean) and is_last (boolean) are available. You can also iterate over objects like {% for key, value in time %}.
Conditions support the typical if, else if and else statements. Following conditions are for example possible:
// Standard comparisons with variable render("{% if time/hour >= 18 %}…{% endif %}", data); // True // Variable in list render("{% if neighbour in guests %}…{% endif %}", data); // True // Logical operations render("{% if guest_count < 5 and all_tired %}…{% endif %}", data); // True // Negations render("{% if not guest_count %}…{% endif %}", data); // True
This includes other template files, relative from the current file location.
{% include "footer.html" %}
A few functions are implemented within the inja template syntax. They can be called with
// Upper and lower function, for string cases render("Hello {{ upper(neighbour) }}!", data); // "Hello PETER!" render("Hello {{ lower(neighbour) }}!", data); // "Hello peter!" // Range function, useful for loops render("{% for i in range(4) %}{{ index1 }}{% endfor %}", data); // "1234" // Length function (please don't combine with range, use list directly...) render("I count {{ length(guests) }} guests.", data); // "I count 3 guests." // Get first and last element in a list render("{{ first(guests) }} was first.", data); // "Jeff was first." render("{{ last(guests) }} was last.", data); // "Patir was last." // Sort a list render("{{ sort([3,2,1]) }}", data); // "[1,2,3]" render("{{ sort(guests) }}", data); // "[\"Jeff\", \"Patrick\", \"Tom\"]" // Round numbers to a given precision render("{{ round(3.1415, 0) }}", data); // 3 render("{{ round(3.1415, 3) }}", data); // 3.142 // Check if a value is odd, even or divisible by a number render("{{ odd(42) }}", data); // false render("{{ even(42) }}", data); // true render("{{ divisibleBy(42, 7) }}", data); // true // Maximum and minimum values from a list render("{{ max([1, 2, 3]) }}", data); // 3 render("{{ min([-2.4, -1.2, 4.5]) }}", data); // -2.4 // Set default values if variables are not defined render("Hello {{ default(neighbour, \"my friend\") }}!", data); // "Hello Peter!" render("Hello {{ default(colleague, \"my friend\") }}!", data); // "Hello my friend!"
You can create your own and more complex functions with callbacks.
Environment env = Environment(); /* * Callbacks are defined by its: * - name * - number of arguments * - callback function. Implemented with std::function, you can for example use lambdas. */ env.add_callback("double", 1, [&env](Parsed::Arguments args, json data) { int number = env.get_argument<int>(args, 0, data); // Adapt the type and index of the argument return 2 * number; }); // You can then use a callback like a regular function env.render("{{ double(16) }}", data); // "32" // A callback without argument can be used like a dynamic variable: std::string greet = "Hello"; env.add_callback("double-greetings", 0, [greet](Parsed::Arguments args, json data) { return greet + " " + greet + "!"; }); env.render("{{ double-greetings }}", data); // "Hello Hello!"
Comments can be written with the {# ... #} syntax.
render("Hello{# Todo #}!", data); // "Hello!"
Currently, the following compilers are tested:
Inja is licensed under the MIT License.