etl_template.h

Go to the documentation of this file.

/* Copyright 2005-2006 Garrett Rooney.
 *
 * 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.
 */

/**
 * @file etl_template.h
 * @brief Functions for manipulating ETL template files
 */

#ifndef ETL_TEMPLATE_H
#define ETL_TEMPLATE_H

#include <apr.h>
#include <apr_hash.h>
#include <apr_tables.h>
#include <apr_buckets.h>

#include "etl_error.h"
#include "etl_resolver.h"

#define ETL_TEMPLATE_MAJOR_VERSION 0
#define ETL_TEMPLATE_MINOR_VERSION 1
#define ETL_TEMPLATE_PATCH_VERSION 0

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** A parsed template. */
typedef struct etl_template_t etl_template_t;

/**
 * Parse a bucket brigade @a input that contains ETL Template Language.
 *
 * Return a template in @a *tmpl, allocated in @a pool.
 */
etl_error_t *
etl_template_parse(etl_template_t **tmpl,
                   apr_bucket_brigade *input,
                   apr_pool_t *pool);

/**
 * Parse a file @a fname, which contains ETL Template Language, returning
 * it in @a *tmpl and allocating it in @a pool.
 */
etl_error_t *
etl_template_parse_file(etl_template_t **tmpl,
                        const char *fname,
                        apr_pool_t *pool);

/**
 * Execute @a tmpl in the context of @a environment sending output to
 * @a out and using @a pool for temporary allocations.
 *
 * @a resolver is used to find included templates.
 *
 * @a environment is a hash mapping <tt>char *</tt>'s to
 * @c etl_template_variable_t's.
 */
etl_error_t *
etl_template_execute(etl_template_t *tmpl,
                     etl_resolver_t *resolver,
                     apr_hash_t *environment,
                     apr_bucket_brigade *out,
                     apr_pool_t *pool);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* ETL_TEMPLATE_H */

---