libabigail/include/abg-reader.h
Dodji Seketeli 73814ba4fa Misc Doxygen API doc fixes
* include/abg-comparison.h: Various doxygen api doc string fixes.
	* include/abg-diff-utils.h: Likewise.
	* include/abg-dwarf-reader.h: Likewise.
	* include/abg-ir.h: Likewise.
	* include/abg-reader.h: Likewise.
	* include/abg-writer.h: Likewise.
	* src/abg-comparison.cc: Likewise.
	* src/abg-corpus.cc: Likewise.
	* src/abg-dwarf-reader.cc: Likewise.
	* src/abg-ir.cc: Likewise.
	* src/abg-libxml-utils.cc: Likewise.
	* src/abg-reader.cc: Likewise.
	* src/abg-writer.cc: Likewise.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
2014-01-17 15:44:25 +01:00

93 lines
2.3 KiB
C++

// -*- Mode: C++ -*-
//
// Copyright (C) 2013 Red Hat, Inc.
//
// This file is part of the GNU Application Binary Interface Generic
// Analysis and Instrumentation Library (libabigail). This library is
// free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License as published by the
// Free Software Foundation; either version 3, or (at your option) any
// later version.
// This library 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 Lesser Public License for more details.
// You should have received a copy of the GNU Lesser General Public
// License along with this program; see the file COPYING-LGPLV3. If
// not, see <http://www.gnu.org/licenses/>.
//
// Author: Dodji Seketeli
/// @file
///
/// This file contains the declarations of the entry points to
/// de-serialize an instance of @ref abigail::translation_unit from an
/// ABI Instrumentation file in libabigail native XML format.
#ifndef __ABG_READER_H__
#define __ABG_READER_H__
#include <istream>
#include "abg-corpus.h"
namespace abigail
{
class translation_unit;
namespace xml_reader
{
translation_unit_sptr
read_translation_unit_from_file(const std::string& file_path);
bool
read_translation_unit_from_file(const string& input_file,
translation_unit& tu);
bool
read_translation_unit_from_file(translation_unit& tu);
translation_unit_sptr
read_translation_unit_from_buffer(const std::string& file_path);
bool
read_translation_unit_from_buffer(const string& buffer,
translation_unit& tu);
bool
read_translation_unit_from_istream(std::istream* in,
translation_unit& tu);
translation_unit_sptr
read_translation_unit_from_istream(std::istream* in);
abigail::corpus_sptr
read_corpus_from_file(const string& path);
int
read_corpus_from_file(corpus& corp, const string& path);
int
read_corpus_from_file(corpus& corp);
bool
read_corpus_from_native_xml(std::istream* in,
corpus& corp);
corpus_sptr
read_corpus_from_native_xml(std::istream* in);
bool
read_corpus_from_native_xml_file(corpus& corp,
const string& path);
corpus_sptr
read_corpus_from_native_xml_file(const string& path);
}//end xml_reader
}//end namespace abigail
#endif // __ABG_READER_H__