Sempare Template Engine
Copyright (c) 2019-2023 Sempare Limited
Contact: [email protected]
License: GPL v3.0 or Sempare Limited Commercial License
Open Source: https://github.com/sempare/sempare-delphi-template-engine
Contents
- Introduction
- Call To Action
- Quickstart
- Features
- Objectives
- Requirements
- Installation
- Feedback
- Template Language
- Template Registry
- Customisation
- Components
- Tricks
- Template Patterns
- Whitespace Removal
- Internals
- Restrictions/Limitations/Known Bugs
- License
Introduction
Template engines are used often in technology where text needs to be customised by substituting variables with values from a data source. Examples where this may take place:
- web sites using template engines (for server side scripting)
- code generation
- mail merge
- notification messages
Please review the License section below before including the Sempare Template Engine in commercial products.
The Sempare Template Engine is a small templating engine for Delphi (Object Pascal) that allows for templates to be created easily and efficiently by providing a simple and easy to use API.
Example usage:
program Example;
uses
Sempare.Template;
type
TInformation = record
name: string;
favourite_sport : string;
count : integer;
end;
begin
var tpl := Template.Parse(
'My name is <% name %>.'#13#10 +
'My favourite sport is <% favourite_sport %>.'#13#10 +
'Counting... <% for i := 1 to count %><% i %><% betweenitems %>, <% end %>'
);
var info : TInformation;
info.name := 'conrad';
info.favourite_sport := 'ultimate';
info.count := 3;
writeln(Template.Eval(tpl, info));
end.
The project uses Run-time Type Information (RTTI) to allow for almost any type to be dereferenced within the template script.
In the example above, you can see that the '<%' start and '%>' end the scripting statement respectively. Within a scripting statement, you can reference variables, assign variables, use conditions, for and while loops, and include other templates.
NOTE In examples in this documentation I may use the latest Delphi syntax, e.g. inline variable declarations. This is not backward compatible as they were introduced in Delphi 10.2 and are used to shorten the code/examples being illustrated in the documentation. The codebase will attempt to be as backward compatible as possible.
Call to action
Please 'star' the project on github.
Quickstart
There are a few ways to get started quickly.
- Look at the examples on how to do server side scripting using some popular web frameworks:
Try the demo if you want to dive in quick and play with the template engine.
Features
- statements
- if, elif, else statements
- for and while statements
- include statement
- extends / block statements
- with statement
- function/method calls
- expressions
- simple expression evaluation (logical, numerical and string)
- variable definition
- functions and methods calls
- dereference records, custom managed records, classes, arrays, JSON objects, TDataSet descendants and dynamic arrays
- ternary operator
- safety
- max run-time protection
- customisation
- custom script token replacement
- add custom functions
- strip recurring spaces and new lines
- lazy template resolution
- parse time evaluation of expressions/statements
- allow use of custom encoding (UTF-8 with BOM, UTF-8 without BOM, ASCII, etc)
- extensibile RTTI interface to easily dereference classes and interfaces (current customisations for ITemplateVariables, TDictionary, TJsonObject)
Objectives
The Sempare Template Engine is not intended to be a fully featured general purpose programming language such as PHP where the script itself could be a self contained programming language (but it does have most of the features).
Sempare Template Engine aims to provide just enough functionality to allow you to easily work with the 'view' aspects of a template. Any enhanced functionality required from the scripting environment should be provided by the custom functions written in Object Pascal.
Requirements
The template engine works with modern versions of Delphi.
Tests currently run using the DUnitX TestFramework.
An attempt has been made not to use the latest features to ease backward compatability. The following versions have been tested:
- Delphi XE 4 to XE 8
- Delphi 10.0 Seatle
- Delphi 10.1 Berlin
- Delphi 10.2 Tokyo
- Delphi 10.3.3 Rio
- Delphi 10.4 Sydney
- Delphi 11.0 to 11.3 Alexandria
There should be no platform specific restrictions.
Have a look at Sempare.Template.Compiler.inc. The following defines can be defined if appropriate:
- SEMPARE_TEMPLATE_NO_INDY - if Indy is not present. This is used to access an html encoder if TNetEncoding is not available.
- SEMPARE_TEMPLATE_CONFIRM_LICENSE - if present, you confirm you understand the conditions.
Installation
GetIt
The Sempare Template Engine for Delphi can be installed via the Embarcadero GetIt manager
This will add the src folder to the search path so you can start working immediately.
Boss
The Sempare Template Engine for Delphi can be installed via the Boss package manager.
Simply run:
boss install sempare/sempare-delphi-template-engine
Delphinus
The Sempare Template Engine for Delphi can be installed via the Delphinus package manager.
This will add the src folder to the search path so you can start working immediately.
Manual Install
Start by adding the src folder to the Delphi search path. Otherwise, there are some projects you can use:
Open Sempare.Template.Engine.Group.groupproj which will include:
-
Sempare.Template.Pkg.dproj
The core template project. (runtime)
-
Sempare.Template.Tester.dproj
180+ unit tests
-
demo\SempareTemplatePlayground\Sempare.TemplateEngine.Playground.dproj
The Sempare Template Playground demo which provides a rich experience for testing the various template language features.
Feedback
You can raise issues on GitHub and they will be addressed based on priority.
Most features have some basic tests in place. If a bug is been discovered, please include a basic test/scenario replicating the issue if possible as this will ease the investigation process.
Contributions
Review contibution terms and conditions to contribute to the project.
License
The Sempare Template Engine is dual-licensed. You may choose to use it under the restrictions of the GPL v3.0 at no cost to you, or you may license it for use under the Sempare Limited Commercial License
The dual-licensing scheme allows you to use and test the library with no restrictions, but subject to the terms of the GPL. A nominal fee is requested to support the maintenance of the library if the product is to be used in commercial products. This support fee binds you to the commercial license, removing any of the GPL restrictions, and allowing you to use the library in your products as you will. The Sempare Template Engine may NOT be included or distributed as part of another commercial library or framework without approval / commercial review.
A commercial licence grants you the right to use Sempare Template Engine in your own applications, royalty free, and without any requirement to disclose your source code nor any modifications to Sempare Template Engine or to any other party. A commercial license lasts into perpetuity, and entitles you to all future updates.
A commercial licence is provided per developer developing applications that uses the Sempare Template Engine. The initial license fee is $70 per developer. For support thereafter, at your discretion, a support fee of $30 per developer per year would be appreciated. The initial site licensing fee is $1,500 and the annual site support licensing fee is $500.
The following payment links allow you to quickly subscribe. Please note that the initial license and support links are seperate.
The following payment links are available for site licenses. Please note that the initial license and support links are seperate.
Please send an e-mail to [email protected] to request an invoice which will contain alternative payment details.
Support and enhancement requests submitted by users that pay for support will be prioritised. New developments may incur additional costs depending on time required for implementation.