[sgt/agedu] / html.h

/*
 * html.h: HTML output format for agedu.
 */

struct html_config {
    /*
     * If "format" is non-NULL, it is treated as an sprintf format
     * string which must contain exactly one %lu and no other
     * formatting directives (other than %%, which doesn't count);
     * this will be used to construct URLs to use in hrefs
     * pointing to queries of other related (parent and child)
     * pathnames.
     */
    const char *format;

    /*
     * Time stamps to assign to the extreme ends of the colour
     * scale. If "autoage" is true, they are ignored and the time
     * stamps are derived from the limits of the age data stored
     * in the index.
     */
    int autoage;
    time_t oldest, newest;
};

/*
 * Generate an HTML document containing the results of a query
 * against the pathname at a given index. Returns a dynamically
 * allocated piece of memory containing the entire HTML document,
 * as an ordinary C zero-terminated string.
 */
char *html_query(const void *t, unsigned long index, 
		 const struct html_config *cfg);
Commit	Line	Data
70322ae3	1	/*
	2	* html.h: HTML output format for agedu.
	3	*/
	4
f2e52893	5	struct html_config {
	6	/*
	7	* If "format" is non-NULL, it is treated as an sprintf format
	8	* string which must contain exactly one %lu and no other
	9	* formatting directives (other than %%, which doesn't count);
	10	* this will be used to construct URLs to use in hrefs
	11	* pointing to queries of other related (parent and child)
	12	* pathnames.
	13	*/
	14	const char *format;
	15
	16	/*
	17	* Time stamps to assign to the extreme ends of the colour
	18	* scale. If "autoage" is true, they are ignored and the time
	19	* stamps are derived from the limits of the age data stored
	20	* in the index.
	21	*/
	22	int autoage;
	23	time_t oldest, newest;
	24	};
	25
70322ae3	26	/*
	27	* Generate an HTML document containing the results of a query
	28	* against the pathname at a given index. Returns a dynamically
	29	* allocated piece of memory containing the entire HTML document,
	30	* as an ordinary C zero-terminated string.
70322ae3	31	*/
f2e52893	32	char html_query(const void t, unsigned long index,
f2e52893	33	const struct html_config *cfg);