plustache 技术文档

1. 安装指南

plustache 是一个将 Mustache 模板引擎移植到 C++ 的项目。以下是安装 plustache 的步骤：

Linux

对于一些 Linux 发行版，可以在 Packagecloud 上找到现成的软件包。

如果没有现成的软件包，可以克隆这个仓库并运行手动安装任务：

git clone git://github.com/mrtazz/plustache.git
autoreconf -i
./configure
make
make install

OSX

在 OS X 上，可以通过以下方式安装：

brew tap mrtazz/oss
brew install plustache

2. 项目的使用说明

以下是如何使用 plustache 的基本示例：

简单使用

创建模板：

<h1>{{title}}</h1>
Hi I am {{name}}.
I like {{thing}}.

创建上下文：

#include <string>
#include <plustache/plustache_types.hpp>
#include <plustache/template.hpp>

using std::string;
using PlustacheTypes::ObjectType;
using Plustache::template_t;

ObjectType ctx;
ctx["title"] = "About";
ctx["name"] = "Daniel";
ctx["thing"] = "turtles";

实例化模板类并渲染模板：

template_t t;
string templateStr("<h1>{{title}}</h1>\nHi I am {{name}}.\nI like {{thing}}.");

string result = t.render(templateStr, ctx);

结果：

<h1>About</h1>
Hi I am Daniel.
I like turtles.

高级使用

创建模板：

<h1> {{title}} </h1>
<ul>
    {{# friends}}
      <li> {{name}}</li>
      <li> {{job}}</li>
      <li> {{status}}</li>
    {{/ friends}}
</ul>

创建上下文：

// 创建类型
context ctx;
CollectionType c;
ObjectType jim;
ObjectType john;
ObjectType jack;
// 填充值
ctx.add("title", "My friends");
jim["name"] = "Jim";
jim["job"] = "Wizard";
jim["status"] = "Eating";
john["name"] = "John";
john["job"] = "Rainbow Painter";
john["status"] = "Sleeping";
jack["name"] = "Jack";
jack["job"] = "Unicorn Trainer";
jack["status"] = "Riding";
// 插入数据
c.push_back(jim);
c.push_back(john);
ctx.add("friends", c);
// 也可以这样
ctx.add("friends", jack);

渲染模板：

template_t t;
string result = t.render(template, ctx);

3. 项目API使用文档

项目的 API 使用主要是通过 template_t 类和相关的上下文类型 PlustacheTypes 来实现的。以下是一个简单的 API 使用示例：

#include <plustache/plustache_types.hpp>
#include <plustache/template.hpp>

using PlustacheTypes::ObjectType;
using Plustache::template_t;

// 创建上下文
ObjectType ctx;
ctx["key"] = "value";

// 创建模板字符串
string templateStr("{{key}}");

// 实例化模板类
template_t t;

// 渲染模板
string result = t.render(templateStr, ctx);

在这个示例中，我们创建了一个模板字符串和对应的上下文，然后使用 template_t 类的 render 方法来生成最终的渲染结果。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。简要概括如下：

• 对于 Linux 发行版，可以通过包管理器或手动克隆仓库并编译安装。
• 对于 OS X，可以通过 Homebrew 安装。

确保遵循上述步骤以正确安装 plustache 项目。