summaryrefslogtreecommitdiff
path: root/support/dktools/hbconf.h
blob: 6889969a3fb532e30f2328e19e3f2854cf79e914 (plain)
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
/*
Copyright (C) 2013-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: hbconf.ctr
*/

/**	@file hbconf.h Header file for the hbconf module.
*/

#ifndef HBCONF_H_INCLUDED
/** Avoid multiple inclusions. */
#define HBCONF_H_INCLUDED 1


#line 9 "hbconf.ctr"

#ifdef __cplusplus
extern "C" {
#endif

/**	Read configuration files.
	@param	job	Job structure.
	@return	1 on success, 0 on error.
*/
int
hbconf_read_files(hb_job_t *job);

/**	Read one configuration file.
	@param	job	Job structure.
	@param	fn	Configuration file name.
	@return	1 on success, 0 on error.
*/
int
hbconf_read_one_file(hb_job_t *job, dkChar const *fn);

/**	Process one configuration line.
	@param	job	Job structure.
	@param	il	Input line to process, stored also in ilfile.
	@param	st	Section type.
	@return	1 on success, 0 on error (can continue), -1 on error (exit).
*/
int
hbconf_process_line(hb_job_t *job, dkChar *il, int st);

/**	Find template name for a node.
	@param	node	Node to find template for.
	@return	Template file name on success, NULL on error.
*/
dkChar const *
hbconf_node_template(hb_node_t *node);

/**	Find icon file name.
	@param	job	Job structure.
	@param	node	Node to find icon for.
	@param	icno	Icon number
			(0=TOC, 1=previous, 2=next, 3=index, 4=home).
	@return	File name pointer.
*/
dkChar const *
hbconf_node_icon(hb_job_t *job, hb_node_t *node, int icno);

/**	Find title for current node.
	This function is used by the hbhtml_write_header() function
	to find the title in the HTML head section.
	We use the full title if available, the title or the title
	from parent objets...
	@param	node	Node to find title for.
	@return	Title on success, NULL on error.
*/
dkChar const *
hbconf_title(hb_node_t *node);

/**	Find CSS style file for current node.
	@param	node	Node to find style file for.
	@return	File name on success, NULL on error.
*/
dkChar const *
hbconf_stylefile(hb_node_t *node);

/**	Find author for current node.
	@param	node	Node to find author for.
	@return	Author name on success, NULL on error.
*/
dkChar const *
hbconf_author(hb_node_t *node);

/**	Find shortcut icon file name.
	@param	node	Node to find file name for.
	@return	File name on success, NULL on error.
*/
dkChar const *
hbconf_favicon(hb_node_t *node);

/**	Find location (city).
	@param	node	Node to find location for.
	@return	Location on success, NULL on error.
*/
dkChar const *
hbconf_location(hb_node_t *node);

/**	Write external link character to elmbuf.
	@param	job	Job structure containing elmchr and elmbuf.
*/
void
hbconf_write_external_marker_character(hb_job_t *job);

#ifdef __cplusplus
}
#endif


#endif