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
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// -*- Mode: C++ -*-
//
// Copyright (C) 2013-2025 Red Hat, Inc.
//
// Author: Dodji Seketeli
/// @file
///
/// This file contains the declarations of the entry points to
/// de-serialize an instance of @ref abigail::translation_unit to an
/// ABI Instrumentation file in libabigail native XML format.
#ifndef __ABG_WRITER_H__
#define __ABG_WRITER_H__
#include "abg-fwd.h"
namespace abigail
{
namespace xml_writer
{
using namespace abigail::ir;
/// The style of type id the XML writer will output.
enum type_id_style_kind
{
SEQUENCE_TYPE_ID_STYLE,
HASH_TYPE_ID_STYLE
};
class write_context;
/// A convenience typedef for a shared pointer to write_context.
typedef shared_ptr<write_context> write_context_sptr;
write_context_sptr
create_write_context(const environment& env,
ostream& output_stream);
void
set_show_locs(write_context& ctxt, bool flag);
void
set_annotate(write_context& ctxt, bool flag);
void
set_write_architecture(write_context& ctxt, bool flag);
void
set_write_corpus_path(write_context& ctxt, bool flag);
void
set_write_comp_dir(write_context& ctxt, bool flag);
void
set_write_elf_needed(write_context& ctxt, bool flag);
void
set_write_undefined_symbols(write_context& ctxt, bool flag);
void
set_write_default_sizes(write_context& ctxt, bool flag);
void
set_short_locs(write_context& ctxt, bool flag);
void
set_write_parameter_names(write_context& ctxt, bool flag);
void
set_type_id_style(write_context& ctxt, type_id_style_kind style);
/// A convenience generic function to set common options (usually used
/// by Libabigail tools) from a generic options carrying-object, into
/// a given @ref write_context.
///
/// @param ctxt the @ref the write_context to consider.
///
/// @param opts the option-carrying object to set the options from.
/// It must contain data members named: annotate, and show_locs, at
/// very least.
template <typename OPTS>
void
set_common_options(write_context& ctxt, const OPTS& opts)
{
set_annotate(ctxt, opts.annotate);
set_show_locs(ctxt, opts.show_locs);
set_write_architecture(ctxt, opts.write_architecture);
set_write_corpus_path(ctxt, opts.write_corpus_path);
set_write_comp_dir(ctxt, opts.write_comp_dir);
set_write_elf_needed(ctxt, opts.write_elf_needed);
set_write_undefined_symbols(ctxt, opts.load_undefined_interfaces);
set_write_parameter_names(ctxt, opts.write_parameter_names);
set_short_locs(ctxt, opts.short_locs);
set_write_default_sizes(ctxt, opts.default_sizes);
set_type_id_style(ctxt, opts.type_id_style);
}
void
set_ostream(write_context& ctxt, ostream& os);
bool
write_translation_unit(write_context& ctxt,
const translation_unit& tu,
const unsigned indent,
bool last = true);
bool
write_corpus_to_archive(const corpus& corp,
const string& path,
const bool annotate = false);
bool
write_corpus_to_archive(const corpus& corp,
const bool annotate = false);
bool
write_corpus_to_archive(const corpus_sptr corp,
const bool annotate = false);
bool
write_corpus(write_context& ctxt,
const corpus_sptr& corpus,
unsigned indent,
bool member_of_group = false);
bool
write_corpus_group(write_context& ctx,
const corpus_group_sptr& group,
unsigned indent);
}// end namespace xml_writer
#ifdef WITH_DEBUG_SELF_COMPARISON
void
write_canonical_type_ids(xml_writer::write_context&, ostream&);
bool
write_canonical_type_ids(xml_writer::write_context&,
const string &);
#endif
}// end namespace abigail
#endif // __ABG_WRITER_H__
|
