1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
|
/*
* template.h - SOIF template processing support
*
* Darren Hardy, hardy@cs.colorado.edu, July 1994
*
* $Id: template.h,v 1.8 1995/02/01 00:55:09 hardy Exp $
*
* ----------------------------------------------------------------------
* Copyright (c) 1994, 1995. All rights reserved.
*
* Mic Bowman of Transarc Corporation.
* Peter Danzig of the University of Southern California.
* Darren R. Hardy of the University of Colorado at Boulder.
* Udi Manber of the University of Arizona.
* Michael F. Schwartz of the University of Colorado at Boulder.
*
* This copyright notice applies to all code in Harvest other than
* subsystems developed elsewhere, which contain other copyright notices
* in their source text.
*
* The Harvest software was developed by the Internet Research Task
* Force Research Group on Resource Discovery (IRTF-RD). The Harvest
* software may be used for academic, research, government, and internal
* business purposes without charge. If you wish to sell or distribute
* the Harvest software to commercial clients or partners, you must
* license the software. See
* http://harvest.cs.colorado.edu/harvest/copyright,licensing.html#licensing.
*
* The Harvest software is provided ``as is'', without express or
* implied warranty, and with no support nor obligation to assist in its
* use, correction, modification or enhancement. We assume no liability
* with respect to the infringement of copyrights, trade secrets, or any
* patents, and are not responsible for consequential damages. Proper
* use of the Harvest software is entirely the responsibility of the user.
*
* For those who are using Harvest for non-commercial purposes, you may
* make derivative works, subject to the following constraints:
*
* - You must include the above copyright notice and these accompanying
* paragraphs in all forms of derivative works, and any documentation
* and other materials related to such distribution and use acknowledge
* that the software was developed at the above institutions.
*
* - You must notify IRTF-RD regarding your distribution of the
* derivative work.
*
* - You must clearly notify users that your are distributing a modified
* version and not the original Harvest software.
*
* - Any derivative product is also subject to the restrictions of the
* copyright, including distribution and use limitations.
*/
#ifndef _TEMPLATE_H_
#define _TEMPLATE_H_
#include <stdio.h>
#include "config.h"
/* Attribute-Value pair */
struct attr_value {
char *attribute; /* Attribute string; '\0' terminated */
char *value; /* Value data; not '\0' terminated */
size_t vsize; /* # of bytes in the value data */
size_t offset; /* Starting byte of the value data in input */
};
typedef struct attr_value AVPair;
/* List of Attribute-Value pairs */
struct attr_value_list {
AVPair *data;
struct attr_value_list *next;
};
typedef struct attr_value_list AVList;
/* SOIF Template structure */
struct template {
char *template_type; /* type of template */
char *url; /* URL for template */
AVList *list; /* List of Attribute-Value pairs */
size_t offset; /* Starting byte of the template; the @ */
size_t length; /* # of bytes that the template covers */
};
typedef struct template Template;
/* Common Attribute Tags */
#define T_ABSTRACT "Abstract"
#define T_AUTHOR "Author"
#define T_FILESIZE "File-Size"
#define T_FULLTEXT "Full-Text"
#define T_GENERATION "Generation-Time"
#define T_GHOST "Gatherer-Host"
#define T_GNAME "Gatherer-Name"
#define T_GVERSION "Gatherer-Version"
#define T_KEYS "Keywords"
#define T_LMT "Last-Modification-Time"
#define T_MD5 "MD5"
#define T_NESTED "Nested-Filename"
#define T_PARTTEXT "Partial-Text"
#define T_REFERENCE "References"
#define T_REFRESH "Refresh-Rate"
#define T_RELATED "Related"
#define T_TITLE "Title"
#define T_TTL "Time-to-Live"
#define T_TYPE "Type"
#define T_UPDATE "Update-Time"
#define T_URL "URL"
/* Backwards compatibility */
#define T_FILETYPE T_TYPE
#define T_TIMESTAMP T_LMT
/* Common time_t numbers */
#define HOUR ((time_t) 60 * 60)
#define DAY ((time_t) HOUR * 24)
#define WEEK ((time_t) DAY * 7)
#define MONTH ((time_t) WEEK * 4)
#define YEAR ((time_t) MONTH * 12)
#ifndef _PARAMS
#if defined(__STDC__) || defined(__cplusplus) || defined(__STRICT_ANSI__)
#define _PARAMS(ARGS) ARGS
#else /* Traditional C */
#define _PARAMS(ARGS) ()
#endif /* __STDC__ */
#endif /* _PARAMS */
/* Templates */
Template *create_template _PARAMS((char *, char *));
Template *embed_template _PARAMS((Template *, Template *));
void free_template _PARAMS((Template *));
/* Attribute-Value pairs */
AVList *create_AVList _PARAMS((char *, char *, int));
void add_AVList _PARAMS((AVList *, char *, char *, int));
void FAST_add_AVList _PARAMS((AVList *, char *, char *, int));
void append_AVList _PARAMS((AVList *, char *, char *, int));
AVPair *extract_AVPair _PARAMS((AVList *, char *));
AVList *merge_AVList _PARAMS((AVList *, AVList *));
AVList *sort_AVList _PARAMS((AVList *));
AVList *sink_embedded _PARAMS((AVList *));
int exists_AVList _PARAMS((AVList *, char *));
void free_AVPair _PARAMS((AVPair *));
void free_AVList _PARAMS((AVList *));
/* Printing Templates */
Buffer *init_print_template _PARAMS((FILE *));
void print_template _PARAMS((Template *));
void print_template_header _PARAMS((Template *));
void print_template_body _PARAMS((Template *));
void print_template_trailer _PARAMS((Template *));
void finish_print_template _PARAMS(());
/* Parsing Templates */
void init_parse_template_file _PARAMS((FILE *));
void init_parse_template_string _PARAMS((char *, int));
Template *parse_template _PARAMS(());
void finish_parse_template _PARAMS(());
int is_parse_end_of_input _PARAMS(());
#endif /* _TEMPLATE_H_ */
|