libabigail/include/abg-reporter.h
Dodji Seketeli c80f79271a Re-license the project to Apache v2 With LLVM Exception
Thanks to the previous work done, changing the license is just a
matter of changing the SPDX identifer from "LGPL-3.0-or-later" to
"Apache-2.0 WITH LLVM-exception".  Note that for the abigail.m4,
tests/test-dot.cc and tests/test-svg.cc the change was from
"GPL-3.0-or-later WITH GCC-exception-3.1" to "Apache-2.0 WITH
LLVM-exception".  include/abg-cxx-compat.h was changed from
"LGPL-2.0-or-later" to "Apache-2.0 WITH LLVM-exception".  Source code
of programs (as opposed to source code of the library) where generally
licensed under GPL-3.0-or-later; they are also now licensed
"Apache-2.0 WITH LLVM-exception".

This is what this patch does.

	* abigail.m4: Change the SPDX identifier from "GPL-3.0-or-later
	WITH GCC-exception-3.1" to "Apache-2.0 WITH LLVM-exception"
	* include/abg-cxx-compat.h: Change the SPDX identifier from
	"LGPL-2.0-or-later" to "Apache-2.0 WITH LLVM-exception".
	* .clang-format: Change the SPDX identifier from
	  "LGPL-3.0-or-later" to "Apache-2.0 WITH LLVM-exception".
	* Makefile.am: Likewise.
	* bash-completion/Makefile.am: Likewise.
	* bash-completion/abicompat: Likewise.
	* bash-completion/abidiff: Likewise.
	* bash-completion/abidw: Likewise.
	* bash-completion/abilint: Likewise.
	* bash-completion/abinilint: Likewise.
	* bash-completion/abipkgdiff: Likewise.
	* bash-completion/abisym: Likewise.
	* bash-completion/fedabipkgdiff: Likewise.
	* configure.ac: Likewise.
	* default.abignore: Likewise.
	* doc/Makefile.am: Likewise.
	* doc/api/libabigail.doxy: Likewise.
	* doc/manuals/Makefile.am: Likewise.
	* doc/website/libabigail-website.doxy: Likewise.
	* include/Makefile.am: Likewise.
	* include/abg-comp-filter.h: Likewise.
	* include/abg-comparison.h: Likewise.
	* include/abg-config.h: Likewise.
	* include/abg-corpus.h: Likewise.
	* include/abg-diff-utils.h: Likewise.
	* include/abg-dwarf-reader.h: Likewise.
	* include/abg-fwd.h: Likewise.
	* include/abg-hash.h: Likewise.
	* include/abg-ini.h: Likewise.
	* include/abg-interned-str.h: Likewise.
	* include/abg-ir.h: Likewise.
	* include/abg-libxml-utils.h: Likewise.
	* include/abg-libzip-utils.h: Likewise.
	* include/abg-reader.h: Likewise.
	* include/abg-regex.h: Likewise.
	* include/abg-reporter.h: Likewise.
	* include/abg-sptr-utils.h: Likewise.
	* include/abg-suppression.h: Likewise.
	* include/abg-tools-utils.h: Likewise.
	* include/abg-traverse.h: Likewise.
	* include/abg-version.h.in: Likewise.
	* include/abg-viz-common.h: Likewise.
	* include/abg-viz-dot.h: Likewise.
	* include/abg-viz-svg.h: Likewise.
	* include/abg-workers.h: Likewise.
	* include/abg-writer.h: Likewise.
	* scripts/dot_to_png.sh: Likewise.
	* scripts/dot_to_svg.sh: Likewise.
	* scripts/make-verbose.sh: Likewise.
	* scripts/svg_to_plain_svg.sh: Likewise.
	* scripts/svg_to_png_and_pdf.sh: Likewise.
	* src/Makefile.am: Likewise.
	* src/abg-comp-filter.cc: Likewise.
	* src/abg-comparison-priv.h: Likewise.
	* src/abg-comparison.cc: Likewise.
	* src/abg-config.cc: Likewise.
	* src/abg-corpus-priv.h: Likewise.
	* src/abg-corpus.cc: Likewise.
	* src/abg-default-reporter.cc: Likewise.
	* src/abg-diff-utils.cc: Likewise.
	* src/abg-dwarf-reader.cc: Likewise.
	* src/abg-elf-helpers.cc: Likewise.
	* src/abg-elf-helpers.h: Likewise.
	* src/abg-hash.cc: Likewise.
	* src/abg-ini.cc: Likewise.
	* src/abg-internal.h: Likewise.
	* src/abg-ir-priv.h: Likewise.
	* src/abg-ir.cc: Likewise.
	* src/abg-leaf-reporter.cc: Likewise.
	* src/abg-libxml-utils.cc: Likewise.
	* src/abg-libzip-utils.cc: Likewise.
	* src/abg-reader.cc: Likewise.
	* src/abg-regex.cc: Likewise.
	* src/abg-reporter-priv.cc: Likewise.
	* src/abg-reporter-priv.h: Likewise.
	* src/abg-suppression-priv.h: Likewise.
	* src/abg-suppression.cc: Likewise.
	* src/abg-tools-utils.cc: Likewise.
	* src/abg-traverse.cc: Likewise.
	* src/abg-viz-common.cc: Likewise.
	* src/abg-viz-dot.cc: Likewise.
	* src/abg-viz-svg.cc: Likewise.
	* src/abg-workers.cc: Likewise.
	* src/abg-writer.cc: Likewise.
	* tests/Makefile.am: Likewise.
	* tests/data/Makefile.am: Likewise.
	* tests/lib/catch.cc: Likewise.
	* tests/mockfedabipkgdiff.in: Likewise.
	* tests/print-diff-tree.cc: Likewise.
	* tests/runtestcanonicalizetypes.sh.in: Likewise.
	* tests/runtestdefaultsupprs.py.in: Likewise.
	* tests/runtestdefaultsupprspy3.sh.in: Likewise.
	* tests/runtestfedabipkgdiff.py.in: Likewise.
	* tests/runtestfedabipkgdiffpy3.sh.in: Likewise.
	* tests/test-abicompat.cc: Likewise.
	* tests/test-abidiff-exit.cc: Likewise.
	* tests/test-abidiff.cc: Likewise.
	* tests/test-alt-dwarf-file.cc: Likewise.
	* tests/test-annotate.cc: Likewise.
	* tests/test-core-diff.cc: Likewise.
	* tests/test-cxx-compat.cc: Likewise.
	* tests/test-diff-dwarf-abixml.cc: Likewise.
	* tests/test-diff-dwarf.cc: Likewise.
	* tests/test-diff-filter.cc: Likewise.
	* tests/test-diff-pkg.cc: Likewise.
	* tests/test-diff-suppr.cc: Likewise.
	* tests/test-diff2.cc: Likewise.
	* tests/test-dot.cc: Change the SPDX identifier from
	"GPL-3.0-or-later WITH GCC-exception-3.1" to "Apache-2.0 WITH
	LLVM-exception"
	* tests/test-elf-helpers.cc: Change the SPDX identifier from
	"LGPL-3.0-or-later" to "Apache-2.0 WITH LLVM-exception"
	* tests/test-ini.cc: Likewise.
	* tests/test-ir-walker.cc: Likewise.
	* tests/test-kmi-whitelist.cc: Likewise.
	* tests/test-lookup-syms.cc: Likewise.
	* tests/test-read-dwarf.cc: Likewise.
	* tests/test-read-write.cc: Likewise.
	* tests/test-svg.cc: Change the SPDX identifier from
	"GPL-3.0-or-later WITH GCC-exception-3.1" to "Apache-2.0 WITH
	LLVM-exception".
	* tests/test-symtab.cc: Change the SPDX identifier from
	"LGPL-3.0-or-later" to "Apache-2.0 WITH LLVM-exception"
	* tests/test-tools-utils.cc: Likewise.
	* tests/test-types-stability.cc: Likewise.
	* tests/test-utils.cc: Likewise.
	* tests/test-utils.h: Likewise.
	* tests/test-write-read-archive.cc: Likewise.
	* tests/update-test-output.py: Likewise.
	* tools/Makefile.am: Likewise.
	* tools/abiar.cc: Likewise.
	* tools/abicompat.cc: Likewise.
	* tools/abidiff.cc: Likewise.
	* tools/abidw.cc: Likewise.
	* tools/abilint.cc: Likewise.
	* tools/abipkgdiff.cc: Likewise.
	* tools/abisym.cc: Likewise.
	* tools/binilint.cc: Likewise.
	* tools/fedabipkgdiff: Likewise.
	* tools/kmidiff.cc: Likewise.
	* update-copyright.sh: Likewise.

