Clearsilver简介

Clearsilver是一套用c语言实现的html模板系统，同时还提供了python、perl、c++等语言的调用接口。Clearsilver本身非常高效，还提供了国际化支持、gzip压缩、字符串转义等功能，在google groups、trac等系统中得到了应用，更多应用请见这里。

Clearsilver的两个基本概念为数据和Clearsilver(CS)模板。模板由html语句和CS语句构成，控制着数据的表现形式。通过使用Clearsilver，可以强制数据和表现分离，有利于后台数据人员和前台数据人员各司其职协同工作，不用修改后台逻辑就可以完成页面的重构。

Clearsilver的数据使用了一种叫做HDF的结构，它支持两种定义方式。第一种是点分路径方式。

Page.Name = My Index
Page.URL = /myindex.html
Page.Menu.0 = Home
Page.Menu.1 = Preferences
Page.Menu.2 = Help
Page.Menu.3 = Support

第二种是嵌套元素的方式。

Page {
  Name = My Index
  URL = /myindex.html
  Menu {
    0 = Home
    1 = Preferences
    2 = Help
    3 = Support
  }
}

Clearsilver的基本使用方式如下：

• 初始化hdf结构
• 填充数据
• 初始化cs模板
• 载入模板文件
• 调用cs_render完成页面的渲染

最后是一个简单的示例

test.html 模板文件

<?cs if:subcount(article.list) != #0?>
<table>
    <tr><th>序号</th><th>作者</th><th>日期</th><th>标题</th></tr>
    <?cs each:item=article.list ?>
    <tr>
        <td><?cs var:item.id ?></td>
        <td><a href="/author_info.cgi?author=&lt;?cs var:item.author ?>"><?cs var:item.author ?></a></td>
        <td><?cs var:item.publish_time ?></td>
        <td><a href="/show_article.cg?id=&lt;?cs var:item.id ?>"><?cs var:item.title ?></a></td>
    </tr>
    <?cs /each ?>
</table>
<?cs /if ?>

test.c 程序文件

#include "ClearSilver.h"
#include <time.h>
#include <stdio.h>

#define ID_LEN 16
#define TITLE_LEN 64
struct article
{
    int id;
    char author[ID_LEN];
    time_t publish_time;
    char title[TITLE_LEN];
};
/* hdf结构
 * article{
     list{
        0 {
            id =
            author =
            publish_time =
            title =
        }
        1 {
            id =
            author =
            publish_time =
            title =
        }
        ...
      }
   }
*/

NEOERR * print_cs(void *ctx, char *result)
{
    printf("%s", result);
    return STATUS_OK;
}

int main()
{
    const int ARTICLE_NUM = 5;
    struct article articles[ARTICLE_NUM];
    int i;
    for( i = 0 ; i < ARTICLE_NUM ; i++ )
    {
        articles[i].id = i+1;
        snprintf(articles[i].author, sizeof(articles[i].author), "author%d", i);
        articles[i].publish_time = time(NULL) - 100 * i;
        snprintf(articles[i].title, sizeof(articles[i].title), "标题--%d", i);
    }

    nerr_init();
    NEOERR *err;
    HDF *hdf;
    err = hdf_init(&hdf);
    if( err != STATUS_OK )
    {
        /* nerr_log_error logs the error to stderr and cleans up */
        nerr_log_error(err);
        return -1;
    }

    char buf[1024];
    char key[64];
    for(i = 0; i < ARTICLE_NUM; i++)
    {
        snprintf(key, sizeof(key), "article.list.%d.id", articles[i].id);
        hdf_set_int_value(hdf, key, articles[i].id);

        snprintf(key, sizeof(key), "article.list.%d.author", articles[i].id);
        hdf_set_value(hdf, key, articles[i].author);

        snprintf(key, sizeof(key), "article.list.%d.publish_time", articles[i].id);
        hdf_set_value(hdf, key, ctime(&articles[i].publish_time));

        snprintf(key, sizeof(key), "article.list.%d.title", articles[i].id);
        hdf_set_value(hdf, key, articles[i].title);
    }

    /*
     * 把hdf结构dump到文件中
    hdf_write_file(hdf, "123.html");
    */

    CSPARSE *parse;
    err = cs_init(&parse, hdf);
    if( err != STATUS_OK )
    {
        nerr_log_error(err);
        return -1;
    }
    err = cs_parse_file(parse, "test.html");
    if( err != STATUS_OK )
    {
        nerr_log_error(err);
        return -1;
    }
    err = cs_render(parse, NULL, print_cs);
    if( err != STATUS_OK )
    {
        nerr_log_error(err);
        return -1;
    }
    cs_destroy(&parse);
    hdf_destroy(&hdf);
    return 0;
}

makefile

all:test.c
    gcc -g test.c -I /home/neoli/usr/include/ClearSilver/ -L/home/neoli/usr/lib -lneo_cs -lneo_utl