1/* Declarations relating to class gcc_rich_location
2 Copyright (C) 2014-2017 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20#ifndef GCC_RICH_LOCATION_H
21#define GCC_RICH_LOCATION_H
22
23/* A gcc_rich_location is libcpp's rich_location with additional
24 helper methods for working with gcc's types. */
25class gcc_rich_location : public rich_location
26{
27 public:
28 /* Constructors. */
29
30 /* Constructing from a location. */
31 gcc_rich_location (source_location loc) :
32 rich_location (line_table, loc) {}
33
34 /* Methods for adding ranges via gcc entities. */
35 void
36 add_expr (tree expr);
37
38 void
39 maybe_add_expr (tree t);
40
41 void add_fixit_misspelled_id (location_t misspelled_token_loc,
42 tree hint_id);
43
44 /* If LOC is within the spans of lines that will already be printed for
45 this gcc_rich_location, then add it as a secondary location
46 and return true.
47
48 Otherwise return false.
49
50 This allows for a diagnostic to compactly print secondary locations
51 in one diagnostic when these are near enough the primary locations for
52 diagnostics-show-locus.c to cope with them, and to fall back to
53 printing them via a note otherwise e.g.:
54
55 gcc_rich_location richloc (primary_loc);
56 bool added secondary = richloc.add_location_if_nearby (secondary_loc);
57 error_at_rich_loc (&richloc, "main message");
58 if (!added secondary)
59 inform (secondary_loc, "message for secondary");
60
61 Implemented in diagnostic-show-locus.c. */
62
63 bool add_location_if_nearby (location_t loc);
64};
65
66#endif /* GCC_RICH_LOCATION_H */
67