blob: 9249c2aabe933bc531fd8d86763d1c4a20a98581 (
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
|
/*
* Copyright (C) 2012 Andreas Steffen
* HSR Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
*
* @defgroup imv_remediation_string_t imv_remediation_string
* @{ @ingroup imv_remediation_string
*/
#ifndef IMV_REMEDIATION_STRING_H_
#define IMV_REMEDIATION_STRING_H_
#include "imv_lang_string.h"
#include <library.h>
#include <collections/linked_list.h>
typedef struct imv_remediation_string_t imv_remediation_string_t;
/**
* Defines and builds an IETF Remediation Instructions String
*/
struct imv_remediation_string_t {
/**
* Add an individual remediation instruction to the string
*
* @param title instruction title
* @param description instruction description
* @param itemsheader optional items header or NULL
* @param items optional items list or NULL
*/
void (*add_instruction)(imv_remediation_string_t *this,
imv_lang_string_t title[],
imv_lang_string_t description[],
imv_lang_string_t itemsheader[],
linked_list_t *items);
/**
* Gets the plaintext or XML encoding of the remediation instructions
*
* @return remediation instructions string
*/
chunk_t (*get_encoding)(imv_remediation_string_t *this);
/**
* Destroys an imv_remediation_string_t object
*/
void (*destroy)(imv_remediation_string_t *this);
};
/**
* Creates an IETF Remediation Instructions String object
*
* @param as_xml XML encoding if TRUE, plaintext otherwise
* @param lang Preferred language
*/
imv_remediation_string_t* imv_remediation_string_create(bool as_xml, char *lang);
#endif /** IMV_REMEDIATION_STRING_H_ @}*/
|
