summaryrefslogtreecommitdiff
path: root/support/dktools/hbcont.h
blob: 968770361678e42889b88b167c5d344b333d3df1 (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
/*
	WARNING: This file was generated by dkct.
	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: hbcont.ctr
*/

/*
Copyright (C) 2013-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

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

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


#line 9 "hbcont.ctr"

#ifdef __cplusplus
extern "C" {
#endif

/**	Process the contents.
	@param	job	Job structure, current node is set.
	@param	p	Previous node (if any).
	@param	n	Next node (if any).
	@return	1 on success, 0 on error.
*/
int
hbcont_process(hb_job_t *job, hb_node_t *p, hb_node_t *n);

/**	Create contents line structure.
	@param	il	Input line to save.
	@param	lineno	Line number of input line.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	Pointer to new line structure on success, NULL on error.
*/
hb_line_t *
hbcont_line_new(dkChar const *il, unsigned long lineno, dk3_app_t *app);

/**	Delete one contents line.
	@param	lp	Contents line to delete.
*/
void
hbcont_line_delete(hb_line_t *lp);

/**	Check whether input line is started by dot and one meta data keyword.
	@param	il	Input line to check.
	@return	Non-negative index on success, -1 if no meta data.
*/
int
hbcont_metadata_index(const dkChar *il);

/**	Find length of metadata name.
	@param	idx	Index of metadata name.
	@return	Positive length on success, 0 on error.
*/
size_t
hbcont_metadata_length(size_t idx);

#ifdef __cplusplus
}
#endif



#endif