libabigail/include/abg-reporter.h
Giuliano Procida ef90972a4a abidiff: Remove blank line after typedef changes.
This patch removes perhaps the last remaining cause of double blank
lines in output.

The state variable emit_nl was being set to true just after emitting a
new line which resulted in a blank line after every local typedef
change report.

	* include/abg-reporter.h
	(default_reporter::report_local_typedef_changes): Change
	return type to void.
	* src/abg-default-reporter.cc:
	(default_reporter::report_local_typedef_changes): Change
	return type to void, remove emit_nl state variable and logic.
	* tests/data/test-abidiff/test-PR18791-report0.txt: Remove
	blank lines.
	* tests/data/test-diff-dwarf/test42-PR21296-clanggcc-report0.txt:
	Ditto.
	* tests/data/test-diff-suppr/test39-opaque-type-report-0.txt:
	Ditto.

Signed-off-by: Giuliano Procida <gprocida@google.com>
2020-04-01 15:54:02 +02:00

329 lines
8.4 KiB
C++

// -*- Mode: C++ -*-
//
// Copyright (C) 2017-2020 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
///
/// The declaration of the reporting types of libabigail's diff
/// engine.
#ifndef __ABG_REPORTER_H__
#define __ABG_REPORTER_H__
#include <ostream>
#include <string>
#include "abg-cxx-compat.h"
namespace abigail
{
using std::ostream;
using abg_compat::shared_ptr;
namespace comparison
{
class diff;
class type_decl_diff;
class enum_diff;
class typedef_diff;
class qualified_type_diff;
class distinct_diff;
class pointer_diff;
class reference_diff;
class array_diff;
class base_diff;
class class_or_union_diff;
class class_diff;
class union_diff;
class scope_diff;
class fn_parm_diff;
class function_type_diff;
class function_decl_diff;
class var_diff;
class translation_unit_diff;
class corpus_diff;
class diff_maps;
class reporter_base;
/// A convenience typedef for a shared pointer to a @ref
/// reporter_base.
typedef shared_ptr<reporter_base> reporter_base_sptr;
/// The base class of all the reporting classes.
class reporter_base
{
public:
virtual bool diff_to_be_reported(const diff *d) const;
virtual void
report(const type_decl_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const enum_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const typedef_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const qualified_type_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const distinct_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const pointer_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const reference_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const array_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const base_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const class_or_union_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const class_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const union_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const scope_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const fn_parm_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const function_type_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const function_decl_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const var_diff& d, ostream& out, const string& indent = "") const = 0;
virtual void
report(const translation_unit_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual void
report(const corpus_diff& d, ostream& out,
const string& indent = "") const = 0;
virtual ~reporter_base() {}
}; //end class reporter_base
class default_reporter;
/// A convenience typedef for a shared_ptr to a @ref default_reporter.
typedef shared_ptr<default_reporter> default_reporter_sptr;
/// The default, initial, reporter of the libabigail comparison engine.
class default_reporter : public reporter_base
{
public:
virtual void
report(const type_decl_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const enum_diff& d, ostream& out,
const string& indent = "") const;
void
report_local_typedef_changes(const typedef_diff &d,
ostream& out,
const string& indent) const;
virtual void
report(const typedef_diff& d, ostream& out,
const string& indent = "") const;
bool
report_local_qualified_type_changes(const qualified_type_diff& d,
ostream& out,
const string& indent) const;
virtual void
report(const qualified_type_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const pointer_diff& d, ostream& out, const string& indent = "") const;
void
report_local_reference_type_changes(const reference_diff& d,
ostream& out,
const string& indent) const;
virtual void
report(const reference_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const fn_parm_diff& d, ostream& out,
const string& indent = "") const;
void
report_local_function_type_changes(const function_type_diff& d,
ostream& out,
const string& indent) const;
virtual void
report(const function_type_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const array_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const base_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const scope_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const class_or_union_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const class_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const union_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const distinct_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const function_decl_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const var_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const translation_unit_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const corpus_diff& d, ostream& out,
const string& indent = "") const;
}; // end class default_reporter
/// A reporter that only reports leaf changes
class leaf_reporter : public default_reporter
{
public:
virtual bool diff_to_be_reported(const diff *d) const;
void
report_changes_from_diff_maps(const diff_maps&,
ostream& out,
const string& indent) const;
virtual void
report(const typedef_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const qualified_type_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const pointer_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const reference_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const fn_parm_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const function_type_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const array_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const scope_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const class_or_union_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const class_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const union_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const distinct_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const function_decl_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const var_diff& d, ostream& out, const string& indent = "") const;
virtual void
report(const translation_unit_diff& d, ostream& out,
const string& indent = "") const;
virtual void
report(const corpus_diff& d, ostream& out,
const string& indent = "") const;
}; // end class leaf_reporter
} // end namespace comparison
} // end namespace abigail
#endif // __ABG_REPORTER_H__