libabigail
Loading...
Searching...
No Matches
abg-writer.h File Reference

This file contains the declarations of the entry points to de-serialize an instance of abigail::translation_unit to an ABI Instrumentation file in libabigail native XML format. More...

#include "abg-fwd.h"
Include dependency graph for abg-writer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  abigail
 Toplevel namespace for libabigail.
 
namespace  abigail::xml_writer
 The namespace for the native XML file format writer.
 

Typedefs

typedef shared_ptr< write_context > write_context_sptr
 A convenience typedef for a shared pointer to write_context.
 

Enumerations

enum  type_id_style_kind { SEQUENCE_TYPE_ID_STYLE , HASH_TYPE_ID_STYLE }
 The style of type id the XML writer will output. More...
 

Functions

write_context_sptr create_write_context (const environment &env, ostream &default_output_stream)
 Create a write_context object that can be used to emit abixml files.
 
void set_annotate (write_context &ctxt, bool flag)
 Set the 'annotate' flag.
 
template<typename OPTS >
void set_common_options (write_context &ctxt, const OPTS &opts)
 A convenience generic function to set common options (usually used by Libabigail tools) from a generic options carrying-object, into a given write_context.
 
void set_ostream (write_context &ctxt, ostream &os)
 Set the new ostream.
 
void set_short_locs (write_context &ctxt, bool flag)
 Set the 'short-locs' flag.
 
void set_show_locs (write_context &ctxt, bool flag)
 Set the "show-locs" flag.
 
void set_type_id_style (write_context &ctxt, type_id_style_kind style)
 Set the 'type-id-style' property.
 
void set_write_architecture (write_context &ctxt, bool flag)
 Set the 'write-architecture' flag.
 
void set_write_comp_dir (write_context &ctxt, bool flag)
 Set the 'write-comp-dir' flag.
 
void set_write_corpus_path (write_context &ctxt, bool flag)
 Set the 'write-corpus-path' flag.
 
void set_write_default_sizes (write_context &ctxt, bool flag)
 Set the 'default-sizes' flag.
 
void set_write_elf_needed (write_context &ctxt, bool flag)
 Set the 'elf-needed' flag.
 
void set_write_parameter_names (write_context &ctxt, bool flag)
 Set the 'parameter-names' flag.
 
void set_write_undefined_symbols (write_context &ctxt, bool flag)
 Set the 'undefined-symbols' flag.
 
bool write_corpus (write_context &ctxt, const corpus_sptr &corpus, unsigned indent, bool member_of_group)
 Serialize an ABI corpus to a single native xml document. The root note of the resulting XML document is 'abi-corpus'.
 
bool write_corpus_group (write_context &ctxt, const corpus_group_sptr &group, unsigned indent)
 Serialize an ABI corpus group to a single native xml document. The root note of the resulting XML document is 'abi-corpus-group'.
 
bool write_corpus_to_archive (const corpus &corp, const bool annotate=false)
 
bool write_corpus_to_archive (const corpus &corp, const string &path, const bool annotate=false)
 
bool write_corpus_to_archive (const corpus_sptr corp, const bool annotate=false)
 
bool write_translation_unit (write_context &ctxt, const translation_unit &tu, const unsigned indent, bool is_last)
 Serialize a translation unit to an output stream.
 

Detailed Description

This file contains the declarations of the entry points to de-serialize an instance of abigail::translation_unit to an ABI Instrumentation file in libabigail native XML format.

Definition in file abg-writer.h.