Signed-off-by: Benjamin De Kosnik <bkoz@gnu.org>
Signed-off-by: Ben Woodard <woodard@redhat.com>
Signed-off-by: Chenxiong Qi <cqi@redhat.com>
Signed-off-by: Dodji Seketeli <dodji@redhat.com>
Signed-off-by: Giuliano Procida <gprocida@google.com>
Signed-off-by: Jan Engelhardt <jengelh@inai.de>
Signed-off-by: Jessica Yu <jeyu@kernel.org>
Signed-off-by: Jonathan Wakely <jwakely@redhat.com>
Signed-off-by: Mark Wielaard <mark@klomp.org>
Signed-off-by: Matthias Klose <doko@ubuntu.com>
Signed-off-by: Matthias Maennich <maennich@google.com>
Signed-off-by: Ondrej Oprala <ondrej.oprala@gmail.com>
Signed-off-by: Roland McGrath <roland@hack.frob.com>
Signed-off-by: Sinny Kumari <ksinny@gmail.com>
Signed-off-by: Slava Barinov <v.barinov@samsung.com>
2020-12-02 11:49:13 +01:00

333 lines
8.5 KiB
C++

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// -*- Mode: C++ -*-
//
// Copyright (C) 2017-2020 Red Hat, Inc.
//
// 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 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 bool diff_has_net_changes(const corpus_diff *d) const = 0;
virtual void
report(const type_decl_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const enum_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const typedef_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const qualified_type_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const distinct_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const pointer_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const reference_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const array_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const base_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const class_or_union_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const class_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const union_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const scope_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const fn_parm_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const function_type_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const function_decl_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const var_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const translation_unit_diff& d, std::ostream& out,
const std::string& indent = "") const = 0;
virtual void
report(const corpus_diff& d, std::ostream& out,
const std::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 bool diff_has_net_changes(const corpus_diff *d) const;
virtual void
report(const type_decl_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const enum_diff& d, std::ostream& out,
const std::string& indent = "") const;
void
report_non_type_typedef_changes(const typedef_diff &d,
std::ostream& out,
const std::string& indent) const;
virtual void
report(const typedef_diff& d, std::ostream& out,
const std::string& indent = "") const;
bool
report_local_qualified_type_changes(const qualified_type_diff& d,
std::ostream& out,
const std::string& indent) const;
virtual void
report(const qualified_type_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const pointer_diff& d, std::ostream& out,
const std::string& indent = "") const;
void
report_local_reference_type_changes(const reference_diff& d,
std::ostream& out,
const std::string& indent) const;
virtual void
report(const reference_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const fn_parm_diff& d, std::ostream& out,
const std::string& indent = "") const;
void
report_local_function_type_changes(const function_type_diff& d,
std::ostream& out,
const std::string& indent) const;
virtual void
report(const function_type_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const array_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const base_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const scope_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const class_or_union_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const class_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const union_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const distinct_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const function_decl_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const var_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const translation_unit_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const corpus_diff& d, std::ostream& out,
const std::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;
virtual bool diff_has_net_changes(const corpus_diff *d) const;
void
report_changes_from_diff_maps(const diff_maps&, std::ostream& out,
const std::string& indent) const;
virtual void
report(const typedef_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const qualified_type_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const pointer_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const reference_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const fn_parm_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const function_type_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const array_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const scope_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const class_or_union_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const class_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const union_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const distinct_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const function_decl_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const var_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const translation_unit_diff& d, std::ostream& out,
const std::string& indent = "") const;
virtual void
report(const corpus_diff& d, std::ostream& out,
const std::string& indent = "") const;
}; // end class leaf_reporter
} // end namespace comparison
} // end namespace abigail
#endif // __ABG_REPORTER_H__