* [PATCH] Multibyte awareness for diagnostics (PR 49973)
@ 2019-09-26 20:16 Lewis Hyatt
2019-09-26 20:47 ` Joseph Myers
0 siblings, 1 reply; 17+ messages in thread
From: Lewis Hyatt @ 2019-09-26 20:16 UTC (permalink / raw)
To: gcc-patches
[-- Attachment #1: Type: text/plain, Size: 1881 bytes --]
Hello-
PR preprocessor/49973 addresses the fact that the column number in diagnostics
is not correct if the source lines contain multibyte characters. The attached
patch corrects this. The outlines of it were discussed starting here:
https://gcc.gnu.org/bugzilla/show_bug.cgi?id=49973#c13. If it looks OK, could
you please apply it? The patch is a bit large unfortunately, because the column
number was just the tip of the iceberg. There is a lot of machinery in
diagnostic-show-locus.c that also requires multibyte awareness, which I have
done in this patch as well.
A couple notes:
- In order to avoid any portability problems with wchar_t, the
equivalent of wcwidth() from libc is implemented in-house.
- The diagnostic-show-locus stuff needs to know both the bytes column and
the display column. All location infrastructure (e.g. line-map.h) tracks byte
offsets, so I left that all alone. Rather, diagnostic-show-locus.c just
computes display columns on demand when it needs them.
- In the above-linked PR, Joseph and I also discussed a couple related
fixes that need to be made, namely, when -finput-charset is in use, the
translation needs to be applied when reading source lines for the purpose of
diagnostics printing, which currently it is not, and also, when outputting
diagnostics, the current locale should be inspected to avoid outputting bytes
that the user's terminal cannot display. I have separate patches for these two
as well, but since they are more or less orthogonal to this one, I will submit
them later.
Thank you for your time taking a look at this. It will be nice to clean these
up as part of the support for extended characters in identifiers. I have a
related issue for extended characters also in PR 91843
(https://gcc.gnu.org/bugzilla/show_bug.cgi?id=91843#c1). I can also submit that
couple-line patch here if it looks OK.
-Lewis
[-- Attachment #2: ChangeLog.txt --]
[-- Type: text/plain, Size: 3845 bytes --]
/ChangeLog
2019-09-26 Lewis Hyatt <lhyatt@gmail.com>
PR preprocessor/49973
* contrib/gen_wcwidth.cpp: New standalone utility to generate
libcpp/generated_cpp_wcwidth.h.
libcpp/ChangeLog
2019-09-26 Lewis Hyatt <lhyatt@gmail.com>
PR preprocessor/49973
* generated_cpp_wcwidth.h: New file generated by
contrib/gen_wcwidth.cpp, supports new cpp_wcwidth function.
* charset.c (compute_next_display_width): New function to help
implement display columns.
(cpp_byte_column_to_display_column): Likewise.
(cpp_display_column_to_byte_column): Likewise.
(cpp_wcwidth): Likewise.
* include/cpplib.h (cpp_byte_column_to_display_column): Declare.
(cpp_display_column_to_byte_column): Declare.
(cpp_wcwidth): Declare.
(cpp_display_width): New function.
gcc/ChangeLog
2019-09-26 Lewis Hyatt <lhyatt@gmail.com>
PR preprocessor/49973
* input.c (location_compute_display_column): New function to help with
multibyte awareness in diagnostics.
(test_cpp_utf8): New self-test.
(input_c_tests): Call the new test.
* input.h (location_compute_display_column): Declare.
* diagnostic.c (diagnostic_get_location_text): Use it to output the
correct column number on diagnostics for source lines containing
multibyte characters.
* diagnostic-show-locus.c: Pervasive changes to add multibyte awareness
to all classes and functions.
(class exploc_with_display_col): New class.
(class layout_point): Add m_display_col member.
(layout_point::get_col): New function.
(layout_range::contains_point): Add use_display argument.
(test_layout_range_for_single_point): Pass new argument.
(test_layout_range_for_single_line): Likewise.
(test_layout_range_for_multiple_lines): Likewise.
(line_bounds::convert_to_display_cols): New function.
(layout::get_state_at_point): Add use_display argument.
(class layout): m_exploc changed to exploc_with_display_col from
expanded_location.
(layout::layout): Add multibyte awareness.
(layout::print_source_line): Likewise.
(layout::print_annotation_line): Likewise.
(line_label::line_label): Likewise.
(layout::print_any_labels): Likewise.
(layout::annotation_line_showed_range_p): Likewise.
(get_printed_columns): Likewise.
(get_affected_columns): Rename to...
(get_affected_range): ...this; add use_display argument and multibyte
awareness.
(class correction): Add m_affected_bytes and m_display_cols
members. Rename m_len to m_bytes for clarity. Add multibyte awareness.
(correction::insertion_p): Add multibyte awareness.
(correction::compute_display_cols): New function.
(correction::ensure_terminated): m_len renamed to m_bytes.
(line_corrections::add_hint): Add multibyte awareness.
(layout::print_trailing_fixits): Likewise.
(layout::get_x_bound_for_row): Likewise.
(test_one_liner_simple_caret_utf8): New self-test analogous to the one
with _utf8 suffix removed, testing multibyte awareness.
(test_one_liner_caret_and_range_utf8): Likewise.
(test_one_liner_multiple_carets_and_ranges_utf8): Likewise.
(test_one_liner_fixit_insert_before_utf8): Likewise.
(test_one_liner_fixit_insert_after_utf8): Likewise.
(test_one_liner_fixit_remove_utf8): Likewise.
(test_one_liner_fixit_replace_utf8): Likewise.
(test_one_liner_fixit_replace_non_equal_range_utf8): Likewise.
(test_one_liner_fixit_replace_equal_secondary_range_utf8): Likewise.
(test_one_liner_fixit_validation_adhoc_locations_utf8): Likewise.
(test_one_liner_many_fixits_1_utf8): Likewise.
(test_one_liner_many_fixits_2_utf8): Likewise.
(test_one_liner_labels_utf8): Likewise.
(test_diagnostic_show_locus_one_liner_utf8): Likewise.
(test_overlapped_fixit_printing_utf8): Likewise.
(test_overlapped_fixit_printing): Adapt for changes to
get_affected_columns, get_printed_columns and class corrections.
(test_overlapped_fixit_printing_2): Likewise.
(diagnostic_show_locus_c_tests): Call new tests.
[-- Attachment #3: display_cols.patch --]
[-- Type: text/x-patch, Size: 83628 bytes --]
diff --git a/contrib/gen_wcwidth.cpp b/contrib/gen_wcwidth.cpp
new file mode 100644
index 00000000000..a9422b0ad08
--- /dev/null
+++ b/contrib/gen_wcwidth.cpp
@@ -0,0 +1,53 @@
+#include <cwchar>
+#include <vector>
+#include <clocale>
+#include <cstdio>
+using namespace std;
+
+#if ! defined __STDC_ISO_10646__
+#error Need to run on a host where wchar_t is a 32-bit Unicode codepoint.
+#endif
+
+int adjusted_wcwidth (wchar_t c)
+{
+ /* N.B. We treat all ASCII control bytes as width 1, this is consistent
+ with how they get output when printing source lines. */
+ const int width = wcwidth (c);
+ return width == -1 ? 1 : width;
+}
+
+int main ()
+{
+ setlocale (LC_CTYPE, "");
+ struct Range
+ {
+ wchar_t last;
+ int width;
+ };
+ vector<Range> v;
+ Range cur = {0, 1}; /* Override null byte to width 1 too. */
+ for (wchar_t c = 1; c <= 0x10FFFF; ++c)
+ {
+ const int width = adjusted_wcwidth (c);
+ if (width == cur.width)
+ cur.last = c;
+ else
+ {
+ v.push_back (cur);
+ cur.last = c;
+ cur.width = width;
+ }
+ }
+ v.push_back (cur);
+
+ printf ("/* Generated by contrib/gen_wcwidth.cpp. */\n\n");
+ printf ("static const cppchar_t wcwidth_range_ends[] = {");
+ for (size_t i = 0, nr = v.size (); i != nr; ++i)
+ printf ("%s0x%x,", i % 8 ? " " : "\n ", v[i].last);
+ printf ("\n};\n\n");
+
+ printf ("static const unsigned char wcwidth_widths[] = {");
+ for (size_t i = 0, nr = v.size (); i != nr; ++i)
+ printf ("%s%d,", i % 24 ? " " : "\n ", v[i].width);
+ printf ("\n};\n");
+}
diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c
index 4d563dda8f4..7a5bd36d962 100644
--- a/gcc/diagnostic-show-locus.c
+++ b/gcc/diagnostic-show-locus.c
@@ -30,6 +30,7 @@ along with GCC; see the file COPYING3. If not see
#include "gcc-rich-location.h"
#include "selftest.h"
#include "selftest-diagnostic.h"
+#include "cpplib.h"
#ifdef HAVE_TERMIOS_H
# include <termios.h>
@@ -112,7 +113,29 @@ class colorizer
const char *m_stop_color;
};
-/* A point within a layout_range; similar to an expanded_location,
+/* In order to handle multibyte sources properly, all of this logic needs to be
+ aware of the distinction between the number of bytes and the number of
+ display columns occupied by a character. One or the other is more useful
+ depending on the context. For instance, in order to output the caret at the
+ correct location, we need to count display columns; in order to colorize a
+ source line, we need to count the bytes. All locations are provided to us
+ as byte counts. We augment these with the display column so that it can be
+ used when need. This is not the most efficient way to do things since it
+ requires looping over the whole line each time, but it should be fine for
+ the purpose of outputting diagnostics. */
+
+class exploc_with_display_col : public expanded_location
+{
+ public:
+ exploc_with_display_col (const expanded_location &exploc)
+ : expanded_location (exploc),
+ m_display_col (location_compute_display_column (exploc)) {}
+
+ int m_display_col;
+};
+
+
+/* A point within a layout_range; similar to an exploc_with_display_col,
but after filtering on file. */
class layout_point
@@ -120,10 +143,17 @@ class layout_point
public:
layout_point (const expanded_location &exploc)
: m_line (exploc.line),
- m_column (exploc.column) {}
+ m_column (exploc.column),
+ m_display_col (location_compute_display_column (exploc)) {}
+
+ int get_col (bool use_display) const
+ {
+ return use_display ? m_display_col : m_column;
+ }
linenum_type m_line;
int m_column;
+ int m_display_col;
};
/* A class for use by "class layout" below: a filtered location_range. */
@@ -138,7 +168,7 @@ class layout_range
unsigned original_idx,
const range_label *label);
- bool contains_point (linenum_type row, int column) const;
+ bool contains_point (linenum_type row, int column, bool use_display) const;
bool intersects_line_p (linenum_type row) const;
layout_point m_start;
@@ -157,6 +187,17 @@ struct line_bounds
{
int m_first_non_ws;
int m_last_non_ws;
+
+ void convert_to_display_cols (char_span line)
+ {
+ m_first_non_ws = cpp_byte_column_to_display_column (line.get_buffer (),
+ line.length (),
+ m_first_non_ws);
+
+ m_last_non_ws = cpp_byte_column_to_display_column (line.get_buffer (),
+ line.length (),
+ m_last_non_ws);
+ }
};
/* A range of contiguous source lines within a layout (e.g. "lines 5-10"
@@ -284,6 +325,7 @@ class layout
get_state_at_point (/* Inputs. */
linenum_type row, int column,
int first_non_ws, int last_non_ws,
+ bool use_display,
/* Outputs. */
point_state *out_state);
@@ -298,7 +340,7 @@ class layout
diagnostic_context *m_context;
pretty_printer *m_pp;
location_t m_primary_loc;
- expanded_location m_exploc;
+ exploc_with_display_col m_exploc;
colorizer m_colorizer;
bool m_colorize_source_p;
bool m_show_labels_p;
@@ -472,10 +514,15 @@ layout_range::layout_range (const expanded_location *start_exploc,
- 'w' indicates a point within the range
- 'F' indicates the finish of the range (which is
within it).
- - 'a' indicates a subsequent point *after* the range. */
+ - 'a' indicates a subsequent point *after* the range.
+
+ USE_DISPLAY controls whether we check the byte column or
+ the display column; one or the other is more convenient
+ depending on the context. */
bool
-layout_range::contains_point (linenum_type row, int column) const
+layout_range::contains_point (linenum_type row, int column,
+ bool use_display) const
{
gcc_assert (m_start.m_line <= m_finish.m_line);
/* ...but the equivalent isn't true for the columns;
@@ -491,7 +538,7 @@ layout_range::contains_point (linenum_type row, int column) const
/* On same line as start of range (corresponding
to line 02 in example A and line 03 in example B). */
{
- if (column < m_start.m_column)
+ if (column < m_start.get_col (use_display))
/* Points on the starting line of the range, but
before the column in which it begins. */
return false;
@@ -505,7 +552,7 @@ layout_range::contains_point (linenum_type row, int column) const
{
/* This is a single-line range. */
gcc_assert (row == m_finish.m_line);
- return column <= m_finish.m_column;
+ return column <= m_finish.get_col (use_display);
}
}
@@ -530,7 +577,7 @@ layout_range::contains_point (linenum_type row, int column) const
gcc_assert (row == m_finish.m_line);
- return column <= m_finish.m_column;
+ return column <= m_finish.get_col (use_display);
}
/* Does this layout_range contain any part of line ROW? */
@@ -574,20 +621,23 @@ test_layout_range_for_single_point ()
/* Tests for layout_range::contains_point. */
- /* Before the line. */
- ASSERT_FALSE (point.contains_point (6, 1));
+ for (int use_display = 0; use_display <= 1; ++use_display)
+ {
+ /* Before the line. */
+ ASSERT_FALSE (point.contains_point (6, 1, use_display));
- /* On the line, but before start. */
- ASSERT_FALSE (point.contains_point (7, 9));
+ /* On the line, but before start. */
+ ASSERT_FALSE (point.contains_point (7, 9, use_display));
- /* At the point. */
- ASSERT_TRUE (point.contains_point (7, 10));
+ /* At the point. */
+ ASSERT_TRUE (point.contains_point (7, 10, use_display));
- /* On the line, after the point. */
- ASSERT_FALSE (point.contains_point (7, 11));
+ /* On the line, after the point. */
+ ASSERT_FALSE (point.contains_point (7, 11, use_display));
- /* After the line. */
- ASSERT_FALSE (point.contains_point (8, 1));
+ /* After the line. */
+ ASSERT_FALSE (point.contains_point (8, 1, use_display));
+ }
/* Tests for layout_range::intersects_line_p. */
ASSERT_FALSE (point.intersects_line_p (6));
@@ -605,26 +655,29 @@ test_layout_range_for_single_line ()
/* Tests for layout_range::contains_point. */
- /* Before the line. */
- ASSERT_FALSE (example_a.contains_point (1, 1));
+ for (int use_display = 0; use_display <= 1; ++use_display)
+ {
+ /* Before the line. */
+ ASSERT_FALSE (example_a.contains_point (1, 1, use_display));
- /* On the line, but before start. */
- ASSERT_FALSE (example_a.contains_point (2, 21));
+ /* On the line, but before start. */
+ ASSERT_FALSE (example_a.contains_point (2, 21, use_display));
- /* On the line, at the start. */
- ASSERT_TRUE (example_a.contains_point (2, 22));
+ /* On the line, at the start. */
+ ASSERT_TRUE (example_a.contains_point (2, 22, use_display));
- /* On the line, within the range. */
- ASSERT_TRUE (example_a.contains_point (2, 23));
+ /* On the line, within the range. */
+ ASSERT_TRUE (example_a.contains_point (2, 23, use_display));
- /* On the line, at the end. */
- ASSERT_TRUE (example_a.contains_point (2, 38));
+ /* On the line, at the end. */
+ ASSERT_TRUE (example_a.contains_point (2, 38, use_display));
- /* On the line, after the end. */
- ASSERT_FALSE (example_a.contains_point (2, 39));
+ /* On the line, after the end. */
+ ASSERT_FALSE (example_a.contains_point (2, 39, use_display));
- /* After the line. */
- ASSERT_FALSE (example_a.contains_point (2, 39));
+ /* After the line. */
+ ASSERT_FALSE (example_a.contains_point (2, 39, use_display));
+ }
/* Tests for layout_range::intersects_line_p. */
ASSERT_FALSE (example_a.intersects_line_p (1));
@@ -642,40 +695,43 @@ test_layout_range_for_multiple_lines ()
/* Tests for layout_range::contains_point. */
- /* Before first line. */
- ASSERT_FALSE (example_b.contains_point (1, 1));
+ for (int use_display = 0; use_display <= 1; ++use_display)
+ {
+ /* Before first line. */
+ ASSERT_FALSE (example_b.contains_point (1, 1, use_display));
- /* On the first line, but before start. */
- ASSERT_FALSE (example_b.contains_point (3, 13));
+ /* On the first line, but before start. */
+ ASSERT_FALSE (example_b.contains_point (3, 13, use_display));
- /* At the start. */
- ASSERT_TRUE (example_b.contains_point (3, 14));
+ /* At the start. */
+ ASSERT_TRUE (example_b.contains_point (3, 14, use_display));
- /* On the first line, within the range. */
- ASSERT_TRUE (example_b.contains_point (3, 15));
+ /* On the first line, within the range. */
+ ASSERT_TRUE (example_b.contains_point (3, 15, use_display));
- /* On an interior line.
- The column number should not matter; try various boundary
- values. */
- ASSERT_TRUE (example_b.contains_point (4, 1));
- ASSERT_TRUE (example_b.contains_point (4, 7));
- ASSERT_TRUE (example_b.contains_point (4, 8));
- ASSERT_TRUE (example_b.contains_point (4, 9));
- ASSERT_TRUE (example_b.contains_point (4, 13));
- ASSERT_TRUE (example_b.contains_point (4, 14));
- ASSERT_TRUE (example_b.contains_point (4, 15));
+ /* On an interior line.
+ The column number should not matter; try various boundary
+ values. */
+ ASSERT_TRUE (example_b.contains_point (4, 1, use_display));
+ ASSERT_TRUE (example_b.contains_point (4, 7, use_display));
+ ASSERT_TRUE (example_b.contains_point (4, 8, use_display));
+ ASSERT_TRUE (example_b.contains_point (4, 9, use_display));
+ ASSERT_TRUE (example_b.contains_point (4, 13, use_display));
+ ASSERT_TRUE (example_b.contains_point (4, 14, use_display));
+ ASSERT_TRUE (example_b.contains_point (4, 15, use_display));
- /* On the final line, before the end. */
- ASSERT_TRUE (example_b.contains_point (5, 7));
+ /* On the final line, before the end. */
+ ASSERT_TRUE (example_b.contains_point (5, 7, use_display));
- /* On the final line, at the end. */
- ASSERT_TRUE (example_b.contains_point (5, 8));
+ /* On the final line, at the end. */
+ ASSERT_TRUE (example_b.contains_point (5, 8, use_display));
- /* On the final line, after the end. */
- ASSERT_FALSE (example_b.contains_point (5, 9));
+ /* On the final line, after the end. */
+ ASSERT_FALSE (example_b.contains_point (5, 9, use_display));
- /* After the line. */
- ASSERT_FALSE (example_b.contains_point (6, 1));
+ /* After the line. */
+ ASSERT_FALSE (example_b.contains_point (6, 1, use_display));
+ }
/* Tests for layout_range::intersects_line_p. */
ASSERT_FALSE (example_b.intersects_line_p (2));
@@ -687,8 +743,8 @@ test_layout_range_for_multiple_lines ()
#endif /* #if CHECKING_P */
-/* Given a source line LINE of length LINE_WIDTH, determine the width
- without any trailing whitespace. */
+/* Given a source line LINE of length LINE_WIDTH bytes, determine the width
+ (in bytes, not display cols) without any trailing whitespace. */
static int
get_line_width_without_trailing_whitespace (const char *line, int line_width)
@@ -897,17 +953,35 @@ layout::layout (diagnostic_context * context,
will be adjusted accordingly. */
size_t max_width = m_context->caret_max_width;
char_span line = location_get_source_line (m_exploc.file, m_exploc.line);
- if (line && (size_t)m_exploc.column <= line.length ())
+ if (line && max_width)
{
- size_t right_margin = CARET_LINE_MARGIN;
- size_t column = m_exploc.column;
- if (m_show_line_numbers_p)
- column += m_linenum_width + 2;
- right_margin = MIN (line.length () - column, right_margin);
- right_margin = max_width - right_margin;
- if (line.length () >= max_width && column > right_margin)
- m_x_offset = column - right_margin;
- gcc_assert (m_x_offset >= 0);
+ size_t column = m_exploc.m_display_col;
+ int line_width
+ = get_line_width_without_trailing_whitespace (line.get_buffer (),
+ line.length ());
+ size_t eol = cpp_display_width (line.get_buffer (), line_width);
+ const size_t eol_before_linenum = eol;
+
+ if (column <= eol)
+ {
+ if (m_show_line_numbers_p)
+ {
+ column += m_linenum_width + 2;
+ eol += m_linenum_width + 2;
+ }
+ size_t right_margin = CARET_LINE_MARGIN;
+ right_margin = MIN (eol - column, right_margin);
+ right_margin = max_width - right_margin;
+ /* Note: if right_margin > max_width, we end up failing this next
+ check due to wrapping, and we don't offset anything. Otherwise we
+ would conclude we can't output the line at all. */
+ if (eol >= max_width && column > right_margin)
+ {
+ m_x_offset = column - right_margin;
+ m_x_offset = MIN (m_x_offset, (int) eol_before_linenum - 1);
+ }
+ gcc_assert (m_x_offset >= 0);
+ }
}
if (context->show_ruler_p)
@@ -1252,7 +1326,9 @@ layout::calculate_line_spans ()
/* Print line ROW of source code, potentially colorized at any ranges, and
populate *LBOUNDS_OUT.
LINE is the source line (not necessarily 0-terminated) and LINE_WIDTH
- is its width. */
+ is its width. This function deals only with byte offsets, not display
+ columns; m_x_offset must be converted from display to byte units. In
+ particular, LINE_WIDTH and LBOUNDS_OUT are in bytes. */
void
layout::print_source_line (linenum_type row, const char *line, int line_width,
@@ -1264,7 +1340,10 @@ layout::print_source_line (linenum_type row, const char *line, int line_width,
whitespace. */
line_width = get_line_width_without_trailing_whitespace (line,
line_width);
- line += m_x_offset;
+
+ const int x_offset_bytes
+ = cpp_display_column_to_byte_column (line, line_width, m_x_offset);
+ line += x_offset_bytes;
if (m_show_line_numbers_p)
{
@@ -1278,7 +1357,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width,
int first_non_ws = INT_MAX;
int last_non_ws = 0;
int column;
- for (column = 1 + m_x_offset; column <= line_width; column++)
+ for (column = 1 + x_offset_bytes; column <= line_width; column++)
{
/* Assuming colorization is enabled for the caret and underline
characters, we may also colorize the associated characters
@@ -1298,6 +1377,8 @@ layout::print_source_line (linenum_type row, const char *line, int line_width,
point_state state;
in_range_p = get_state_at_point (row, column,
0, INT_MAX,
+ false, /* Using bytes, not display
+ columns, here. */
&state);
if (in_range_p)
m_colorizer.set_range (state.range_idx);
@@ -1360,12 +1441,13 @@ layout::start_annotation_line (char margin_char) const
}
/* Print a line consisting of the caret/underlines for the given
- source line. */
+ source line. This function works with display columns, rather than byte
+ counts; in particular, LBOUNDS should be in display column units. */
void
layout::print_annotation_line (linenum_type row, const line_bounds lbounds)
{
- int x_bound = get_x_bound_for_row (row, m_exploc.column,
+ int x_bound = get_x_bound_for_row (row, m_exploc.m_display_col,
lbounds.m_last_non_ws);
start_annotation_line ();
@@ -1378,6 +1460,7 @@ layout::print_annotation_line (linenum_type row, const line_bounds lbounds)
in_range_p = get_state_at_point (row, column,
lbounds.m_first_non_ws,
lbounds.m_last_non_ws,
+ true, /* Using display units. */
&state);
if (in_range_p)
{
@@ -1415,9 +1498,11 @@ class line_label
public:
line_label (int state_idx, int column, label_text text)
: m_state_idx (state_idx), m_column (column),
- m_text (text), m_length (strlen (text.m_buffer)),
- m_label_line (0)
- {}
+ m_text (text), m_label_line (0)
+ {
+ const int bytes = strlen (text.m_buffer);
+ m_length = cpp_display_width (text.m_buffer, bytes);
+ }
/* Sorting is primarily by column, then by state index. */
static int comparator (const void *p1, const void *p2)
@@ -1459,7 +1544,7 @@ layout::print_any_labels (linenum_type row)
/* Reject labels that aren't fully visible due to clipping
by m_x_offset. */
- if (range->m_caret.m_column <= m_x_offset)
+ if (range->m_caret.m_display_col <= m_x_offset)
continue;
label_text text;
@@ -1471,7 +1556,7 @@ layout::print_any_labels (linenum_type row)
if (text.m_buffer == NULL)
continue;
- labels.safe_push (line_label (i, range->m_caret.m_column, text));
+ labels.safe_push (line_label (i, range->m_caret.m_display_col, text));
}
}
@@ -1624,7 +1709,7 @@ layout::print_leading_fixits (linenum_type row)
/* Subroutine of layout::print_trailing_fixits.
Determine if the annotation line printed for LINE contained
- the exact range from START_COLUMN to FINISH_COLUMN. */
+ the exact range from START_COLUMN to FINISH_COLUMN (in display units). */
bool
layout::annotation_line_showed_range_p (linenum_type line, int start_column,
@@ -1634,9 +1719,9 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column,
int i;
FOR_EACH_VEC_ELT (m_layout_ranges, i, range)
if (range->m_start.m_line == line
- && range->m_start.m_column == start_column
+ && range->m_start.m_display_col == start_column
&& range->m_finish.m_line == line
- && range->m_finish.m_column == finish_column)
+ && range->m_finish.m_display_col == finish_column)
return true;
return false;
}
@@ -1723,7 +1808,7 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column,
and is thus printed as desired. */
-/* A range of columns within a line. */
+/* A range of (byte or display) columns within a line. */
class column_range
{
@@ -1743,32 +1828,51 @@ public:
int finish;
};
-/* Get the range of columns that HINT would affect. */
-
+/* Get the range of bytes or display columns that HINT would affect. */
static column_range
-get_affected_columns (const fixit_hint *hint)
+get_affected_range (const fixit_hint *hint, bool use_display)
{
- int start_column = LOCATION_COLUMN (hint->get_start_loc ());
- int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1;
+ expanded_location exploc_start = expand_location (hint->get_start_loc ());
+ expanded_location exploc_finish = expand_location (hint->get_next_loc ());
+ --exploc_finish.column;
+ int start_column;
+ int finish_column;
+ if (use_display)
+ {
+ start_column = location_compute_display_column (exploc_start);
+ if (hint->insertion_p ())
+ finish_column = start_column - 1;
+ else
+ finish_column = location_compute_display_column (exploc_finish);
+ }
+ else
+ {
+ start_column = exploc_start.column;
+ finish_column = exploc_finish.column;
+ }
return column_range (start_column, finish_column);
}
-/* Get the range of columns that would be printed for HINT. */
+/* Get the range of display columns that would be printed for HINT. */
static column_range
get_printed_columns (const fixit_hint *hint)
{
- int start_column = LOCATION_COLUMN (hint->get_start_loc ());
- int final_hint_column = start_column + hint->get_length () - 1;
+ expanded_location exploc = expand_location (hint->get_start_loc ());
+ int start_column = location_compute_display_column (exploc);
+ int hint_width = cpp_display_width (hint->get_string (),
+ hint->get_length ());
+ int final_hint_column = start_column + hint_width - 1;
if (hint->insertion_p ())
{
return column_range (start_column, final_hint_column);
}
else
{
- int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1;
-
+ exploc = expand_location (hint->get_next_loc ());
+ --exploc.column;
+ int finish_column = location_compute_display_column (exploc);
return column_range (start_column,
MAX (finish_column, final_hint_column));
}
@@ -1782,27 +1886,35 @@ get_printed_columns (const fixit_hint *hint)
class correction
{
public:
- correction (column_range affected_columns,
+ correction (column_range affected_bytes,
+ column_range affected_columns,
column_range printed_columns,
const char *new_text, size_t new_text_len)
- : m_affected_columns (affected_columns),
+ : m_affected_bytes (affected_bytes),
+ m_affected_columns (affected_columns),
m_printed_columns (printed_columns),
m_text (xstrdup (new_text)),
- m_len (new_text_len),
+ m_bytes (new_text_len),
m_alloc_sz (new_text_len + 1)
{
+ compute_display_cols ();
}
~correction () { free (m_text); }
bool insertion_p () const
{
- return m_affected_columns.start == m_affected_columns.finish + 1;
+ return m_affected_bytes.start == m_affected_bytes.finish + 1;
}
void ensure_capacity (size_t len);
void ensure_terminated ();
+ void compute_display_cols ()
+ {
+ m_display_cols = cpp_display_width (m_text, m_bytes);
+ }
+
void overwrite (int dst_offset, const char_span &src_span)
{
gcc_assert (dst_offset >= 0);
@@ -1815,6 +1927,7 @@ public:
is to be inserted, and finish is offset by the length of
the replacement.
If replace, then the range of columns affected. */
+ column_range m_affected_bytes;
column_range m_affected_columns;
/* If insert, then start: the column before which the text
@@ -1825,7 +1938,8 @@ public:
/* The text to be inserted/used as replacement. */
char *m_text;
- size_t m_len;
+ size_t m_bytes;
+ int m_display_cols;
size_t m_alloc_sz;
};
@@ -1850,8 +1964,8 @@ void
correction::ensure_terminated ()
{
/* 0-terminate the buffer. */
- gcc_assert (m_len < m_alloc_sz);
- m_text[m_len] = '\0';
+ gcc_assert (m_bytes < m_alloc_sz);
+ m_text[m_bytes] = '\0';
}
/* A list of corrections affecting a particular line.
@@ -1913,7 +2027,8 @@ source_line::source_line (const char *filename, int line)
void
line_corrections::add_hint (const fixit_hint *hint)
{
- column_range affected_columns = get_affected_columns (hint);
+ column_range affected_bytes = get_affected_range (hint, false);
+ column_range affected_columns = get_affected_range (hint, true);
column_range printed_columns = get_printed_columns (hint);
/* Potentially consolidate. */
@@ -1924,8 +2039,8 @@ line_corrections::add_hint (const fixit_hint *hint)
/* The following consolidation code assumes that the fix-it hints
have been sorted by start (done within layout's ctor). */
- gcc_assert (affected_columns.start
- >= last_correction->m_affected_columns.start);
+ gcc_assert (affected_bytes.start
+ >= last_correction->m_affected_bytes.start);
gcc_assert (printed_columns.start
>= last_correction->m_printed_columns.start);
@@ -1937,8 +2052,8 @@ line_corrections::add_hint (const fixit_hint *hint)
Attempt to inject a "replace" correction from immediately
after the end of the last hint to immediately before the start
of the next hint. */
- column_range between (last_correction->m_affected_columns.finish + 1,
- printed_columns.start - 1);
+ column_range between (last_correction->m_affected_bytes.finish + 1,
+ affected_bytes.start - 1);
/* Try to read the source. */
source_line line (m_filename, m_row);
@@ -1947,7 +2062,7 @@ line_corrections::add_hint (const fixit_hint *hint)
/* Consolidate into the last correction:
add a no-op "replace" of the "between" text, and
add the text from the new hint. */
- int old_len = last_correction->m_len;
+ int old_len = last_correction->m_bytes;
gcc_assert (old_len >= 0);
int between_len = between.finish + 1 - between.start;
gcc_assert (between_len >= 0);
@@ -1961,19 +2076,24 @@ line_corrections::add_hint (const fixit_hint *hint)
last_correction->overwrite (old_len + between_len,
char_span (hint->get_string (),
hint->get_length ()));
- last_correction->m_len = new_len;
+ last_correction->m_bytes = new_len;
last_correction->ensure_terminated ();
+ last_correction->m_affected_bytes.finish
+ = affected_bytes.finish;
last_correction->m_affected_columns.finish
= affected_columns.finish;
+ int prev_display_cols = last_correction->m_display_cols;
+ last_correction->compute_display_cols ();
last_correction->m_printed_columns.finish
- += between_len + hint->get_length ();
+ += last_correction->m_display_cols - prev_display_cols;
return;
}
}
}
/* If no consolidation happened, add a new correction instance. */
- m_corrections.safe_push (new correction (affected_columns,
+ m_corrections.safe_push (new correction (affected_bytes,
+ affected_columns,
printed_columns,
hint->get_string (),
hint->get_length ()));
@@ -2022,7 +2142,7 @@ layout::print_trailing_fixits (linenum_type row)
m_colorizer.set_fixit_insert ();
pp_string (m_pp, c->m_text);
m_colorizer.set_normal_text ();
- column += c->m_len;
+ column += c->m_display_cols;
}
else
{
@@ -2034,7 +2154,7 @@ layout::print_trailing_fixits (linenum_type row)
int finish_column = c->m_affected_columns.finish;
if (!annotation_line_showed_range_p (row, start_column,
finish_column)
- || c->m_len == 0)
+ || c->m_bytes == 0)
{
move_to_column (&column, start_column, true);
m_colorizer.set_fixit_delete ();
@@ -2045,13 +2165,13 @@ layout::print_trailing_fixits (linenum_type row)
/* Print the replacement text. REPLACE also covers
removals, so only do this extra work (potentially starting
a new line) if we have actual replacement text. */
- if (c->m_len > 0)
+ if (c->m_bytes > 0)
{
move_to_column (&column, start_column, true);
m_colorizer.set_fixit_insert ();
pp_string (m_pp, c->m_text);
m_colorizer.set_normal_text ();
- column += c->m_len;
+ column += c->m_display_cols;
}
}
}
@@ -2072,12 +2192,14 @@ layout::print_newline ()
/* Return true if (ROW/COLUMN) is within a range of the layout.
If it returns true, OUT_STATE is written to, with the
range index, and whether we should draw the caret at
- (ROW/COLUMN) (as opposed to an underline). */
+ (ROW/COLUMN) (as opposed to an underline). USE_DISPLAY controls
+ whether all inputs and outputs are in bytes or display column units. */
bool
layout::get_state_at_point (/* Inputs. */
linenum_type row, int column,
int first_non_ws, int last_non_ws,
+ bool use_display,
/* Outputs. */
point_state *out_state)
{
@@ -2090,7 +2212,7 @@ layout::get_state_at_point (/* Inputs. */
source colorization. */
continue;
- if (range->contains_point (row, column))
+ if (range->contains_point (row, column, use_display))
{
out_state->range_idx = i;
@@ -2098,7 +2220,7 @@ layout::get_state_at_point (/* Inputs. */
out_state->draw_caret_p = false;
if (range->m_range_display_kind == SHOW_RANGE_WITH_CARET
&& row == range->m_caret.m_line
- && column == range->m_caret.m_column)
+ && column == range->m_caret.get_col (use_display))
out_state->draw_caret_p = true;
/* Within a multiline range, don't display any underline
@@ -2118,11 +2240,11 @@ layout::get_state_at_point (/* Inputs. */
/* Helper function for use by layout::print_line when printing the
annotation line under the source line.
- Get the column beyond the rightmost one that could contain a caret or
- range marker, given that we stop rendering at trailing whitespace.
+ Get the display column beyond the rightmost one that could contain a caret
+ or range marker, given that we stop rendering at trailing whitespace.
ROW is the source line within the given file.
- CARET_COLUMN is the column of range 0's caret.
- LAST_NON_WS_COLUMN is the last column containing a non-whitespace
+ CARET_COLUMN is the display column of range 0's caret.
+ LAST_NON_WS_COLUMN is the last display column containing a non-whitespace
character of source (as determined when printing the source line). */
int
@@ -2141,8 +2263,8 @@ layout::get_x_bound_for_row (linenum_type row, int caret_column,
{
/* On the final line within a range; ensure that
we render up to the end of the range. */
- if (result <= range->m_finish.m_column)
- result = range->m_finish.m_column + 1;
+ if (result <= range->m_finish.m_display_col)
+ result = range->m_finish.m_display_col + 1;
}
else if (row < range->m_finish.m_line)
{
@@ -2233,7 +2355,11 @@ layout::print_line (linenum_type row)
print_leading_fixits (row);
print_source_line (row, line.get_buffer (), line.length (), &lbounds);
if (should_print_annotation_line_p (row))
- print_annotation_line (row, lbounds);
+ {
+ if (lbounds.m_first_non_ws != INT_MAX)
+ lbounds.convert_to_display_cols (line);
+ print_annotation_line (row, lbounds);
+ }
if (m_show_labels_p)
print_any_labels (row);
print_trailing_fixits (row);
@@ -2846,6 +2972,560 @@ test_diagnostic_show_locus_one_liner (const line_table_case &case_)
test_one_liner_labels ();
}
+/* Version of all one-liner tests exercising multibyte awareness. For
+ simplicity we stick to using two multibyte characters in the test, U+1F602
+ == "\xf0\x9f\x98\x82", which uses 4 bytes and 2 display columns, and U+03C0
+ == "\xcf\x80", which uses 2 bytes and 1 display column. Note: all of the
+ below asserts would be easier to read if we used UTF-8 directly in the
+ string constants, but it seems better not to demand the host compiler
+ support this, when it isn't otherwise necessary. Instead, whenever an
+ extended character appears in a string, we put a line break after it so that
+ all succeeding characters can appear visually at the correct display column.
+
+ All of these work on the following 1-line source file:
+
+ .0000000001111111111222222 display
+ .1234567890123456789012345 columns
+ "SS_foo = P_bar.SS_fieldP;\n"
+ .0000000111111111222222223 byte
+ .1356789012456789134567891 columns
+
+ which is set up by test_diagnostic_show_locus_one_liner and calls
+ them. Here SS represents the two display columns for the U+1F602 emoji and
+ P represents the one display column for the U+03C0 pi symbol. */
+
+/* Just a caret. */
+
+static void
+test_one_liner_simple_caret_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t caret = linemap_position_for_column (line_table, 18);
+ rich_location richloc (line_table, caret);
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Caret and range. */
+static void
+test_one_liner_caret_and_range_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t caret = linemap_position_for_column (line_table, 18);
+ location_t start = linemap_position_for_column (line_table, 12);
+ location_t finish = linemap_position_for_column (line_table, 30);
+ location_t loc = make_location (caret, start, finish);
+ rich_location richloc (line_table, loc);
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ~~~~~^~~~~~~~~~\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Multiple ranges and carets. */
+
+static void
+test_one_liner_multiple_carets_and_ranges_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t foo
+ = make_location (linemap_position_for_column (line_table, 7),
+ linemap_position_for_column (line_table, 1),
+ linemap_position_for_column (line_table, 8));
+ dc.caret_chars[0] = 'A';
+
+ location_t bar
+ = make_location (linemap_position_for_column (line_table, 16),
+ linemap_position_for_column (line_table, 12),
+ linemap_position_for_column (line_table, 17));
+ dc.caret_chars[1] = 'B';
+
+ location_t field
+ = make_location (linemap_position_for_column (line_table, 26),
+ linemap_position_for_column (line_table, 19),
+ linemap_position_for_column (line_table, 30));
+ dc.caret_chars[2] = 'C';
+ rich_location richloc (line_table, foo);
+ richloc.add_range (bar, SHOW_RANGE_WITH_CARET);
+ richloc.add_range (field, SHOW_RANGE_WITH_CARET);
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ~~~~A~ ~~~B~ ~~~~~C~~~\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Insertion fix-it hint: adding an "&" to the front of "P_bar.field". */
+
+static void
+test_one_liner_fixit_insert_before_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t caret = linemap_position_for_column (line_table, 12);
+ rich_location richloc (line_table, caret);
+ richloc.add_fixit_insert_before ("&");
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^\n"
+ " &\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Insertion fix-it hint: adding a "[0]" after "SS_foo". */
+
+static void
+test_one_liner_fixit_insert_after_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t start = linemap_position_for_column (line_table, 1);
+ location_t finish = linemap_position_for_column (line_table, 8);
+ location_t foo = make_location (start, start, finish);
+ rich_location richloc (line_table, foo);
+ richloc.add_fixit_insert_after ("[0]");
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~\n"
+ " [0]\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Removal fix-it hint: removal of the ".SS_fieldP". */
+
+static void
+test_one_liner_fixit_remove_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t start = linemap_position_for_column (line_table, 18);
+ location_t finish = linemap_position_for_column (line_table, 30);
+ location_t dot = make_location (start, start, finish);
+ rich_location richloc (line_table, dot);
+ richloc.add_fixit_remove ();
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~\n"
+ " ----------\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP". */
+
+static void
+test_one_liner_fixit_replace_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t start = linemap_position_for_column (line_table, 19);
+ location_t finish = linemap_position_for_column (line_table, 30);
+ location_t field = make_location (start, start, finish);
+ rich_location richloc (line_table, field);
+ richloc.add_fixit_replace ("m_\xf0\x9f\x98\x82_field\xcf\x80");
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~\n"
+ " m_\xf0\x9f\x98\x82"
+ "_field\xcf\x80\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP",
+ but where the caret was elsewhere. */
+
+static void
+test_one_liner_fixit_replace_non_equal_range_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t equals = linemap_position_for_column (line_table, 10);
+ location_t start = linemap_position_for_column (line_table, 19);
+ location_t finish = linemap_position_for_column (line_table, 30);
+ rich_location richloc (line_table, equals);
+ source_range range;
+ range.m_start = start;
+ range.m_finish = finish;
+ richloc.add_fixit_replace (range, "m_\xf0\x9f\x98\x82_field\xcf\x80");
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ /* The replacement range is not indicated in the annotation line, so
+ it should be indicated via an additional underline. */
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^\n"
+ " ---------\n"
+ " m_\xf0\x9f\x98\x82"
+ "_field\xcf\x80\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP",
+ where the caret was elsewhere, but where a secondary range
+ exactly covers "field". */
+
+static void
+test_one_liner_fixit_replace_equal_secondary_range_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t equals = linemap_position_for_column (line_table, 10);
+ location_t start = linemap_position_for_column (line_table, 19);
+ location_t finish = linemap_position_for_column (line_table, 30);
+ rich_location richloc (line_table, equals);
+ location_t field = make_location (start, start, finish);
+ richloc.add_range (field);
+ richloc.add_fixit_replace (field, "m_\xf0\x9f\x98\x82_field\xcf\x80");
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ /* The replacement range is indicated in the annotation line,
+ so it shouldn't be indicated via an additional underline. */
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^ ~~~~~~~~~\n"
+ " m_\xf0\x9f\x98\x82"
+ "_field\xcf\x80\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Verify that we can use ad-hoc locations when adding fixits to a
+ rich_location. */
+
+static void
+test_one_liner_fixit_validation_adhoc_locations_utf8 ()
+{
+ /* Generate a range that's too long to be packed, so must
+ be stored as an ad-hoc location (given the defaults
+ of 5 bits or 0 bits of packed range); 41 columns > 2**5. */
+ const location_t c12 = linemap_position_for_column (line_table, 12);
+ const location_t c52 = linemap_position_for_column (line_table, 52);
+ const location_t loc = make_location (c12, c12, c52);
+
+ if (c52 > LINE_MAP_MAX_LOCATION_WITH_COLS)
+ return;
+
+ ASSERT_TRUE (IS_ADHOC_LOC (loc));
+
+ /* Insert. */
+ {
+ rich_location richloc (line_table, loc);
+ richloc.add_fixit_insert_before (loc, "test");
+ /* It should not have been discarded by the validator. */
+ ASSERT_EQ (1, richloc.get_num_fixit_hints ());
+
+ test_diagnostic_context dc;
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~~~~~~ \n"
+ " test\n",
+ pp_formatted_text (dc.printer));
+ }
+
+ /* Remove. */
+ {
+ rich_location richloc (line_table, loc);
+ source_range range = source_range::from_locations (loc, c52);
+ richloc.add_fixit_remove (range);
+ /* It should not have been discarded by the validator. */
+ ASSERT_EQ (1, richloc.get_num_fixit_hints ());
+
+ test_diagnostic_context dc;
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~~~~~~ \n"
+ " -------------------------------------\n",
+ pp_formatted_text (dc.printer));
+ }
+
+ /* Replace. */
+ {
+ rich_location richloc (line_table, loc);
+ source_range range = source_range::from_locations (loc, c52);
+ richloc.add_fixit_replace (range, "test");
+ /* It should not have been discarded by the validator. */
+ ASSERT_EQ (1, richloc.get_num_fixit_hints ());
+
+ test_diagnostic_context dc;
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~~~~~~ \n"
+ " test\n",
+ pp_formatted_text (dc.printer));
+ }
+}
+
+/* Test of consolidating insertions at the same location. */
+
+static void
+test_one_liner_many_fixits_1_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t equals = linemap_position_for_column (line_table, 10);
+ rich_location richloc (line_table, equals);
+ for (int i = 0; i < 19; i++)
+ richloc.add_fixit_insert_before (i & 1 ? "@" : "\xcf\x80");
+ ASSERT_EQ (1, richloc.get_num_fixit_hints ());
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^\n"
+ " \xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@"
+ "\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Ensure that we can add an arbitrary number of fix-it hints to a
+ rich_location, even if they are not consolidated. */
+
+static void
+test_one_liner_many_fixits_2_utf8 ()
+{
+ test_diagnostic_context dc;
+ location_t equals = linemap_position_for_column (line_table, 10);
+ rich_location richloc (line_table, equals);
+ const int nlocs = 19;
+ int locs[nlocs] = {1, 5, 7, 9, 11, 14, 16, 18, 23, 25, 27, 29, 32,
+ 34, 36, 38, 40, 42, 44};
+ for (int i = 0; i != nlocs; ++i)
+ {
+ location_t loc = linemap_position_for_column (line_table, locs[i]);
+ richloc.add_fixit_insert_before (loc, i & 1 ? "@" : "\xcf\x80");
+ }
+
+ ASSERT_EQ (nlocs, richloc.get_num_fixit_hints ());
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^\n"
+ " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @"
+ " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80\n",
+ pp_formatted_text (dc.printer));
+}
+
+/* Test of labeling the ranges within a rich_location. */
+
+static void
+test_one_liner_labels_utf8 ()
+{
+ location_t foo
+ = make_location (linemap_position_for_column (line_table, 1),
+ linemap_position_for_column (line_table, 1),
+ linemap_position_for_column (line_table, 8));
+ location_t bar
+ = make_location (linemap_position_for_column (line_table, 12),
+ linemap_position_for_column (line_table, 12),
+ linemap_position_for_column (line_table, 17));
+ location_t field
+ = make_location (linemap_position_for_column (line_table, 19),
+ linemap_position_for_column (line_table, 19),
+ linemap_position_for_column (line_table, 30));
+
+ /* Example where all the labels fit on one line. */
+ {
+ text_range_label label0
+ ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80");
+ text_range_label label1
+ ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80");
+ text_range_label label2
+ ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"
+ "\xcf\x80");
+ gcc_rich_location richloc (foo, &label0);
+ richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1);
+ richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2);
+
+ {
+ test_diagnostic_context dc;
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~ ~~~~~ ~~~~~~~~~\n"
+ " | | |\n"
+ " \xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"
+ " \xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"
+ " \xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82"
+ "\xf0\x9f\x98\x82\xcf\x80\xcf\x80\n",
+ pp_formatted_text (dc.printer));
+ }
+
+ /* Verify that we can disable label-printing. */
+ {
+ test_diagnostic_context dc;
+ dc.show_labels_p = false;
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~ ~~~~~ ~~~~~~~~~\n",
+ pp_formatted_text (dc.printer));
+ }
+ }
+
+ /* Example where the labels need extra lines. */
+ {
+ text_range_label label0 ("label 0\xf0\x9f\x98\x82");
+ text_range_label label1 ("label 1\xcf\x80");
+ text_range_label label2 ("label 2\xcf\x80");
+ gcc_rich_location richloc (foo, &label0);
+ richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1);
+ richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2);
+
+ test_diagnostic_context dc;
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~ ~~~~~ ~~~~~~~~~\n"
+ " | | |\n"
+ " | | label 2\xcf\x80\n"
+ " | label 1\xcf\x80\n"
+ " label 0\xf0\x9f\x98\x82\n",
+ pp_formatted_text (dc.printer));
+ }
+
+ /* Example of boundary conditions: label 0 and 1 have just enough clearance,
+ but label 1 just touches label 2. */
+ {
+ text_range_label label0 ("aaaaa\xf0\x9f\x98\x82\xcf\x80");
+ text_range_label label1 ("bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82");
+ text_range_label label2 ("c");
+ gcc_rich_location richloc (foo, &label0);
+ richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1);
+ richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2);
+
+ test_diagnostic_context dc;
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " \xf0\x9f\x98\x82"
+ "_foo = \xcf\x80"
+ "_bar.\xf0\x9f\x98\x82"
+ "_field\xcf\x80"
+ ";\n"
+ " ^~~~~~ ~~~~~ ~~~~~~~~~\n"
+ " | | |\n"
+ " | | c\n"
+ " aaaaa\xf0\x9f\x98\x82\xcf\x80"
+ " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n",
+ pp_formatted_text (dc.printer));
+ }
+}
+
+/* Run the various one-liner tests. */
+
+static void
+test_diagnostic_show_locus_one_liner_utf8 (const line_table_case &case_)
+{
+ /* Create a tempfile and write some text to it. */
+ const char *content
+ /* Display columns.
+ 0000000000000000000000011111111111111111111111111111112222222222222
+ 1111111122222222345678900000000123456666666677777777890123444444445 */
+ = "\xf0\x9f\x98\x82_foo = \xcf\x80_bar.\xf0\x9f\x98\x82_field\xcf\x80;\n";
+ /* 0000000000000000000001111111111111111111222222222222222222222233333
+ 1111222233334444567890122223333456789999000011112222345678999900001
+ Byte columns. */
+ temp_source_file tmp (SELFTEST_LOCATION, ".c", content);
+ line_table_test ltt (case_);
+
+ linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1);
+
+ location_t line_end = linemap_position_for_column (line_table, 31);
+
+ /* Don't attempt to run the tests if column data might be unavailable. */
+ if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS)
+ return;
+
+ ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end));
+ ASSERT_EQ (1, LOCATION_LINE (line_end));
+ ASSERT_EQ (31, LOCATION_COLUMN (line_end));
+
+ char_span lspan = location_get_source_line (tmp.get_filename (), 1);
+ ASSERT_EQ (25, cpp_display_width (lspan.get_buffer (), lspan.length ()));
+ ASSERT_EQ (25, location_compute_display_column (expand_location (line_end)));
+
+ test_one_liner_simple_caret_utf8 ();
+ test_one_liner_caret_and_range_utf8 ();
+ test_one_liner_multiple_carets_and_ranges_utf8 ();
+ test_one_liner_fixit_insert_before_utf8 ();
+ test_one_liner_fixit_insert_after_utf8 ();
+ test_one_liner_fixit_remove_utf8 ();
+ test_one_liner_fixit_replace_utf8 ();
+ test_one_liner_fixit_replace_non_equal_range_utf8 ();
+ test_one_liner_fixit_replace_equal_secondary_range_utf8 ();
+ test_one_liner_fixit_validation_adhoc_locations_utf8 ();
+ test_one_liner_many_fixits_1_utf8 ();
+ test_one_liner_many_fixits_2_utf8 ();
+ test_one_liner_labels_utf8 ();
+}
+
/* Verify that gcc_rich_location::add_location_if_nearby works. */
static void
@@ -3221,13 +3901,16 @@ test_overlapped_fixit_printing (const line_table_case &case_)
/* Unit-test the line_corrections machinery. */
ASSERT_EQ (3, richloc.get_num_fixit_hints ());
const fixit_hint *hint_0 = richloc.get_fixit_hint (0);
- ASSERT_EQ (column_range (12, 12), get_affected_columns (hint_0));
+ ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, false));
+ ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, true));
ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0));
const fixit_hint *hint_1 = richloc.get_fixit_hint (1);
- ASSERT_EQ (column_range (18, 18), get_affected_columns (hint_1));
+ ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, false));
+ ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, true));
ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1));
const fixit_hint *hint_2 = richloc.get_fixit_hint (2);
- ASSERT_EQ (column_range (29, 28), get_affected_columns (hint_2));
+ ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, false));
+ ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, true));
ASSERT_EQ (column_range (29, 29), get_printed_columns (hint_2));
/* Add each hint in turn to a line_corrections instance,
@@ -3238,6 +3921,7 @@ test_overlapped_fixit_printing (const line_table_case &case_)
/* The first replace hint by itself. */
lc.add_hint (hint_0);
ASSERT_EQ (1, lc.m_corrections.length ());
+ ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_bytes);
ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns);
ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns);
ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text);
@@ -3247,6 +3931,7 @@ test_overlapped_fixit_printing (const line_table_case &case_)
lc.add_hint (hint_1);
ASSERT_EQ (1, lc.m_corrections.length ());
ASSERT_STREQ ("const_cast<foo *> (", lc.m_corrections[0]->m_text);
+ ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_bytes);
ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns);
ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns);
@@ -3256,6 +3941,7 @@ test_overlapped_fixit_printing (const line_table_case &case_)
ASSERT_STREQ ("const_cast<foo *> (ptr->field)",
lc.m_corrections[0]->m_text);
ASSERT_EQ (1, lc.m_corrections.length ());
+ ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_bytes);
ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_columns);
ASSERT_EQ (column_range (12, 41), lc.m_corrections[0]->m_printed_columns);
}
@@ -3358,6 +4044,243 @@ test_overlapped_fixit_printing (const line_table_case &case_)
}
}
+/* Multibyte-aware version of preceding tests. See comments above
+ test_one_liner_simple_caret_utf8() too, we use the same two multibyte
+ characters here. */
+
+static void
+test_overlapped_fixit_printing_utf8 (const line_table_case &case_)
+{
+ /* Create a tempfile and write some text to it. */
+
+ const char *content
+ /* Display columns.
+ 00000000000000000000000111111111111111111111111222222222222222223
+ 12344444444555555556789012344444444555555556789012345678999999990 */
+ = " f\xf0\x9f\x98\x82 *f = (f\xf0\x9f\x98\x82 *)ptr->field\xcf\x80;\n";
+ /* 00000000000000000000011111111111111111111112222222222333333333333
+ 12344445555666677778901234566667777888899990123456789012333344445
+ Byte columns. */
+
+ temp_source_file tmp (SELFTEST_LOCATION, ".C", content);
+ line_table_test ltt (case_);
+
+ const line_map_ordinary *ord_map
+ = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false,
+ tmp.get_filename (), 0));
+
+ linemap_line_start (line_table, 1, 100);
+
+ const location_t final_line_end
+ = linemap_position_for_line_and_column (line_table, ord_map, 6, 50);
+
+ /* Don't attempt to run the tests if column data might be unavailable. */
+ if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS)
+ return;
+
+ /* A test for converting a C-style cast to a C++-style cast. */
+ const location_t open_paren
+ = linemap_position_for_line_and_column (line_table, ord_map, 1, 14);
+ const location_t close_paren
+ = linemap_position_for_line_and_column (line_table, ord_map, 1, 22);
+ const location_t expr_start
+ = linemap_position_for_line_and_column (line_table, ord_map, 1, 23);
+ const location_t expr_finish
+ = linemap_position_for_line_and_column (line_table, ord_map, 1, 34);
+ const location_t expr = make_location (expr_start, expr_start, expr_finish);
+
+ /* Various examples of fix-it hints that aren't themselves consolidated,
+ but for which the *printing* may need consolidation. */
+
+ /* Example where 3 fix-it hints are printed as one. */
+ {
+ test_diagnostic_context dc;
+ rich_location richloc (line_table, expr);
+ richloc.add_fixit_replace (open_paren, "const_cast<");
+ richloc.add_fixit_replace (close_paren, "> (");
+ richloc.add_fixit_insert_after (")");
+
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " f\xf0\x9f\x98\x82"
+ " *f = (f\xf0\x9f\x98\x82"
+ " *)ptr->field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~\n"
+ " ------------------\n"
+ " const_cast<f\xf0\x9f\x98\x82"
+ " *> (ptr->field\xcf\x80"
+ ")\n",
+ pp_formatted_text (dc.printer));
+
+ /* Unit-test the line_corrections machinery. */
+ ASSERT_EQ (3, richloc.get_num_fixit_hints ());
+ const fixit_hint *hint_0 = richloc.get_fixit_hint (0);
+ ASSERT_EQ (column_range (14, 14), get_affected_range (hint_0, false));
+ ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, true));
+ ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0));
+ const fixit_hint *hint_1 = richloc.get_fixit_hint (1);
+ ASSERT_EQ (column_range (22, 22), get_affected_range (hint_1, false));
+ ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, true));
+ ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1));
+ const fixit_hint *hint_2 = richloc.get_fixit_hint (2);
+ ASSERT_EQ (column_range (35, 34), get_affected_range (hint_2, false));
+ ASSERT_EQ (column_range (30, 29), get_affected_range (hint_2, true));
+ ASSERT_EQ (column_range (30, 30), get_printed_columns (hint_2));
+
+ /* Add each hint in turn to a line_corrections instance,
+ and verify that they are consolidated into one correction instance
+ as expected. */
+ line_corrections lc (tmp.get_filename (), 1);
+
+ /* The first replace hint by itself. */
+ lc.add_hint (hint_0);
+ ASSERT_EQ (1, lc.m_corrections.length ());
+ ASSERT_EQ (column_range (14, 14), lc.m_corrections[0]->m_affected_bytes);
+ ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns);
+ ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns);
+ ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text);
+
+ /* After the second replacement hint, they are printed together
+ as a replacement (along with the text between them). */
+ lc.add_hint (hint_1);
+ ASSERT_EQ (1, lc.m_corrections.length ());
+ ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (",
+ lc.m_corrections[0]->m_text);
+ ASSERT_EQ (column_range (14, 22), lc.m_corrections[0]->m_affected_bytes);
+ ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns);
+ ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns);
+
+ /* After the final insertion hint, they are all printed together
+ as a replacement (along with the text between them). */
+ lc.add_hint (hint_2);
+ ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (ptr->field\xcf\x80)",
+ lc.m_corrections[0]->m_text);
+ ASSERT_EQ (1, lc.m_corrections.length ());
+ ASSERT_EQ (column_range (14, 34), lc.m_corrections[0]->m_affected_bytes);
+ ASSERT_EQ (column_range (12, 29), lc.m_corrections[0]->m_affected_columns);
+ ASSERT_EQ (column_range (12, 42), lc.m_corrections[0]->m_printed_columns);
+ }
+
+ /* Example where two are consolidated during printing. */
+ {
+ test_diagnostic_context dc;
+ rich_location richloc (line_table, expr);
+ richloc.add_fixit_replace (open_paren, "CAST (");
+ richloc.add_fixit_replace (close_paren, ") (");
+ richloc.add_fixit_insert_after (")");
+
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " f\xf0\x9f\x98\x82"
+ " *f = (f\xf0\x9f\x98\x82"
+ " *)ptr->field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~\n"
+ " -\n"
+ " CAST (-\n"
+ " ) ( )\n",
+ pp_formatted_text (dc.printer));
+ }
+
+ /* Example where none are consolidated during printing. */
+ {
+ test_diagnostic_context dc;
+ rich_location richloc (line_table, expr);
+ richloc.add_fixit_replace (open_paren, "CST (");
+ richloc.add_fixit_replace (close_paren, ") (");
+ richloc.add_fixit_insert_after (")");
+
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " f\xf0\x9f\x98\x82"
+ " *f = (f\xf0\x9f\x98\x82"
+ " *)ptr->field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~\n"
+ " -\n"
+ " CST ( -\n"
+ " ) ( )\n",
+ pp_formatted_text (dc.printer));
+ }
+
+ /* Example of deletion fix-it hints. */
+ {
+ test_diagnostic_context dc;
+ rich_location richloc (line_table, expr);
+ richloc.add_fixit_insert_before (open_paren, "(bar\xf0\x9f\x98\x82 *)");
+ source_range victim = {open_paren, close_paren};
+ richloc.add_fixit_remove (victim);
+
+ /* This case is actually handled by fixit-consolidation,
+ rather than by line_corrections. */
+ ASSERT_EQ (1, richloc.get_num_fixit_hints ());
+
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " f\xf0\x9f\x98\x82"
+ " *f = (f\xf0\x9f\x98\x82"
+ " *)ptr->field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~\n"
+ " -------\n"
+ " (bar\xf0\x9f\x98\x82"
+ " *)\n",
+ pp_formatted_text (dc.printer));
+ }
+
+ /* Example of deletion fix-it hints that would overlap. */
+ {
+ test_diagnostic_context dc;
+ rich_location richloc (line_table, expr);
+ richloc.add_fixit_insert_before (open_paren, "(long\xf0\x9f\x98\x82 *)");
+ source_range victim = {expr_start, expr_finish};
+ richloc.add_fixit_remove (victim);
+
+ /* These fixits are not consolidated. */
+ ASSERT_EQ (2, richloc.get_num_fixit_hints ());
+
+ /* But the corrections are. */
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " f\xf0\x9f\x98\x82"
+ " *f = (f\xf0\x9f\x98\x82"
+ " *)ptr->field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~\n"
+ " ------------------\n"
+ " (long\xf0\x9f\x98\x82"
+ " *)(f\xf0\x9f\x98\x82"
+ " *)\n",
+ pp_formatted_text (dc.printer));
+ }
+
+ /* Example of insertion fix-it hints that would overlap. */
+ {
+ test_diagnostic_context dc;
+ rich_location richloc (line_table, expr);
+ richloc.add_fixit_insert_before
+ (open_paren, "L\xf0\x9f\x98\x82NGER THAN THE CAST");
+ richloc.add_fixit_insert_after (close_paren, "TEST");
+
+ /* The first insertion is long enough that if printed naively,
+ it would overlap with the second.
+ Verify that they are printed as a single replacement. */
+ diagnostic_show_locus (&dc, &richloc, DK_ERROR);
+ ASSERT_STREQ ("\n"
+ " f\xf0\x9f\x98\x82"
+ " *f = (f\xf0\x9f\x98\x82"
+ " *)ptr->field\xcf\x80"
+ ";\n"
+ " ^~~~~~~~~~~\n"
+ " -------\n"
+ " L\xf0\x9f\x98\x82"
+ "NGER THAN THE CAST(f\xf0\x9f\x98\x82"
+ " *)TEST\n",
+ pp_formatted_text (dc.printer));
+ }
+}
+
/* Verify that the line_corrections machinery correctly prints
overlapping fixit-hints that have been added in the wrong
order.
@@ -3407,10 +4330,10 @@ test_overlapped_fixit_printing_2 (const line_table_case &case_)
/* These fixits should be accepted; they can't be consolidated. */
ASSERT_EQ (2, richloc.get_num_fixit_hints ());
const fixit_hint *hint_0 = richloc.get_fixit_hint (0);
- ASSERT_EQ (column_range (23, 22), get_affected_columns (hint_0));
+ ASSERT_EQ (column_range (23, 22), get_affected_range (hint_0, false));
ASSERT_EQ (column_range (23, 23), get_printed_columns (hint_0));
const fixit_hint *hint_1 = richloc.get_fixit_hint (1);
- ASSERT_EQ (column_range (21, 20), get_affected_columns (hint_1));
+ ASSERT_EQ (column_range (21, 20), get_affected_range (hint_1, false));
ASSERT_EQ (column_range (21, 21), get_printed_columns (hint_1));
/* Verify that they're printed correctly. */
@@ -3737,10 +4660,12 @@ diagnostic_show_locus_c_tests ()
test_diagnostic_show_locus_unknown_location ();
for_each_line_table_case (test_diagnostic_show_locus_one_liner);
+ for_each_line_table_case (test_diagnostic_show_locus_one_liner_utf8);
for_each_line_table_case (test_add_location_if_nearby);
for_each_line_table_case (test_diagnostic_show_locus_fixit_lines);
for_each_line_table_case (test_fixit_consolidation);
for_each_line_table_case (test_overlapped_fixit_printing);
+ for_each_line_table_case (test_overlapped_fixit_printing_utf8);
for_each_line_table_case (test_overlapped_fixit_printing_2);
for_each_line_table_case (test_fixit_insert_containing_newline);
for_each_line_table_case (test_fixit_insert_containing_newline_2);
diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c
index 96b6fa30052..8638fbebb2d 100644
--- a/gcc/diagnostic.c
+++ b/gcc/diagnostic.c
@@ -346,9 +346,13 @@ diagnostic_get_location_text (diagnostic_context *context,
const char *locus_cs = colorize_start (pp_show_color (pp), "locus");
const char *locus_ce = colorize_stop (pp_show_color (pp));
const char *file = s.file ? s.file : progname;
- int line = strcmp (file, N_("<built-in>")) ? s.line : 0;
- int col = context->show_column ? s.column : 0;
-
+ int line = 0;
+ int col = 0;
+ if (strcmp (file, N_("<built-in>")))
+ {
+ line = s.line;
+ col = context->show_column ? location_compute_display_column (s) : 0;
+ }
const char *line_col = maybe_line_and_column (line, col);
return build_message_string ("%s%s%s:%s", locus_cs, file,
line_col, locus_ce);
diff --git a/gcc/input.c b/gcc/input.c
index 00301ef68dd..d2d99000b84 100644
--- a/gcc/input.c
+++ b/gcc/input.c
@@ -908,6 +908,18 @@ make_location (location_t caret, source_range src_range)
return COMBINE_LOCATION_DATA (line_table, pure_loc, src_range, NULL);
}
+int
+location_compute_display_column (expanded_location exploc)
+{
+ if (!(exploc.file && exploc.line && exploc.column))
+ return exploc.column;
+ char_span line = location_get_source_line (exploc.file, exploc.line);
+ /* If line is NULL, this function returns exploc.column which is the
+ desired fallback. */
+ return cpp_byte_column_to_display_column (line.get_buffer (), line.length (),
+ exploc.column);
+}
+
/* Dump statistics to stderr about the memory usage of the line_table
set of line maps. This also displays some statistics about macro
expansion. */
@@ -3590,6 +3602,51 @@ test_line_offset_overflow ()
ASSERT_NE (ordmap_a, ordmap_b);
}
+void test_cpp_utf8 ()
+{
+ /* Verify that wcwidth of invalid UTF-8 or control bytes is 1. */
+ {
+ int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8);
+ ASSERT_EQ (8, w_bad);
+ int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6);
+ ASSERT_EQ (6, w_ctrl);
+ }
+
+ /* Verify that wcwidth of valid UTF-8 is as expected. */
+ {
+ const int w_pi = cpp_display_width ("\xcf\x80", 2);
+ ASSERT_EQ (1, w_pi);
+ const int w_emoji = cpp_display_width ("\xf0\x9f\x98\x82", 4);
+ ASSERT_EQ (2, w_emoji);
+ const int w_ascii = cpp_display_width ("GCC", 3);
+ ASSERT_EQ (3, w_ascii);
+ const int w_mixed
+ = cpp_display_width ("\xcf\x80 = 3.14 \xf0\x9f\x98\x82 \x9f!", 17);
+ ASSERT_EQ (14, w_mixed);
+ }
+
+ /* Verify that cpp_byte_column_to_display_column can go past the end,
+ and similar edge cases. */
+ {
+ const char *str = "\xcf\x80 abc";
+ ASSERT_EQ (5, cpp_display_width (str, 6));
+ ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106));
+ ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000));
+ ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0));
+ }
+
+ /* Verify that cpp_display_column_to_byte_column can go past the end,
+ and similar edge cases. */
+ {
+ const char *str = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello";
+ ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2));
+ ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11));
+ ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111));
+ ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000));
+ ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0));
+ }
+}
+
/* Run all of the selftests within this file. */
void
@@ -3631,6 +3688,8 @@ input_c_tests ()
test_reading_source_line ();
test_line_offset_overflow ();
+
+ test_cpp_utf8 ();
}
} // namespace selftest
diff --git a/gcc/input.h b/gcc/input.h
index c459bf28553..35e02bd91d5 100644
--- a/gcc/input.h
+++ b/gcc/input.h
@@ -38,6 +38,7 @@ STATIC_ASSERT (BUILTINS_LOCATION < RESERVED_LOCATION_COUNT);
extern bool is_location_from_builtin_token (location_t);
extern expanded_location expand_location (location_t);
+extern int location_compute_display_column (expanded_location);
/* A class capturing the bounds of a buffer, to allow for run-time
bounds-checking in a checked build. */
diff --git a/libcpp/charset.c b/libcpp/charset.c
index 10286219bd6..1efdaec15a9 100644
--- a/libcpp/charset.c
+++ b/libcpp/charset.c
@@ -2244,3 +2244,106 @@ cpp_string_location_reader::get_next ()
m_loc += m_offset_per_column;
return result;
}
+
+/* Helper for cpp_byte_column_to_display_column and its inverse. Given a
+ pointer to a UTF-8-encoded character, compute its display width. *INBUFP
+ points on entry to the start of the UTF-8 encoding of the character, and
+ is updated to point just after the last byte of the encoding. *INBYTESLEFTP
+ contains on entry the remaining size of the buffer into which *INBUFP
+ points, and this is also updated accordingly. If *INBUFP does not
+ point to a valid UTF-8-encoded sequence, then it will be treated as a single
+ byte with display width 1. */
+
+static inline int
+compute_next_display_width (const uchar **inbufp, size_t *inbytesleftp)
+{
+ cppchar_t c;
+ if (one_utf8_to_cppchar (inbufp, inbytesleftp, &c) != 0)
+ {
+ /* Input is not convertible to UTF-8. This could be fine, e.g. in a
+ string literal, so don't complain. Just treat it as if it has a width
+ of one. */
+ ++*inbufp;
+ --*inbytesleftp;
+ return 1;
+ }
+
+ /* one_utf8_to_cppchar() has updated inbufp and inbytesleftp for us. */
+ return cpp_wcwidth (c);
+}
+
+/* For the string of length DATA_LENGTH bytes that begins at DATA, compute
+ how many display columns are occupied by the first COLUMN bytes. COLUMN
+ may exceed DATA_LENGTH, in which case the phantom bytes at the end are
+ treated as if they have display width 1. */
+
+int
+cpp_byte_column_to_display_column (const char *data, int data_length,
+ int column)
+{
+ int display_col = 0;
+ const uchar *udata = (const uchar *) data;
+ const int offset = MAX (0, column - data_length);
+ size_t inbytesleft = column - offset;
+ while (inbytesleft)
+ display_col += compute_next_display_width (&udata, &inbytesleft);
+ return display_col + offset;
+}
+
+/* For the string of length DATA_LENGTH bytes that begins at DATA, compute
+ the least number of bytes that will result in at least DISPLAY_COL display
+ columns. The return value may exceed DATA_LENGTH if the entire string does
+ not occupy enough display columns. */
+
+int
+cpp_display_column_to_byte_column (const char *data, int data_length,
+ int display_col)
+{
+ int column = 0;
+ const uchar *udata = (const uchar *) data;
+ size_t inbytesleft = data_length;
+ while (column < display_col && inbytesleft)
+ column += compute_next_display_width (&udata, &inbytesleft);
+ return data_length - inbytesleft + (display_col - column);
+}
+
+/* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc,
+ because that will inspect the user's locale, and in particular in an ASCII
+ locale, it will not return anything useful for extended characters. But GCC
+ in other respects (see e.g. _cpp_default_encoding()) behaves as if
+ everything is UTF-8. We also make some tweaks that are useful for the way
+ GCC needs to use this data, e.g. tabs and other control characters should be
+ treated as having width 1. The lookup tables are generated from
+ contrib/gen_wcwidth.cpp and were made by simply calling glibc wcwidth() on
+ all codepoints, then applying the small tweaks. These tables are not highly
+ optimized, but for the present purpose of outputting diagnostics, they are
+ sufficient. */
+
+#include "generated_cpp_wcwidth.h"
+int cpp_wcwidth (cppchar_t c)
+{
+ if (__builtin_expect (c <= wcwidth_range_ends[0], true))
+ return wcwidth_widths[0];
+
+ /* Binary search the tables. */
+ int begin = 1;
+ static const int end
+ = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends);
+ int len = end - begin;
+ do
+ {
+ int half = len/2;
+ int middle = begin + half;
+ if (c > wcwidth_range_ends[middle])
+ {
+ begin = middle + 1;
+ len -= half + 1;
+ }
+ else
+ len = half;
+ } while (len);
+
+ if (__builtin_expect (begin != end, true))
+ return wcwidth_widths[begin];
+ return 1;
+}
diff --git a/libcpp/generated_cpp_wcwidth.h b/libcpp/generated_cpp_wcwidth.h
new file mode 100644
index 00000000000..3ebada447a1
--- /dev/null
+++ b/libcpp/generated_cpp_wcwidth.h
@@ -0,0 +1,147 @@
+/* Generated by contrib/gen_wcwidth.cpp. */
+
+static const cppchar_t wcwidth_range_ends[] = {
+ 0x2ff, 0x36f, 0x482, 0x489, 0x590, 0x5bd, 0x5be, 0x5bf,
+ 0x5c0, 0x5c2, 0x5c3, 0x5c5, 0x5c6, 0x5c7, 0x60f, 0x61a,
+ 0x61b, 0x61c, 0x64a, 0x65f, 0x66f, 0x670, 0x6d5, 0x6dc,
+ 0x6de, 0x6e4, 0x6e6, 0x6e8, 0x6e9, 0x6ed, 0x710, 0x711,
+ 0x72f, 0x74a, 0x7a5, 0x7b0, 0x7ea, 0x7f3, 0x815, 0x819,
+ 0x81a, 0x823, 0x824, 0x827, 0x828, 0x82d, 0x858, 0x85b,
+ 0x8d3, 0x8e1, 0x8e2, 0x902, 0x939, 0x93a, 0x93b, 0x93c,
+ 0x940, 0x948, 0x94c, 0x94d, 0x950, 0x957, 0x961, 0x963,
+ 0x980, 0x981, 0x9bb, 0x9bc, 0x9c0, 0x9c4, 0x9cc, 0x9cd,
+ 0x9e1, 0x9e3, 0xa00, 0xa02, 0xa3b, 0xa3c, 0xa40, 0xa42,
+ 0xa46, 0xa48, 0xa4a, 0xa4d, 0xa50, 0xa51, 0xa6f, 0xa71,
+ 0xa74, 0xa75, 0xa80, 0xa82, 0xabb, 0xabc, 0xac0, 0xac5,
+ 0xac6, 0xac8, 0xacc, 0xacd, 0xae1, 0xae3, 0xaf9, 0xaff,
+ 0xb00, 0xb01, 0xb3b, 0xb3c, 0xb3e, 0xb3f, 0xb40, 0xb44,
+ 0xb4c, 0xb4d, 0xb55, 0xb56, 0xb61, 0xb63, 0xb81, 0xb82,
+ 0xbbf, 0xbc0, 0xbcc, 0xbcd, 0xbff, 0xc00, 0xc3d, 0xc40,
+ 0xc45, 0xc48, 0xc49, 0xc4d, 0xc54, 0xc56, 0xc61, 0xc63,
+ 0xc80, 0xc81, 0xcbb, 0xcbc, 0xcbe, 0xcbf, 0xcc5, 0xcc6,
+ 0xccb, 0xccd, 0xce1, 0xce3, 0xcff, 0xd01, 0xd3a, 0xd3c,
+ 0xd40, 0xd44, 0xd4c, 0xd4d, 0xd61, 0xd63, 0xdc9, 0xdca,
+ 0xdd1, 0xdd4, 0xdd5, 0xdd6, 0xe30, 0xe31, 0xe33, 0xe3a,
+ 0xe46, 0xe4e, 0xeb0, 0xeb1, 0xeb3, 0xeb9, 0xeba, 0xebc,
+ 0xec7, 0xecd, 0xf17, 0xf19, 0xf34, 0xf35, 0xf36, 0xf37,
+ 0xf38, 0xf39, 0xf70, 0xf7e, 0xf7f, 0xf84, 0xf85, 0xf87,
+ 0xf8c, 0xf97, 0xf98, 0xfbc, 0xfc5, 0xfc6, 0x102c, 0x1030,
+ 0x1031, 0x1037, 0x1038, 0x103a, 0x103c, 0x103e, 0x1057, 0x1059,
+ 0x105d, 0x1060, 0x1070, 0x1074, 0x1081, 0x1082, 0x1084, 0x1086,
+ 0x108c, 0x108d, 0x109c, 0x109d, 0x10ff, 0x115f, 0x11ff, 0x135c,
+ 0x135f, 0x1711, 0x1714, 0x1731, 0x1734, 0x1751, 0x1753, 0x1771,
+ 0x1773, 0x17b3, 0x17b5, 0x17b6, 0x17bd, 0x17c5, 0x17c6, 0x17c8,
+ 0x17d3, 0x17dc, 0x17dd, 0x180a, 0x180e, 0x1884, 0x1886, 0x18a8,
+ 0x18a9, 0x191f, 0x1922, 0x1926, 0x1928, 0x1931, 0x1932, 0x1938,
+ 0x193b, 0x1a16, 0x1a18, 0x1a1a, 0x1a1b, 0x1a55, 0x1a56, 0x1a57,
+ 0x1a5e, 0x1a5f, 0x1a60, 0x1a61, 0x1a62, 0x1a64, 0x1a6c, 0x1a72,
+ 0x1a7c, 0x1a7e, 0x1a7f, 0x1aaf, 0x1abe, 0x1aff, 0x1b03, 0x1b33,
+ 0x1b34, 0x1b35, 0x1b3a, 0x1b3b, 0x1b3c, 0x1b41, 0x1b42, 0x1b6a,
+ 0x1b73, 0x1b7f, 0x1b81, 0x1ba1, 0x1ba5, 0x1ba7, 0x1ba9, 0x1baa,
+ 0x1bad, 0x1be5, 0x1be6, 0x1be7, 0x1be9, 0x1bec, 0x1bed, 0x1bee,
+ 0x1bf1, 0x1c2b, 0x1c33, 0x1c35, 0x1c37, 0x1ccf, 0x1cd2, 0x1cd3,
+ 0x1ce0, 0x1ce1, 0x1ce8, 0x1cec, 0x1ced, 0x1cf3, 0x1cf4, 0x1cf7,
+ 0x1cf9, 0x1dbf, 0x1df9, 0x1dfa, 0x1dff, 0x200a, 0x200f, 0x2029,
+ 0x202e, 0x205f, 0x2064, 0x2065, 0x206f, 0x20cf, 0x20f0, 0x2319,
+ 0x231b, 0x2328, 0x232a, 0x23e8, 0x23ec, 0x23ef, 0x23f0, 0x23f2,
+ 0x23f3, 0x25fc, 0x25fe, 0x2613, 0x2615, 0x2647, 0x2653, 0x267e,
+ 0x267f, 0x2692, 0x2693, 0x26a0, 0x26a1, 0x26a9, 0x26ab, 0x26bc,
+ 0x26be, 0x26c3, 0x26c5, 0x26cd, 0x26ce, 0x26d3, 0x26d4, 0x26e9,
+ 0x26ea, 0x26f1, 0x26f3, 0x26f4, 0x26f5, 0x26f9, 0x26fa, 0x26fc,
+ 0x26fd, 0x2704, 0x2705, 0x2709, 0x270b, 0x2727, 0x2728, 0x274b,
+ 0x274c, 0x274d, 0x274e, 0x2752, 0x2755, 0x2756, 0x2757, 0x2794,
+ 0x2797, 0x27af, 0x27b0, 0x27be, 0x27bf, 0x2b1a, 0x2b1c, 0x2b4f,
+ 0x2b50, 0x2b54, 0x2b55, 0x2cee, 0x2cf1, 0x2d7e, 0x2d7f, 0x2ddf,
+ 0x2dff, 0x2e7f, 0x2e99, 0x2e9a, 0x2ef3, 0x2eff, 0x2fd5, 0x2fef,
+ 0x2ffb, 0x2fff, 0x3029, 0x302d, 0x303e, 0x3040, 0x3096, 0x3098,
+ 0x309a, 0x30ff, 0x3104, 0x312e, 0x3130, 0x318e, 0x318f, 0x31ba,
+ 0x31bf, 0x31e3, 0x31ef, 0x321e, 0x321f, 0x32fe, 0x32ff, 0x4db5,
+ 0x4dbf, 0x9fea, 0x9fff, 0xa48c, 0xa48f, 0xa4c6, 0xa66e, 0xa672,
+ 0xa673, 0xa67d, 0xa69d, 0xa69f, 0xa6ef, 0xa6f1, 0xa801, 0xa802,
+ 0xa805, 0xa806, 0xa80a, 0xa80b, 0xa824, 0xa826, 0xa8c3, 0xa8c5,
+ 0xa8df, 0xa8f1, 0xa925, 0xa92d, 0xa946, 0xa951, 0xa95f, 0xa97c,
+ 0xa97f, 0xa982, 0xa9b2, 0xa9b3, 0xa9b5, 0xa9b9, 0xa9bb, 0xa9bc,
+ 0xa9e4, 0xa9e5, 0xaa28, 0xaa2e, 0xaa30, 0xaa32, 0xaa34, 0xaa36,
+ 0xaa42, 0xaa43, 0xaa4b, 0xaa4c, 0xaa7b, 0xaa7c, 0xaaaf, 0xaab0,
+ 0xaab1, 0xaab4, 0xaab6, 0xaab8, 0xaabd, 0xaabf, 0xaac0, 0xaac1,
+ 0xaaeb, 0xaaed, 0xaaf5, 0xaaf6, 0xabe4, 0xabe5, 0xabe7, 0xabe8,
+ 0xabec, 0xabed, 0xabff, 0xd7a3, 0xf8ff, 0xfa6d, 0xfa6f, 0xfad9,
+ 0xfb1d, 0xfb1e, 0xfdff, 0xfe0f, 0xfe19, 0xfe1f, 0xfe2f, 0xfe52,
+ 0xfe53, 0xfe66, 0xfe67, 0xfe6b, 0xfefe, 0xfeff, 0xff00, 0xff60,
+ 0xffdf, 0xffe6, 0xfff8, 0xfffb, 0x101fc, 0x101fd, 0x102df, 0x102e0,
+ 0x10375, 0x1037a, 0x10a00, 0x10a03, 0x10a04, 0x10a06, 0x10a0b, 0x10a0f,
+ 0x10a37, 0x10a3a, 0x10a3e, 0x10a3f, 0x10ae4, 0x10ae6, 0x11000, 0x11001,
+ 0x11037, 0x11046, 0x1107e, 0x11081, 0x110b2, 0x110b6, 0x110b8, 0x110ba,
+ 0x110ff, 0x11102, 0x11126, 0x1112b, 0x1112c, 0x11134, 0x11172, 0x11173,
+ 0x1117f, 0x11181, 0x111b5, 0x111be, 0x111c9, 0x111cc, 0x1122e, 0x11231,
+ 0x11233, 0x11234, 0x11235, 0x11237, 0x1123d, 0x1123e, 0x112de, 0x112df,
+ 0x112e2, 0x112ea, 0x112ff, 0x11301, 0x1133b, 0x1133c, 0x1133f, 0x11340,
+ 0x11365, 0x1136c, 0x1136f, 0x11374, 0x11437, 0x1143f, 0x11441, 0x11444,
+ 0x11445, 0x11446, 0x114b2, 0x114b8, 0x114b9, 0x114ba, 0x114be, 0x114c0,
+ 0x114c1, 0x114c3, 0x115b1, 0x115b5, 0x115bb, 0x115bd, 0x115be, 0x115c0,
+ 0x115db, 0x115dd, 0x11632, 0x1163a, 0x1163c, 0x1163d, 0x1163e, 0x11640,
+ 0x116aa, 0x116ab, 0x116ac, 0x116ad, 0x116af, 0x116b5, 0x116b6, 0x116b7,
+ 0x1171c, 0x1171f, 0x11721, 0x11725, 0x11726, 0x1172b, 0x11a00, 0x11a06,
+ 0x11a08, 0x11a0a, 0x11a32, 0x11a38, 0x11a3a, 0x11a3e, 0x11a46, 0x11a47,
+ 0x11a50, 0x11a56, 0x11a58, 0x11a5b, 0x11a89, 0x11a96, 0x11a97, 0x11a99,
+ 0x11c2f, 0x11c36, 0x11c37, 0x11c3d, 0x11c3e, 0x11c3f, 0x11c91, 0x11ca7,
+ 0x11ca9, 0x11cb0, 0x11cb1, 0x11cb3, 0x11cb4, 0x11cb6, 0x11d30, 0x11d36,
+ 0x11d39, 0x11d3a, 0x11d3b, 0x11d3d, 0x11d3e, 0x11d45, 0x11d46, 0x11d47,
+ 0x16aef, 0x16af4, 0x16b2f, 0x16b36, 0x16f8e, 0x16f92, 0x16fdf, 0x16fe1,
+ 0x16fff, 0x187ec, 0x187ff, 0x18af2, 0x1afff, 0x1b11e, 0x1b16f, 0x1b2fb,
+ 0x1bc9c, 0x1bc9e, 0x1bc9f, 0x1bca3, 0x1d166, 0x1d169, 0x1d172, 0x1d182,
+ 0x1d184, 0x1d18b, 0x1d1a9, 0x1d1ad, 0x1d241, 0x1d244, 0x1d9ff, 0x1da36,
+ 0x1da3a, 0x1da6c, 0x1da74, 0x1da75, 0x1da83, 0x1da84, 0x1da9a, 0x1da9f,
+ 0x1daa0, 0x1daaf, 0x1dfff, 0x1e006, 0x1e007, 0x1e018, 0x1e01a, 0x1e021,
+ 0x1e022, 0x1e024, 0x1e025, 0x1e02a, 0x1e8cf, 0x1e8d6, 0x1e943, 0x1e94a,
+ 0x1f003, 0x1f004, 0x1f0ce, 0x1f0cf, 0x1f18d, 0x1f18e, 0x1f190, 0x1f19a,
+ 0x1f1ff, 0x1f202, 0x1f20f, 0x1f23b, 0x1f23f, 0x1f248, 0x1f24f, 0x1f251,
+ 0x1f25f, 0x1f265, 0x1f2ff, 0x1f320, 0x1f32c, 0x1f335, 0x1f336, 0x1f37c,
+ 0x1f37d, 0x1f393, 0x1f39f, 0x1f3ca, 0x1f3ce, 0x1f3d3, 0x1f3df, 0x1f3f0,
+ 0x1f3f3, 0x1f3f4, 0x1f3f7, 0x1f43e, 0x1f43f, 0x1f440, 0x1f441, 0x1f4fc,
+ 0x1f4fe, 0x1f53d, 0x1f54a, 0x1f54e, 0x1f54f, 0x1f567, 0x1f579, 0x1f57a,
+ 0x1f594, 0x1f596, 0x1f5a3, 0x1f5a4, 0x1f5fa, 0x1f64f, 0x1f67f, 0x1f6c5,
+ 0x1f6cb, 0x1f6cc, 0x1f6cf, 0x1f6d2, 0x1f6ea, 0x1f6ec, 0x1f6f3, 0x1f6f8,
+ 0x1f90f, 0x1f93e, 0x1f93f, 0x1f94c, 0x1f94f, 0x1f96b, 0x1f97f, 0x1f997,
+ 0x1f9bf, 0x1f9c0, 0x1f9cf, 0x1f9e6, 0x1ffff, 0x2a6d6, 0x2a6ff, 0x2b734,
+ 0x2b73f, 0x2b81d, 0x2b81f, 0x2cea1, 0x2ceaf, 0x2ebe0, 0x2f7ff, 0x2fa1d,
+ 0xe0000, 0xe0001, 0xe001f, 0xe007f, 0xe00ff, 0xe01ef, 0x10ffff,
+};
+
+static const unsigned char wcwidth_widths[] = {
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1,
+ 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1,
+ 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1,
+ 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1,
+ 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1,
+ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1,
+ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1,
+ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1,
+ 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 0, 2, 1, 2, 1, 0, 2, 1, 2, 1, 2, 1, 2,
+ 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 2, 1, 0, 2,
+ 1, 2, 1, 2, 1, 0, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2,
+ 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
+ 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2,
+ 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2,
+ 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2,
+ 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1,
+};
diff --git a/libcpp/include/cpplib.h b/libcpp/include/cpplib.h
index a645f8136a6..fdc8badba7d 100644
--- a/libcpp/include/cpplib.h
+++ b/libcpp/include/cpplib.h
@@ -1305,4 +1305,15 @@ extern bool cpp_userdef_char_p
extern const char * cpp_get_userdef_suffix
(const cpp_token *);
+/* In charset.c */
+int cpp_byte_column_to_display_column (const char *data, int data_length,
+ int column);
+inline int cpp_display_width (const char *data, int data_length)
+{
+ return cpp_byte_column_to_display_column (data, data_length, data_length);
+}
+int cpp_display_column_to_byte_column (const char *data, int data_length,
+ int display_col);
+int cpp_wcwidth (cppchar_t c);
+
#endif /* ! LIBCPP_CPPLIB_H */
^ permalink raw reply [flat|nested] 17+ messages in thread* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-09-26 20:16 [PATCH] Multibyte awareness for diagnostics (PR 49973) Lewis Hyatt @ 2019-09-26 20:47 ` Joseph Myers 2019-09-26 20:51 ` Lewis Hyatt 2019-09-27 20:42 ` Lewis Hyatt 0 siblings, 2 replies; 17+ messages in thread From: Joseph Myers @ 2019-09-26 20:47 UTC (permalink / raw) To: Lewis Hyatt; +Cc: gcc-patches On Thu, 26 Sep 2019, Lewis Hyatt wrote: > A couple notes: > - In order to avoid any portability problems with wchar_t, the > equivalent of wcwidth() from libc is implemented in-house. I'm uneasy about contrib/gen_wcwidth.cpp doing the generation using host libc's wcwidth. The effect is that libcpp/generated_cpp_wcwidth.h is *not* reproducible unless you know exactly what host (libc version, locale used when running the program, distribution patches to libc and locale data) was used to run the program. I think we need a generator that works from Unicode data in some way so we can explicitly say what version of the (unmodified) Unicode data was used. -- Joseph S. Myers joseph@codesourcery.com ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-09-26 20:47 ` Joseph Myers @ 2019-09-26 20:51 ` Lewis Hyatt 2019-09-27 20:42 ` Lewis Hyatt 1 sibling, 0 replies; 17+ messages in thread From: Lewis Hyatt @ 2019-09-26 20:51 UTC (permalink / raw) To: Joseph Myers; +Cc: gcc-patches On Thu, Sep 26, 2019 at 4:47 PM Joseph Myers <joseph@codesourcery.com> wrote: > > On Thu, 26 Sep 2019, Lewis Hyatt wrote: > > > A couple notes: > > - In order to avoid any portability problems with wchar_t, the > > equivalent of wcwidth() from libc is implemented in-house. > > I'm uneasy about contrib/gen_wcwidth.cpp doing the generation using host > libc's wcwidth. The effect is that libcpp/generated_cpp_wcwidth.h is > *not* reproducible unless you know exactly what host (libc version, locale > used when running the program, distribution patches to libc and locale > data) was used to run the program. I think we need a generator that works > from Unicode data in some way so we can explicitly say what version of the > (unmodified) Unicode data was used. > Got it, no problem, will find something that accomplishes this. -Lewis ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-09-26 20:47 ` Joseph Myers 2019-09-26 20:51 ` Lewis Hyatt @ 2019-09-27 20:42 ` Lewis Hyatt 2019-10-18 13:59 ` Lewis Hyatt 2019-11-19 17:38 ` David Malcolm 1 sibling, 2 replies; 17+ messages in thread From: Lewis Hyatt @ 2019-09-27 20:42 UTC (permalink / raw) To: gcc-patches; +Cc: joseph [-- Attachment #1: Type: text/plain, Size: 2656 bytes --] On Thu, Sep 26, 2019 at 08:46:56PM +0000, Joseph Myers wrote: > On Thu, 26 Sep 2019, Lewis Hyatt wrote: > > > A couple notes: > > - In order to avoid any portability problems with wchar_t, the > > equivalent of wcwidth() from libc is implemented in-house. > > I'm uneasy about contrib/gen_wcwidth.cpp doing the generation using host > libc's wcwidth. The effect is that libcpp/generated_cpp_wcwidth.h is > *not* reproducible unless you know exactly what host (libc version, locale > used when running the program, distribution patches to libc and locale > data) was used to run the program. I think we need a generator that works > from Unicode data in some way so we can explicitly say what version of the > (unmodified) Unicode data was used. Here is a revised patch that hopefully addresses your concerns. I borrowed the relevant Python code for parsing Unicode's data files from glibc, then added a new script that parses the locale data they output into the same sort of simply searchable tables I was creating before. The new generated table is very close to the old one, but there are some differences due to improvements that have been made to glibc recently, affecting 200 or so codepoints. The procedure for updating GCC's wcwidth would then be the following: -The three Unicode data files live in contrib/unicode/ {EastAsianWidth.txt,PropList.txt,UnicodeData.txt} and can be updated at any time when Unicode changes them. -glibc's processing logic lives in two Python scripts in contrib/unicode/from_glibc and these would ideally be updated when glibc makes updates. It seems they occasionally put some manual overrides, etc., based on feedback and bug reports. (These are the verbatim scripts from glibc with no changes, so they need only be copied over.) -contrib/unicode/gen_wcwidth.py runs the glibc code, using GCC's Unicode data files as inputs, and produces the necessary tables for libcpp/generated_cpp_wcwidth.h. Hope that sounds better. This way it is relatively straightforward to keep in sync with glibc (which seems desirable to me anyway), but is also always reproducible. Note: I did not include the three large unicode data files in this emailed patch, although they would be committed as part of the patch presumably. They are available here: ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt The rest of the patch is unchanged from before, other than one comment updated to reflect the new situation, and charset.c rebased to current trunk. Thank you for taking the time to review this. -Lewis [-- Attachment #2: ChangeLog.txt --] [-- Type: text/plain, Size: 4272 bytes --] /ChangeLog 2019-09-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * contrib/unicode/from_glibc/unicode_utils.py: Support script from glibc (commit 464cd3) to extract character widths from Unicode data files. * contrib/unicode/from_glibc/utf8_gen.py: Likewise. * contrib/unicode/UnicodeData.txt: Unicode v. 12.1.0 data file. * contrib/unicode/EastAsianWidth.txt: Likewise. * contrib/unicode/PropList.txt: Likewise. * contrib/unicode/gen_wcwidth.py: New utility to generate libcpp/generated_cpp_wcwidth.h with help from the glibc support scripts and the Unicode data files. libcpp/ChangeLog 2019-09-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * generated_cpp_wcwidth.h: New file generated by contrib/unicode/gen_wcwidth.py, supports new cpp_wcwidth function. * charset.c (compute_next_display_width): New function to help implement display columns. (cpp_byte_column_to_display_column): Likewise. (cpp_display_column_to_byte_column): Likewise. (cpp_wcwidth): Likewise. * include/cpplib.h (cpp_byte_column_to_display_column): Declare. (cpp_display_column_to_byte_column): Declare. (cpp_wcwidth): Declare. (cpp_display_width): New function. gcc/ChangeLog 2019-09-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * input.c (location_compute_display_column): New function to help with multibyte awareness in diagnostics. (test_cpp_utf8): New self-test. (input_c_tests): Call the new test. * input.h (location_compute_display_column): Declare. * diagnostic.c (diagnostic_get_location_text): Use it to output the correct column number on diagnostics for source lines containing multibyte characters. * diagnostic-show-locus.c: Pervasive changes to add multibyte awareness to all classes and functions. (class exploc_with_display_col): New class. (class layout_point): Add m_display_col member. (layout_point::get_col): New function. (layout_range::contains_point): Add use_display argument. (test_layout_range_for_single_point): Pass new argument. (test_layout_range_for_single_line): Likewise. (test_layout_range_for_multiple_lines): Likewise. (line_bounds::convert_to_display_cols): New function. (layout::get_state_at_point): Add use_display argument. (class layout): m_exploc changed to exploc_with_display_col from expanded_location. (layout::layout): Add multibyte awareness. (layout::print_source_line): Likewise. (layout::print_annotation_line): Likewise. (line_label::line_label): Likewise. (layout::print_any_labels): Likewise. (layout::annotation_line_showed_range_p): Likewise. (get_printed_columns): Likewise. (get_affected_columns): Rename to... (get_affected_range): ...this; add use_display argument and multibyte awareness. (class correction): Add m_affected_bytes and m_display_cols members. Rename m_len to m_bytes for clarity. Add multibyte awareness. (correction::insertion_p): Add multibyte awareness. (correction::compute_display_cols): New function. (correction::ensure_terminated): m_len renamed to m_bytes. (line_corrections::add_hint): Add multibyte awareness. (layout::print_trailing_fixits): Likewise. (layout::get_x_bound_for_row): Likewise. (test_one_liner_simple_caret_utf8): New self-test analogous to the one with _utf8 suffix removed, testing multibyte awareness. (test_one_liner_caret_and_range_utf8): Likewise. (test_one_liner_multiple_carets_and_ranges_utf8): Likewise. (test_one_liner_fixit_insert_before_utf8): Likewise. (test_one_liner_fixit_insert_after_utf8): Likewise. (test_one_liner_fixit_remove_utf8): Likewise. (test_one_liner_fixit_replace_utf8): Likewise. (test_one_liner_fixit_replace_non_equal_range_utf8): Likewise. (test_one_liner_fixit_replace_equal_secondary_range_utf8): Likewise. (test_one_liner_fixit_validation_adhoc_locations_utf8): Likewise. (test_one_liner_many_fixits_1_utf8): Likewise. (test_one_liner_many_fixits_2_utf8): Likewise. (test_one_liner_labels_utf8): Likewise. (test_diagnostic_show_locus_one_liner_utf8): Likewise. (test_overlapped_fixit_printing_utf8): Likewise. (test_overlapped_fixit_printing): Adapt for changes to get_affected_columns, get_printed_columns and class corrections. (test_overlapped_fixit_printing_2): Likewise. (diagnostic_show_locus_c_tests): Call new tests. [-- Attachment #3: display_cols_v2.patch --] [-- Type: text/x-patch, Size: 125066 bytes --] diff --git a/contrib/unicode/from_glibc/unicode_utils.py b/contrib/unicode/from_glibc/unicode_utils.py new file mode 100644 index 00000000000..a9e94cce418 --- /dev/null +++ b/contrib/unicode/from_glibc/unicode_utils.py @@ -0,0 +1,527 @@ +# Utilities to generate Unicode data for glibc from upstream Unicode data. +# +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +''' +This module contains utilities used by the scripts to generate +Unicode data for glibc from upstream Unicode data files. +''' + +import sys +import re + + +# Common locale header. +COMMENT_HEADER = """ +% This file is part of the GNU C Library and contains locale data. +% The Free Software Foundation does not claim any copyright interest +% in the locale data contained in this file. The foregoing does not +% affect the license of the GNU C Library as a whole. It does not +% exempt you from the conditions of the license if your use would +% otherwise be governed by that license. +""" + +# Dictionary holding the entire contents of the UnicodeData.txt file +# +# Contents of this dictionary look like this: +# +# {0: {'category': 'Cc', +# 'title': None, +# 'digit': '', +# 'name': '<control>', +# 'bidi': 'BN', +# 'combining': '0', +# 'comment': '', +# 'oldname': 'NULL', +# 'decomposition': '', +# 'upper': None, +# 'mirrored': 'N', +# 'lower': None, +# 'decdigit': '', +# 'numeric': ''}, +# … +# } +UNICODE_ATTRIBUTES = {} + +# Dictionary holding the entire contents of the DerivedCoreProperties.txt file +# +# Contents of this dictionary look like this: +# +# {917504: ['Default_Ignorable_Code_Point'], +# 917505: ['Case_Ignorable', 'Default_Ignorable_Code_Point'], +# … +# } +DERIVED_CORE_PROPERTIES = {} + +# Dictionary holding the entire contents of the EastAsianWidths.txt file +# +# Contents of this dictionary look like this: +# +# {0: 'N', … , 45430: 'W', …} +EAST_ASIAN_WIDTHS = {} + +def fill_attribute(code_point, fields): + '''Stores in UNICODE_ATTRIBUTES[code_point] the values from the fields. + + One entry in the UNICODE_ATTRIBUTES dictionary represents one line + in the UnicodeData.txt file. + + ''' + UNICODE_ATTRIBUTES[code_point] = { + 'name': fields[1], # Character name + 'category': fields[2], # General category + 'combining': fields[3], # Canonical combining classes + 'bidi': fields[4], # Bidirectional category + 'decomposition': fields[5], # Character decomposition mapping + 'decdigit': fields[6], # Decimal digit value + 'digit': fields[7], # Digit value + 'numeric': fields[8], # Numeric value + 'mirrored': fields[9], # mirrored + 'oldname': fields[10], # Old Unicode 1.0 name + 'comment': fields[11], # comment + # Uppercase mapping + 'upper': int(fields[12], 16) if fields[12] else None, + # Lowercase mapping + 'lower': int(fields[13], 16) if fields[13] else None, + # Titlecase mapping + 'title': int(fields[14], 16) if fields[14] else None, + } + +def fill_attributes(filename): + '''Stores the entire contents of the UnicodeData.txt file + in the UNICODE_ATTRIBUTES dictionary. + + A typical line for a single code point in UnicodeData.txt looks + like this: + + 0041;LATIN CAPITAL LETTER A;Lu;0;L;;;;;N;;;;0061; + + Code point ranges are indicated by pairs of lines like this: + + 4E00;<CJK Ideograph, First>;Lo;0;L;;;;;N;;;;; + 9FCC;<CJK Ideograph, Last>;Lo;0;L;;;;;N;;;;; + ''' + with open(filename, mode='r') as unicode_data_file: + fields_start = [] + for line in unicode_data_file: + fields = line.strip().split(';') + if len(fields) != 15: + sys.stderr.write( + 'short line in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + if fields[2] == 'Cs': + # Surrogates are UTF-16 artefacts, + # not real characters. Ignore them. + fields_start = [] + continue + if fields[1].endswith(', First>'): + fields_start = fields + fields_start[1] = fields_start[1].split(',')[0][1:] + continue + if fields[1].endswith(', Last>'): + fields[1] = fields[1].split(',')[0][1:] + if fields[1:] != fields_start[1:]: + sys.stderr.write( + 'broken code point range in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + for code_point in range( + int(fields_start[0], 16), + int(fields[0], 16)+1): + fill_attribute(code_point, fields) + fields_start = [] + continue + fill_attribute(int(fields[0], 16), fields) + fields_start = [] + +def fill_derived_core_properties(filename): + '''Stores the entire contents of the DerivedCoreProperties.txt file + in the DERIVED_CORE_PROPERTIES dictionary. + + Lines in DerivedCoreProperties.txt are either a code point range like + this: + + 0061..007A ; Lowercase # L& [26] LATIN SMALL LETTER A..LATIN SMALL LETTER Z + + or a single code point like this: + + 00AA ; Lowercase # Lo FEMININE ORDINAL INDICATOR + + ''' + with open(filename, mode='r') as derived_core_properties_file: + for line in derived_core_properties_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + + r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + + r'\s*;\s*(?P<property>[a-zA-Z_]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + prop = match.group('property') + if code_point in DERIVED_CORE_PROPERTIES: + DERIVED_CORE_PROPERTIES[code_point].append(prop) + else: + DERIVED_CORE_PROPERTIES[code_point] = [prop] + +def fill_east_asian_widths(filename): + '''Stores the entire contents of the EastAsianWidths.txt file + in the EAST_ASIAN_WIDTHS dictionary. + + Lines in EastAsianWidths.txt are either a code point range like + this: + + 9FCD..9FFF;W # Cn [51] <reserved-9FCD>..<reserved-9FFF> + + or a single code point like this: + + A015;W # Lm YI SYLLABLE WU + ''' + with open(filename, mode='r') as east_asian_widths_file: + for line in east_asian_widths_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + +r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + +r'\s*;\s*(?P<property>[a-zA-Z]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + EAST_ASIAN_WIDTHS[code_point] = match.group('property') + +def to_upper(code_point): + '''Returns the code point of the uppercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['upper']): + return UNICODE_ATTRIBUTES[code_point]['upper'] + else: + return code_point + +def to_lower(code_point): + '''Returns the code point of the lowercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['lower']): + return UNICODE_ATTRIBUTES[code_point]['lower'] + else: + return code_point + +def to_upper_turkish(code_point): + '''Returns the code point of the Turkish uppercase version + of the given code point''' + if code_point == 0x0069: + return 0x0130 + return to_upper(code_point) + +def to_lower_turkish(code_point): + '''Returns the code point of the Turkish lowercase version + of the given code point''' + if code_point == 0x0049: + return 0x0131 + return to_lower(code_point) + +def to_title(code_point): + '''Returns the code point of the titlecase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['title']): + return UNICODE_ATTRIBUTES[code_point]['title'] + else: + return code_point + +def is_upper(code_point): + '''Checks whether the character with this code point is uppercase''' + return (to_lower(code_point) != code_point + or (code_point in DERIVED_CORE_PROPERTIES + and 'Uppercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_lower(code_point): + '''Checks whether the character with this code point is lowercase''' + # Some characters are defined as “Lowercase†in + # DerivedCoreProperties.txt but do not have a mapping to upper + # case. For example, ꜰ U+A72F “LATIN LETTER SMALL CAPITAL F†is + # one of these. + return (to_upper(code_point) != code_point + # <U00DF> is lowercase, but without simple to_upper mapping. + or code_point == 0x00DF + or (code_point in DERIVED_CORE_PROPERTIES + and 'Lowercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_alpha(code_point): + '''Checks whether the character with this code point is alphabetic''' + return ((code_point in DERIVED_CORE_PROPERTIES + and + 'Alphabetic' in DERIVED_CORE_PROPERTIES[code_point]) + or + # Consider all the non-ASCII digits as alphabetic. + # ISO C 99 forbids us to have them in category “digitâ€, + # but we want iswalnum to return true on them. + (UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd' + and not (code_point >= 0x0030 and code_point <= 0x0039))) + +def is_digit(code_point): + '''Checks whether the character with this code point is a digit''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd') + # Note: U+0BE7..U+0BEF and U+1369..U+1371 are digit systems without + # a zero. Must add <0> in front of them by hand. + else: + # SUSV2 gives us some freedom for the "digit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.5: + # The iswdigit function tests for any wide character that + # corresponds to a decimal-digit character (as defined in 5.2.1). + # 5.2.1: + # the 10 decimal digits 0 1 2 3 4 5 6 7 8 9 + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_outdigit(code_point): + '''Checks whether the character with this code point is outdigit''' + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_blank(code_point): + '''Checks whether the character with this code point is blank''' + return (code_point == 0x0009 # '\t' + # Category Zs without mention of '<noBreak>' + or (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Zs' + and '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])) + +def is_space(code_point): + '''Checks whether the character with this code point is a space''' + # Don’t make U+00A0 a space. Non-breaking space means that all programs + # should treat it like a punctuation character, not like a space. + return (code_point == 0x0020 # ' ' + or code_point == 0x000C # '\f' + or code_point == 0x000A # '\n' + or code_point == 0x000D # '\r' + or code_point == 0x0009 # '\t' + or code_point == 0x000B # '\v' + # Categories Zl, Zp, and Zs without mention of "<noBreak>" + or (UNICODE_ATTRIBUTES[code_point]['name'] + and + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'] + or + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zs'] + and + '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])))) + +def is_cntrl(code_point): + '''Checks whether the character with this code point is + a control character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and (UNICODE_ATTRIBUTES[code_point]['name'] == '<control>' + or + UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'])) + +def is_xdigit(code_point): + '''Checks whether the character with this code point is + a hexadecimal digit''' + if False: + return (is_digit(code_point) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + else: + # SUSV2 gives us some freedom for the "xdigit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.12: + # The iswxdigit function tests for any wide character that + # corresponds to a hexadecimal-digit character (as defined + # in 6.4.4.1). + # 6.4.4.1: + # hexadecimal-digit: one of + # 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F + return ((code_point >= 0x0030 and code_point <= 0x0039) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + +def is_graph(code_point): + '''Checks whether the character with this code point is + a graphical character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and not is_space(code_point)) + +def is_print(code_point): + '''Checks whether the character with this code point is printable''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and UNICODE_ATTRIBUTES[code_point]['category'] not in ['Zl', 'Zp']) + +def is_punct(code_point): + '''Checks whether the character with this code point is punctuation''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'].startswith('P')) + else: + # The traditional POSIX definition of punctuation is every graphic, + # non-alphanumeric character. + return (is_graph(code_point) + and not is_alpha(code_point) + and not is_digit(code_point)) + +def is_combining(code_point): + '''Checks whether the character with this code point is + a combining character''' + # Up to Unicode 3.0.1 we took the Combining property from the PropList.txt + # file. In 3.0.1 it was identical to the union of the general categories + # "Mn", "Mc", "Me". In Unicode 3.1 this property has been dropped from the + # PropList.txt file, so we take the latter definition. + return (UNICODE_ATTRIBUTES[code_point]['name'] + and + UNICODE_ATTRIBUTES[code_point]['category'] in ['Mn', 'Mc', 'Me']) + +def is_combining_level3(code_point): + '''Checks whether the character with this code point is + a combining level3 character''' + return (is_combining(code_point) + and + int(UNICODE_ATTRIBUTES[code_point]['combining']) in range(0, 200)) + +def ucs_symbol(code_point): + '''Return the UCS symbol string for a Unicode character.''' + if code_point < 0x10000: + return '<U{:04X}>'.format(code_point) + else: + return '<U{:08X}>'.format(code_point) + +def ucs_symbol_range(code_point_low, code_point_high): + '''Returns a string UCS symbol string for a code point range. + + Example: + + <U0041>..<U005A> + ''' + return ucs_symbol(code_point_low) + '..' + ucs_symbol(code_point_high) + +def verifications(): + '''Tests whether the is_* functions observe the known restrictions''' + for code_point in sorted(UNICODE_ATTRIBUTES): + # toupper restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_upper(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but toupper(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_upper(code_point)}) + # tolower restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_lower(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but tolower(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_lower(code_point)}) + # alpha restriction: "Characters classified as either upper or lower + # shall automatically belong to this class. + if ((is_lower(code_point) or is_upper(code_point)) + and not is_alpha(code_point)): + sys.stderr.write('%(sym)s is upper|lower but not alpha\n' %{ + 'sym': ucs_symbol(code_point)}) + # alpha restriction: “No character specified for the keywords cntrl, + # digit, punct or space shall be specified.†+ if (is_alpha(code_point) and is_cntrl(code_point)): + sys.stderr.write('%(sym)s is alpha and cntrl\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is alpha and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is alpha and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_space(code_point)): + sys.stderr.write('%(sym)s is alpha and space\n' %{ + 'sym': ucs_symbol(code_point)}) + # space restriction: “No character specified for the keywords upper, + # lower, alpha, digit, graph or xdigit shall be specified.†+ # upper, lower, alpha already checked above. + if (is_space(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is space and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is space and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is space and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # cntrl restriction: “No character specified for the keywords upper, + # lower, alpha, digit, punct, graph, print or xdigit shall be + # specified.†upper, lower, alpha already checked above. + if (is_cntrl(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is cntrl and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is cntrl and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is cntrl and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_print(code_point)): + sys.stderr.write('%(sym)s is cntrl and print\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is cntrl and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # punct restriction: “No character specified for the keywords upper, + # lower, alpha, digit, cntrl, xdigit or as the <space> character shall + # be specified.†upper, lower, alpha, cntrl already checked above. + if (is_punct(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is punct and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is punct and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and code_point == 0x0020): + sys.stderr.write('%(sym)s is punct\n' %{ + 'sym': ucs_symbol(code_point)}) + # graph restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # print restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # graph - print relation: differ only in the <space> character. + # How is this possible if there are more than one space character?! + # I think susv2/xbd/locale.html should speak of “space charactersâ€, + # not “space characterâ€. + if (is_print(code_point) + and not (is_graph(code_point) or is_space(code_point))): + sys.stderr.write('%(sym)s is print but not graph|<space>\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) + if (not is_print(code_point) + and (is_graph(code_point) or code_point == 0x0020)): + sys.stderr.write('%(sym)s is graph|<space> but not print\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) diff --git a/contrib/unicode/from_glibc/utf8_gen.py b/contrib/unicode/from_glibc/utf8_gen.py new file mode 100755 index 00000000000..0e5583cd259 --- /dev/null +++ b/contrib/unicode/from_glibc/utf8_gen.py @@ -0,0 +1,364 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +'''glibc/localedata/charmaps/UTF-8 file generator script + +This script generates a glibc/localedata/charmaps/UTF-8 file +from Unicode data. + +Usage: python3 utf8_gen.py UnicodeData.txt EastAsianWidth.txt + +It will output UTF-8 file +''' + +import argparse +import sys +import re +import unicode_utils + +# Auxiliary tables for Hangul syllable names, see the Unicode 3.0 book, +# sections 3.11 and 4.4. + +JAMO_INITIAL_SHORT_NAME = ( + 'G', 'GG', 'N', 'D', 'DD', 'R', 'M', 'B', 'BB', 'S', 'SS', '', 'J', 'JJ', + 'C', 'K', 'T', 'P', 'H' +) + +JAMO_MEDIAL_SHORT_NAME = ( + 'A', 'AE', 'YA', 'YAE', 'EO', 'E', 'YEO', 'YE', 'O', 'WA', 'WAE', 'OE', + 'YO', 'U', 'WEO', 'WE', 'WI', 'YU', 'EU', 'YI', 'I' +) + +JAMO_FINAL_SHORT_NAME = ( + '', 'G', 'GG', 'GS', 'N', 'NI', 'NH', 'D', 'L', 'LG', 'LM', 'LB', 'LS', + 'LT', 'LP', 'LH', 'M', 'B', 'BS', 'S', 'SS', 'NG', 'J', 'C', 'K', 'T', + 'P', 'H' +) + +def process_range(start, end, outfile, name): + '''Writes a range of code points into the CHARMAP section of the + output file + + ''' + if 'Hangul Syllable' in name: + # from glibc/localedata/ChangeLog: + # + # 2000-09-24 Bruno Haible <haible@clisp.cons.org> + # * charmaps/UTF-8: Expand <Hangul Syllable> and <Private Use> ranges, + # so they become printable and carry a width. Comment out surrogate + # ranges. Add a WIDTH table + # + # So we expand the Hangul Syllables here: + for i in range(int(start, 16), int(end, 16)+1 ): + index2, index3 = divmod(i - 0xaC00, 28) + index1, index2 = divmod(index2, 21) + hangul_syllable_name = 'HANGUL SYLLABLE ' \ + + JAMO_INITIAL_SHORT_NAME[index1] \ + + JAMO_MEDIAL_SHORT_NAME[index2] \ + + JAMO_FINAL_SHORT_NAME[index3] + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), convert_to_hex(i), + hangul_syllable_name)) + return + # UnicodeData.txt file has contains code point ranges like this: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + # + # The glibc UTF-8 file splits ranges like these into shorter + # ranges of 64 code points each: + # + # <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + # … + # <U4D80>..<U4DB5> /xe4/xb6/x80 <CJK Ideograph Extension A> + for i in range(int(start, 16), int(end, 16), 64 ): + if i > (int(end, 16)-64): + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(int(end,16)), + convert_to_hex(i), + name)) + break + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(i+63), + convert_to_hex(i), + name)) + +def process_charmap(flines, outfile): + '''This function takes an array which contains *all* lines of + of UnicodeData.txt and write lines to outfile as used in the + + CHARMAP + … + END CHARMAP + + section of the UTF-8 file in glibc/localedata/charmaps/UTF-8. + + Samples for input lines: + + 0010;<control>;Cc;0;BN;;;;;N;DATA LINK ESCAPE;;;; + 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + D800;<Non Private Use High Surrogate, First>;Cs;0;L;;;;;N;;;;; + DB7F;<Non Private Use High Surrogate, Last>;Cs;0;L;;;;;N;;;;; + 100000;<Plane 16 Private Use, First>;Co;0;L;;;;;N;;;;; + 10FFFD;<Plane 16 Private Use, Last>;Co;0;L;;;;;N;;;;; + + Samples for output lines (Unicode-Value UTF-8-HEX Unicode-Char-Name): + + <U0010> /x10 DATA LINK ESCAPE + <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + %<UD800> /xed/xa0/x80 <Non Private Use High Surrogate, First> + %<UDB7F> /xed/xad/xbf <Non Private Use High Surrogate, Last> + <U0010FFC0>..<U0010FFFD> /xf4/x8f/xbf/x80 <Plane 16 Private Use> + + ''' + fields_start = [] + for line in flines: + fields = line.split(";") + # Some characters have “<control>†as their name. We try to + # use the “Unicode 1.0 Name†(10th field in + # UnicodeData.txt) for them. + # + # The Characters U+0080, U+0081, U+0084 and U+0099 have + # “<control>†as their name but do not even have aa + # â€Unicode 1.0 Nameâ€. We could write code to take their + # alternate names from NameAliases.txt. + if fields[1] == "<control>" and fields[10]: + fields[1] = fields[10] + # Handling code point ranges like: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + if fields[1].endswith(', First>') and not 'Surrogate,' in fields[1]: + fields_start = fields + continue + if fields[1].endswith(', Last>') and not 'Surrogate,' in fields[1]: + process_range(fields_start[0], fields[0], + outfile, fields[1][:-7]+'>') + fields_start = [] + continue + fields_start = [] + if 'Surrogate,' in fields[1]: + # Comment out the surrogates in the UTF-8 file. + # One could of course skip them completely but + # the original UTF-8 file in glibc had them as + # comments, so we keep these comment lines. + outfile.write('%') + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(int(fields[0], 16)), + convert_to_hex(int(fields[0], 16)), + fields[1])) + +def convert_to_hex(code_point): + '''Converts a code point to a hexadecimal UTF-8 representation + like /x**/x**/x**.''' + # Getting UTF8 of Unicode characters. + # In Python3, .encode('UTF-8') does not work for + # surrogates. Therefore, we use this conversion table + surrogates = { + 0xD800: '/xed/xa0/x80', + 0xDB7F: '/xed/xad/xbf', + 0xDB80: '/xed/xae/x80', + 0xDBFF: '/xed/xaf/xbf', + 0xDC00: '/xed/xb0/x80', + 0xDFFF: '/xed/xbf/xbf', + } + if code_point in surrogates: + return surrogates[code_point] + return ''.join([ + '/x{:02x}'.format(c) for c in chr(code_point).encode('UTF-8') + ]) + +def write_header_charmap(outfile): + '''Write the header on top of the CHARMAP section to the output file''' + outfile.write("<code_set_name> UTF-8\n") + outfile.write("<comment_char> %\n") + outfile.write("<escape_char> /\n") + outfile.write("<mb_cur_min> 1\n") + outfile.write("<mb_cur_max> 6\n\n") + outfile.write("% CHARMAP generated using utf8_gen.py\n") + outfile.write("% alias ISO-10646/UTF-8\n") + outfile.write("CHARMAP\n") + +def write_header_width(outfile, unicode_version): + '''Writes the header on top of the WIDTH section to the output file''' + outfile.write('% Character width according to Unicode ' + + '{:s}.\n'.format(unicode_version)) + outfile.write('% - Default width is 1.\n') + outfile.write('% - Double-width characters have width 2; generated from\n') + outfile.write('% "grep \'^[^;]*;[WF]\' EastAsianWidth.txt"\n') + outfile.write('% - Non-spacing characters have width 0; ' + + 'generated from PropList.txt or\n') + outfile.write('% "grep \'^[^;]*;[^;]*;[^;]*;[^;]*;NSM;\' ' + + 'UnicodeData.txt"\n') + outfile.write('% - Format control characters have width 0; ' + + 'generated from\n') + outfile.write("% \"grep '^[^;]*;[^;]*;Cf;' UnicodeData.txt\"\n") +# Not needed covered by Cf +# outfile.write("% - Zero width characters have width 0; generated from\n") +# outfile.write("% \"grep '^[^;]*;ZERO WIDTH ' UnicodeData.txt\"\n") + outfile.write("WIDTH\n") + +def process_width(outfile, ulines, elines, plines): + '''ulines are lines from UnicodeData.txt, elines are lines from + EastAsianWidth.txt containing characters with width “W†or “Fâ€, + plines are lines from PropList.txt which contain characters + with the property “Prepended_Concatenation_Markâ€. + + ''' + width_dict = {} + for line in elines: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + width_dict[key] = 2 + + for line in ulines: + fields = line.split(";") + if fields[4] == "NSM" or fields[2] in ("Cf", "Me", "Mn"): + width_dict[int(fields[0], 16)] = 0 + + for line in plines: + # Characters with the property “Prepended_Concatenation_Mark†+ # should have the width 1: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + del width_dict[key] # default width is 1 + + # handle special cases for compatibility + for key in list((0x00AD,)): + # https://www.cs.tut.fi/~jkorpela/shy.html + if key in width_dict: + del width_dict[key] # default width is 1 + for key in list(range(0x1160, 0x1200)): + width_dict[key] = 0 + for key in list(range(0x3248, 0x3250)): + # These are “A†which means we can decide whether to treat them + # as “W†or “N†based on context: + # http://www.unicode.org/mail-arch/unicode-ml/y2017-m08/0023.html + # For us, “W†seems better. + width_dict[key] = 2 + for key in list(range(0x4DC0, 0x4E00)): + width_dict[key] = 2 + + same_width_lists = [] + current_width_list = [] + for key in sorted(width_dict): + if not current_width_list: + current_width_list = [key] + elif (key == current_width_list[-1] + 1 + and width_dict[key] == width_dict[current_width_list[0]]): + current_width_list.append(key) + else: + same_width_lists.append(current_width_list) + current_width_list = [key] + if current_width_list: + same_width_lists.append(current_width_list) + + for same_width_list in same_width_lists: + if len(same_width_list) == 1: + outfile.write('{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + width_dict[same_width_list[0]])) + else: + outfile.write('{:s}...{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + unicode_utils.ucs_symbol(same_width_list[-1]), + width_dict[same_width_list[0]])) + +if __name__ == "__main__": + PARSER = argparse.ArgumentParser( + description=''' + Generate a UTF-8 file from UnicodeData.txt, EastAsianWidth.txt, and PropList.txt. + ''') + PARSER.add_argument( + '-u', '--unicode_data_file', + nargs='?', + type=str, + default='UnicodeData.txt', + help=('The UnicodeData.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-e', '--east_asian_with_file', + nargs='?', + type=str, + default='EastAsianWidth.txt', + help=('The EastAsianWidth.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-p', '--prop_list_file', + nargs='?', + type=str, + default='PropList.txt', + help=('The PropList.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '--unicode_version', + nargs='?', + required=True, + type=str, + help='The Unicode version of the input files used.') + ARGS = PARSER.parse_args() + + with open(ARGS.unicode_data_file, mode='r') as UNIDATA_FILE: + UNICODE_DATA_LINES = UNIDATA_FILE.readlines() + with open(ARGS.east_asian_with_file, mode='r') as EAST_ASIAN_WIDTH_FILE: + EAST_ASIAN_WIDTH_LINES = [] + for LINE in EAST_ASIAN_WIDTH_FILE: + # If characters from EastAasianWidth.txt which are from + # from reserved ranges (i.e. not yet assigned code points) + # are added to the WIDTH section of the UTF-8 file, then + # “make check†produces “Unknown Character†errors for + # these code points because such unassigned code points + # are not in the CHARMAP section of the UTF-8 file. + # + # Therefore, we skip all reserved code points when reading + # the EastAsianWidth.txt file. + if re.match(r'.*<reserved-.+>\.\.<reserved-.+>.*', LINE): + continue + if re.match(r'^[^;]*;[WF]', LINE): + EAST_ASIAN_WIDTH_LINES.append(LINE.strip()) + with open(ARGS.prop_list_file, mode='r') as PROP_LIST_FILE: + PROP_LIST_LINES = [] + for LINE in PROP_LIST_FILE: + if re.match(r'^[^;]*;[\s]*Prepended_Concatenation_Mark', LINE): + PROP_LIST_LINES.append(LINE.strip()) + with open('UTF-8', mode='w') as OUTFILE: + # Processing UnicodeData.txt and write CHARMAP to UTF-8 file + write_header_charmap(OUTFILE) + process_charmap(UNICODE_DATA_LINES, OUTFILE) + OUTFILE.write("END CHARMAP\n\n") + # Processing EastAsianWidth.txt and write WIDTH to UTF-8 file + write_header_width(OUTFILE, ARGS.unicode_version) + process_width(OUTFILE, + UNICODE_DATA_LINES, + EAST_ASIAN_WIDTH_LINES, + PROP_LIST_LINES) + OUTFILE.write("END WIDTH\n") diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py new file mode 100755 index 00000000000..02b28bcedcf --- /dev/null +++ b/contrib/unicode/gen_wcwidth.py @@ -0,0 +1,106 @@ +#!/usr/bin/env python3 +# +# Script to generate tables for cpp_wcwidth, leveraging glibc's utf8_gen.py. +# +# This file is part of GCC. +# +# GCC is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation; either version 3, or (at your option) any later +# version. +# +# GCC 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 Public License +# for more details. +# +# You should have received a copy of the GNU General Public License +# along with GCC; see the file COPYING3. If not see +# <http://www.gnu.org/licenses/>. */ + +import sys +import os + +if len(sys.argv) != 2: + print("usage: %s <unicode version>", file=sys.stderr) + sys.exit(1) +unicode_version = sys.argv[1] + +# Parse a codepoint in the format output by glibc tools. +def parse_ucn(s): + if not (s.startswith("<U") and s.endswith(">")): + raise ValueError + return int(s[2:-1], base=16) + +# Process a line of width output from utf_gen.py and update global array. +widths = [1] * (1 + 0x10FFFF) +def process_width(line): + # Example lines: + # <UA8FF> 0 + # <UA926>...<UA92D> 0 + + s = line.split() + width = int(s[1]) + r = s[0].split("...") + if len(r) == 1: + begin = parse_ucn(r[0]) + end = begin + 1 + elif len(r) == 2: + begin = parse_ucn(r[0]) + end = parse_ucn(r[1]) + 1 + else: + raise ValueError + widths[begin:end] = [width] * (end - begin) + +# To keep things simple, we use glibc utf8_gen.py as-is. It only outputs to a +# file named UTF-8, which is not configurable. Then we parse this into the form +# we want it. +os.system("from_glibc/utf8_gen.py --unicode_version %s" % unicode_version) +processing = False +for line in open("UTF-8", "r"): + if processing: + if line == "END WIDTH\n": + processing = False + else: + try: + process_width(line) + except (ValueError, IndexError): + print(e, "warning: ignored unexpected line: %s" % line, + file=sys.stderr, end="") + elif line == "WIDTH\n": + processing = True + +# All bytes < 256 we treat as width 1. +widths[0:255] = [1] * 255 + +# Condense the list to contiguous ranges. +cur_range = [-1, 1] +all_ranges = [] +for i, width in enumerate(widths): + if width == cur_range[1]: + cur_range[0] = i + else: + all_ranges.append(cur_range) + cur_range = [i, width] + +# Output the arrays for generated_cpp_wcwidth.h +print("/* Generated by contrib/unicode/gen_wcwidth.py,", + "with the help of glibc's") +print(" utf8_gen.py, using version %s" % unicode_version, + "of the Unicode standard. */") +print("\nstatic const cppchar_t wcwidth_range_ends[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 8: + print(" ", end="") + else: + print("\n ", end="") + print("0x%x," % (r[0]), end="") +print("\n};\n") +print("static const unsigned char wcwidth_widths[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 24: + print(" ", end="") + else: + print("\n ", end="") + print("%d," % r[1], end="") +print("\n};") diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c index 4d563dda8f4..7a5bd36d962 100644 --- a/gcc/diagnostic-show-locus.c +++ b/gcc/diagnostic-show-locus.c @@ -30,6 +30,7 @@ along with GCC; see the file COPYING3. If not see #include "gcc-rich-location.h" #include "selftest.h" #include "selftest-diagnostic.h" +#include "cpplib.h" #ifdef HAVE_TERMIOS_H # include <termios.h> @@ -112,7 +113,29 @@ class colorizer const char *m_stop_color; }; -/* A point within a layout_range; similar to an expanded_location, +/* In order to handle multibyte sources properly, all of this logic needs to be + aware of the distinction between the number of bytes and the number of + display columns occupied by a character. One or the other is more useful + depending on the context. For instance, in order to output the caret at the + correct location, we need to count display columns; in order to colorize a + source line, we need to count the bytes. All locations are provided to us + as byte counts. We augment these with the display column so that it can be + used when need. This is not the most efficient way to do things since it + requires looping over the whole line each time, but it should be fine for + the purpose of outputting diagnostics. */ + +class exploc_with_display_col : public expanded_location +{ + public: + exploc_with_display_col (const expanded_location &exploc) + : expanded_location (exploc), + m_display_col (location_compute_display_column (exploc)) {} + + int m_display_col; +}; + + +/* A point within a layout_range; similar to an exploc_with_display_col, but after filtering on file. */ class layout_point @@ -120,10 +143,17 @@ class layout_point public: layout_point (const expanded_location &exploc) : m_line (exploc.line), - m_column (exploc.column) {} + m_column (exploc.column), + m_display_col (location_compute_display_column (exploc)) {} + + int get_col (bool use_display) const + { + return use_display ? m_display_col : m_column; + } linenum_type m_line; int m_column; + int m_display_col; }; /* A class for use by "class layout" below: a filtered location_range. */ @@ -138,7 +168,7 @@ class layout_range unsigned original_idx, const range_label *label); - bool contains_point (linenum_type row, int column) const; + bool contains_point (linenum_type row, int column, bool use_display) const; bool intersects_line_p (linenum_type row) const; layout_point m_start; @@ -157,6 +187,17 @@ struct line_bounds { int m_first_non_ws; int m_last_non_ws; + + void convert_to_display_cols (char_span line) + { + m_first_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_first_non_ws); + + m_last_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_last_non_ws); + } }; /* A range of contiguous source lines within a layout (e.g. "lines 5-10" @@ -284,6 +325,7 @@ class layout get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + bool use_display, /* Outputs. */ point_state *out_state); @@ -298,7 +340,7 @@ class layout diagnostic_context *m_context; pretty_printer *m_pp; location_t m_primary_loc; - expanded_location m_exploc; + exploc_with_display_col m_exploc; colorizer m_colorizer; bool m_colorize_source_p; bool m_show_labels_p; @@ -472,10 +514,15 @@ layout_range::layout_range (const expanded_location *start_exploc, - 'w' indicates a point within the range - 'F' indicates the finish of the range (which is within it). - - 'a' indicates a subsequent point *after* the range. */ + - 'a' indicates a subsequent point *after* the range. + + USE_DISPLAY controls whether we check the byte column or + the display column; one or the other is more convenient + depending on the context. */ bool -layout_range::contains_point (linenum_type row, int column) const +layout_range::contains_point (linenum_type row, int column, + bool use_display) const { gcc_assert (m_start.m_line <= m_finish.m_line); /* ...but the equivalent isn't true for the columns; @@ -491,7 +538,7 @@ layout_range::contains_point (linenum_type row, int column) const /* On same line as start of range (corresponding to line 02 in example A and line 03 in example B). */ { - if (column < m_start.m_column) + if (column < m_start.get_col (use_display)) /* Points on the starting line of the range, but before the column in which it begins. */ return false; @@ -505,7 +552,7 @@ layout_range::contains_point (linenum_type row, int column) const { /* This is a single-line range. */ gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.get_col (use_display); } } @@ -530,7 +577,7 @@ layout_range::contains_point (linenum_type row, int column) const gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.get_col (use_display); } /* Does this layout_range contain any part of line ROW? */ @@ -574,20 +621,23 @@ test_layout_range_for_single_point () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (point.contains_point (6, 1)); + for (int use_display = 0; use_display <= 1; ++use_display) + { + /* Before the line. */ + ASSERT_FALSE (point.contains_point (6, 1, use_display)); - /* On the line, but before start. */ - ASSERT_FALSE (point.contains_point (7, 9)); + /* On the line, but before start. */ + ASSERT_FALSE (point.contains_point (7, 9, use_display)); - /* At the point. */ - ASSERT_TRUE (point.contains_point (7, 10)); + /* At the point. */ + ASSERT_TRUE (point.contains_point (7, 10, use_display)); - /* On the line, after the point. */ - ASSERT_FALSE (point.contains_point (7, 11)); + /* On the line, after the point. */ + ASSERT_FALSE (point.contains_point (7, 11, use_display)); - /* After the line. */ - ASSERT_FALSE (point.contains_point (8, 1)); + /* After the line. */ + ASSERT_FALSE (point.contains_point (8, 1, use_display)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (point.intersects_line_p (6)); @@ -605,26 +655,29 @@ test_layout_range_for_single_line () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (example_a.contains_point (1, 1)); + for (int use_display = 0; use_display <= 1; ++use_display) + { + /* Before the line. */ + ASSERT_FALSE (example_a.contains_point (1, 1, use_display)); - /* On the line, but before start. */ - ASSERT_FALSE (example_a.contains_point (2, 21)); + /* On the line, but before start. */ + ASSERT_FALSE (example_a.contains_point (2, 21, use_display)); - /* On the line, at the start. */ - ASSERT_TRUE (example_a.contains_point (2, 22)); + /* On the line, at the start. */ + ASSERT_TRUE (example_a.contains_point (2, 22, use_display)); - /* On the line, within the range. */ - ASSERT_TRUE (example_a.contains_point (2, 23)); + /* On the line, within the range. */ + ASSERT_TRUE (example_a.contains_point (2, 23, use_display)); - /* On the line, at the end. */ - ASSERT_TRUE (example_a.contains_point (2, 38)); + /* On the line, at the end. */ + ASSERT_TRUE (example_a.contains_point (2, 38, use_display)); - /* On the line, after the end. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* On the line, after the end. */ + ASSERT_FALSE (example_a.contains_point (2, 39, use_display)); - /* After the line. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* After the line. */ + ASSERT_FALSE (example_a.contains_point (2, 39, use_display)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_a.intersects_line_p (1)); @@ -642,40 +695,43 @@ test_layout_range_for_multiple_lines () /* Tests for layout_range::contains_point. */ - /* Before first line. */ - ASSERT_FALSE (example_b.contains_point (1, 1)); + for (int use_display = 0; use_display <= 1; ++use_display) + { + /* Before first line. */ + ASSERT_FALSE (example_b.contains_point (1, 1, use_display)); - /* On the first line, but before start. */ - ASSERT_FALSE (example_b.contains_point (3, 13)); + /* On the first line, but before start. */ + ASSERT_FALSE (example_b.contains_point (3, 13, use_display)); - /* At the start. */ - ASSERT_TRUE (example_b.contains_point (3, 14)); + /* At the start. */ + ASSERT_TRUE (example_b.contains_point (3, 14, use_display)); - /* On the first line, within the range. */ - ASSERT_TRUE (example_b.contains_point (3, 15)); + /* On the first line, within the range. */ + ASSERT_TRUE (example_b.contains_point (3, 15, use_display)); - /* On an interior line. - The column number should not matter; try various boundary - values. */ - ASSERT_TRUE (example_b.contains_point (4, 1)); - ASSERT_TRUE (example_b.contains_point (4, 7)); - ASSERT_TRUE (example_b.contains_point (4, 8)); - ASSERT_TRUE (example_b.contains_point (4, 9)); - ASSERT_TRUE (example_b.contains_point (4, 13)); - ASSERT_TRUE (example_b.contains_point (4, 14)); - ASSERT_TRUE (example_b.contains_point (4, 15)); + /* On an interior line. + The column number should not matter; try various boundary + values. */ + ASSERT_TRUE (example_b.contains_point (4, 1, use_display)); + ASSERT_TRUE (example_b.contains_point (4, 7, use_display)); + ASSERT_TRUE (example_b.contains_point (4, 8, use_display)); + ASSERT_TRUE (example_b.contains_point (4, 9, use_display)); + ASSERT_TRUE (example_b.contains_point (4, 13, use_display)); + ASSERT_TRUE (example_b.contains_point (4, 14, use_display)); + ASSERT_TRUE (example_b.contains_point (4, 15, use_display)); - /* On the final line, before the end. */ - ASSERT_TRUE (example_b.contains_point (5, 7)); + /* On the final line, before the end. */ + ASSERT_TRUE (example_b.contains_point (5, 7, use_display)); - /* On the final line, at the end. */ - ASSERT_TRUE (example_b.contains_point (5, 8)); + /* On the final line, at the end. */ + ASSERT_TRUE (example_b.contains_point (5, 8, use_display)); - /* On the final line, after the end. */ - ASSERT_FALSE (example_b.contains_point (5, 9)); + /* On the final line, after the end. */ + ASSERT_FALSE (example_b.contains_point (5, 9, use_display)); - /* After the line. */ - ASSERT_FALSE (example_b.contains_point (6, 1)); + /* After the line. */ + ASSERT_FALSE (example_b.contains_point (6, 1, use_display)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_b.intersects_line_p (2)); @@ -687,8 +743,8 @@ test_layout_range_for_multiple_lines () #endif /* #if CHECKING_P */ -/* Given a source line LINE of length LINE_WIDTH, determine the width - without any trailing whitespace. */ +/* Given a source line LINE of length LINE_WIDTH bytes, determine the width + (in bytes, not display cols) without any trailing whitespace. */ static int get_line_width_without_trailing_whitespace (const char *line, int line_width) @@ -897,17 +953,35 @@ layout::layout (diagnostic_context * context, will be adjusted accordingly. */ size_t max_width = m_context->caret_max_width; char_span line = location_get_source_line (m_exploc.file, m_exploc.line); - if (line && (size_t)m_exploc.column <= line.length ()) + if (line && max_width) { - size_t right_margin = CARET_LINE_MARGIN; - size_t column = m_exploc.column; - if (m_show_line_numbers_p) - column += m_linenum_width + 2; - right_margin = MIN (line.length () - column, right_margin); - right_margin = max_width - right_margin; - if (line.length () >= max_width && column > right_margin) - m_x_offset = column - right_margin; - gcc_assert (m_x_offset >= 0); + size_t column = m_exploc.m_display_col; + int line_width + = get_line_width_without_trailing_whitespace (line.get_buffer (), + line.length ()); + size_t eol = cpp_display_width (line.get_buffer (), line_width); + const size_t eol_before_linenum = eol; + + if (column <= eol) + { + if (m_show_line_numbers_p) + { + column += m_linenum_width + 2; + eol += m_linenum_width + 2; + } + size_t right_margin = CARET_LINE_MARGIN; + right_margin = MIN (eol - column, right_margin); + right_margin = max_width - right_margin; + /* Note: if right_margin > max_width, we end up failing this next + check due to wrapping, and we don't offset anything. Otherwise we + would conclude we can't output the line at all. */ + if (eol >= max_width && column > right_margin) + { + m_x_offset = column - right_margin; + m_x_offset = MIN (m_x_offset, (int) eol_before_linenum - 1); + } + gcc_assert (m_x_offset >= 0); + } } if (context->show_ruler_p) @@ -1252,7 +1326,9 @@ layout::calculate_line_spans () /* Print line ROW of source code, potentially colorized at any ranges, and populate *LBOUNDS_OUT. LINE is the source line (not necessarily 0-terminated) and LINE_WIDTH - is its width. */ + is its width. This function deals only with byte offsets, not display + columns; m_x_offset must be converted from display to byte units. In + particular, LINE_WIDTH and LBOUNDS_OUT are in bytes. */ void layout::print_source_line (linenum_type row, const char *line, int line_width, @@ -1264,7 +1340,10 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, whitespace. */ line_width = get_line_width_without_trailing_whitespace (line, line_width); - line += m_x_offset; + + const int x_offset_bytes + = cpp_display_column_to_byte_column (line, line_width, m_x_offset); + line += x_offset_bytes; if (m_show_line_numbers_p) { @@ -1278,7 +1357,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, int first_non_ws = INT_MAX; int last_non_ws = 0; int column; - for (column = 1 + m_x_offset; column <= line_width; column++) + for (column = 1 + x_offset_bytes; column <= line_width; column++) { /* Assuming colorization is enabled for the caret and underline characters, we may also colorize the associated characters @@ -1298,6 +1377,8 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, point_state state; in_range_p = get_state_at_point (row, column, 0, INT_MAX, + false, /* Using bytes, not display + columns, here. */ &state); if (in_range_p) m_colorizer.set_range (state.range_idx); @@ -1360,12 +1441,13 @@ layout::start_annotation_line (char margin_char) const } /* Print a line consisting of the caret/underlines for the given - source line. */ + source line. This function works with display columns, rather than byte + counts; in particular, LBOUNDS should be in display column units. */ void layout::print_annotation_line (linenum_type row, const line_bounds lbounds) { - int x_bound = get_x_bound_for_row (row, m_exploc.column, + int x_bound = get_x_bound_for_row (row, m_exploc.m_display_col, lbounds.m_last_non_ws); start_annotation_line (); @@ -1378,6 +1460,7 @@ layout::print_annotation_line (linenum_type row, const line_bounds lbounds) in_range_p = get_state_at_point (row, column, lbounds.m_first_non_ws, lbounds.m_last_non_ws, + true, /* Using display units. */ &state); if (in_range_p) { @@ -1415,9 +1498,11 @@ class line_label public: line_label (int state_idx, int column, label_text text) : m_state_idx (state_idx), m_column (column), - m_text (text), m_length (strlen (text.m_buffer)), - m_label_line (0) - {} + m_text (text), m_label_line (0) + { + const int bytes = strlen (text.m_buffer); + m_length = cpp_display_width (text.m_buffer, bytes); + } /* Sorting is primarily by column, then by state index. */ static int comparator (const void *p1, const void *p2) @@ -1459,7 +1544,7 @@ layout::print_any_labels (linenum_type row) /* Reject labels that aren't fully visible due to clipping by m_x_offset. */ - if (range->m_caret.m_column <= m_x_offset) + if (range->m_caret.m_display_col <= m_x_offset) continue; label_text text; @@ -1471,7 +1556,7 @@ layout::print_any_labels (linenum_type row) if (text.m_buffer == NULL) continue; - labels.safe_push (line_label (i, range->m_caret.m_column, text)); + labels.safe_push (line_label (i, range->m_caret.m_display_col, text)); } } @@ -1624,7 +1709,7 @@ layout::print_leading_fixits (linenum_type row) /* Subroutine of layout::print_trailing_fixits. Determine if the annotation line printed for LINE contained - the exact range from START_COLUMN to FINISH_COLUMN. */ + the exact range from START_COLUMN to FINISH_COLUMN (in display units). */ bool layout::annotation_line_showed_range_p (linenum_type line, int start_column, @@ -1634,9 +1719,9 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, int i; FOR_EACH_VEC_ELT (m_layout_ranges, i, range) if (range->m_start.m_line == line - && range->m_start.m_column == start_column + && range->m_start.m_display_col == start_column && range->m_finish.m_line == line - && range->m_finish.m_column == finish_column) + && range->m_finish.m_display_col == finish_column) return true; return false; } @@ -1723,7 +1808,7 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, and is thus printed as desired. */ -/* A range of columns within a line. */ +/* A range of (byte or display) columns within a line. */ class column_range { @@ -1743,32 +1828,51 @@ public: int finish; }; -/* Get the range of columns that HINT would affect. */ - +/* Get the range of bytes or display columns that HINT would affect. */ static column_range -get_affected_columns (const fixit_hint *hint) +get_affected_range (const fixit_hint *hint, bool use_display) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; + expanded_location exploc_start = expand_location (hint->get_start_loc ()); + expanded_location exploc_finish = expand_location (hint->get_next_loc ()); + --exploc_finish.column; + int start_column; + int finish_column; + if (use_display) + { + start_column = location_compute_display_column (exploc_start); + if (hint->insertion_p ()) + finish_column = start_column - 1; + else + finish_column = location_compute_display_column (exploc_finish); + } + else + { + start_column = exploc_start.column; + finish_column = exploc_finish.column; + } return column_range (start_column, finish_column); } -/* Get the range of columns that would be printed for HINT. */ +/* Get the range of display columns that would be printed for HINT. */ static column_range get_printed_columns (const fixit_hint *hint) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int final_hint_column = start_column + hint->get_length () - 1; + expanded_location exploc = expand_location (hint->get_start_loc ()); + int start_column = location_compute_display_column (exploc); + int hint_width = cpp_display_width (hint->get_string (), + hint->get_length ()); + int final_hint_column = start_column + hint_width - 1; if (hint->insertion_p ()) { return column_range (start_column, final_hint_column); } else { - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; - + exploc = expand_location (hint->get_next_loc ()); + --exploc.column; + int finish_column = location_compute_display_column (exploc); return column_range (start_column, MAX (finish_column, final_hint_column)); } @@ -1782,27 +1886,35 @@ get_printed_columns (const fixit_hint *hint) class correction { public: - correction (column_range affected_columns, + correction (column_range affected_bytes, + column_range affected_columns, column_range printed_columns, const char *new_text, size_t new_text_len) - : m_affected_columns (affected_columns), + : m_affected_bytes (affected_bytes), + m_affected_columns (affected_columns), m_printed_columns (printed_columns), m_text (xstrdup (new_text)), - m_len (new_text_len), + m_bytes (new_text_len), m_alloc_sz (new_text_len + 1) { + compute_display_cols (); } ~correction () { free (m_text); } bool insertion_p () const { - return m_affected_columns.start == m_affected_columns.finish + 1; + return m_affected_bytes.start == m_affected_bytes.finish + 1; } void ensure_capacity (size_t len); void ensure_terminated (); + void compute_display_cols () + { + m_display_cols = cpp_display_width (m_text, m_bytes); + } + void overwrite (int dst_offset, const char_span &src_span) { gcc_assert (dst_offset >= 0); @@ -1815,6 +1927,7 @@ public: is to be inserted, and finish is offset by the length of the replacement. If replace, then the range of columns affected. */ + column_range m_affected_bytes; column_range m_affected_columns; /* If insert, then start: the column before which the text @@ -1825,7 +1938,8 @@ public: /* The text to be inserted/used as replacement. */ char *m_text; - size_t m_len; + size_t m_bytes; + int m_display_cols; size_t m_alloc_sz; }; @@ -1850,8 +1964,8 @@ void correction::ensure_terminated () { /* 0-terminate the buffer. */ - gcc_assert (m_len < m_alloc_sz); - m_text[m_len] = '\0'; + gcc_assert (m_bytes < m_alloc_sz); + m_text[m_bytes] = '\0'; } /* A list of corrections affecting a particular line. @@ -1913,7 +2027,8 @@ source_line::source_line (const char *filename, int line) void line_corrections::add_hint (const fixit_hint *hint) { - column_range affected_columns = get_affected_columns (hint); + column_range affected_bytes = get_affected_range (hint, false); + column_range affected_columns = get_affected_range (hint, true); column_range printed_columns = get_printed_columns (hint); /* Potentially consolidate. */ @@ -1924,8 +2039,8 @@ line_corrections::add_hint (const fixit_hint *hint) /* The following consolidation code assumes that the fix-it hints have been sorted by start (done within layout's ctor). */ - gcc_assert (affected_columns.start - >= last_correction->m_affected_columns.start); + gcc_assert (affected_bytes.start + >= last_correction->m_affected_bytes.start); gcc_assert (printed_columns.start >= last_correction->m_printed_columns.start); @@ -1937,8 +2052,8 @@ line_corrections::add_hint (const fixit_hint *hint) Attempt to inject a "replace" correction from immediately after the end of the last hint to immediately before the start of the next hint. */ - column_range between (last_correction->m_affected_columns.finish + 1, - printed_columns.start - 1); + column_range between (last_correction->m_affected_bytes.finish + 1, + affected_bytes.start - 1); /* Try to read the source. */ source_line line (m_filename, m_row); @@ -1947,7 +2062,7 @@ line_corrections::add_hint (const fixit_hint *hint) /* Consolidate into the last correction: add a no-op "replace" of the "between" text, and add the text from the new hint. */ - int old_len = last_correction->m_len; + int old_len = last_correction->m_bytes; gcc_assert (old_len >= 0); int between_len = between.finish + 1 - between.start; gcc_assert (between_len >= 0); @@ -1961,19 +2076,24 @@ line_corrections::add_hint (const fixit_hint *hint) last_correction->overwrite (old_len + between_len, char_span (hint->get_string (), hint->get_length ())); - last_correction->m_len = new_len; + last_correction->m_bytes = new_len; last_correction->ensure_terminated (); + last_correction->m_affected_bytes.finish + = affected_bytes.finish; last_correction->m_affected_columns.finish = affected_columns.finish; + int prev_display_cols = last_correction->m_display_cols; + last_correction->compute_display_cols (); last_correction->m_printed_columns.finish - += between_len + hint->get_length (); + += last_correction->m_display_cols - prev_display_cols; return; } } } /* If no consolidation happened, add a new correction instance. */ - m_corrections.safe_push (new correction (affected_columns, + m_corrections.safe_push (new correction (affected_bytes, + affected_columns, printed_columns, hint->get_string (), hint->get_length ())); @@ -2022,7 +2142,7 @@ layout::print_trailing_fixits (linenum_type row) m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } else { @@ -2034,7 +2154,7 @@ layout::print_trailing_fixits (linenum_type row) int finish_column = c->m_affected_columns.finish; if (!annotation_line_showed_range_p (row, start_column, finish_column) - || c->m_len == 0) + || c->m_bytes == 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_delete (); @@ -2045,13 +2165,13 @@ layout::print_trailing_fixits (linenum_type row) /* Print the replacement text. REPLACE also covers removals, so only do this extra work (potentially starting a new line) if we have actual replacement text. */ - if (c->m_len > 0) + if (c->m_bytes > 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } } } @@ -2072,12 +2192,14 @@ layout::print_newline () /* Return true if (ROW/COLUMN) is within a range of the layout. If it returns true, OUT_STATE is written to, with the range index, and whether we should draw the caret at - (ROW/COLUMN) (as opposed to an underline). */ + (ROW/COLUMN) (as opposed to an underline). USE_DISPLAY controls + whether all inputs and outputs are in bytes or display column units. */ bool layout::get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + bool use_display, /* Outputs. */ point_state *out_state) { @@ -2090,7 +2212,7 @@ layout::get_state_at_point (/* Inputs. */ source colorization. */ continue; - if (range->contains_point (row, column)) + if (range->contains_point (row, column, use_display)) { out_state->range_idx = i; @@ -2098,7 +2220,7 @@ layout::get_state_at_point (/* Inputs. */ out_state->draw_caret_p = false; if (range->m_range_display_kind == SHOW_RANGE_WITH_CARET && row == range->m_caret.m_line - && column == range->m_caret.m_column) + && column == range->m_caret.get_col (use_display)) out_state->draw_caret_p = true; /* Within a multiline range, don't display any underline @@ -2118,11 +2240,11 @@ layout::get_state_at_point (/* Inputs. */ /* Helper function for use by layout::print_line when printing the annotation line under the source line. - Get the column beyond the rightmost one that could contain a caret or - range marker, given that we stop rendering at trailing whitespace. + Get the display column beyond the rightmost one that could contain a caret + or range marker, given that we stop rendering at trailing whitespace. ROW is the source line within the given file. - CARET_COLUMN is the column of range 0's caret. - LAST_NON_WS_COLUMN is the last column containing a non-whitespace + CARET_COLUMN is the display column of range 0's caret. + LAST_NON_WS_COLUMN is the last display column containing a non-whitespace character of source (as determined when printing the source line). */ int @@ -2141,8 +2263,8 @@ layout::get_x_bound_for_row (linenum_type row, int caret_column, { /* On the final line within a range; ensure that we render up to the end of the range. */ - if (result <= range->m_finish.m_column) - result = range->m_finish.m_column + 1; + if (result <= range->m_finish.m_display_col) + result = range->m_finish.m_display_col + 1; } else if (row < range->m_finish.m_line) { @@ -2233,7 +2355,11 @@ layout::print_line (linenum_type row) print_leading_fixits (row); print_source_line (row, line.get_buffer (), line.length (), &lbounds); if (should_print_annotation_line_p (row)) - print_annotation_line (row, lbounds); + { + if (lbounds.m_first_non_ws != INT_MAX) + lbounds.convert_to_display_cols (line); + print_annotation_line (row, lbounds); + } if (m_show_labels_p) print_any_labels (row); print_trailing_fixits (row); @@ -2846,6 +2972,560 @@ test_diagnostic_show_locus_one_liner (const line_table_case &case_) test_one_liner_labels (); } +/* Version of all one-liner tests exercising multibyte awareness. For + simplicity we stick to using two multibyte characters in the test, U+1F602 + == "\xf0\x9f\x98\x82", which uses 4 bytes and 2 display columns, and U+03C0 + == "\xcf\x80", which uses 2 bytes and 1 display column. Note: all of the + below asserts would be easier to read if we used UTF-8 directly in the + string constants, but it seems better not to demand the host compiler + support this, when it isn't otherwise necessary. Instead, whenever an + extended character appears in a string, we put a line break after it so that + all succeeding characters can appear visually at the correct display column. + + All of these work on the following 1-line source file: + + .0000000001111111111222222 display + .1234567890123456789012345 columns + "SS_foo = P_bar.SS_fieldP;\n" + .0000000111111111222222223 byte + .1356789012456789134567891 columns + + which is set up by test_diagnostic_show_locus_one_liner and calls + them. Here SS represents the two display columns for the U+1F602 emoji and + P represents the one display column for the U+03C0 pi symbol. */ + +/* Just a caret. */ + +static void +test_one_liner_simple_caret_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + rich_location richloc (line_table, caret); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n", + pp_formatted_text (dc.printer)); +} + +/* Caret and range. */ +static void +test_one_liner_caret_and_range_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + location_t start = linemap_position_for_column (line_table, 12); + location_t finish = linemap_position_for_column (line_table, 30); + location_t loc = make_location (caret, start, finish); + rich_location richloc (line_table, loc); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~~^~~~~~~~~~\n", + pp_formatted_text (dc.printer)); +} + +/* Multiple ranges and carets. */ + +static void +test_one_liner_multiple_carets_and_ranges_utf8 () +{ + test_diagnostic_context dc; + location_t foo + = make_location (linemap_position_for_column (line_table, 7), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + dc.caret_chars[0] = 'A'; + + location_t bar + = make_location (linemap_position_for_column (line_table, 16), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + dc.caret_chars[1] = 'B'; + + location_t field + = make_location (linemap_position_for_column (line_table, 26), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + dc.caret_chars[2] = 'C'; + rich_location richloc (line_table, foo); + richloc.add_range (bar, SHOW_RANGE_WITH_CARET); + richloc.add_range (field, SHOW_RANGE_WITH_CARET); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~A~ ~~~B~ ~~~~~C~~~\n", + pp_formatted_text (dc.printer)); +} + +/* Insertion fix-it hint: adding an "&" to the front of "P_bar.field". */ + +static void +test_one_liner_fixit_insert_before_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 12); + rich_location richloc (line_table, caret); + richloc.add_fixit_insert_before ("&"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " &\n", + pp_formatted_text (dc.printer)); +} + +/* Insertion fix-it hint: adding a "[0]" after "SS_foo". */ + +static void +test_one_liner_fixit_insert_after_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 1); + location_t finish = linemap_position_for_column (line_table, 8); + location_t foo = make_location (start, start, finish); + rich_location richloc (line_table, foo); + richloc.add_fixit_insert_after ("[0]"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~\n" + " [0]\n", + pp_formatted_text (dc.printer)); +} + +/* Removal fix-it hint: removal of the ".SS_fieldP". */ + +static void +test_one_liner_fixit_remove_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 18); + location_t finish = linemap_position_for_column (line_table, 30); + location_t dot = make_location (start, start, finish); + rich_location richloc (line_table, dot); + richloc.add_fixit_remove (); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~\n" + " ----------\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP". */ + +static void +test_one_liner_fixit_replace_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + location_t field = make_location (start, start, finish); + rich_location richloc (line_table, field); + richloc.add_fixit_replace ("m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + but where the caret was elsewhere. */ + +static void +test_one_liner_fixit_replace_non_equal_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + source_range range; + range.m_start = start; + range.m_finish = finish; + richloc.add_fixit_replace (range, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is not indicated in the annotation line, so + it should be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " ---------\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + where the caret was elsewhere, but where a secondary range + exactly covers "field". */ + +static void +test_one_liner_fixit_replace_equal_secondary_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + location_t field = make_location (start, start, finish); + richloc.add_range (field); + richloc.add_fixit_replace (field, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is indicated in the annotation line, + so it shouldn't be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^ ~~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Verify that we can use ad-hoc locations when adding fixits to a + rich_location. */ + +static void +test_one_liner_fixit_validation_adhoc_locations_utf8 () +{ + /* Generate a range that's too long to be packed, so must + be stored as an ad-hoc location (given the defaults + of 5 bits or 0 bits of packed range); 41 columns > 2**5. */ + const location_t c12 = linemap_position_for_column (line_table, 12); + const location_t c52 = linemap_position_for_column (line_table, 52); + const location_t loc = make_location (c12, c12, c52); + + if (c52 > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_TRUE (IS_ADHOC_LOC (loc)); + + /* Insert. */ + { + rich_location richloc (line_table, loc); + richloc.add_fixit_insert_before (loc, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } + + /* Remove. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_remove (range); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " -------------------------------------\n", + pp_formatted_text (dc.printer)); + } + + /* Replace. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_replace (range, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } +} + +/* Test of consolidating insertions at the same location. */ + +static void +test_one_liner_many_fixits_1_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + for (int i = 0; i < 19; i++) + richloc.add_fixit_insert_before (i & 1 ? "@" : "\xcf\x80"); + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@" + "\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Ensure that we can add an arbitrary number of fix-it hints to a + rich_location, even if they are not consolidated. */ + +static void +test_one_liner_many_fixits_2_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + const int nlocs = 19; + int locs[nlocs] = {1, 5, 7, 9, 11, 14, 16, 18, 23, 25, 27, 29, 32, + 34, 36, 38, 40, 42, 44}; + for (int i = 0; i != nlocs; ++i) + { + location_t loc = linemap_position_for_column (line_table, locs[i]); + richloc.add_fixit_insert_before (loc, i & 1 ? "@" : "\xcf\x80"); + } + + ASSERT_EQ (nlocs, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Test of labeling the ranges within a rich_location. */ + +static void +test_one_liner_labels_utf8 () +{ + location_t foo + = make_location (linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + location_t bar + = make_location (linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + location_t field + = make_location (linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + + /* Example where all the labels fit on one line. */ + { + text_range_label label0 + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); + text_range_label label1 + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label2 + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + "\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + { + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " \xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80" + " \xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + " \xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82" + "\xf0\x9f\x98\x82\xcf\x80\xcf\x80\n", + pp_formatted_text (dc.printer)); + } + + /* Verify that we can disable label-printing. */ + { + test_diagnostic_context dc; + dc.show_labels_p = false; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n", + pp_formatted_text (dc.printer)); + } + } + + /* Example where the labels need extra lines. */ + { + text_range_label label0 ("label 0\xf0\x9f\x98\x82"); + text_range_label label1 ("label 1\xcf\x80"); + text_range_label label2 ("label 2\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | label 2\xcf\x80\n" + " | label 1\xcf\x80\n" + " label 0\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } + + /* Example of boundary conditions: label 0 and 1 have just enough clearance, + but label 1 just touches label 2. */ + { + text_range_label label0 ("aaaaa\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label1 ("bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82"); + text_range_label label2 ("c"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | c\n" + " aaaaa\xf0\x9f\x98\x82\xcf\x80" + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } +} + +/* Run the various one-liner tests. */ + +static void +test_diagnostic_show_locus_one_liner_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + const char *content + /* Display columns. + 0000000000000000000000011111111111111111111111111111112222222222222 + 1111111122222222345678900000000123456666666677777777890123444444445 */ + = "\xf0\x9f\x98\x82_foo = \xcf\x80_bar.\xf0\x9f\x98\x82_field\xcf\x80;\n"; + /* 0000000000000000000001111111111111111111222222222222222222222233333 + 1111222233334444567890122223333456789999000011112222345678999900001 + Byte columns. */ + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1); + + location_t line_end = linemap_position_for_column (line_table, 31); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end)); + ASSERT_EQ (1, LOCATION_LINE (line_end)); + ASSERT_EQ (31, LOCATION_COLUMN (line_end)); + + char_span lspan = location_get_source_line (tmp.get_filename (), 1); + ASSERT_EQ (25, cpp_display_width (lspan.get_buffer (), lspan.length ())); + ASSERT_EQ (25, location_compute_display_column (expand_location (line_end))); + + test_one_liner_simple_caret_utf8 (); + test_one_liner_caret_and_range_utf8 (); + test_one_liner_multiple_carets_and_ranges_utf8 (); + test_one_liner_fixit_insert_before_utf8 (); + test_one_liner_fixit_insert_after_utf8 (); + test_one_liner_fixit_remove_utf8 (); + test_one_liner_fixit_replace_utf8 (); + test_one_liner_fixit_replace_non_equal_range_utf8 (); + test_one_liner_fixit_replace_equal_secondary_range_utf8 (); + test_one_liner_fixit_validation_adhoc_locations_utf8 (); + test_one_liner_many_fixits_1_utf8 (); + test_one_liner_many_fixits_2_utf8 (); + test_one_liner_labels_utf8 (); +} + /* Verify that gcc_rich_location::add_location_if_nearby works. */ static void @@ -3221,13 +3901,16 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* Unit-test the line_corrections machinery. */ ASSERT_EQ (3, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (12, 12), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, false)); + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, true)); ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (18, 18), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, false)); + ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, true)); ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); const fixit_hint *hint_2 = richloc.get_fixit_hint (2); - ASSERT_EQ (column_range (29, 28), get_affected_columns (hint_2)); + ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, false)); + ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, true)); ASSERT_EQ (column_range (29, 29), get_printed_columns (hint_2)); /* Add each hint in turn to a line_corrections instance, @@ -3238,6 +3921,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* The first replace hint by itself. */ lc.add_hint (hint_0); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); @@ -3247,6 +3931,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) lc.add_hint (hint_1); ASSERT_EQ (1, lc.m_corrections.length ()); ASSERT_STREQ ("const_cast<foo *> (", lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); @@ -3256,6 +3941,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) ASSERT_STREQ ("const_cast<foo *> (ptr->field)", lc.m_corrections[0]->m_text); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 41), lc.m_corrections[0]->m_printed_columns); } @@ -3358,6 +4044,243 @@ test_overlapped_fixit_printing (const line_table_case &case_) } } +/* Multibyte-aware version of preceding tests. See comments above + test_one_liner_simple_caret_utf8() too, we use the same two multibyte + characters here. */ + +static void +test_overlapped_fixit_printing_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + + const char *content + /* Display columns. + 00000000000000000000000111111111111111111111111222222222222222223 + 12344444444555555556789012344444444555555556789012345678999999990 */ + = " f\xf0\x9f\x98\x82 *f = (f\xf0\x9f\x98\x82 *)ptr->field\xcf\x80;\n"; + /* 00000000000000000000011111111111111111111112222222222333333333333 + 12344445555666677778901234566667777888899990123456789012333344445 + Byte columns. */ + + temp_source_file tmp (SELFTEST_LOCATION, ".C", content); + line_table_test ltt (case_); + + const line_map_ordinary *ord_map + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, + tmp.get_filename (), 0)); + + linemap_line_start (line_table, 1, 100); + + const location_t final_line_end + = linemap_position_for_line_and_column (line_table, ord_map, 6, 50); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + /* A test for converting a C-style cast to a C++-style cast. */ + const location_t open_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 14); + const location_t close_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 22); + const location_t expr_start + = linemap_position_for_line_and_column (line_table, ord_map, 1, 23); + const location_t expr_finish + = linemap_position_for_line_and_column (line_table, ord_map, 1, 34); + const location_t expr = make_location (expr_start, expr_start, expr_finish); + + /* Various examples of fix-it hints that aren't themselves consolidated, + but for which the *printing* may need consolidation. */ + + /* Example where 3 fix-it hints are printed as one. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "const_cast<"); + richloc.add_fixit_replace (close_paren, "> ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " const_cast<f\xf0\x9f\x98\x82" + " *> (ptr->field\xcf\x80" + ")\n", + pp_formatted_text (dc.printer)); + + /* Unit-test the line_corrections machinery. */ + ASSERT_EQ (3, richloc.get_num_fixit_hints ()); + const fixit_hint *hint_0 = richloc.get_fixit_hint (0); + ASSERT_EQ (column_range (14, 14), get_affected_range (hint_0, false)); + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, true)); + ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); + const fixit_hint *hint_1 = richloc.get_fixit_hint (1); + ASSERT_EQ (column_range (22, 22), get_affected_range (hint_1, false)); + ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, true)); + ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); + const fixit_hint *hint_2 = richloc.get_fixit_hint (2); + ASSERT_EQ (column_range (35, 34), get_affected_range (hint_2, false)); + ASSERT_EQ (column_range (30, 29), get_affected_range (hint_2, true)); + ASSERT_EQ (column_range (30, 30), get_printed_columns (hint_2)); + + /* Add each hint in turn to a line_corrections instance, + and verify that they are consolidated into one correction instance + as expected. */ + line_corrections lc (tmp.get_filename (), 1); + + /* The first replace hint by itself. */ + lc.add_hint (hint_0); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 14), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); + ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); + + /* After the second replacement hint, they are printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_1); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (", + lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (14, 22), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); + + /* After the final insertion hint, they are all printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_2); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (ptr->field\xcf\x80)", + lc.m_corrections[0]->m_text); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 34), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 29), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 42), lc.m_corrections[0]->m_printed_columns); + } + + /* Example where two are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CAST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CAST (-\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example where none are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CST ( -\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(bar\xf0\x9f\x98\x82 *)"); + source_range victim = {open_paren, close_paren}; + richloc.add_fixit_remove (victim); + + /* This case is actually handled by fixit-consolidation, + rather than by line_corrections. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " (bar\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(long\xf0\x9f\x98\x82 *)"); + source_range victim = {expr_start, expr_finish}; + richloc.add_fixit_remove (victim); + + /* These fixits are not consolidated. */ + ASSERT_EQ (2, richloc.get_num_fixit_hints ()); + + /* But the corrections are. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " (long\xf0\x9f\x98\x82" + " *)(f\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of insertion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before + (open_paren, "L\xf0\x9f\x98\x82NGER THAN THE CAST"); + richloc.add_fixit_insert_after (close_paren, "TEST"); + + /* The first insertion is long enough that if printed naively, + it would overlap with the second. + Verify that they are printed as a single replacement. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " L\xf0\x9f\x98\x82" + "NGER THAN THE CAST(f\xf0\x9f\x98\x82" + " *)TEST\n", + pp_formatted_text (dc.printer)); + } +} + /* Verify that the line_corrections machinery correctly prints overlapping fixit-hints that have been added in the wrong order. @@ -3407,10 +4330,10 @@ test_overlapped_fixit_printing_2 (const line_table_case &case_) /* These fixits should be accepted; they can't be consolidated. */ ASSERT_EQ (2, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (23, 22), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (23, 22), get_affected_range (hint_0, false)); ASSERT_EQ (column_range (23, 23), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (21, 20), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (21, 20), get_affected_range (hint_1, false)); ASSERT_EQ (column_range (21, 21), get_printed_columns (hint_1)); /* Verify that they're printed correctly. */ @@ -3737,10 +4660,12 @@ diagnostic_show_locus_c_tests () test_diagnostic_show_locus_unknown_location (); for_each_line_table_case (test_diagnostic_show_locus_one_liner); + for_each_line_table_case (test_diagnostic_show_locus_one_liner_utf8); for_each_line_table_case (test_add_location_if_nearby); for_each_line_table_case (test_diagnostic_show_locus_fixit_lines); for_each_line_table_case (test_fixit_consolidation); for_each_line_table_case (test_overlapped_fixit_printing); + for_each_line_table_case (test_overlapped_fixit_printing_utf8); for_each_line_table_case (test_overlapped_fixit_printing_2); for_each_line_table_case (test_fixit_insert_containing_newline); for_each_line_table_case (test_fixit_insert_containing_newline_2); diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c index 96b6fa30052..8638fbebb2d 100644 --- a/gcc/diagnostic.c +++ b/gcc/diagnostic.c @@ -346,9 +346,13 @@ diagnostic_get_location_text (diagnostic_context *context, const char *locus_cs = colorize_start (pp_show_color (pp), "locus"); const char *locus_ce = colorize_stop (pp_show_color (pp)); const char *file = s.file ? s.file : progname; - int line = strcmp (file, N_("<built-in>")) ? s.line : 0; - int col = context->show_column ? s.column : 0; - + int line = 0; + int col = 0; + if (strcmp (file, N_("<built-in>"))) + { + line = s.line; + col = context->show_column ? location_compute_display_column (s) : 0; + } const char *line_col = maybe_line_and_column (line, col); return build_message_string ("%s%s%s:%s", locus_cs, file, line_col, locus_ce); diff --git a/gcc/input.c b/gcc/input.c index 00301ef68dd..d2d99000b84 100644 --- a/gcc/input.c +++ b/gcc/input.c @@ -908,6 +908,18 @@ make_location (location_t caret, source_range src_range) return COMBINE_LOCATION_DATA (line_table, pure_loc, src_range, NULL); } +int +location_compute_display_column (expanded_location exploc) +{ + if (!(exploc.file && exploc.line && exploc.column)) + return exploc.column; + char_span line = location_get_source_line (exploc.file, exploc.line); + /* If line is NULL, this function returns exploc.column which is the + desired fallback. */ + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), + exploc.column); +} + /* Dump statistics to stderr about the memory usage of the line_table set of line maps. This also displays some statistics about macro expansion. */ @@ -3590,6 +3602,51 @@ test_line_offset_overflow () ASSERT_NE (ordmap_a, ordmap_b); } +void test_cpp_utf8 () +{ + /* Verify that wcwidth of invalid UTF-8 or control bytes is 1. */ + { + int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8); + ASSERT_EQ (8, w_bad); + int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6); + ASSERT_EQ (6, w_ctrl); + } + + /* Verify that wcwidth of valid UTF-8 is as expected. */ + { + const int w_pi = cpp_display_width ("\xcf\x80", 2); + ASSERT_EQ (1, w_pi); + const int w_emoji = cpp_display_width ("\xf0\x9f\x98\x82", 4); + ASSERT_EQ (2, w_emoji); + const int w_ascii = cpp_display_width ("GCC", 3); + ASSERT_EQ (3, w_ascii); + const int w_mixed + = cpp_display_width ("\xcf\x80 = 3.14 \xf0\x9f\x98\x82 \x9f!", 17); + ASSERT_EQ (14, w_mixed); + } + + /* Verify that cpp_byte_column_to_display_column can go past the end, + and similar edge cases. */ + { + const char *str = "\xcf\x80 abc"; + ASSERT_EQ (5, cpp_display_width (str, 6)); + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); + } + + /* Verify that cpp_display_column_to_byte_column can go past the end, + and similar edge cases. */ + { + const char *str = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); + } +} + /* Run all of the selftests within this file. */ void @@ -3631,6 +3688,8 @@ input_c_tests () test_reading_source_line (); test_line_offset_overflow (); + + test_cpp_utf8 (); } } // namespace selftest diff --git a/gcc/input.h b/gcc/input.h index c459bf28553..35e02bd91d5 100644 --- a/gcc/input.h +++ b/gcc/input.h @@ -38,6 +38,7 @@ STATIC_ASSERT (BUILTINS_LOCATION < RESERVED_LOCATION_COUNT); extern bool is_location_from_builtin_token (location_t); extern expanded_location expand_location (location_t); +extern int location_compute_display_column (expanded_location); /* A class capturing the bounds of a buffer, to allow for run-time bounds-checking in a checked build. */ diff --git a/libcpp/charset.c b/libcpp/charset.c index 39af77a554a..d1bdff095eb 100644 --- a/libcpp/charset.c +++ b/libcpp/charset.c @@ -2257,3 +2257,106 @@ cpp_string_location_reader::get_next () m_loc += m_offset_per_column; return result; } + +/* Helper for cpp_byte_column_to_display_column and its inverse. Given a + pointer to a UTF-8-encoded character, compute its display width. *INBUFP + points on entry to the start of the UTF-8 encoding of the character, and + is updated to point just after the last byte of the encoding. *INBYTESLEFTP + contains on entry the remaining size of the buffer into which *INBUFP + points, and this is also updated accordingly. If *INBUFP does not + point to a valid UTF-8-encoded sequence, then it will be treated as a single + byte with display width 1. */ + +static inline int +compute_next_display_width (const uchar **inbufp, size_t *inbytesleftp) +{ + cppchar_t c; + if (one_utf8_to_cppchar (inbufp, inbytesleftp, &c) != 0) + { + /* Input is not convertible to UTF-8. This could be fine, e.g. in a + string literal, so don't complain. Just treat it as if it has a width + of one. */ + ++*inbufp; + --*inbytesleftp; + return 1; + } + + /* one_utf8_to_cppchar() has updated inbufp and inbytesleftp for us. */ + return cpp_wcwidth (c); +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + how many display columns are occupied by the first COLUMN bytes. COLUMN + may exceed DATA_LENGTH, in which case the phantom bytes at the end are + treated as if they have display width 1. */ + +int +cpp_byte_column_to_display_column (const char *data, int data_length, + int column) +{ + int display_col = 0; + const uchar *udata = (const uchar *) data; + const int offset = MAX (0, column - data_length); + size_t inbytesleft = column - offset; + while (inbytesleft) + display_col += compute_next_display_width (&udata, &inbytesleft); + return display_col + offset; +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + the least number of bytes that will result in at least DISPLAY_COL display + columns. The return value may exceed DATA_LENGTH if the entire string does + not occupy enough display columns. */ + +int +cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col) +{ + int column = 0; + const uchar *udata = (const uchar *) data; + size_t inbytesleft = data_length; + while (column < display_col && inbytesleft) + column += compute_next_display_width (&udata, &inbytesleft); + return data_length - inbytesleft + (display_col - column); +} + +/* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc, + because that will inspect the user's locale, and in particular in an ASCII + locale, it will not return anything useful for extended characters. But GCC + in other respects (see e.g. _cpp_default_encoding()) behaves as if + everything is UTF-8. We also make some tweaks that are useful for the way + GCC needs to use this data, e.g. tabs and other control characters should be + treated as having width 1. The lookup tables are generated from + contrib/unicode/gen_wcwidth.py and were made by simply calling glibc + wcwidth() on all codepoints, then applying the small tweaks. These tables + are not highly optimized, but for the present purpose of outputting + diagnostics, they are sufficient. */ + +#include "generated_cpp_wcwidth.h" +int cpp_wcwidth (cppchar_t c) +{ + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) + return wcwidth_widths[0]; + + /* Binary search the tables. */ + int begin = 1; + static const int end + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); + int len = end - begin; + do + { + int half = len/2; + int middle = begin + half; + if (c > wcwidth_range_ends[middle]) + { + begin = middle + 1; + len -= half + 1; + } + else + len = half; + } while (len); + + if (__builtin_expect (begin != end, true)) + return wcwidth_widths[begin]; + return 1; +} diff --git a/libcpp/generated_cpp_wcwidth.h b/libcpp/generated_cpp_wcwidth.h new file mode 100644 index 00000000000..ec8b73d3d01 --- /dev/null +++ b/libcpp/generated_cpp_wcwidth.h @@ -0,0 +1,156 @@ +/* Generated by contrib/unicode/gen_wcwidth.py, with the help of glibc's + utf8_gen.py, using version 12.1.0 of the Unicode standard. */ + +static const cppchar_t wcwidth_range_ends[] = { + 0x2ff, 0x36f, 0x482, 0x489, 0x590, 0x5bd, 0x5be, 0x5bf, + 0x5c0, 0x5c2, 0x5c3, 0x5c5, 0x5c6, 0x5c7, 0x60f, 0x61a, + 0x61b, 0x61c, 0x64a, 0x65f, 0x66f, 0x670, 0x6d5, 0x6dc, + 0x6de, 0x6e4, 0x6e6, 0x6e8, 0x6e9, 0x6ed, 0x710, 0x711, + 0x72f, 0x74a, 0x7a5, 0x7b0, 0x7ea, 0x7f3, 0x7fc, 0x7fd, + 0x815, 0x819, 0x81a, 0x823, 0x824, 0x827, 0x828, 0x82d, + 0x858, 0x85b, 0x8d2, 0x8e1, 0x8e2, 0x902, 0x939, 0x93a, + 0x93b, 0x93c, 0x940, 0x948, 0x94c, 0x94d, 0x950, 0x957, + 0x961, 0x963, 0x980, 0x981, 0x9bb, 0x9bc, 0x9c0, 0x9c4, + 0x9cc, 0x9cd, 0x9e1, 0x9e3, 0x9fd, 0x9fe, 0xa00, 0xa02, + 0xa3b, 0xa3c, 0xa40, 0xa42, 0xa46, 0xa48, 0xa4a, 0xa4d, + 0xa50, 0xa51, 0xa6f, 0xa71, 0xa74, 0xa75, 0xa80, 0xa82, + 0xabb, 0xabc, 0xac0, 0xac5, 0xac6, 0xac8, 0xacc, 0xacd, + 0xae1, 0xae3, 0xaf9, 0xaff, 0xb00, 0xb01, 0xb3b, 0xb3c, + 0xb3e, 0xb3f, 0xb40, 0xb44, 0xb4c, 0xb4d, 0xb55, 0xb56, + 0xb61, 0xb63, 0xb81, 0xb82, 0xbbf, 0xbc0, 0xbcc, 0xbcd, + 0xbff, 0xc00, 0xc03, 0xc04, 0xc3d, 0xc40, 0xc45, 0xc48, + 0xc49, 0xc4d, 0xc54, 0xc56, 0xc61, 0xc63, 0xc80, 0xc81, + 0xcbb, 0xcbc, 0xcbe, 0xcbf, 0xcc5, 0xcc6, 0xccb, 0xccd, + 0xce1, 0xce3, 0xcff, 0xd01, 0xd3a, 0xd3c, 0xd40, 0xd44, + 0xd4c, 0xd4d, 0xd61, 0xd63, 0xdc9, 0xdca, 0xdd1, 0xdd4, + 0xdd5, 0xdd6, 0xe30, 0xe31, 0xe33, 0xe3a, 0xe46, 0xe4e, + 0xeb0, 0xeb1, 0xeb3, 0xebc, 0xec7, 0xecd, 0xf17, 0xf19, + 0xf34, 0xf35, 0xf36, 0xf37, 0xf38, 0xf39, 0xf70, 0xf7e, + 0xf7f, 0xf84, 0xf85, 0xf87, 0xf8c, 0xf97, 0xf98, 0xfbc, + 0xfc5, 0xfc6, 0x102c, 0x1030, 0x1031, 0x1037, 0x1038, 0x103a, + 0x103c, 0x103e, 0x1057, 0x1059, 0x105d, 0x1060, 0x1070, 0x1074, + 0x1081, 0x1082, 0x1084, 0x1086, 0x108c, 0x108d, 0x109c, 0x109d, + 0x10ff, 0x115f, 0x11ff, 0x135c, 0x135f, 0x1711, 0x1714, 0x1731, + 0x1734, 0x1751, 0x1753, 0x1771, 0x1773, 0x17b3, 0x17b5, 0x17b6, + 0x17bd, 0x17c5, 0x17c6, 0x17c8, 0x17d3, 0x17dc, 0x17dd, 0x180a, + 0x180e, 0x1884, 0x1886, 0x18a8, 0x18a9, 0x191f, 0x1922, 0x1926, + 0x1928, 0x1931, 0x1932, 0x1938, 0x193b, 0x1a16, 0x1a18, 0x1a1a, + 0x1a1b, 0x1a55, 0x1a56, 0x1a57, 0x1a5e, 0x1a5f, 0x1a60, 0x1a61, + 0x1a62, 0x1a64, 0x1a6c, 0x1a72, 0x1a7c, 0x1a7e, 0x1a7f, 0x1aaf, + 0x1abe, 0x1aff, 0x1b03, 0x1b33, 0x1b34, 0x1b35, 0x1b3a, 0x1b3b, + 0x1b3c, 0x1b41, 0x1b42, 0x1b6a, 0x1b73, 0x1b7f, 0x1b81, 0x1ba1, + 0x1ba5, 0x1ba7, 0x1ba9, 0x1baa, 0x1bad, 0x1be5, 0x1be6, 0x1be7, + 0x1be9, 0x1bec, 0x1bed, 0x1bee, 0x1bf1, 0x1c2b, 0x1c33, 0x1c35, + 0x1c37, 0x1ccf, 0x1cd2, 0x1cd3, 0x1ce0, 0x1ce1, 0x1ce8, 0x1cec, + 0x1ced, 0x1cf3, 0x1cf4, 0x1cf7, 0x1cf9, 0x1dbf, 0x1df9, 0x1dfa, + 0x1dff, 0x200a, 0x200f, 0x2029, 0x202e, 0x205f, 0x2064, 0x2065, + 0x206f, 0x20cf, 0x20f0, 0x2319, 0x231b, 0x2328, 0x232a, 0x23e8, + 0x23ec, 0x23ef, 0x23f0, 0x23f2, 0x23f3, 0x25fc, 0x25fe, 0x2613, + 0x2615, 0x2647, 0x2653, 0x267e, 0x267f, 0x2692, 0x2693, 0x26a0, + 0x26a1, 0x26a9, 0x26ab, 0x26bc, 0x26be, 0x26c3, 0x26c5, 0x26cd, + 0x26ce, 0x26d3, 0x26d4, 0x26e9, 0x26ea, 0x26f1, 0x26f3, 0x26f4, + 0x26f5, 0x26f9, 0x26fa, 0x26fc, 0x26fd, 0x2704, 0x2705, 0x2709, + 0x270b, 0x2727, 0x2728, 0x274b, 0x274c, 0x274d, 0x274e, 0x2752, + 0x2755, 0x2756, 0x2757, 0x2794, 0x2797, 0x27af, 0x27b0, 0x27be, + 0x27bf, 0x2b1a, 0x2b1c, 0x2b4f, 0x2b50, 0x2b54, 0x2b55, 0x2cee, + 0x2cf1, 0x2d7e, 0x2d7f, 0x2ddf, 0x2dff, 0x2e7f, 0x2e99, 0x2e9a, + 0x2ef3, 0x2eff, 0x2fd5, 0x2fef, 0x2ffb, 0x2fff, 0x3029, 0x302d, + 0x303e, 0x3040, 0x3096, 0x3098, 0x309a, 0x30ff, 0x3104, 0x312f, + 0x3130, 0x318e, 0x318f, 0x31ba, 0x31bf, 0x31e3, 0x31ef, 0x321e, + 0x321f, 0x4db5, 0x4dbf, 0x9fef, 0x9fff, 0xa48c, 0xa48f, 0xa4c6, + 0xa66e, 0xa672, 0xa673, 0xa67d, 0xa69d, 0xa69f, 0xa6ef, 0xa6f1, + 0xa801, 0xa802, 0xa805, 0xa806, 0xa80a, 0xa80b, 0xa824, 0xa826, + 0xa8c3, 0xa8c5, 0xa8df, 0xa8f1, 0xa8fe, 0xa8ff, 0xa925, 0xa92d, + 0xa946, 0xa951, 0xa95f, 0xa97c, 0xa97f, 0xa982, 0xa9b2, 0xa9b3, + 0xa9b5, 0xa9b9, 0xa9bb, 0xa9bd, 0xa9e4, 0xa9e5, 0xaa28, 0xaa2e, + 0xaa30, 0xaa32, 0xaa34, 0xaa36, 0xaa42, 0xaa43, 0xaa4b, 0xaa4c, + 0xaa7b, 0xaa7c, 0xaaaf, 0xaab0, 0xaab1, 0xaab4, 0xaab6, 0xaab8, + 0xaabd, 0xaabf, 0xaac0, 0xaac1, 0xaaeb, 0xaaed, 0xaaf5, 0xaaf6, + 0xabe4, 0xabe5, 0xabe7, 0xabe8, 0xabec, 0xabed, 0xabff, 0xd7a3, + 0xf8ff, 0xfa6d, 0xfa6f, 0xfad9, 0xfb1d, 0xfb1e, 0xfdff, 0xfe0f, + 0xfe19, 0xfe1f, 0xfe2f, 0xfe52, 0xfe53, 0xfe66, 0xfe67, 0xfe6b, + 0xfefe, 0xfeff, 0xff00, 0xff60, 0xffdf, 0xffe6, 0xfff8, 0xfffb, + 0x101fc, 0x101fd, 0x102df, 0x102e0, 0x10375, 0x1037a, 0x10a00, 0x10a03, + 0x10a04, 0x10a06, 0x10a0b, 0x10a0f, 0x10a37, 0x10a3a, 0x10a3e, 0x10a3f, + 0x10ae4, 0x10ae6, 0x10d23, 0x10d27, 0x10f45, 0x10f50, 0x11000, 0x11001, + 0x11037, 0x11046, 0x1107e, 0x11081, 0x110b2, 0x110b6, 0x110b8, 0x110ba, + 0x110ff, 0x11102, 0x11126, 0x1112b, 0x1112c, 0x11134, 0x11172, 0x11173, + 0x1117f, 0x11181, 0x111b5, 0x111be, 0x111c8, 0x111cc, 0x1122e, 0x11231, + 0x11233, 0x11234, 0x11235, 0x11237, 0x1123d, 0x1123e, 0x112de, 0x112df, + 0x112e2, 0x112ea, 0x112ff, 0x11301, 0x1133a, 0x1133c, 0x1133f, 0x11340, + 0x11365, 0x1136c, 0x1136f, 0x11374, 0x11437, 0x1143f, 0x11441, 0x11444, + 0x11445, 0x11446, 0x1145d, 0x1145e, 0x114b2, 0x114b8, 0x114b9, 0x114ba, + 0x114be, 0x114c0, 0x114c1, 0x114c3, 0x115b1, 0x115b5, 0x115bb, 0x115bd, + 0x115be, 0x115c0, 0x115db, 0x115dd, 0x11632, 0x1163a, 0x1163c, 0x1163d, + 0x1163e, 0x11640, 0x116aa, 0x116ab, 0x116ac, 0x116ad, 0x116af, 0x116b5, + 0x116b6, 0x116b7, 0x1171c, 0x1171f, 0x11721, 0x11725, 0x11726, 0x1172b, + 0x1182e, 0x11837, 0x11838, 0x1183a, 0x119d3, 0x119d7, 0x119d9, 0x119db, + 0x119df, 0x119e0, 0x11a00, 0x11a0a, 0x11a32, 0x11a38, 0x11a3a, 0x11a3e, + 0x11a46, 0x11a47, 0x11a50, 0x11a56, 0x11a58, 0x11a5b, 0x11a89, 0x11a96, + 0x11a97, 0x11a99, 0x11c2f, 0x11c36, 0x11c37, 0x11c3d, 0x11c3e, 0x11c3f, + 0x11c91, 0x11ca7, 0x11ca9, 0x11cb0, 0x11cb1, 0x11cb3, 0x11cb4, 0x11cb6, + 0x11d30, 0x11d36, 0x11d39, 0x11d3a, 0x11d3b, 0x11d3d, 0x11d3e, 0x11d45, + 0x11d46, 0x11d47, 0x11d8f, 0x11d91, 0x11d94, 0x11d95, 0x11d96, 0x11d97, + 0x11ef2, 0x11ef4, 0x1342f, 0x13438, 0x16aef, 0x16af4, 0x16b2f, 0x16b36, + 0x16f4e, 0x16f4f, 0x16f8e, 0x16f92, 0x16fdf, 0x16fe3, 0x16fff, 0x187f7, + 0x187ff, 0x18af2, 0x1afff, 0x1b11e, 0x1b14f, 0x1b152, 0x1b163, 0x1b167, + 0x1b16f, 0x1b2fb, 0x1bc9c, 0x1bc9e, 0x1bc9f, 0x1bca3, 0x1d166, 0x1d169, + 0x1d172, 0x1d182, 0x1d184, 0x1d18b, 0x1d1a9, 0x1d1ad, 0x1d241, 0x1d244, + 0x1d9ff, 0x1da36, 0x1da3a, 0x1da6c, 0x1da74, 0x1da75, 0x1da83, 0x1da84, + 0x1da9a, 0x1da9f, 0x1daa0, 0x1daaf, 0x1dfff, 0x1e006, 0x1e007, 0x1e018, + 0x1e01a, 0x1e021, 0x1e022, 0x1e024, 0x1e025, 0x1e02a, 0x1e12f, 0x1e136, + 0x1e2eb, 0x1e2ef, 0x1e8cf, 0x1e8d6, 0x1e943, 0x1e94a, 0x1f003, 0x1f004, + 0x1f0ce, 0x1f0cf, 0x1f18d, 0x1f18e, 0x1f190, 0x1f19a, 0x1f1ff, 0x1f202, + 0x1f20f, 0x1f23b, 0x1f23f, 0x1f248, 0x1f24f, 0x1f251, 0x1f25f, 0x1f265, + 0x1f2ff, 0x1f320, 0x1f32c, 0x1f335, 0x1f336, 0x1f37c, 0x1f37d, 0x1f393, + 0x1f39f, 0x1f3ca, 0x1f3ce, 0x1f3d3, 0x1f3df, 0x1f3f0, 0x1f3f3, 0x1f3f4, + 0x1f3f7, 0x1f43e, 0x1f43f, 0x1f440, 0x1f441, 0x1f4fc, 0x1f4fe, 0x1f53d, + 0x1f54a, 0x1f54e, 0x1f54f, 0x1f567, 0x1f579, 0x1f57a, 0x1f594, 0x1f596, + 0x1f5a3, 0x1f5a4, 0x1f5fa, 0x1f64f, 0x1f67f, 0x1f6c5, 0x1f6cb, 0x1f6cc, + 0x1f6cf, 0x1f6d2, 0x1f6d4, 0x1f6d5, 0x1f6ea, 0x1f6ec, 0x1f6f3, 0x1f6fa, + 0x1f7df, 0x1f7eb, 0x1f90c, 0x1f971, 0x1f972, 0x1f976, 0x1f979, 0x1f9a2, + 0x1f9a4, 0x1f9aa, 0x1f9ad, 0x1f9ca, 0x1f9cc, 0x1f9ff, 0x1fa6f, 0x1fa73, + 0x1fa77, 0x1fa7a, 0x1fa7f, 0x1fa82, 0x1fa8f, 0x1fa95, 0x1ffff, 0x2a6d6, + 0x2a6ff, 0x2b734, 0x2b73f, 0x2b81d, 0x2b81f, 0x2cea1, 0x2ceaf, 0x2ebe0, + 0x2f7ff, 0x2fa1d, 0xe0000, 0xe0001, 0xe001f, 0xe007f, 0xe00ff, 0xe01ef, +}; + +static const unsigned char wcwidth_widths[] = { + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 0, 2, 1, 2, 1, 0, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, + 2, 1, 0, 2, 1, 2, 1, 2, 1, 0, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, +}; diff --git a/libcpp/include/cpplib.h b/libcpp/include/cpplib.h index a645f8136a6..fdc8badba7d 100644 --- a/libcpp/include/cpplib.h +++ b/libcpp/include/cpplib.h @@ -1305,4 +1305,15 @@ extern bool cpp_userdef_char_p extern const char * cpp_get_userdef_suffix (const cpp_token *); +/* In charset.c */ +int cpp_byte_column_to_display_column (const char *data, int data_length, + int column); +inline int cpp_display_width (const char *data, int data_length) +{ + return cpp_byte_column_to_display_column (data, data_length, data_length); +} +int cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col); +int cpp_wcwidth (cppchar_t c); + #endif /* ! LIBCPP_CPPLIB_H */ ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-09-27 20:42 ` Lewis Hyatt @ 2019-10-18 13:59 ` Lewis Hyatt 2019-11-19 17:38 ` David Malcolm 1 sibling, 0 replies; 17+ messages in thread From: Lewis Hyatt @ 2019-10-18 13:59 UTC (permalink / raw) To: gcc-patches; +Cc: Joseph Myers On Fri, Sep 27, 2019 at 4:41 PM Lewis Hyatt <lhyatt@gmail.com> wrote: > > On Thu, Sep 26, 2019 at 08:46:56PM +0000, Joseph Myers wrote: > > On Thu, 26 Sep 2019, Lewis Hyatt wrote: > > > > > A couple notes: > > > - In order to avoid any portability problems with wchar_t, the > > > equivalent of wcwidth() from libc is implemented in-house. > > > > I'm uneasy about contrib/gen_wcwidth.cpp doing the generation using host > > libc's wcwidth. The effect is that libcpp/generated_cpp_wcwidth.h is > > *not* reproducible unless you know exactly what host (libc version, locale > > used when running the program, distribution patches to libc and locale > > data) was used to run the program. I think we need a generator that works > > from Unicode data in some way so we can explicitly say what version of the > > (unmodified) Unicode data was used. > > Here is a revised patch that hopefully addresses your concerns. I borrowed the > relevant Python code for parsing Unicode's data files from glibc, then added a > new script that parses the locale data they output into the same sort of simply > searchable tables I was creating before. The new generated table is very close > to the old one, but there are some differences due to improvements that have > been made to glibc recently, affecting 200 or so codepoints. This patch (https://gcc.gnu.org/ml/gcc-patches/2019-09/msg01627.html) now requires some minor merge resolution, after recent other commits affecting diagnostic-show-locus.c. I wasn't sure what's the preferred practice, should I resend it now so that you have something that can be applied to trunk, or it's better to wait for comments on what was already sent? Thank you! -Lewis ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-09-27 20:42 ` Lewis Hyatt 2019-10-18 13:59 ` Lewis Hyatt @ 2019-11-19 17:38 ` David Malcolm 2019-11-19 18:40 ` Joseph Myers ` (2 more replies) 1 sibling, 3 replies; 17+ messages in thread From: David Malcolm @ 2019-11-19 17:38 UTC (permalink / raw) To: Lewis Hyatt, gcc-patches; +Cc: joseph On Fri, 2019-09-27 at 16:41 -0400, Lewis Hyatt wrote: > On Thu, Sep 26, 2019 at 08:46:56PM +0000, Joseph Myers wrote: > > On Thu, 26 Sep 2019, Lewis Hyatt wrote: > > > > > A couple notes: > > > - In order to avoid any portability problems with wchar_t, > > > the > > > equivalent of wcwidth() from libc is implemented in-house. > > > > I'm uneasy about contrib/gen_wcwidth.cpp doing the generation using > > host > > libc's wcwidth. The effect is that libcpp/generated_cpp_wcwidth.h > > is > > *not* reproducible unless you know exactly what host (libc version, > > locale > > used when running the program, distribution patches to libc and > > locale > > data) was used to run the program. I think we need a generator > > that works > > from Unicode data in some way so we can explicitly say what version > > of the > > (unmodified) Unicode data was used. > > Here is a revised patch that hopefully addresses your concerns. I > borrowed the > relevant Python code for parsing Unicode's data files from glibc, > then added a > new script that parses the locale data they output into the same sort > of simply > searchable tables I was creating before. The new generated table is > very close > to the old one, but there are some differences due to improvements > that have > been made to glibc recently, affecting 200 or so codepoints. The > procedure for > updating GCC's wcwidth would then be the following: > > -The three Unicode data files live in contrib/unicode/ > {EastAsianWidth.txt,PropList.txt,UnicodeData.txt} and can be updated > at any > time when Unicode changes them. > > -glibc's processing logic lives in two Python scripts in > contrib/unicode/from_glibc and these would ideally be updated when > glibc makes > updates. It seems they occasionally put some manual overrides, etc., > based on > feedback and bug reports. (These are the verbatim scripts from glibc > with no > changes, so they need only be copied over.) > > -contrib/unicode/gen_wcwidth.py runs the glibc code, using GCC's > Unicode data > files as inputs, and produces the necessary tables for > libcpp/generated_cpp_wcwidth.h. > > Hope that sounds better. This way it is relatively straightforward to > keep in > sync with glibc (which seems desirable to me anyway), but is also > always > reproducible. > > Note: I did not include the three large unicode data files in this > emailed > patch, although they would be committed as part of the patch > presumably. > They are available here: > ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt > ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt > ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt > > The rest of the patch is unchanged from before, other than one > comment updated > to reflect the new situation, and charset.c rebased to current trunk. > > Thank you for taking the time to review this. > > -Lewis Thanks for posting this patch; I'm sorry about how long it's taken me to review it. BTW, have you done GCC contributor paperwork? https://gcc.gnu.org/contribute.html#legal > diff --git a/contrib/unicode/from_glibc/unicode_utils.py b/contrib/unicode/from_glibc/unicode_utils.py > new file mode 100644 > index 00000000000..a9e94cce418 > --- /dev/null > +++ b/contrib/unicode/from_glibc/unicode_utils.py [...snip...] I'll leave it for Joseph to comment on whether this approach satisifies his concerns; I'll focus on the diagnostic-show-locus.c changes. I'm assuming that all of the Python code is Python 3, rather than 2 (I see python 3 shebangs and python3-style-print, so it looks good from that POV). It appears that there's no need for the build machine to have Python, it's only needed when maintainers are refreshing the data from glibc. If we're going with this approach, and redistributing those unicode data files as part of our repo and tarballs, do we need some kind of copyright/license statement that spells out the situation? What does glibc do for this? > diff --git a/contrib/unicode/from_glibc/utf8_gen.py b/contrib/unicode/from_glibc/utf8_gen.py > new file mode 100755 > index 00000000000..0e5583cd259 > --- /dev/null > +++ b/contrib/unicode/from_glibc/utf8_gen.py [...snip...] > diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py > new file mode 100755 > index 00000000000..02b28bcedcf > --- /dev/null > +++ b/contrib/unicode/gen_wcwidth.py [...snip...] If we're going with this approach (which I'll leave to Joseph), perhaps this directory should have a brief README (covering much of the material you've mentioned in the email with the patch, talking about syncing with glibc, regenerating the data, etc). > diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c > index 4d563dda8f4..7a5bd36d962 100644 > --- a/gcc/diagnostic-show-locus.c > +++ b/gcc/diagnostic-show-locus.c > @@ -30,6 +30,7 @@ along with GCC; see the file COPYING3. If not see > #include "gcc-rich-location.h" > #include "selftest.h" > #include "selftest-diagnostic.h" > +#include "cpplib.h" > > #ifdef HAVE_TERMIOS_H > # include <termios.h> > @@ -112,7 +113,29 @@ class colorizer > const char *m_stop_color; > }; > > -/* A point within a layout_range; similar to an expanded_location, > +/* In order to handle multibyte sources properly, all of this logic needs to be > + aware of the distinction between the number of bytes and the number of > + display columns occupied by a character. One or the other is more useful > + depending on the context. For instance, in order to output the caret at the > + correct location, we need to count display columns; in order to colorize a > + source line, we need to count the bytes. All locations are provided to us > + as byte counts. We augment these with the display column so that it can be > + used when need. This is not the most efficient way to do things since it > + requires looping over the whole line each time, but it should be fine for > + the purpose of outputting diagnostics. */ The patch uses a bool in many places to indicate what kind of column is being referred to. I think an enum would be more typesafe and self-documenting - perhaps: "enum column_unit" with values CU_BYTES, CU_DISPLAY_COLUMN? or "enum column_kind" with values CK_BYTES, CK_DISPLAY_COLUMN? I wonder if this might eventually grow a third value, representing the a count of unicode characters, but that's out of scope for this patch. I should confess that it took me a while to realize the whole multi-column display thing (I had an "aha" moment, then felt rather foolish, given that I'd been playing with the examples in the PR; it was on reading through the ASCII art in the new selftests and going "huh" that I had my epiphany on the problem your patch is solving). I think this file could use a high-level introductory comment at the top talking about the various meanings of "column". I liked the two example code points you used below, so perhaps have a comment up at the top talking about the distinction between byte vs display column, using those code points as examples (and a plain ASCII character, by way of contrast). Perhaps have the comment describing the enum be the big introductory comment. It would be good for that introductory comment to have a copy of the ASCII art you used in the selftests below, or similar. > +class exploc_with_display_col : public expanded_location > +{ > + public: > + exploc_with_display_col (const expanded_location &exploc) > + : expanded_location (exploc), > + m_display_col (location_compute_display_column (exploc)) {} > + > + int m_display_col; > +}; OK > + > +/* A point within a layout_range; similar to an exploc_with_display_col, > but after filtering on file. */ > > class layout_point > @@ -120,10 +143,17 @@ class layout_point > public: > layout_point (const expanded_location &exploc) > : m_line (exploc.line), > - m_column (exploc.column) {} > + m_column (exploc.column), > + m_display_col (location_compute_display_column (exploc)) {} > + > + int get_col (bool use_display) const > + { > + return use_display ? m_display_col : m_column; > + } enum here. > linenum_type m_line; > int m_column; > + int m_display_col; Does it simplify things if this is an array accessed via the enum? (not sure, just a thought that occurred to me) > }; > > /* A class for use by "class layout" below: a filtered location_range. */ > @@ -138,7 +168,7 @@ class layout_range > unsigned original_idx, > const range_label *label); > > - bool contains_point (linenum_type row, int column) const; > + bool contains_point (linenum_type row, int column, bool use_display) const; enum > bool intersects_line_p (linenum_type row) const; > > layout_point m_start; > @@ -157,6 +187,17 @@ struct line_bounds > { > int m_first_non_ws; > int m_last_non_ws; > + > + void convert_to_display_cols (char_span line) > + { > + m_first_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), > + line.length (), > + m_first_non_ws); > + > + m_last_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), > + line.length (), > + m_last_non_ws); > + } > }; > > /* A range of contiguous source lines within a layout (e.g. "lines 5-10" > @@ -284,6 +325,7 @@ class layout > get_state_at_point (/* Inputs. */ > linenum_type row, int column, > int first_non_ws, int last_non_ws, > + bool use_display, enum > /* Outputs. */ > point_state *out_state); > > @@ -298,7 +340,7 @@ class layout > diagnostic_context *m_context; > pretty_printer *m_pp; > location_t m_primary_loc; > - expanded_location m_exploc; > + exploc_with_display_col m_exploc; > colorizer m_colorizer; > bool m_colorize_source_p; > bool m_show_labels_p; > @@ -472,10 +514,15 @@ layout_range::layout_range (const expanded_location *start_exploc, > - 'w' indicates a point within the range > - 'F' indicates the finish of the range (which is > within it). > - - 'a' indicates a subsequent point *after* the range. */ > + - 'a' indicates a subsequent point *after* the range. > + > + USE_DISPLAY controls whether we check the byte column or > + the display column; one or the other is more convenient > + depending on the context. */ FWIW it looks like this is only used by layout::get_state_at_point, which in turn is used by layout::print_source_line for colorization, and by layout::print_annotation_line for printing carets/underlines; looks like they're using false and true respectively. > bool > -layout_range::contains_point (linenum_type row, int column) const > +layout_range::contains_point (linenum_type row, int column, > + bool use_display) const enum again > { > gcc_assert (m_start.m_line <= m_finish.m_line); > /* ...but the equivalent isn't true for the columns; > @@ -491,7 +538,7 @@ layout_range::contains_point (linenum_type row, int column) const > /* On same line as start of range (corresponding > to line 02 in example A and line 03 in example B). */ > { > - if (column < m_start.m_column) > + if (column < m_start.get_col (use_display)) > /* Points on the starting line of the range, but > before the column in which it begins. */ > return false; > @@ -505,7 +552,7 @@ layout_range::contains_point (linenum_type row, int column) const > { > /* This is a single-line range. */ > gcc_assert (row == m_finish.m_line); > - return column <= m_finish.m_column; > + return column <= m_finish.get_col (use_display); > } > } > > @@ -530,7 +577,7 @@ layout_range::contains_point (linenum_type row, int column) const > > gcc_assert (row == m_finish.m_line); > > - return column <= m_finish.m_column; > + return column <= m_finish.get_col (use_display); > } > > /* Does this layout_range contain any part of line ROW? */ > @@ -574,20 +621,23 @@ test_layout_range_for_single_point () > > /* Tests for layout_range::contains_point. */ > > - /* Before the line. */ > - ASSERT_FALSE (point.contains_point (6, 1)); > + for (int use_display = 0; use_display <= 1; ++use_display) > + { > + /* Before the line. */ > + ASSERT_FALSE (point.contains_point (6, 1, use_display)); [...snip...] Here you generalize the layout_range tests to iterate over both meanings of "column". If I'm reading things right, implicit here is that the layout_point ctors within the layout range are now calling: m_display_col (location_compute_display_column (exploc)) which in this selftest is looking for a file named "test.c", presumably not finding it, and hitting the case of a NULL "line" char_span. So if there happens to be a test.c in the current directory containing the "right" characters, this selftest could break. Previously it's never mattered to this selftest whether or not there was an actual test.c, so it might be good to modify it to use temp_source_file (and maybe even to have some multicolumn chars in it, though that might be taking things too far). > @@ -642,40 +695,43 @@ test_layout_range_for_multiple_lines () [...snip...] Similar comments as for the single_point case. > @@ -687,8 +743,8 @@ test_layout_range_for_multiple_lines () > > #endif /* #if CHECKING_P */ > > -/* Given a source line LINE of length LINE_WIDTH, determine the width > - without any trailing whitespace. */ > +/* Given a source line LINE of length LINE_WIDTH bytes, determine the width > + (in bytes, not display cols) without any trailing whitespace. */ > > static int > get_line_width_without_trailing_whitespace (const char *line, int line_width) Why is get_line_width_without_trailing_whitespace done in bytes? It's used for calculating the maximum number of printed columns, to try to cope with extra wide source lines, offsetting things to fit within the width of the user's terminal. > @@ -897,17 +953,35 @@ layout::layout (diagnostic_context * context, > will be adjusted accordingly. */ > size_t max_width = m_context->caret_max_width; > char_span line = location_get_source_line (m_exploc.file, m_exploc.line); > - if (line && (size_t)m_exploc.column <= line.length ()) > + if (line && max_width) > { > - size_t right_margin = CARET_LINE_MARGIN; > - size_t column = m_exploc.column; > - if (m_show_line_numbers_p) > - column += m_linenum_width + 2; > - right_margin = MIN (line.length () - column, right_margin); > - right_margin = max_width - right_margin; > - if (line.length () >= max_width && column > right_margin) > - m_x_offset = column - right_margin; > - gcc_assert (m_x_offset >= 0); > + size_t column = m_exploc.m_display_col; > + int line_width > + = get_line_width_without_trailing_whitespace (line.get_buffer (), > + line.length ()); > + size_t eol = cpp_display_width (line.get_buffer (), line_width); > + const size_t eol_before_linenum = eol; > + > + if (column <= eol) > + { > + if (m_show_line_numbers_p) > + { > + column += m_linenum_width + 2; > + eol += m_linenum_width + 2; > + } > + size_t right_margin = CARET_LINE_MARGIN; > + right_margin = MIN (eol - column, right_margin); > + right_margin = max_width - right_margin; > + /* Note: if right_margin > max_width, we end up failing this next > + check due to wrapping, and we don't offset anything. Otherwise we > + would conclude we can't output the line at all. */ > + if (eol >= max_width && column > right_margin) > + { > + m_x_offset = column - right_margin; > + m_x_offset = MIN (m_x_offset, (int) eol_before_linenum - 1); > + } > + gcc_assert (m_x_offset >= 0); > + } > } > > if (context->show_ruler_p) > @@ -1252,7 +1326,9 @@ layout::calculate_line_spans () > /* Print line ROW of source code, potentially colorized at any ranges, and > populate *LBOUNDS_OUT. > LINE is the source line (not necessarily 0-terminated) and LINE_WIDTH > - is its width. */ > + is its width. This function deals only with byte offsets, not display > + columns; m_x_offset must be converted from display to byte units. In > + particular, LINE_WIDTH and LBOUNDS_OUT are in bytes. */ > > void > layout::print_source_line (linenum_type row, const char *line, int line_width, > @@ -1264,7 +1340,10 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, > whitespace. */ > line_width = get_line_width_without_trailing_whitespace (line, > line_width); > - line += m_x_offset; > + > + const int x_offset_bytes > + = cpp_display_column_to_byte_column (line, line_width, m_x_offset); > + line += x_offset_bytes; > > if (m_show_line_numbers_p) > { > @@ -1278,7 +1357,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, > int first_non_ws = INT_MAX; > int last_non_ws = 0; > int column; > - for (column = 1 + m_x_offset; column <= line_width; column++) > + for (column = 1 + x_offset_bytes; column <= line_width; column++) > { > /* Assuming colorization is enabled for the caret and underline > characters, we may also colorize the associated characters > @@ -1298,6 +1377,8 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, > point_state state; > in_range_p = get_state_at_point (row, column, > 0, INT_MAX, > + false, /* Using bytes, not display > + columns, here. */ > &state); > if (in_range_p) > m_colorizer.set_range (state.range_idx); > @@ -1360,12 +1441,13 @@ layout::start_annotation_line (char margin_char) const > } > > /* Print a line consisting of the caret/underlines for the given > - source line. */ > + source line. This function works with display columns, rather than byte > + counts; in particular, LBOUNDS should be in display column units. */ > > void > layout::print_annotation_line (linenum_type row, const line_bounds lbounds) > { > - int x_bound = get_x_bound_for_row (row, m_exploc.column, > + int x_bound = get_x_bound_for_row (row, m_exploc.m_display_col, > lbounds.m_last_non_ws); > > start_annotation_line (); > @@ -1378,6 +1460,7 @@ layout::print_annotation_line (linenum_type row, const line_bounds lbounds) > in_range_p = get_state_at_point (row, column, > lbounds.m_first_non_ws, > lbounds.m_last_non_ws, > + true, /* Using display units. */ > &state); > if (in_range_p) > { > @@ -1415,9 +1498,11 @@ class line_label > public: > line_label (int state_idx, int column, label_text text) > : m_state_idx (state_idx), m_column (column), > - m_text (text), m_length (strlen (text.m_buffer)), > - m_label_line (0) > - {} > + m_text (text), m_label_line (0) > + { > + const int bytes = strlen (text.m_buffer); > + m_length = cpp_display_width (text.m_buffer, bytes); > + } Please rename m_length to m_display_width, given that it's changing meaning. [...snip...] > @@ -1723,7 +1808,7 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, > > and is thus printed as desired. */ > > -/* A range of columns within a line. */ > +/* A range of (byte or display) columns within a line. */ > > class column_range > { > @@ -1743,32 +1828,51 @@ public: > int finish; > }; > > -/* Get the range of columns that HINT would affect. */ > - > +/* Get the range of bytes or display columns that HINT would affect. */ > static column_range > -get_affected_columns (const fixit_hint *hint) > +get_affected_range (const fixit_hint *hint, bool use_display) > { enum again. [...snip...] > @@ -1825,7 +1938,8 @@ public: > > /* The text to be inserted/used as replacement. */ > char *m_text; > - size_t m_len; > + size_t m_bytes; How about: size_t m_byte_length; /* not including 0-terminator. */ ? > + int m_display_cols; > size_t m_alloc_sz; > }; > > @@ -1850,8 +1964,8 @@ void > correction::ensure_terminated () > { > /* 0-terminate the buffer. */ > - gcc_assert (m_len < m_alloc_sz); > - m_text[m_len] = '\0'; > + gcc_assert (m_bytes < m_alloc_sz); > + m_text[m_bytes] = '\0'; > } > > /* A list of corrections affecting a particular line. > @@ -1913,7 +2027,8 @@ source_line::source_line (const char *filename, int line) > void > line_corrections::add_hint (const fixit_hint *hint) > { > - column_range affected_columns = get_affected_columns (hint); > + column_range affected_bytes = get_affected_range (hint, false); > + column_range affected_columns = get_affected_range (hint, true); enum again. > column_range printed_columns = get_printed_columns (hint); > > /* Potentially consolidate. */ [...snip...] > @@ -1947,7 +2062,7 @@ line_corrections::add_hint (const fixit_hint *hint) > /* Consolidate into the last correction: > add a no-op "replace" of the "between" text, and > add the text from the new hint. */ > - int old_len = last_correction->m_len; > + int old_len = last_correction->m_bytes; Maybe rename to old_len, new_len to old_byte_len, new_byte_len? > gcc_assert (old_len >= 0); > int between_len = between.finish + 1 - between.start; > gcc_assert (between_len >= 0); > @@ -1961,19 +2076,24 @@ line_corrections::add_hint (const fixit_hint *hint) > last_correction->overwrite (old_len + between_len, > char_span (hint->get_string (), > hint->get_length ())); > - last_correction->m_len = new_len; > + last_correction->m_bytes = new_len; > last_correction->ensure_terminated (); > + last_correction->m_affected_bytes.finish > + = affected_bytes.finish; > last_correction->m_affected_columns.finish > = affected_columns.finish; > + int prev_display_cols = last_correction->m_display_cols; > + last_correction->compute_display_cols (); > last_correction->m_printed_columns.finish > - += between_len + hint->get_length (); > + += last_correction->m_display_cols - prev_display_cols; > return; > } > } > } > > /* If no consolidation happened, add a new correction instance. */ > - m_corrections.safe_push (new correction (affected_columns, > + m_corrections.safe_push (new correction (affected_bytes, > + affected_columns, > printed_columns, > hint->get_string (), > hint->get_length ())); [...snip...] > @@ -2072,12 +2192,14 @@ layout::print_newline () > /* Return true if (ROW/COLUMN) is within a range of the layout. > If it returns true, OUT_STATE is written to, with the > range index, and whether we should draw the caret at > - (ROW/COLUMN) (as opposed to an underline). */ > + (ROW/COLUMN) (as opposed to an underline). USE_DISPLAY controls > + whether all inputs and outputs are in bytes or display column units. */ > > bool > layout::get_state_at_point (/* Inputs. */ > linenum_type row, int column, > int first_non_ws, int last_non_ws, > + bool use_display, enum again. > /* Outputs. */ > point_state *out_state) > { [...snip...] > @@ -2846,6 +2972,560 @@ test_diagnostic_show_locus_one_liner (const line_table_case &case_) > test_one_liner_labels (); > } > > +/* Version of all one-liner tests exercising multibyte awareness. For > + simplicity we stick to using two multibyte characters in the test, U+1F602 > + == "\xf0\x9f\x98\x82", which uses 4 bytes and 2 display columns, and U+03C0 > + == "\xcf\x80", which uses 2 bytes and 1 display column. Note: all of the > + below asserts would be easier to read if we used UTF-8 directly in the > + string constants, but it seems better not to demand the host compiler > + support this, when it isn't otherwise necessary. Instead, whenever an > + extended character appears in a string, we put a line break after it so that > + all succeeding characters can appear visually at the correct display column. > + > + All of these work on the following 1-line source file: > + > + .0000000001111111111222222 display > + .1234567890123456789012345 columns > + "SS_foo = P_bar.SS_fieldP;\n" > + .0000000111111111222222223 byte > + .1356789012456789134567891 columns > + > + which is set up by test_diagnostic_show_locus_one_liner and calls > + them. Here SS represents the two display columns for the U+1F602 emoji and > + P represents the one display column for the U+03C0 pi symbol. */ > + [...snip...] Thanks for exercising all this with selftests. Presumably this involved a big copy-and-paste from the existing selftests. How did you generate the expected output for the various _utf8 selftests? Was it a lot of tedious manual editing, or is there a handy way to do this? (I'm nervous about how much work it will be to update these if e.g. we want to experiment with new ways of printing fix-it hints) > +/* Test of labeling the ranges within a rich_location. */ > + > +static void > +test_one_liner_labels_utf8 () > +{ > + location_t foo > + = make_location (linemap_position_for_column (line_table, 1), > + linemap_position_for_column (line_table, 1), > + linemap_position_for_column (line_table, 8)); > + location_t bar > + = make_location (linemap_position_for_column (line_table, 12), > + linemap_position_for_column (line_table, 12), > + linemap_position_for_column (line_table, 17)); > + location_t field > + = make_location (linemap_position_for_column (line_table, 19), > + linemap_position_for_column (line_table, 19), > + linemap_position_for_column (line_table, 30)); > + > + /* Example where all the labels fit on one line. */ > + { > + text_range_label label0 > + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); > + text_range_label label1 > + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); > + text_range_label label2 > + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" > + "\xcf\x80"); Can you add a comment describing these labels. In particular the label placement code is meant to ensure that labels don't overlap, so I think this is adding coverage that we're computing using display columns when placing labels, since otherwise foo's label would need to be pushed onto a new line to avoid overlapping the other labels. > + gcc_rich_location richloc (foo, &label0); > + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); > + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); > + > + { > + test_diagnostic_context dc; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" > + " | | |\n" > + " \xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80" > + " \xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" > + " \xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82" > + "\xf0\x9f\x98\x82\xcf\x80\xcf\x80\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Verify that we can disable label-printing. */ > + { > + test_diagnostic_context dc; > + dc.show_labels_p = false; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n", > + pp_formatted_text (dc.printer)); > + } This part of the test might be redundant. [...snip...] > + } > + > + /* Example of boundary conditions: label 0 and 1 have just enough clearance, > + but label 1 just touches label 2. */ > + { > + text_range_label label0 ("aaaaa\xf0\x9f\x98\x82\xcf\x80"); > + text_range_label label1 ("bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82"); > + text_range_label label2 ("c"); > + gcc_rich_location richloc (foo, &label0); > + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); > + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); > + > + test_diagnostic_context dc; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" > + " | | |\n" > + " | | c\n" > + " aaaaa\xf0\x9f\x98\x82\xcf\x80" > + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", > + pp_formatted_text (dc.printer)); It's hard to tell from the escaped expected string, but presumably this matches the comment about boundary conditions, right? (compared with the ASCII case). [...snip...] > @@ -3221,13 +3901,16 @@ test_overlapped_fixit_printing (const line_table_case &case_) > /* Unit-test the line_corrections machinery. */ > ASSERT_EQ (3, richloc.get_num_fixit_hints ()); > const fixit_hint *hint_0 = richloc.get_fixit_hint (0); > - ASSERT_EQ (column_range (12, 12), get_affected_columns (hint_0)); > + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, false)); > + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, true)); enums again [...snip...] > @@ -3407,10 +4330,10 @@ test_overlapped_fixit_printing_2 (const line_table_case &case_) > /* These fixits should be accepted; they can't be consolidated. */ > ASSERT_EQ (2, richloc.get_num_fixit_hints ()); > const fixit_hint *hint_0 = richloc.get_fixit_hint (0); > - ASSERT_EQ (column_range (23, 22), get_affected_columns (hint_0)); > + ASSERT_EQ (column_range (23, 22), get_affected_range (hint_0, false)); > ASSERT_EQ (column_range (23, 23), get_printed_columns (hint_0)); > const fixit_hint *hint_1 = richloc.get_fixit_hint (1); > - ASSERT_EQ (column_range (21, 20), get_affected_columns (hint_1)); > + ASSERT_EQ (column_range (21, 20), get_affected_range (hint_1, false)); > ASSERT_EQ (column_range (21, 21), get_printed_columns (hint_1)); enums again. [...snip...] > diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c > index 96b6fa30052..8638fbebb2d 100644 > --- a/gcc/diagnostic.c > +++ b/gcc/diagnostic.c > @@ -346,9 +346,13 @@ diagnostic_get_location_text (diagnostic_context *context, > const char *locus_cs = colorize_start (pp_show_color (pp), "locus"); > const char *locus_ce = colorize_stop (pp_show_color (pp)); > const char *file = s.file ? s.file : progname; > - int line = strcmp (file, N_("<built-in>")) ? s.line : 0; > - int col = context->show_column ? s.column : 0; > - > + int line = 0; > + int col = 0; > + if (strcmp (file, N_("<built-in>"))) > + { > + line = s.line; > + col = context->show_column ? location_compute_display_column (s) : 0; > + } Why does the patch use the display column here? Ideally it would be the count of unicode characters, but I think we want to preserve the current behavior of using a byte offset. > const char *line_col = maybe_line_and_column (line, col); > return build_message_string ("%s%s%s:%s", locus_cs, file, > line_col, locus_ce); > diff --git a/gcc/input.c b/gcc/input.c > index 00301ef68dd..d2d99000b84 100644 > --- a/gcc/input.c > +++ b/gcc/input.c > @@ -908,6 +908,18 @@ make_location (location_t caret, source_range src_range) > return COMBINE_LOCATION_DATA (line_table, pure_loc, src_range, NULL); > } > > +int > +location_compute_display_column (expanded_location exploc) > +{ > + if (!(exploc.file && exploc.line && exploc.column)) > + return exploc.column; > + char_span line = location_get_source_line (exploc.file, exploc.line); > + /* If line is NULL, this function returns exploc.column which is the > + desired fallback. */ > + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), > + exploc.column); > +} This new function needs a leading comment (in particular spelling out the "file not found" error-handling). > /* Dump statistics to stderr about the memory usage of the line_table > set of line maps. This also displays some statistics about macro > expansion. */ > @@ -3590,6 +3602,51 @@ test_line_offset_overflow () > ASSERT_NE (ordmap_a, ordmap_b); > } > > +void test_cpp_utf8 () > +{ > + /* Verify that wcwidth of invalid UTF-8 or control bytes is 1. */ > + { > + int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8); > + ASSERT_EQ (8, w_bad); > + int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6); > + ASSERT_EQ (6, w_ctrl); > + } > + > + /* Verify that wcwidth of valid UTF-8 is as expected. */ > + { > + const int w_pi = cpp_display_width ("\xcf\x80", 2); > + ASSERT_EQ (1, w_pi); > + const int w_emoji = cpp_display_width ("\xf0\x9f\x98\x82", 4); > + ASSERT_EQ (2, w_emoji); > + const int w_ascii = cpp_display_width ("GCC", 3); > + ASSERT_EQ (3, w_ascii); > + const int w_mixed > + = cpp_display_width ("\xcf\x80 = 3.14 \xf0\x9f\x98\x82 \x9f!", 17); > + ASSERT_EQ (14, w_mixed); > + } > + > + /* Verify that cpp_byte_column_to_display_column can go past the end, > + and similar edge cases. */ > + { > + const char *str = "\xcf\x80 abc"; > + ASSERT_EQ (5, cpp_display_width (str, 6)); > + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); > + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); > + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); > + } > + > + /* Verify that cpp_display_column_to_byte_column can go past the end, > + and similar edge cases. */ > + { > + const char *str = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; > + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); > + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); > + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); > + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); > + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); I think the two "str" consts could use comments showing the numbering within them, like. Maybe a brute force test for inverse, something like: for (int display_column = 0; display_column < 20; display_column++) { int byte_column = cpp_display_column_to_byte_column (str, 15, display_column); ASSERT_EQ (cpp_byte_column_to_display_column (str, 15, byte_column), display_column); } or similar? What happens if you request a display column that's in the middle of a character? It feels like we ought to have selftest coverage for that. [...snip...] > diff --git a/libcpp/charset.c b/libcpp/charset.c > index 39af77a554a..d1bdff095eb 100644 > --- a/libcpp/charset.c > +++ b/libcpp/charset.c [...snip...] > +/* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc, > + because that will inspect the user's locale, and in particular in an ASCII > + locale, it will not return anything useful for extended characters. But GCC > + in other respects (see e.g. _cpp_default_encoding()) behaves as if > + everything is UTF-8. We also make some tweaks that are useful for the way > + GCC needs to use this data, e.g. tabs and other control characters should be > + treated as having width 1. The lookup tables are generated from > + contrib/unicode/gen_wcwidth.py and were made by simply calling glibc > + wcwidth() on all codepoints, then applying the small tweaks. These tables > + are not highly optimized, but for the present purpose of outputting > + diagnostics, they are sufficient. */ > + > +#include "generated_cpp_wcwidth.h" > +int cpp_wcwidth (cppchar_t c) > +{ > + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) > + return wcwidth_widths[0]; > + > + /* Binary search the tables. */ > + int begin = 1; > + static const int end > + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); > + int len = end - begin; > + do > + { > + int half = len/2; > + int middle = begin + half; > + if (c > wcwidth_range_ends[middle]) > + { > + begin = middle + 1; > + len -= half + 1; > + } > + else > + len = half; > + } while (len); > + > + if (__builtin_expect (begin != end, true)) > + return wcwidth_widths[begin]; > + return 1; > +} Please can you add some unit-testing for this function in selftest form to input.c (i.e. testing a few specific code points). [...snip...] Again, thanks for this patch, and sorry again for the delay in reviewing it. Dave ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-11-19 17:38 ` David Malcolm @ 2019-11-19 18:40 ` Joseph Myers 2019-11-19 22:33 ` Joseph Myers 2019-11-20 16:31 ` Lewis Hyatt 2 siblings, 0 replies; 17+ messages in thread From: Joseph Myers @ 2019-11-19 18:40 UTC (permalink / raw) To: David Malcolm; +Cc: Lewis Hyatt, gcc-patches On Tue, 19 Nov 2019, David Malcolm wrote: > If we're going with this approach, and redistributing those unicode data > files as part of our repo and tarballs, do we need some kind of > copyright/license statement that spells out the situation? What does > glibc do for this? glibc includes the files in localedata/unicode-gen/ directory. My inclination is that we should include them in the GCC sources, but there were concerns about doing so when I asked about that issue when last updating the data used for warnings about normalization of UCNs in identifiers (which I should probably update again - given the work I did last time, this time it should just be a regeneration with newer input files) <https://gcc.gnu.org/ml/gcc-patches/2013-11/msg01932.html>. -- Joseph S. Myers joseph@codesourcery.com ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-11-19 17:38 ` David Malcolm 2019-11-19 18:40 ` Joseph Myers @ 2019-11-19 22:33 ` Joseph Myers 2019-11-20 16:31 ` Lewis Hyatt 2 siblings, 0 replies; 17+ messages in thread From: Joseph Myers @ 2019-11-19 22:33 UTC (permalink / raw) To: David Malcolm; +Cc: Lewis Hyatt, gcc-patches On Tue, 19 Nov 2019, David Malcolm wrote: > If we're going with this approach (which I'll leave to Joseph), perhaps I think reusing the glibc generator is appropriate. -- Joseph S. Myers joseph@codesourcery.com ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-11-19 17:38 ` David Malcolm 2019-11-19 18:40 ` Joseph Myers 2019-11-19 22:33 ` Joseph Myers @ 2019-11-20 16:31 ` Lewis Hyatt 2019-11-20 16:39 ` Lewis Hyatt 2 siblings, 1 reply; 17+ messages in thread From: Lewis Hyatt @ 2019-11-20 16:31 UTC (permalink / raw) To: David Malcolm; +Cc: gcc-patches, joseph [-- Attachment #1: Type: text/plain, Size: 15358 bytes --] On Tue, Nov 19, 2019 at 12:30:39PM -0500, David Malcolm wrote: > Thanks for posting this patch; I'm sorry about how long it's taken me > to review it. > Thank you very much for the thorough review and the great suggestions. I know it was a lot to look through... I attached an updated patch that incorporates your comments. I also put some more responses inline below. > BTW, have you done GCC contributor paperwork? > https://gcc.gnu.org/contribute.html#legal > Yes, all set there. > > diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py > > new file mode 100755 > > index 00000000000..02b28bcedcf > > --- /dev/null > > +++ b/contrib/unicode/gen_wcwidth.py > > [...snip...] > > If we're going with this approach (which I'll leave to Joseph), perhaps > this directory should have a brief README (covering much of the material > you've mentioned in the email with the patch, talking about syncing with > glibc, regenerating the data, etc). > I took a stab at that in this revised patch. > > diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c > The patch uses a bool in many places to indicate what kind of column is > being referred to. I think an enum would be more typesafe and > self-documenting - perhaps: > "enum column_unit" with values CU_BYTES, CU_DISPLAY_COLUMN? or > "enum column_kind" with values CK_BYTES, CK_DISPLAY_COLUMN? > I wonder if this might eventually grow a third value, representing the > a count of unicode characters, but that's out of scope for this patch. > That's a good idea, yeah, done. > I should confess that it took me a while to realize the whole > multi-column display thing (I had an "aha" moment, then felt rather > foolish, given that I'd been playing with the examples in the PR; it was > on reading through the ASCII art in the new selftests and going "huh" > that I had my epiphany on the problem your patch is solving). > > I think this file could use a high-level introductory comment at the top > talking about the various meanings of "column". I liked the two example > code points you used below, so perhaps have a comment up at the top > talking about the distinction between byte vs display column, using > those code points as examples (and a plain ASCII character, by way of > contrast). Perhaps have the comment describing the enum be the big > introductory comment. > > It would be good for that introductory comment to have a copy of the > ASCII art you used in the selftests below, or similar. > Done, I beefed up the introductory comments as you suggested. > > @@ -120,10 +143,17 @@ class layout_point > > linenum_type m_line; > > int m_column; > > + int m_display_col; > > Does it simplify things if this is an array accessed via the enum? > (not sure, just a thought that occurred to me) > I think on balance it is simpler with the array, yeah. Done. > > @@ -574,20 +621,23 @@ test_layout_range_for_single_point () > > > > /* Tests for layout_range::contains_point. */ > > > > - /* Before the line. */ > > - ASSERT_FALSE (point.contains_point (6, 1)); > > + for (int use_display = 0; use_display <= 1; ++use_display) > > + { > > + /* Before the line. */ > > + ASSERT_FALSE (point.contains_point (6, 1, use_display)); > > [...snip...] > > Here you generalize the layout_range tests to iterate over both > meanings of "column". > > If I'm reading things right, implicit here is that the layout_point > ctors within the layout range are now calling: > m_display_col (location_compute_display_column (exploc)) > which in this selftest is looking for a file named "test.c", > presumably not finding it, and hitting the case of a NULL "line" > char_span. > > So if there happens to be a test.c in the current directory > containing the "right" characters, this selftest could break. > > Previously it's never mattered to this selftest whether or not > there was an actual test.c, so it might be good to modify it > to use temp_source_file (and maybe even to have some multicolumn > chars in it, though that might be taking things too far). > Assuming we're comfortable that the other selftests exercise the multibyte logic sufficiently, it seems simplest just to use an empty string rather than "test.c", since nothing is actually expecting to read a file here. I did that for now, and also made sure that location_get_display_column() will not try to open an empty filename either. > > static int > > get_line_width_without_trailing_whitespace (const char *line, int line_width) > > Why is get_line_width_without_trailing_whitespace done in bytes? > It's used for calculating the maximum number of printed columns, to try > to cope with extra wide source lines, offsetting things to fit within the width > of the user's terminal. > It's used in two places. Once in the layout::layout() constructor to compute the m_x_offset in display columns for wide lines, and then again in layout::print_source_line(), which handles printing arbitrary source lines, not necessarily the primary line that was inspected in the constructor. So the m_x_offset needs to be in display column units, that are then translated back to bytes for each different line to which it applies. For this it seemed most convenient for get_line_width_without_trailing_whitespace() to return the bytes offset, since that's what we need in layout::print_source_line() to find the end of the line. > > @@ -1415,9 +1498,11 @@ class line_label > > public: > > line_label (int state_idx, int column, label_text text) > > : m_state_idx (state_idx), m_column (column), > > - m_text (text), m_length (strlen (text.m_buffer)), > > - m_label_line (0) > > - {} > > + m_text (text), m_label_line (0) > > + { > > + const int bytes = strlen (text.m_buffer); > > + m_length = cpp_display_width (text.m_buffer, bytes); > > + } > > Please rename m_length to m_display_width, given that it's changing meaning. > > Done. > > @@ -1825,7 +1938,8 @@ public: > > > > /* The text to be inserted/used as replacement. */ > > char *m_text; > > - size_t m_len; > > + size_t m_bytes; > > How about: > > size_t m_byte_length; /* not including 0-terminator. */ > > ? > Done. > > @@ -1947,7 +2062,7 @@ line_corrections::add_hint (const fixit_hint *hint) > > /* Consolidate into the last correction: > > add a no-op "replace" of the "between" text, and > > add the text from the new hint. */ > > - int old_len = last_correction->m_len; > > + int old_len = last_correction->m_bytes; > > Maybe rename to old_len, new_len to old_byte_len, new_byte_len? > Done. > Thanks for exercising all this with selftests. > > Presumably this involved a big copy-and-paste from the existing > selftests. > > How did you generate the expected output for the various _utf8 > selftests? Was it a lot of tedious manual editing, or is there a handy > way to do this? (I'm nervous about how much work it will be to update > these if e.g. we want to experiment with new ways of printing fix-it > hints) > I just went through the existing tests one by one and adapted them manually. I made them with the actual UTF-8 chars initially so that it made sense visually, and then replaced to hex escapes and aligned the lines manually at the end. Wasn't so bad this way. I don't think it would have been especially easy to automate because there were some non-mechanical adjustments made, e.g. to make sure to exercise edge cases like where two strings would overlap in byte units, but not in display units. I feel like it wouldn't be necessary to add UTF-8 duplicates of all new future tests, hopefully -- rather could just insure that all new test cases include a multibyte character or two? Anyway I am happy to help with that if it comes up in the future too. > > + /* Example where all the labels fit on one line. */ > > + { > > + text_range_label label0 > > + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); > > + text_range_label label1 > > + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); > > + text_range_label label2 > > + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" > > + "\xcf\x80"); > > Can you add a comment describing these labels. > In particular the label placement code is meant to ensure that labels > don't overlap, so I think this is adding coverage that we're computing > using display columns when placing labels, since otherwise foo's label > would need to be pushed onto a new line to avoid overlapping the other > labels. > Done. > > + /* Verify that we can disable label-printing. */ > > + { > > + test_diagnostic_context dc; > > + dc.show_labels_p = false; > > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > > + ASSERT_STREQ ("\n" > > + " \xf0\x9f\x98\x82" > > + "_foo = \xcf\x80" > > + "_bar.\xf0\x9f\x98\x82" > > + "_field\xcf\x80" > > + ";\n" > > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n", > > + pp_formatted_text (dc.printer)); > > + } > > This part of the test might be redundant. > Agreed, I removed it. > > + ASSERT_STREQ ("\n" > > + " \xf0\x9f\x98\x82" > > + "_foo = \xcf\x80" > > + "_bar.\xf0\x9f\x98\x82" > > + "_field\xcf\x80" > > + ";\n" > > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" > > + " | | |\n" > > + " | | c\n" > > + " aaaaa\xf0\x9f\x98\x82\xcf\x80" > > + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", > > + pp_formatted_text (dc.printer)); > > It's hard to tell from the escaped expected string, but presumably this > matches the comment about boundary conditions, right? (compared with > the ASCII case). > Correct. What I found useful for testing, was just to add an extra character to the expected string to make the test fail. Then the expected output goes to stderr the way it should look with the actual extended characters, and you can verify it tests what was intended. > > diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c > > index 96b6fa30052..8638fbebb2d 100644 > > --- a/gcc/diagnostic.c > > +++ b/gcc/diagnostic.c > > @@ -346,9 +346,13 @@ diagnostic_get_location_text (diagnostic_context *context, > > const char *locus_cs = colorize_start (pp_show_color (pp), "locus"); > > const char *locus_ce = colorize_stop (pp_show_color (pp)); > > const char *file = s.file ? s.file : progname; > > - int line = strcmp (file, N_("<built-in>")) ? s.line : 0; > > - int col = context->show_column ? s.column : 0; > > - > > + int line = 0; > > + int col = 0; > > + if (strcmp (file, N_("<built-in>"))) > > + { > > + line = s.line; > > + col = context->show_column ? location_compute_display_column (s) : 0; > > + } > > Why does the patch use the display column here? > > Ideally it would be the count of unicode characters, but I think we want > to preserve the current behavior of using a byte offset. > So that column number was actually the original motivation for the PR 49973 from several years ago. It seems to me that the discussion there concluded that the column number should be the display column (Joseph's comment https://gcc.gnu.org/bugzilla/show_bug.cgi?id=49973#c10). It makes sense to me that this column should match what you see in your editor, which would be the display column, but I don't know if some standards have evolved here. > > +int > > +location_compute_display_column (expanded_location exploc) > > +{ > > + if (!(exploc.file && exploc.line && exploc.column)) > > + return exploc.column; > > + char_span line = location_get_source_line (exploc.file, exploc.line); > > + /* If line is NULL, this function returns exploc.column which is the > > + desired fallback. */ > > + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), > > + exploc.column); > > +} > > This new function needs a leading comment (in particular spelling out the > "file not found" error-handling). Done. > > + const char *str = "\xcf\x80 abc"; > > + ASSERT_EQ (5, cpp_display_width (str, 6)); > > + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); > > + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); > > + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); > > + } > > + > > + /* Verify that cpp_display_column_to_byte_column can go past the end, > > + and similar edge cases. */ > > + { > > + const char *str = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; > > + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); > > + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); > > + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); > > + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); > > + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); > > I think the two "str" consts could use comments showing the numbering > within them, like. > Done. > Maybe a brute force test for inverse, something like: > > for (int display_column = 0; display_column < 20; display_column++) > { > int byte_column = cpp_display_column_to_byte_column (str, 15, display_column); > ASSERT_EQ (cpp_byte_column_to_display_column (str, 15, byte_column), > display_column); > } > > or similar? > > What happens if you request a display column that's in the middle of a > character? It feels like we ought to have selftest coverage for that. > In this case the UTF-8 conversion fails so it treats each byte as a display width of 1, basically falling back to the existing behavior of GCC whenever things don't make sense. I added a selftest for the round-trip conversion as you suggested; this test needs to make an exception for partial codepoints, so it tests both things effectively. > > +int cpp_wcwidth (cppchar_t c) > > +{ > > + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) > > + return wcwidth_widths[0]; > > + > > + /* Binary search the tables. */ > > + int begin = 1; > > + static const int end > > + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); > > + int len = end - begin; > > + do > > + { > > + int half = len/2; > > + int middle = begin + half; > > + if (c > wcwidth_range_ends[middle]) > > + { > > + begin = middle + 1; > > + len -= half + 1; > > + } > > + else > > + len = half; > > + } while (len); > > + > > + if (__builtin_expect (begin != end, true)) > > + return wcwidth_widths[begin]; > > + return 1; > > +} > > Please can you add some unit-testing for this function in selftest form to input.c > (i.e. testing a few specific code points). > > [...snip...] The second block of test_cpp_utf() in input.c contained tests for a couple codepoints already (pi, an emoji, ascii, and invalid utf8). I added a couple more specific codepoints, something from latin-1, a combining character, and a Chinese character. Please let me know if that seems good now or if there should be more. It's easy enough to add more. > > Again, thanks for this patch, and sorry again for the delay in reviewing it. Thanks for your time, I appreciate it! I think it would be great if this can get in for GCC 10, since otherwise the new support for UTF-8 identifiers would feel rather incomplete. -Lewis [-- Attachment #2: ChangeLog.txt --] [-- Type: text/plain, Size: 4512 bytes --] /ChangeLog 2019-11-20 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * contrib/unicode/from_glibc/unicode_utils.py: Support script from glibc (commit 464cd3) to extract character widths from Unicode data files. * contrib/unicode/from_glibc/utf8_gen.py: Likewise. * contrib/unicode/UnicodeData.txt: Unicode v. 12.1.0 data file. * contrib/unicode/EastAsianWidth.txt: Likewise. * contrib/unicode/PropList.txt: Likewise. * contrib/unicode/gen_wcwidth.py: New utility to generate libcpp/generated_cpp_wcwidth.h with help from the glibc support scripts and the Unicode data files. * contrib/unicode/README: New explanatory file. libcpp/ChangeLog 2019-11-20 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * generated_cpp_wcwidth.h: New file generated by ../contrib/unicode/gen_wcwidth.py, supports new cpp_wcwidth function. * charset.c (compute_next_display_width): New function to help implement display columns. (cpp_byte_column_to_display_column): Likewise. (cpp_display_column_to_byte_column): Likewise. (cpp_wcwidth): Likewise. * include/cpplib.h (cpp_byte_column_to_display_column): Declare. (cpp_display_column_to_byte_column): Declare. (cpp_wcwidth): Declare. (cpp_display_width): New function. gcc/ChangeLog 2019-11-20 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * input.c (location_compute_display_column): New function to help with multibyte awareness in diagnostics. (test_cpp_utf8): New self-test. (input_c_tests): Call the new test. * input.h (location_compute_display_column): Declare. * diagnostic.c (diagnostic_get_location_text): Use it to output the correct column number on diagnostics for source lines containing multibyte characters. * diagnostic-show-locus.c: Pervasive changes to add multibyte awareness to all classes and functions. (enum column_unit): New enum. (class exploc_with_display_col): New class. (class layout_point): Convert m_column member to array m_columns[2]. (layout_range::contains_point): Add col_unit argument. (test_layout_range_for_single_point): Pass new argument. (test_layout_range_for_single_line): Likewise. (test_layout_range_for_multiple_lines): Likewise. (line_bounds::convert_to_display_cols): New function. (layout::get_state_at_point): Add col_unit argument. (make_range): Use empty filename rather than dummy filename. (class layout): m_exploc changed to exploc_with_display_col from plain expanded_location. (layout::layout): Add multibyte awareness. (layout::print_source_line): Likewise. (layout::print_line): Likewise. (layout::print_annotation_line): Likewise. (line_label::line_label): Likewise. (layout::print_any_labels): Likewise. (layout::annotation_line_showed_range_p): Likewise. (get_printed_columns): Likewise. (class line_label): Rename m_length to m_display_width. (get_affected_columns): Rename to... (get_affected_range): ...this; add col_unit argument and multibyte awareness. (class correction): Add m_affected_bytes and m_display_cols members. Rename m_len to m_byte_length for clarity. Add multibyte awareness throughout. (correction::insertion_p): Add multibyte awareness. (correction::compute_display_cols): New function. (correction::ensure_terminated): Use new member name m_byte_length. (line_corrections::add_hint): Add multibyte awareness. (layout::print_trailing_fixits): Likewise. (layout::get_x_bound_for_row): Likewise. (test_one_liner_simple_caret_utf8): New self-test analogous to the one with _utf8 suffix removed, testing multibyte awareness. (test_one_liner_caret_and_range_utf8): Likewise. (test_one_liner_multiple_carets_and_ranges_utf8): Likewise. (test_one_liner_fixit_insert_before_utf8): Likewise. (test_one_liner_fixit_insert_after_utf8): Likewise. (test_one_liner_fixit_remove_utf8): Likewise. (test_one_liner_fixit_replace_utf8): Likewise. (test_one_liner_fixit_replace_non_equal_range_utf8): Likewise. (test_one_liner_fixit_replace_equal_secondary_range_utf8): Likewise. (test_one_liner_fixit_validation_adhoc_locations_utf8): Likewise. (test_one_liner_many_fixits_1_utf8): Likewise. (test_one_liner_many_fixits_2_utf8): Likewise. (test_one_liner_labels_utf8): Likewise. (test_diagnostic_show_locus_one_liner_utf8): Likewise. (test_overlapped_fixit_printing_utf8): Likewise. (test_overlapped_fixit_printing): Adapt for changes to get_affected_columns, get_printed_columns and class corrections. (test_overlapped_fixit_printing_2): Likewise. (diagnostic_show_locus_c_tests): Call new tests. [-- Attachment #3: display_cols_v3.patch --] [-- Type: text/x-patch, Size: 132862 bytes --] diff --git a/contrib/unicode/README b/contrib/unicode/README new file mode 100644 index 00000000000..fbee919647b --- /dev/null +++ b/contrib/unicode/README @@ -0,0 +1,36 @@ +This directory contains a mechanism for GCC to have its own internal +implementation of wcwidth functionality. (cpp_wcwidth () in libcpp/charset.c). + +The idea is to produce the necessary lookup table +(../../libcpp/generated_cpp_wcwidth.h) in a reproducible way, starting from the +following files that are distributed by the Unicode Consortium: + +ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt +ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt +ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt + +These three files have been added to source control in this directory. + +In order to keep in sync with glibc's wcwidth as much as possible, it is +desirable for the logic that processes the Unicode data to be the same as +glibc's. To that end, we also put in this directory, in the from_glibc/ +directory, the glibc python code that implements their logic. This code was +copied verbatim from glibc, and it can be updated at any time from the glibc +source code repository. + +Finally, the script gen_wcwidth.py found here contains the GCC-specific code to +map glibc's output to the lookup tables we require. This script should not need +to change, unless there are structural changes to the Unicode data files or to +the glibc code. + +The procedure to update GCC's wcwidth tables is the following: + +1. Update the three Unicode data files from the above URLs. + +2. Update the two glibc files in from_glibc/ from glibc's git. + +3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_wcwidth.h + (where X.Y is the version of the Unicode standard corresponding to the + Unicode data files being used, most recently, 12.0). + +After that, GCC's wcwidth will match the most recent glibc. diff --git a/contrib/unicode/from_glibc/unicode_utils.py b/contrib/unicode/from_glibc/unicode_utils.py new file mode 100644 index 00000000000..a9e94cce418 --- /dev/null +++ b/contrib/unicode/from_glibc/unicode_utils.py @@ -0,0 +1,527 @@ +# Utilities to generate Unicode data for glibc from upstream Unicode data. +# +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +''' +This module contains utilities used by the scripts to generate +Unicode data for glibc from upstream Unicode data files. +''' + +import sys +import re + + +# Common locale header. +COMMENT_HEADER = """ +% This file is part of the GNU C Library and contains locale data. +% The Free Software Foundation does not claim any copyright interest +% in the locale data contained in this file. The foregoing does not +% affect the license of the GNU C Library as a whole. It does not +% exempt you from the conditions of the license if your use would +% otherwise be governed by that license. +""" + +# Dictionary holding the entire contents of the UnicodeData.txt file +# +# Contents of this dictionary look like this: +# +# {0: {'category': 'Cc', +# 'title': None, +# 'digit': '', +# 'name': '<control>', +# 'bidi': 'BN', +# 'combining': '0', +# 'comment': '', +# 'oldname': 'NULL', +# 'decomposition': '', +# 'upper': None, +# 'mirrored': 'N', +# 'lower': None, +# 'decdigit': '', +# 'numeric': ''}, +# … +# } +UNICODE_ATTRIBUTES = {} + +# Dictionary holding the entire contents of the DerivedCoreProperties.txt file +# +# Contents of this dictionary look like this: +# +# {917504: ['Default_Ignorable_Code_Point'], +# 917505: ['Case_Ignorable', 'Default_Ignorable_Code_Point'], +# … +# } +DERIVED_CORE_PROPERTIES = {} + +# Dictionary holding the entire contents of the EastAsianWidths.txt file +# +# Contents of this dictionary look like this: +# +# {0: 'N', … , 45430: 'W', …} +EAST_ASIAN_WIDTHS = {} + +def fill_attribute(code_point, fields): + '''Stores in UNICODE_ATTRIBUTES[code_point] the values from the fields. + + One entry in the UNICODE_ATTRIBUTES dictionary represents one line + in the UnicodeData.txt file. + + ''' + UNICODE_ATTRIBUTES[code_point] = { + 'name': fields[1], # Character name + 'category': fields[2], # General category + 'combining': fields[3], # Canonical combining classes + 'bidi': fields[4], # Bidirectional category + 'decomposition': fields[5], # Character decomposition mapping + 'decdigit': fields[6], # Decimal digit value + 'digit': fields[7], # Digit value + 'numeric': fields[8], # Numeric value + 'mirrored': fields[9], # mirrored + 'oldname': fields[10], # Old Unicode 1.0 name + 'comment': fields[11], # comment + # Uppercase mapping + 'upper': int(fields[12], 16) if fields[12] else None, + # Lowercase mapping + 'lower': int(fields[13], 16) if fields[13] else None, + # Titlecase mapping + 'title': int(fields[14], 16) if fields[14] else None, + } + +def fill_attributes(filename): + '''Stores the entire contents of the UnicodeData.txt file + in the UNICODE_ATTRIBUTES dictionary. + + A typical line for a single code point in UnicodeData.txt looks + like this: + + 0041;LATIN CAPITAL LETTER A;Lu;0;L;;;;;N;;;;0061; + + Code point ranges are indicated by pairs of lines like this: + + 4E00;<CJK Ideograph, First>;Lo;0;L;;;;;N;;;;; + 9FCC;<CJK Ideograph, Last>;Lo;0;L;;;;;N;;;;; + ''' + with open(filename, mode='r') as unicode_data_file: + fields_start = [] + for line in unicode_data_file: + fields = line.strip().split(';') + if len(fields) != 15: + sys.stderr.write( + 'short line in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + if fields[2] == 'Cs': + # Surrogates are UTF-16 artefacts, + # not real characters. Ignore them. + fields_start = [] + continue + if fields[1].endswith(', First>'): + fields_start = fields + fields_start[1] = fields_start[1].split(',')[0][1:] + continue + if fields[1].endswith(', Last>'): + fields[1] = fields[1].split(',')[0][1:] + if fields[1:] != fields_start[1:]: + sys.stderr.write( + 'broken code point range in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + for code_point in range( + int(fields_start[0], 16), + int(fields[0], 16)+1): + fill_attribute(code_point, fields) + fields_start = [] + continue + fill_attribute(int(fields[0], 16), fields) + fields_start = [] + +def fill_derived_core_properties(filename): + '''Stores the entire contents of the DerivedCoreProperties.txt file + in the DERIVED_CORE_PROPERTIES dictionary. + + Lines in DerivedCoreProperties.txt are either a code point range like + this: + + 0061..007A ; Lowercase # L& [26] LATIN SMALL LETTER A..LATIN SMALL LETTER Z + + or a single code point like this: + + 00AA ; Lowercase # Lo FEMININE ORDINAL INDICATOR + + ''' + with open(filename, mode='r') as derived_core_properties_file: + for line in derived_core_properties_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + + r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + + r'\s*;\s*(?P<property>[a-zA-Z_]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + prop = match.group('property') + if code_point in DERIVED_CORE_PROPERTIES: + DERIVED_CORE_PROPERTIES[code_point].append(prop) + else: + DERIVED_CORE_PROPERTIES[code_point] = [prop] + +def fill_east_asian_widths(filename): + '''Stores the entire contents of the EastAsianWidths.txt file + in the EAST_ASIAN_WIDTHS dictionary. + + Lines in EastAsianWidths.txt are either a code point range like + this: + + 9FCD..9FFF;W # Cn [51] <reserved-9FCD>..<reserved-9FFF> + + or a single code point like this: + + A015;W # Lm YI SYLLABLE WU + ''' + with open(filename, mode='r') as east_asian_widths_file: + for line in east_asian_widths_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + +r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + +r'\s*;\s*(?P<property>[a-zA-Z]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + EAST_ASIAN_WIDTHS[code_point] = match.group('property') + +def to_upper(code_point): + '''Returns the code point of the uppercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['upper']): + return UNICODE_ATTRIBUTES[code_point]['upper'] + else: + return code_point + +def to_lower(code_point): + '''Returns the code point of the lowercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['lower']): + return UNICODE_ATTRIBUTES[code_point]['lower'] + else: + return code_point + +def to_upper_turkish(code_point): + '''Returns the code point of the Turkish uppercase version + of the given code point''' + if code_point == 0x0069: + return 0x0130 + return to_upper(code_point) + +def to_lower_turkish(code_point): + '''Returns the code point of the Turkish lowercase version + of the given code point''' + if code_point == 0x0049: + return 0x0131 + return to_lower(code_point) + +def to_title(code_point): + '''Returns the code point of the titlecase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['title']): + return UNICODE_ATTRIBUTES[code_point]['title'] + else: + return code_point + +def is_upper(code_point): + '''Checks whether the character with this code point is uppercase''' + return (to_lower(code_point) != code_point + or (code_point in DERIVED_CORE_PROPERTIES + and 'Uppercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_lower(code_point): + '''Checks whether the character with this code point is lowercase''' + # Some characters are defined as “Lowercase†in + # DerivedCoreProperties.txt but do not have a mapping to upper + # case. For example, ꜰ U+A72F “LATIN LETTER SMALL CAPITAL F†is + # one of these. + return (to_upper(code_point) != code_point + # <U00DF> is lowercase, but without simple to_upper mapping. + or code_point == 0x00DF + or (code_point in DERIVED_CORE_PROPERTIES + and 'Lowercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_alpha(code_point): + '''Checks whether the character with this code point is alphabetic''' + return ((code_point in DERIVED_CORE_PROPERTIES + and + 'Alphabetic' in DERIVED_CORE_PROPERTIES[code_point]) + or + # Consider all the non-ASCII digits as alphabetic. + # ISO C 99 forbids us to have them in category “digitâ€, + # but we want iswalnum to return true on them. + (UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd' + and not (code_point >= 0x0030 and code_point <= 0x0039))) + +def is_digit(code_point): + '''Checks whether the character with this code point is a digit''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd') + # Note: U+0BE7..U+0BEF and U+1369..U+1371 are digit systems without + # a zero. Must add <0> in front of them by hand. + else: + # SUSV2 gives us some freedom for the "digit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.5: + # The iswdigit function tests for any wide character that + # corresponds to a decimal-digit character (as defined in 5.2.1). + # 5.2.1: + # the 10 decimal digits 0 1 2 3 4 5 6 7 8 9 + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_outdigit(code_point): + '''Checks whether the character with this code point is outdigit''' + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_blank(code_point): + '''Checks whether the character with this code point is blank''' + return (code_point == 0x0009 # '\t' + # Category Zs without mention of '<noBreak>' + or (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Zs' + and '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])) + +def is_space(code_point): + '''Checks whether the character with this code point is a space''' + # Don’t make U+00A0 a space. Non-breaking space means that all programs + # should treat it like a punctuation character, not like a space. + return (code_point == 0x0020 # ' ' + or code_point == 0x000C # '\f' + or code_point == 0x000A # '\n' + or code_point == 0x000D # '\r' + or code_point == 0x0009 # '\t' + or code_point == 0x000B # '\v' + # Categories Zl, Zp, and Zs without mention of "<noBreak>" + or (UNICODE_ATTRIBUTES[code_point]['name'] + and + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'] + or + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zs'] + and + '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])))) + +def is_cntrl(code_point): + '''Checks whether the character with this code point is + a control character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and (UNICODE_ATTRIBUTES[code_point]['name'] == '<control>' + or + UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'])) + +def is_xdigit(code_point): + '''Checks whether the character with this code point is + a hexadecimal digit''' + if False: + return (is_digit(code_point) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + else: + # SUSV2 gives us some freedom for the "xdigit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.12: + # The iswxdigit function tests for any wide character that + # corresponds to a hexadecimal-digit character (as defined + # in 6.4.4.1). + # 6.4.4.1: + # hexadecimal-digit: one of + # 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F + return ((code_point >= 0x0030 and code_point <= 0x0039) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + +def is_graph(code_point): + '''Checks whether the character with this code point is + a graphical character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and not is_space(code_point)) + +def is_print(code_point): + '''Checks whether the character with this code point is printable''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and UNICODE_ATTRIBUTES[code_point]['category'] not in ['Zl', 'Zp']) + +def is_punct(code_point): + '''Checks whether the character with this code point is punctuation''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'].startswith('P')) + else: + # The traditional POSIX definition of punctuation is every graphic, + # non-alphanumeric character. + return (is_graph(code_point) + and not is_alpha(code_point) + and not is_digit(code_point)) + +def is_combining(code_point): + '''Checks whether the character with this code point is + a combining character''' + # Up to Unicode 3.0.1 we took the Combining property from the PropList.txt + # file. In 3.0.1 it was identical to the union of the general categories + # "Mn", "Mc", "Me". In Unicode 3.1 this property has been dropped from the + # PropList.txt file, so we take the latter definition. + return (UNICODE_ATTRIBUTES[code_point]['name'] + and + UNICODE_ATTRIBUTES[code_point]['category'] in ['Mn', 'Mc', 'Me']) + +def is_combining_level3(code_point): + '''Checks whether the character with this code point is + a combining level3 character''' + return (is_combining(code_point) + and + int(UNICODE_ATTRIBUTES[code_point]['combining']) in range(0, 200)) + +def ucs_symbol(code_point): + '''Return the UCS symbol string for a Unicode character.''' + if code_point < 0x10000: + return '<U{:04X}>'.format(code_point) + else: + return '<U{:08X}>'.format(code_point) + +def ucs_symbol_range(code_point_low, code_point_high): + '''Returns a string UCS symbol string for a code point range. + + Example: + + <U0041>..<U005A> + ''' + return ucs_symbol(code_point_low) + '..' + ucs_symbol(code_point_high) + +def verifications(): + '''Tests whether the is_* functions observe the known restrictions''' + for code_point in sorted(UNICODE_ATTRIBUTES): + # toupper restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_upper(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but toupper(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_upper(code_point)}) + # tolower restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_lower(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but tolower(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_lower(code_point)}) + # alpha restriction: "Characters classified as either upper or lower + # shall automatically belong to this class. + if ((is_lower(code_point) or is_upper(code_point)) + and not is_alpha(code_point)): + sys.stderr.write('%(sym)s is upper|lower but not alpha\n' %{ + 'sym': ucs_symbol(code_point)}) + # alpha restriction: “No character specified for the keywords cntrl, + # digit, punct or space shall be specified.†+ if (is_alpha(code_point) and is_cntrl(code_point)): + sys.stderr.write('%(sym)s is alpha and cntrl\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is alpha and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is alpha and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_space(code_point)): + sys.stderr.write('%(sym)s is alpha and space\n' %{ + 'sym': ucs_symbol(code_point)}) + # space restriction: “No character specified for the keywords upper, + # lower, alpha, digit, graph or xdigit shall be specified.†+ # upper, lower, alpha already checked above. + if (is_space(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is space and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is space and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is space and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # cntrl restriction: “No character specified for the keywords upper, + # lower, alpha, digit, punct, graph, print or xdigit shall be + # specified.†upper, lower, alpha already checked above. + if (is_cntrl(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is cntrl and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is cntrl and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is cntrl and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_print(code_point)): + sys.stderr.write('%(sym)s is cntrl and print\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is cntrl and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # punct restriction: “No character specified for the keywords upper, + # lower, alpha, digit, cntrl, xdigit or as the <space> character shall + # be specified.†upper, lower, alpha, cntrl already checked above. + if (is_punct(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is punct and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is punct and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and code_point == 0x0020): + sys.stderr.write('%(sym)s is punct\n' %{ + 'sym': ucs_symbol(code_point)}) + # graph restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # print restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # graph - print relation: differ only in the <space> character. + # How is this possible if there are more than one space character?! + # I think susv2/xbd/locale.html should speak of “space charactersâ€, + # not “space characterâ€. + if (is_print(code_point) + and not (is_graph(code_point) or is_space(code_point))): + sys.stderr.write('%(sym)s is print but not graph|<space>\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) + if (not is_print(code_point) + and (is_graph(code_point) or code_point == 0x0020)): + sys.stderr.write('%(sym)s is graph|<space> but not print\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) diff --git a/contrib/unicode/from_glibc/utf8_gen.py b/contrib/unicode/from_glibc/utf8_gen.py new file mode 100755 index 00000000000..0e5583cd259 --- /dev/null +++ b/contrib/unicode/from_glibc/utf8_gen.py @@ -0,0 +1,364 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +'''glibc/localedata/charmaps/UTF-8 file generator script + +This script generates a glibc/localedata/charmaps/UTF-8 file +from Unicode data. + +Usage: python3 utf8_gen.py UnicodeData.txt EastAsianWidth.txt + +It will output UTF-8 file +''' + +import argparse +import sys +import re +import unicode_utils + +# Auxiliary tables for Hangul syllable names, see the Unicode 3.0 book, +# sections 3.11 and 4.4. + +JAMO_INITIAL_SHORT_NAME = ( + 'G', 'GG', 'N', 'D', 'DD', 'R', 'M', 'B', 'BB', 'S', 'SS', '', 'J', 'JJ', + 'C', 'K', 'T', 'P', 'H' +) + +JAMO_MEDIAL_SHORT_NAME = ( + 'A', 'AE', 'YA', 'YAE', 'EO', 'E', 'YEO', 'YE', 'O', 'WA', 'WAE', 'OE', + 'YO', 'U', 'WEO', 'WE', 'WI', 'YU', 'EU', 'YI', 'I' +) + +JAMO_FINAL_SHORT_NAME = ( + '', 'G', 'GG', 'GS', 'N', 'NI', 'NH', 'D', 'L', 'LG', 'LM', 'LB', 'LS', + 'LT', 'LP', 'LH', 'M', 'B', 'BS', 'S', 'SS', 'NG', 'J', 'C', 'K', 'T', + 'P', 'H' +) + +def process_range(start, end, outfile, name): + '''Writes a range of code points into the CHARMAP section of the + output file + + ''' + if 'Hangul Syllable' in name: + # from glibc/localedata/ChangeLog: + # + # 2000-09-24 Bruno Haible <haible@clisp.cons.org> + # * charmaps/UTF-8: Expand <Hangul Syllable> and <Private Use> ranges, + # so they become printable and carry a width. Comment out surrogate + # ranges. Add a WIDTH table + # + # So we expand the Hangul Syllables here: + for i in range(int(start, 16), int(end, 16)+1 ): + index2, index3 = divmod(i - 0xaC00, 28) + index1, index2 = divmod(index2, 21) + hangul_syllable_name = 'HANGUL SYLLABLE ' \ + + JAMO_INITIAL_SHORT_NAME[index1] \ + + JAMO_MEDIAL_SHORT_NAME[index2] \ + + JAMO_FINAL_SHORT_NAME[index3] + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), convert_to_hex(i), + hangul_syllable_name)) + return + # UnicodeData.txt file has contains code point ranges like this: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + # + # The glibc UTF-8 file splits ranges like these into shorter + # ranges of 64 code points each: + # + # <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + # … + # <U4D80>..<U4DB5> /xe4/xb6/x80 <CJK Ideograph Extension A> + for i in range(int(start, 16), int(end, 16), 64 ): + if i > (int(end, 16)-64): + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(int(end,16)), + convert_to_hex(i), + name)) + break + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(i+63), + convert_to_hex(i), + name)) + +def process_charmap(flines, outfile): + '''This function takes an array which contains *all* lines of + of UnicodeData.txt and write lines to outfile as used in the + + CHARMAP + … + END CHARMAP + + section of the UTF-8 file in glibc/localedata/charmaps/UTF-8. + + Samples for input lines: + + 0010;<control>;Cc;0;BN;;;;;N;DATA LINK ESCAPE;;;; + 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + D800;<Non Private Use High Surrogate, First>;Cs;0;L;;;;;N;;;;; + DB7F;<Non Private Use High Surrogate, Last>;Cs;0;L;;;;;N;;;;; + 100000;<Plane 16 Private Use, First>;Co;0;L;;;;;N;;;;; + 10FFFD;<Plane 16 Private Use, Last>;Co;0;L;;;;;N;;;;; + + Samples for output lines (Unicode-Value UTF-8-HEX Unicode-Char-Name): + + <U0010> /x10 DATA LINK ESCAPE + <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + %<UD800> /xed/xa0/x80 <Non Private Use High Surrogate, First> + %<UDB7F> /xed/xad/xbf <Non Private Use High Surrogate, Last> + <U0010FFC0>..<U0010FFFD> /xf4/x8f/xbf/x80 <Plane 16 Private Use> + + ''' + fields_start = [] + for line in flines: + fields = line.split(";") + # Some characters have “<control>†as their name. We try to + # use the “Unicode 1.0 Name†(10th field in + # UnicodeData.txt) for them. + # + # The Characters U+0080, U+0081, U+0084 and U+0099 have + # “<control>†as their name but do not even have aa + # â€Unicode 1.0 Nameâ€. We could write code to take their + # alternate names from NameAliases.txt. + if fields[1] == "<control>" and fields[10]: + fields[1] = fields[10] + # Handling code point ranges like: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + if fields[1].endswith(', First>') and not 'Surrogate,' in fields[1]: + fields_start = fields + continue + if fields[1].endswith(', Last>') and not 'Surrogate,' in fields[1]: + process_range(fields_start[0], fields[0], + outfile, fields[1][:-7]+'>') + fields_start = [] + continue + fields_start = [] + if 'Surrogate,' in fields[1]: + # Comment out the surrogates in the UTF-8 file. + # One could of course skip them completely but + # the original UTF-8 file in glibc had them as + # comments, so we keep these comment lines. + outfile.write('%') + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(int(fields[0], 16)), + convert_to_hex(int(fields[0], 16)), + fields[1])) + +def convert_to_hex(code_point): + '''Converts a code point to a hexadecimal UTF-8 representation + like /x**/x**/x**.''' + # Getting UTF8 of Unicode characters. + # In Python3, .encode('UTF-8') does not work for + # surrogates. Therefore, we use this conversion table + surrogates = { + 0xD800: '/xed/xa0/x80', + 0xDB7F: '/xed/xad/xbf', + 0xDB80: '/xed/xae/x80', + 0xDBFF: '/xed/xaf/xbf', + 0xDC00: '/xed/xb0/x80', + 0xDFFF: '/xed/xbf/xbf', + } + if code_point in surrogates: + return surrogates[code_point] + return ''.join([ + '/x{:02x}'.format(c) for c in chr(code_point).encode('UTF-8') + ]) + +def write_header_charmap(outfile): + '''Write the header on top of the CHARMAP section to the output file''' + outfile.write("<code_set_name> UTF-8\n") + outfile.write("<comment_char> %\n") + outfile.write("<escape_char> /\n") + outfile.write("<mb_cur_min> 1\n") + outfile.write("<mb_cur_max> 6\n\n") + outfile.write("% CHARMAP generated using utf8_gen.py\n") + outfile.write("% alias ISO-10646/UTF-8\n") + outfile.write("CHARMAP\n") + +def write_header_width(outfile, unicode_version): + '''Writes the header on top of the WIDTH section to the output file''' + outfile.write('% Character width according to Unicode ' + + '{:s}.\n'.format(unicode_version)) + outfile.write('% - Default width is 1.\n') + outfile.write('% - Double-width characters have width 2; generated from\n') + outfile.write('% "grep \'^[^;]*;[WF]\' EastAsianWidth.txt"\n') + outfile.write('% - Non-spacing characters have width 0; ' + + 'generated from PropList.txt or\n') + outfile.write('% "grep \'^[^;]*;[^;]*;[^;]*;[^;]*;NSM;\' ' + + 'UnicodeData.txt"\n') + outfile.write('% - Format control characters have width 0; ' + + 'generated from\n') + outfile.write("% \"grep '^[^;]*;[^;]*;Cf;' UnicodeData.txt\"\n") +# Not needed covered by Cf +# outfile.write("% - Zero width characters have width 0; generated from\n") +# outfile.write("% \"grep '^[^;]*;ZERO WIDTH ' UnicodeData.txt\"\n") + outfile.write("WIDTH\n") + +def process_width(outfile, ulines, elines, plines): + '''ulines are lines from UnicodeData.txt, elines are lines from + EastAsianWidth.txt containing characters with width “W†or “Fâ€, + plines are lines from PropList.txt which contain characters + with the property “Prepended_Concatenation_Markâ€. + + ''' + width_dict = {} + for line in elines: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + width_dict[key] = 2 + + for line in ulines: + fields = line.split(";") + if fields[4] == "NSM" or fields[2] in ("Cf", "Me", "Mn"): + width_dict[int(fields[0], 16)] = 0 + + for line in plines: + # Characters with the property “Prepended_Concatenation_Mark†+ # should have the width 1: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + del width_dict[key] # default width is 1 + + # handle special cases for compatibility + for key in list((0x00AD,)): + # https://www.cs.tut.fi/~jkorpela/shy.html + if key in width_dict: + del width_dict[key] # default width is 1 + for key in list(range(0x1160, 0x1200)): + width_dict[key] = 0 + for key in list(range(0x3248, 0x3250)): + # These are “A†which means we can decide whether to treat them + # as “W†or “N†based on context: + # http://www.unicode.org/mail-arch/unicode-ml/y2017-m08/0023.html + # For us, “W†seems better. + width_dict[key] = 2 + for key in list(range(0x4DC0, 0x4E00)): + width_dict[key] = 2 + + same_width_lists = [] + current_width_list = [] + for key in sorted(width_dict): + if not current_width_list: + current_width_list = [key] + elif (key == current_width_list[-1] + 1 + and width_dict[key] == width_dict[current_width_list[0]]): + current_width_list.append(key) + else: + same_width_lists.append(current_width_list) + current_width_list = [key] + if current_width_list: + same_width_lists.append(current_width_list) + + for same_width_list in same_width_lists: + if len(same_width_list) == 1: + outfile.write('{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + width_dict[same_width_list[0]])) + else: + outfile.write('{:s}...{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + unicode_utils.ucs_symbol(same_width_list[-1]), + width_dict[same_width_list[0]])) + +if __name__ == "__main__": + PARSER = argparse.ArgumentParser( + description=''' + Generate a UTF-8 file from UnicodeData.txt, EastAsianWidth.txt, and PropList.txt. + ''') + PARSER.add_argument( + '-u', '--unicode_data_file', + nargs='?', + type=str, + default='UnicodeData.txt', + help=('The UnicodeData.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-e', '--east_asian_with_file', + nargs='?', + type=str, + default='EastAsianWidth.txt', + help=('The EastAsianWidth.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-p', '--prop_list_file', + nargs='?', + type=str, + default='PropList.txt', + help=('The PropList.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '--unicode_version', + nargs='?', + required=True, + type=str, + help='The Unicode version of the input files used.') + ARGS = PARSER.parse_args() + + with open(ARGS.unicode_data_file, mode='r') as UNIDATA_FILE: + UNICODE_DATA_LINES = UNIDATA_FILE.readlines() + with open(ARGS.east_asian_with_file, mode='r') as EAST_ASIAN_WIDTH_FILE: + EAST_ASIAN_WIDTH_LINES = [] + for LINE in EAST_ASIAN_WIDTH_FILE: + # If characters from EastAasianWidth.txt which are from + # from reserved ranges (i.e. not yet assigned code points) + # are added to the WIDTH section of the UTF-8 file, then + # “make check†produces “Unknown Character†errors for + # these code points because such unassigned code points + # are not in the CHARMAP section of the UTF-8 file. + # + # Therefore, we skip all reserved code points when reading + # the EastAsianWidth.txt file. + if re.match(r'.*<reserved-.+>\.\.<reserved-.+>.*', LINE): + continue + if re.match(r'^[^;]*;[WF]', LINE): + EAST_ASIAN_WIDTH_LINES.append(LINE.strip()) + with open(ARGS.prop_list_file, mode='r') as PROP_LIST_FILE: + PROP_LIST_LINES = [] + for LINE in PROP_LIST_FILE: + if re.match(r'^[^;]*;[\s]*Prepended_Concatenation_Mark', LINE): + PROP_LIST_LINES.append(LINE.strip()) + with open('UTF-8', mode='w') as OUTFILE: + # Processing UnicodeData.txt and write CHARMAP to UTF-8 file + write_header_charmap(OUTFILE) + process_charmap(UNICODE_DATA_LINES, OUTFILE) + OUTFILE.write("END CHARMAP\n\n") + # Processing EastAsianWidth.txt and write WIDTH to UTF-8 file + write_header_width(OUTFILE, ARGS.unicode_version) + process_width(OUTFILE, + UNICODE_DATA_LINES, + EAST_ASIAN_WIDTH_LINES, + PROP_LIST_LINES) + OUTFILE.write("END WIDTH\n") diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py new file mode 100755 index 00000000000..02b28bcedcf --- /dev/null +++ b/contrib/unicode/gen_wcwidth.py @@ -0,0 +1,106 @@ +#!/usr/bin/env python3 +# +# Script to generate tables for cpp_wcwidth, leveraging glibc's utf8_gen.py. +# +# This file is part of GCC. +# +# GCC is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation; either version 3, or (at your option) any later +# version. +# +# GCC 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 Public License +# for more details. +# +# You should have received a copy of the GNU General Public License +# along with GCC; see the file COPYING3. If not see +# <http://www.gnu.org/licenses/>. */ + +import sys +import os + +if len(sys.argv) != 2: + print("usage: %s <unicode version>", file=sys.stderr) + sys.exit(1) +unicode_version = sys.argv[1] + +# Parse a codepoint in the format output by glibc tools. +def parse_ucn(s): + if not (s.startswith("<U") and s.endswith(">")): + raise ValueError + return int(s[2:-1], base=16) + +# Process a line of width output from utf_gen.py and update global array. +widths = [1] * (1 + 0x10FFFF) +def process_width(line): + # Example lines: + # <UA8FF> 0 + # <UA926>...<UA92D> 0 + + s = line.split() + width = int(s[1]) + r = s[0].split("...") + if len(r) == 1: + begin = parse_ucn(r[0]) + end = begin + 1 + elif len(r) == 2: + begin = parse_ucn(r[0]) + end = parse_ucn(r[1]) + 1 + else: + raise ValueError + widths[begin:end] = [width] * (end - begin) + +# To keep things simple, we use glibc utf8_gen.py as-is. It only outputs to a +# file named UTF-8, which is not configurable. Then we parse this into the form +# we want it. +os.system("from_glibc/utf8_gen.py --unicode_version %s" % unicode_version) +processing = False +for line in open("UTF-8", "r"): + if processing: + if line == "END WIDTH\n": + processing = False + else: + try: + process_width(line) + except (ValueError, IndexError): + print(e, "warning: ignored unexpected line: %s" % line, + file=sys.stderr, end="") + elif line == "WIDTH\n": + processing = True + +# All bytes < 256 we treat as width 1. +widths[0:255] = [1] * 255 + +# Condense the list to contiguous ranges. +cur_range = [-1, 1] +all_ranges = [] +for i, width in enumerate(widths): + if width == cur_range[1]: + cur_range[0] = i + else: + all_ranges.append(cur_range) + cur_range = [i, width] + +# Output the arrays for generated_cpp_wcwidth.h +print("/* Generated by contrib/unicode/gen_wcwidth.py,", + "with the help of glibc's") +print(" utf8_gen.py, using version %s" % unicode_version, + "of the Unicode standard. */") +print("\nstatic const cppchar_t wcwidth_range_ends[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 8: + print(" ", end="") + else: + print("\n ", end="") + print("0x%x," % (r[0]), end="") +print("\n};\n") +print("static const unsigned char wcwidth_widths[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 24: + print(" ", end="") + else: + print("\n ", end="") + print("%d," % r[1], end="") +print("\n};") diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c index cb920f6b9d0..3460da3cf32 100644 --- a/gcc/diagnostic-show-locus.c +++ b/gcc/diagnostic-show-locus.c @@ -30,6 +30,7 @@ along with GCC; see the file COPYING3. If not see #include "gcc-rich-location.h" #include "selftest.h" #include "selftest-diagnostic.h" +#include "cpplib.h" #ifdef HAVE_TERMIOS_H # include <termios.h> @@ -112,18 +113,81 @@ class colorizer const char *m_stop_color; }; -/* A point within a layout_range; similar to an expanded_location, +/* In order to handle multibyte sources properly, all of this logic needs to be + aware of the distinction between the number of bytes and the number of + display columns occupied by a character, which are not the same for non-ASCII + characters. For example, the Unicode pi symbol, U+03C0, is encoded in UTF-8 + as "\xcf\x80", and thus occupies 2 bytes of space while only occupying 1 + display column when it is output. A typical emoji, such as U+1F602 (in + UTF-8, "\xf0\x9f\x98\x82"), requires 4 bytes and has a display width of 2. + + The below example line, which is also used for selftests below, shows how the + display column and byte column are related: + + 0000000001111111111222222 display + 1234567890123456789012345 columns + SS_foo = P_bar.SS_fieldP; + 0000000111111111222222223 byte + 1356789012456789134567891 columns + + Here SS represents the two display columns for the U+1F602 emoji, and P + represents the one display column for the U+03C0 pi symbol. As an example, a + diagnostic pointing to the final P on this line is at byte column 29 and + display column 24. This reflects the fact that the three extended characters + before the final P occupy cumulatively 5 more bytes than they do display + columns (a difference of 2 for each of the two SSs, and one for the other P). + + One or the other of the two column units is more useful depending on the + context. For instance, in order to output the caret at the correct location, + we need to count display columns; in order to colorize a source line, we need + to count the bytes. All locations are provided to us as byte counts, which + we augment with the display column on demand so that it can be used when + needed. This is not the most efficient way to do things since it requires + looping over the whole line each time, but it should be fine for the purpose + of outputting diagnostics. + + In order to keep straight which units (byte or display) are in use at a + given time, the following enum lets us specify that explicitly. */ + +enum column_unit { + /* Measured in raw bytes. */ + CU_BYTES = 0, + + /* Measured in display units. */ + CU_DISPLAY_COLS, + + /* For arrays indexed by column_unit. */ + CU_NUM_UNITS +}; + +/* Utility class to augment an exploc with the corresponding display column. */ + +class exploc_with_display_col : public expanded_location +{ + public: + exploc_with_display_col (const expanded_location &exploc) + : expanded_location (exploc), + m_display_col (location_compute_display_column (exploc)) {} + + int m_display_col; +}; + + +/* A point within a layout_range; similar to an exploc_with_display_col, but after filtering on file. */ class layout_point { public: layout_point (const expanded_location &exploc) - : m_line (exploc.line), - m_column (exploc.column) {} + : m_line (exploc.line) + { + m_columns[CU_BYTES] = exploc.column; + m_columns[CU_DISPLAY_COLS] = location_compute_display_column (exploc); + } linenum_type m_line; - int m_column; + int m_columns[CU_NUM_UNITS]; }; /* A class for use by "class layout" below: a filtered location_range. */ @@ -138,7 +202,8 @@ class layout_range unsigned original_idx, const range_label *label); - bool contains_point (linenum_type row, int column) const; + bool contains_point (linenum_type row, int column, + enum column_unit col_unit) const; bool intersects_line_p (linenum_type row) const; layout_point m_start; @@ -157,6 +222,17 @@ struct line_bounds { int m_first_non_ws; int m_last_non_ws; + + void convert_to_display_cols (char_span line) + { + m_first_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_first_non_ws); + + m_last_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_last_non_ws); + } }; /* A range of contiguous source lines within a layout (e.g. "lines 5-10" @@ -284,6 +360,7 @@ class layout get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + enum column_unit col_unit, /* Outputs. */ point_state *out_state); @@ -298,7 +375,7 @@ class layout diagnostic_context *m_context; pretty_printer *m_pp; location_t m_primary_loc; - expanded_location m_exploc; + exploc_with_display_col m_exploc; colorizer m_colorizer; bool m_colorize_source_p; bool m_show_labels_p; @@ -472,10 +549,15 @@ layout_range::layout_range (const expanded_location *start_exploc, - 'w' indicates a point within the range - 'F' indicates the finish of the range (which is within it). - - 'a' indicates a subsequent point *after* the range. */ + - 'a' indicates a subsequent point *after* the range. + + COL_UNIT controls whether we check the byte column or + the display column; one or the other is more convenient + depending on the context. */ bool -layout_range::contains_point (linenum_type row, int column) const +layout_range::contains_point (linenum_type row, int column, + enum column_unit col_unit) const { gcc_assert (m_start.m_line <= m_finish.m_line); /* ...but the equivalent isn't true for the columns; @@ -491,7 +573,7 @@ layout_range::contains_point (linenum_type row, int column) const /* On same line as start of range (corresponding to line 02 in example A and line 03 in example B). */ { - if (column < m_start.m_column) + if (column < m_start.m_columns[col_unit]) /* Points on the starting line of the range, but before the column in which it begins. */ return false; @@ -505,7 +587,7 @@ layout_range::contains_point (linenum_type row, int column) const { /* This is a single-line range. */ gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.m_columns[col_unit]; } } @@ -530,7 +612,7 @@ layout_range::contains_point (linenum_type row, int column) const gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.m_columns[col_unit]; } /* Does this layout_range contain any part of line ROW? */ @@ -554,9 +636,9 @@ static layout_range make_range (int start_line, int start_col, int end_line, int end_col) { const expanded_location start_exploc - = {"test.c", start_line, start_col, NULL, false}; + = {"", start_line, start_col, NULL, false}; const expanded_location finish_exploc - = {"test.c", end_line, end_col, NULL, false}; + = {"", end_line, end_col, NULL, false}; return layout_range (&start_exploc, &finish_exploc, SHOW_RANGE_WITHOUT_CARET, &start_exploc, 0, NULL); } @@ -574,20 +656,25 @@ test_layout_range_for_single_point () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (point.contains_point (6, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before the line. */ + ASSERT_FALSE (point.contains_point (6, 1, col_unit)); - /* On the line, but before start. */ - ASSERT_FALSE (point.contains_point (7, 9)); + /* On the line, but before start. */ + ASSERT_FALSE (point.contains_point (7, 9, col_unit)); - /* At the point. */ - ASSERT_TRUE (point.contains_point (7, 10)); + /* At the point. */ + ASSERT_TRUE (point.contains_point (7, 10, col_unit)); - /* On the line, after the point. */ - ASSERT_FALSE (point.contains_point (7, 11)); + /* On the line, after the point. */ + ASSERT_FALSE (point.contains_point (7, 11, col_unit)); - /* After the line. */ - ASSERT_FALSE (point.contains_point (8, 1)); + /* After the line. */ + ASSERT_FALSE (point.contains_point (8, 1, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (point.intersects_line_p (6)); @@ -605,26 +692,31 @@ test_layout_range_for_single_line () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (example_a.contains_point (1, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before the line. */ + ASSERT_FALSE (example_a.contains_point (1, 1, col_unit)); - /* On the line, but before start. */ - ASSERT_FALSE (example_a.contains_point (2, 21)); + /* On the line, but before start. */ + ASSERT_FALSE (example_a.contains_point (2, 21, col_unit)); - /* On the line, at the start. */ - ASSERT_TRUE (example_a.contains_point (2, 22)); + /* On the line, at the start. */ + ASSERT_TRUE (example_a.contains_point (2, 22, col_unit)); - /* On the line, within the range. */ - ASSERT_TRUE (example_a.contains_point (2, 23)); + /* On the line, within the range. */ + ASSERT_TRUE (example_a.contains_point (2, 23, col_unit)); - /* On the line, at the end. */ - ASSERT_TRUE (example_a.contains_point (2, 38)); + /* On the line, at the end. */ + ASSERT_TRUE (example_a.contains_point (2, 38, col_unit)); - /* On the line, after the end. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* On the line, after the end. */ + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); - /* After the line. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* After the line. */ + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_a.intersects_line_p (1)); @@ -642,40 +734,45 @@ test_layout_range_for_multiple_lines () /* Tests for layout_range::contains_point. */ - /* Before first line. */ - ASSERT_FALSE (example_b.contains_point (1, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; - /* On the first line, but before start. */ - ASSERT_FALSE (example_b.contains_point (3, 13)); + /* Before first line. */ + ASSERT_FALSE (example_b.contains_point (1, 1, col_unit)); - /* At the start. */ - ASSERT_TRUE (example_b.contains_point (3, 14)); + /* On the first line, but before start. */ + ASSERT_FALSE (example_b.contains_point (3, 13, col_unit)); - /* On the first line, within the range. */ - ASSERT_TRUE (example_b.contains_point (3, 15)); + /* At the start. */ + ASSERT_TRUE (example_b.contains_point (3, 14, col_unit)); - /* On an interior line. - The column number should not matter; try various boundary - values. */ - ASSERT_TRUE (example_b.contains_point (4, 1)); - ASSERT_TRUE (example_b.contains_point (4, 7)); - ASSERT_TRUE (example_b.contains_point (4, 8)); - ASSERT_TRUE (example_b.contains_point (4, 9)); - ASSERT_TRUE (example_b.contains_point (4, 13)); - ASSERT_TRUE (example_b.contains_point (4, 14)); - ASSERT_TRUE (example_b.contains_point (4, 15)); + /* On the first line, within the range. */ + ASSERT_TRUE (example_b.contains_point (3, 15, col_unit)); - /* On the final line, before the end. */ - ASSERT_TRUE (example_b.contains_point (5, 7)); + /* On an interior line. + The column number should not matter; try various boundary + values. */ + ASSERT_TRUE (example_b.contains_point (4, 1, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 7, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 8, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 9, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 13, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 14, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 15, col_unit)); - /* On the final line, at the end. */ - ASSERT_TRUE (example_b.contains_point (5, 8)); + /* On the final line, before the end. */ + ASSERT_TRUE (example_b.contains_point (5, 7, col_unit)); - /* On the final line, after the end. */ - ASSERT_FALSE (example_b.contains_point (5, 9)); + /* On the final line, at the end. */ + ASSERT_TRUE (example_b.contains_point (5, 8, col_unit)); - /* After the line. */ - ASSERT_FALSE (example_b.contains_point (6, 1)); + /* On the final line, after the end. */ + ASSERT_FALSE (example_b.contains_point (5, 9, col_unit)); + + /* After the line. */ + ASSERT_FALSE (example_b.contains_point (6, 1, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_b.intersects_line_p (2)); @@ -687,8 +784,8 @@ test_layout_range_for_multiple_lines () #endif /* #if CHECKING_P */ -/* Given a source line LINE of length LINE_WIDTH, determine the width - without any trailing whitespace. */ +/* Given a source line LINE of length LINE_WIDTH bytes, determine the width + (in bytes, not display cols) without any trailing whitespace. */ static int get_line_width_without_trailing_whitespace (const char *line, int line_width) @@ -897,17 +994,35 @@ layout::layout (diagnostic_context * context, will be adjusted accordingly. */ size_t max_width = m_context->caret_max_width; char_span line = location_get_source_line (m_exploc.file, m_exploc.line); - if (line && (size_t)m_exploc.column <= line.length ()) + if (line && max_width) { - size_t right_margin = CARET_LINE_MARGIN; - size_t column = m_exploc.column; - if (m_show_line_numbers_p) - column += m_linenum_width + 2; - right_margin = MIN (line.length () - column, right_margin); - right_margin = max_width - right_margin; - if (line.length () >= max_width && column > right_margin) - m_x_offset = column - right_margin; - gcc_assert (m_x_offset >= 0); + size_t column = m_exploc.m_display_col; + int line_width + = get_line_width_without_trailing_whitespace (line.get_buffer (), + line.length ()); + size_t eol = cpp_display_width (line.get_buffer (), line_width); + const size_t eol_before_linenum = eol; + + if (column <= eol) + { + if (m_show_line_numbers_p) + { + column += m_linenum_width + 2; + eol += m_linenum_width + 2; + } + size_t right_margin = CARET_LINE_MARGIN; + right_margin = MIN (eol - column, right_margin); + right_margin = max_width - right_margin; + /* Note: if right_margin > max_width, we end up failing this next + check due to wrapping, and we don't offset anything. Otherwise we + would conclude we can't output the line at all. */ + if (eol >= max_width && column > right_margin) + { + m_x_offset = column - right_margin; + m_x_offset = MIN (m_x_offset, (int) eol_before_linenum - 1); + } + gcc_assert (m_x_offset >= 0); + } } if (context->show_ruler_p) @@ -1086,7 +1201,7 @@ layout::get_expanded_location (const line_span *line_span) const { expanded_location exploc = m_exploc; exploc.line = lr->m_start.m_line; - exploc.column = lr->m_start.m_column; + exploc.column = lr->m_start.m_columns[CU_BYTES]; return exploc; } } @@ -1254,7 +1369,9 @@ layout::calculate_line_spans () /* Print line ROW of source code, potentially colorized at any ranges, and populate *LBOUNDS_OUT. LINE is the source line (not necessarily 0-terminated) and LINE_WIDTH - is its width. */ + is its width. This function deals only with byte offsets, not display + columns; m_x_offset must be converted from display to byte units. In + particular, LINE_WIDTH and LBOUNDS_OUT are in bytes. */ void layout::print_source_line (linenum_type row, const char *line, int line_width, @@ -1266,7 +1383,10 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, whitespace. */ line_width = get_line_width_without_trailing_whitespace (line, line_width); - line += m_x_offset; + + const int x_offset_bytes + = cpp_display_column_to_byte_column (line, line_width, m_x_offset); + line += x_offset_bytes; pp_emit_prefix (m_pp); @@ -1282,7 +1402,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, int first_non_ws = INT_MAX; int last_non_ws = 0; int column; - for (column = 1 + m_x_offset; column <= line_width; column++) + for (column = 1 + x_offset_bytes; column <= line_width; column++) { /* Assuming colorization is enabled for the caret and underline characters, we may also colorize the associated characters @@ -1302,6 +1422,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, point_state state; in_range_p = get_state_at_point (row, column, 0, INT_MAX, + CU_BYTES, &state); if (in_range_p) m_colorizer.set_range (state.range_idx); @@ -1365,12 +1486,13 @@ layout::start_annotation_line (char margin_char) const } /* Print a line consisting of the caret/underlines for the given - source line. */ + source line. This function works with display columns, rather than byte + counts; in particular, LBOUNDS should be in display column units. */ void layout::print_annotation_line (linenum_type row, const line_bounds lbounds) { - int x_bound = get_x_bound_for_row (row, m_exploc.column, + int x_bound = get_x_bound_for_row (row, m_exploc.m_display_col, lbounds.m_last_non_ws); start_annotation_line (); @@ -1383,6 +1505,7 @@ layout::print_annotation_line (linenum_type row, const line_bounds lbounds) in_range_p = get_state_at_point (row, column, lbounds.m_first_non_ws, lbounds.m_last_non_ws, + CU_DISPLAY_COLS, &state); if (in_range_p) { @@ -1420,9 +1543,11 @@ class line_label public: line_label (int state_idx, int column, label_text text) : m_state_idx (state_idx), m_column (column), - m_text (text), m_length (strlen (text.m_buffer)), - m_label_line (0), m_has_vbar (true) - {} + m_text (text), m_label_line (0), m_has_vbar (true) + { + const int bytes = strlen (text.m_buffer); + m_display_width = cpp_display_width (text.m_buffer, bytes); + } /* Sorting is primarily by column, then by state index. */ static int comparator (const void *p1, const void *p2) @@ -1441,7 +1566,7 @@ public: int m_state_idx; int m_column; label_text m_text; - size_t m_length; + size_t m_display_width; int m_label_line; bool m_has_vbar; }; @@ -1468,7 +1593,8 @@ layout::print_any_labels (linenum_type row) /* Reject labels that aren't fully visible due to clipping by m_x_offset. */ - if (range->m_caret.m_column <= m_x_offset) + const int disp_col = range->m_caret.m_columns[CU_DISPLAY_COLS]; + if (disp_col <= m_x_offset) continue; label_text text; @@ -1480,7 +1606,7 @@ layout::print_any_labels (linenum_type row) if (text.m_buffer == NULL) continue; - labels.safe_push (line_label (i, range->m_caret.m_column, text)); + labels.safe_push (line_label (i, disp_col, text)); } } @@ -1530,7 +1656,7 @@ layout::print_any_labels (linenum_type row) FOR_EACH_VEC_ELT_REVERSE (labels, i, label) { /* Would this label "touch" or overlap the next label? */ - if (label->m_column + label->m_length >= (size_t)next_column) + if (label->m_column + label->m_display_width >= (size_t)next_column) { max_label_line++; @@ -1569,7 +1695,7 @@ layout::print_any_labels (linenum_type row) m_colorizer.set_range (label->m_state_idx); pp_string (m_pp, label->m_text.m_buffer); m_colorizer.set_normal_text (); - column += label->m_length; + column += label->m_display_width; } else if (label->m_has_vbar) { @@ -1636,7 +1762,7 @@ layout::print_leading_fixits (linenum_type row) /* Subroutine of layout::print_trailing_fixits. Determine if the annotation line printed for LINE contained - the exact range from START_COLUMN to FINISH_COLUMN. */ + the exact range from START_COLUMN to FINISH_COLUMN (in display units). */ bool layout::annotation_line_showed_range_p (linenum_type line, int start_column, @@ -1646,9 +1772,9 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, int i; FOR_EACH_VEC_ELT (m_layout_ranges, i, range) if (range->m_start.m_line == line - && range->m_start.m_column == start_column + && range->m_start.m_columns[CU_DISPLAY_COLS] == start_column && range->m_finish.m_line == line - && range->m_finish.m_column == finish_column) + && range->m_finish.m_columns[CU_DISPLAY_COLS] == finish_column) return true; return false; } @@ -1735,7 +1861,7 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, and is thus printed as desired. */ -/* A range of columns within a line. */ +/* A range of (byte or display) columns within a line. */ class column_range { @@ -1755,32 +1881,51 @@ public: int finish; }; -/* Get the range of columns that HINT would affect. */ - +/* Get the range of bytes or display columns that HINT would affect. */ static column_range -get_affected_columns (const fixit_hint *hint) +get_affected_range (const fixit_hint *hint, enum column_unit col_unit) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; + expanded_location exploc_start = expand_location (hint->get_start_loc ()); + expanded_location exploc_finish = expand_location (hint->get_next_loc ()); + --exploc_finish.column; + int start_column; + int finish_column; + if (col_unit == CU_DISPLAY_COLS) + { + start_column = location_compute_display_column (exploc_start); + if (hint->insertion_p ()) + finish_column = start_column - 1; + else + finish_column = location_compute_display_column (exploc_finish); + } + else + { + start_column = exploc_start.column; + finish_column = exploc_finish.column; + } return column_range (start_column, finish_column); } -/* Get the range of columns that would be printed for HINT. */ +/* Get the range of display columns that would be printed for HINT. */ static column_range get_printed_columns (const fixit_hint *hint) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int final_hint_column = start_column + hint->get_length () - 1; + expanded_location exploc = expand_location (hint->get_start_loc ()); + int start_column = location_compute_display_column (exploc); + int hint_width = cpp_display_width (hint->get_string (), + hint->get_length ()); + int final_hint_column = start_column + hint_width - 1; if (hint->insertion_p ()) { return column_range (start_column, final_hint_column); } else { - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; - + exploc = expand_location (hint->get_next_loc ()); + --exploc.column; + int finish_column = location_compute_display_column (exploc); return column_range (start_column, MAX (finish_column, final_hint_column)); } @@ -1794,27 +1939,35 @@ get_printed_columns (const fixit_hint *hint) class correction { public: - correction (column_range affected_columns, + correction (column_range affected_bytes, + column_range affected_columns, column_range printed_columns, const char *new_text, size_t new_text_len) - : m_affected_columns (affected_columns), + : m_affected_bytes (affected_bytes), + m_affected_columns (affected_columns), m_printed_columns (printed_columns), m_text (xstrdup (new_text)), - m_len (new_text_len), + m_byte_length (new_text_len), m_alloc_sz (new_text_len + 1) { + compute_display_cols (); } ~correction () { free (m_text); } bool insertion_p () const { - return m_affected_columns.start == m_affected_columns.finish + 1; + return m_affected_bytes.start == m_affected_bytes.finish + 1; } void ensure_capacity (size_t len); void ensure_terminated (); + void compute_display_cols () + { + m_display_cols = cpp_display_width (m_text, m_byte_length); + } + void overwrite (int dst_offset, const char_span &src_span) { gcc_assert (dst_offset >= 0); @@ -1827,6 +1980,7 @@ public: is to be inserted, and finish is offset by the length of the replacement. If replace, then the range of columns affected. */ + column_range m_affected_bytes; column_range m_affected_columns; /* If insert, then start: the column before which the text @@ -1837,7 +1991,8 @@ public: /* The text to be inserted/used as replacement. */ char *m_text; - size_t m_len; + size_t m_byte_length; /* Not including null-terminator. */ + int m_display_cols; size_t m_alloc_sz; }; @@ -1862,8 +2017,8 @@ void correction::ensure_terminated () { /* 0-terminate the buffer. */ - gcc_assert (m_len < m_alloc_sz); - m_text[m_len] = '\0'; + gcc_assert (m_byte_length < m_alloc_sz); + m_text[m_byte_length] = '\0'; } /* A list of corrections affecting a particular line. @@ -1925,7 +2080,8 @@ source_line::source_line (const char *filename, int line) void line_corrections::add_hint (const fixit_hint *hint) { - column_range affected_columns = get_affected_columns (hint); + column_range affected_bytes = get_affected_range (hint, CU_BYTES); + column_range affected_columns = get_affected_range (hint, CU_DISPLAY_COLS); column_range printed_columns = get_printed_columns (hint); /* Potentially consolidate. */ @@ -1936,8 +2092,8 @@ line_corrections::add_hint (const fixit_hint *hint) /* The following consolidation code assumes that the fix-it hints have been sorted by start (done within layout's ctor). */ - gcc_assert (affected_columns.start - >= last_correction->m_affected_columns.start); + gcc_assert (affected_bytes.start + >= last_correction->m_affected_bytes.start); gcc_assert (printed_columns.start >= last_correction->m_printed_columns.start); @@ -1949,8 +2105,8 @@ line_corrections::add_hint (const fixit_hint *hint) Attempt to inject a "replace" correction from immediately after the end of the last hint to immediately before the start of the next hint. */ - column_range between (last_correction->m_affected_columns.finish + 1, - printed_columns.start - 1); + column_range between (last_correction->m_affected_bytes.finish + 1, + affected_bytes.start - 1); /* Try to read the source. */ source_line line (m_filename, m_row); @@ -1959,33 +2115,39 @@ line_corrections::add_hint (const fixit_hint *hint) /* Consolidate into the last correction: add a no-op "replace" of the "between" text, and add the text from the new hint. */ - int old_len = last_correction->m_len; - gcc_assert (old_len >= 0); - int between_len = between.finish + 1 - between.start; - gcc_assert (between_len >= 0); - int new_len = old_len + between_len + hint->get_length (); - gcc_assert (new_len >= 0); - last_correction->ensure_capacity (new_len); + int old_byte_len = last_correction->m_byte_length; + gcc_assert (old_byte_len >= 0); + int between_byte_len = between.finish + 1 - between.start; + gcc_assert (between_byte_len >= 0); + int new_byte_len + = old_byte_len + between_byte_len + hint->get_length (); + gcc_assert (new_byte_len >= 0); + last_correction->ensure_capacity (new_byte_len); last_correction->overwrite - (old_len, + (old_byte_len, line.as_span ().subspan (between.start - 1, between.finish + 1 - between.start)); - last_correction->overwrite (old_len + between_len, + last_correction->overwrite (old_byte_len + between_byte_len, char_span (hint->get_string (), hint->get_length ())); - last_correction->m_len = new_len; + last_correction->m_byte_length = new_byte_len; last_correction->ensure_terminated (); + last_correction->m_affected_bytes.finish + = affected_bytes.finish; last_correction->m_affected_columns.finish = affected_columns.finish; + int prev_display_cols = last_correction->m_display_cols; + last_correction->compute_display_cols (); last_correction->m_printed_columns.finish - += between_len + hint->get_length (); + += last_correction->m_display_cols - prev_display_cols; return; } } } /* If no consolidation happened, add a new correction instance. */ - m_corrections.safe_push (new correction (affected_columns, + m_corrections.safe_push (new correction (affected_bytes, + affected_columns, printed_columns, hint->get_string (), hint->get_length ())); @@ -2034,7 +2196,7 @@ layout::print_trailing_fixits (linenum_type row) m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } else { @@ -2046,7 +2208,7 @@ layout::print_trailing_fixits (linenum_type row) int finish_column = c->m_affected_columns.finish; if (!annotation_line_showed_range_p (row, start_column, finish_column) - || c->m_len == 0) + || c->m_byte_length == 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_delete (); @@ -2057,13 +2219,13 @@ layout::print_trailing_fixits (linenum_type row) /* Print the replacement text. REPLACE also covers removals, so only do this extra work (potentially starting a new line) if we have actual replacement text. */ - if (c->m_len > 0) + if (c->m_byte_length > 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } } } @@ -2084,12 +2246,14 @@ layout::print_newline () /* Return true if (ROW/COLUMN) is within a range of the layout. If it returns true, OUT_STATE is written to, with the range index, and whether we should draw the caret at - (ROW/COLUMN) (as opposed to an underline). */ + (ROW/COLUMN) (as opposed to an underline). COL_UNIT controls + whether all inputs and outputs are in bytes or display column units. */ bool layout::get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + enum column_unit col_unit, /* Outputs. */ point_state *out_state) { @@ -2102,7 +2266,7 @@ layout::get_state_at_point (/* Inputs. */ source colorization. */ continue; - if (range->contains_point (row, column)) + if (range->contains_point (row, column, col_unit)) { out_state->range_idx = i; @@ -2110,7 +2274,7 @@ layout::get_state_at_point (/* Inputs. */ out_state->draw_caret_p = false; if (range->m_range_display_kind == SHOW_RANGE_WITH_CARET && row == range->m_caret.m_line - && column == range->m_caret.m_column) + && column == range->m_caret.m_columns[col_unit]) out_state->draw_caret_p = true; /* Within a multiline range, don't display any underline @@ -2130,11 +2294,11 @@ layout::get_state_at_point (/* Inputs. */ /* Helper function for use by layout::print_line when printing the annotation line under the source line. - Get the column beyond the rightmost one that could contain a caret or - range marker, given that we stop rendering at trailing whitespace. + Get the display column beyond the rightmost one that could contain a caret + or range marker, given that we stop rendering at trailing whitespace. ROW is the source line within the given file. - CARET_COLUMN is the column of range 0's caret. - LAST_NON_WS_COLUMN is the last column containing a non-whitespace + CARET_COLUMN is the display column of range 0's caret. + LAST_NON_WS_COLUMN is the last display column containing a non-whitespace character of source (as determined when printing the source line). */ int @@ -2153,8 +2317,9 @@ layout::get_x_bound_for_row (linenum_type row, int caret_column, { /* On the final line within a range; ensure that we render up to the end of the range. */ - if (result <= range->m_finish.m_column) - result = range->m_finish.m_column + 1; + const int disp_col = range->m_finish.m_columns[CU_DISPLAY_COLS]; + if (result <= disp_col) + result = disp_col + 1; } else if (row < range->m_finish.m_line) { @@ -2245,7 +2410,11 @@ layout::print_line (linenum_type row) print_leading_fixits (row); print_source_line (row, line.get_buffer (), line.length (), &lbounds); if (should_print_annotation_line_p (row)) - print_annotation_line (row, lbounds); + { + if (lbounds.m_first_non_ws != INT_MAX) + lbounds.convert_to_display_cols (line); + print_annotation_line (row, lbounds); + } if (m_show_labels_p) print_any_labels (row); print_trailing_fixits (row); @@ -2965,6 +3134,551 @@ test_diagnostic_show_locus_one_liner (const line_table_case &case_) test_one_liner_labels (); } +/* Version of all one-liner tests exercising multibyte awareness. For + simplicity we stick to using two multibyte characters in the test, U+1F602 + == "\xf0\x9f\x98\x82", which uses 4 bytes and 2 display columns, and U+03C0 + == "\xcf\x80", which uses 2 bytes and 1 display column. Note: all of the + below asserts would be easier to read if we used UTF-8 directly in the + string constants, but it seems better not to demand the host compiler + support this, when it isn't otherwise necessary. Instead, whenever an + extended character appears in a string, we put a line break after it so that + all succeeding characters can appear visually at the correct display column. + + All of these work on the following 1-line source file: + + .0000000001111111111222222 display + .1234567890123456789012345 columns + "SS_foo = P_bar.SS_fieldP;\n" + .0000000111111111222222223 byte + .1356789012456789134567891 columns + + which is set up by test_diagnostic_show_locus_one_liner and calls + them. Here SS represents the two display columns for the U+1F602 emoji and + P represents the one display column for the U+03C0 pi symbol. */ + +/* Just a caret. */ + +static void +test_one_liner_simple_caret_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + rich_location richloc (line_table, caret); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n", + pp_formatted_text (dc.printer)); +} + +/* Caret and range. */ +static void +test_one_liner_caret_and_range_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + location_t start = linemap_position_for_column (line_table, 12); + location_t finish = linemap_position_for_column (line_table, 30); + location_t loc = make_location (caret, start, finish); + rich_location richloc (line_table, loc); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~~^~~~~~~~~~\n", + pp_formatted_text (dc.printer)); +} + +/* Multiple ranges and carets. */ + +static void +test_one_liner_multiple_carets_and_ranges_utf8 () +{ + test_diagnostic_context dc; + location_t foo + = make_location (linemap_position_for_column (line_table, 7), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + dc.caret_chars[0] = 'A'; + + location_t bar + = make_location (linemap_position_for_column (line_table, 16), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + dc.caret_chars[1] = 'B'; + + location_t field + = make_location (linemap_position_for_column (line_table, 26), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + dc.caret_chars[2] = 'C'; + rich_location richloc (line_table, foo); + richloc.add_range (bar, SHOW_RANGE_WITH_CARET); + richloc.add_range (field, SHOW_RANGE_WITH_CARET); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~A~ ~~~B~ ~~~~~C~~~\n", + pp_formatted_text (dc.printer)); +} + +/* Insertion fix-it hint: adding an "&" to the front of "P_bar.field". */ + +static void +test_one_liner_fixit_insert_before_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 12); + rich_location richloc (line_table, caret); + richloc.add_fixit_insert_before ("&"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " &\n", + pp_formatted_text (dc.printer)); +} + +/* Insertion fix-it hint: adding a "[0]" after "SS_foo". */ + +static void +test_one_liner_fixit_insert_after_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 1); + location_t finish = linemap_position_for_column (line_table, 8); + location_t foo = make_location (start, start, finish); + rich_location richloc (line_table, foo); + richloc.add_fixit_insert_after ("[0]"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~\n" + " [0]\n", + pp_formatted_text (dc.printer)); +} + +/* Removal fix-it hint: removal of the ".SS_fieldP". */ + +static void +test_one_liner_fixit_remove_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 18); + location_t finish = linemap_position_for_column (line_table, 30); + location_t dot = make_location (start, start, finish); + rich_location richloc (line_table, dot); + richloc.add_fixit_remove (); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~\n" + " ----------\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP". */ + +static void +test_one_liner_fixit_replace_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + location_t field = make_location (start, start, finish); + rich_location richloc (line_table, field); + richloc.add_fixit_replace ("m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + but where the caret was elsewhere. */ + +static void +test_one_liner_fixit_replace_non_equal_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + source_range range; + range.m_start = start; + range.m_finish = finish; + richloc.add_fixit_replace (range, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is not indicated in the annotation line, so + it should be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " ---------\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + where the caret was elsewhere, but where a secondary range + exactly covers "field". */ + +static void +test_one_liner_fixit_replace_equal_secondary_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + location_t field = make_location (start, start, finish); + richloc.add_range (field); + richloc.add_fixit_replace (field, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is indicated in the annotation line, + so it shouldn't be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^ ~~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Verify that we can use ad-hoc locations when adding fixits to a + rich_location. */ + +static void +test_one_liner_fixit_validation_adhoc_locations_utf8 () +{ + /* Generate a range that's too long to be packed, so must + be stored as an ad-hoc location (given the defaults + of 5 bits or 0 bits of packed range); 41 columns > 2**5. */ + const location_t c12 = linemap_position_for_column (line_table, 12); + const location_t c52 = linemap_position_for_column (line_table, 52); + const location_t loc = make_location (c12, c12, c52); + + if (c52 > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_TRUE (IS_ADHOC_LOC (loc)); + + /* Insert. */ + { + rich_location richloc (line_table, loc); + richloc.add_fixit_insert_before (loc, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } + + /* Remove. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_remove (range); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " -------------------------------------\n", + pp_formatted_text (dc.printer)); + } + + /* Replace. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_replace (range, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } +} + +/* Test of consolidating insertions at the same location. */ + +static void +test_one_liner_many_fixits_1_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + for (int i = 0; i < 19; i++) + richloc.add_fixit_insert_before (i & 1 ? "@" : "\xcf\x80"); + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@" + "\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Ensure that we can add an arbitrary number of fix-it hints to a + rich_location, even if they are not consolidated. */ + +static void +test_one_liner_many_fixits_2_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + const int nlocs = 19; + int locs[nlocs] = {1, 5, 7, 9, 11, 14, 16, 18, 23, 25, 27, 29, 32, + 34, 36, 38, 40, 42, 44}; + for (int i = 0; i != nlocs; ++i) + { + location_t loc = linemap_position_for_column (line_table, locs[i]); + richloc.add_fixit_insert_before (loc, i & 1 ? "@" : "\xcf\x80"); + } + + ASSERT_EQ (nlocs, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Test of labeling the ranges within a rich_location. */ + +static void +test_one_liner_labels_utf8 () +{ + location_t foo + = make_location (linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + location_t bar + = make_location (linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + location_t field + = make_location (linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + + /* Example where all the labels fit on one line. */ + { + /* These three labels contain multibyte characters such that their byte + lengths are respectively (12, 10, 18), but their display widths are only + (6, 5, 9). All three fit on the line when considering the display + widths, but not when considering the byte widths, so verify that we do + indeed put them all on one line. */ + text_range_label label0 + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); + text_range_label label1 + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label2 + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + "\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + { + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " \xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80" + " \xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + " \xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82" + "\xf0\x9f\x98\x82\xcf\x80\xcf\x80\n", + pp_formatted_text (dc.printer)); + } + + } + + /* Example where the labels need extra lines. */ + { + text_range_label label0 ("label 0\xf0\x9f\x98\x82"); + text_range_label label1 ("label 1\xcf\x80"); + text_range_label label2 ("label 2\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | label 2\xcf\x80\n" + " | label 1\xcf\x80\n" + " label 0\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } + + /* Example of boundary conditions: label 0 and 1 have just enough clearance, + but label 1 just touches label 2. */ + { + text_range_label label0 ("aaaaa\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label1 ("bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82"); + text_range_label label2 ("c"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | c\n" + " aaaaa\xf0\x9f\x98\x82\xcf\x80" + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } +} + +/* Run the various one-liner tests. */ + +static void +test_diagnostic_show_locus_one_liner_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + const char *content + /* Display columns. + 0000000000000000000000011111111111111111111111111111112222222222222 + 1111111122222222345678900000000123456666666677777777890123444444445 */ + = "\xf0\x9f\x98\x82_foo = \xcf\x80_bar.\xf0\x9f\x98\x82_field\xcf\x80;\n"; + /* 0000000000000000000001111111111111111111222222222222222222222233333 + 1111222233334444567890122223333456789999000011112222345678999900001 + Byte columns. */ + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1); + + location_t line_end = linemap_position_for_column (line_table, 31); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end)); + ASSERT_EQ (1, LOCATION_LINE (line_end)); + ASSERT_EQ (31, LOCATION_COLUMN (line_end)); + + char_span lspan = location_get_source_line (tmp.get_filename (), 1); + ASSERT_EQ (25, cpp_display_width (lspan.get_buffer (), lspan.length ())); + ASSERT_EQ (25, location_compute_display_column (expand_location (line_end))); + + test_one_liner_simple_caret_utf8 (); + test_one_liner_caret_and_range_utf8 (); + test_one_liner_multiple_carets_and_ranges_utf8 (); + test_one_liner_fixit_insert_before_utf8 (); + test_one_liner_fixit_insert_after_utf8 (); + test_one_liner_fixit_remove_utf8 (); + test_one_liner_fixit_replace_utf8 (); + test_one_liner_fixit_replace_non_equal_range_utf8 (); + test_one_liner_fixit_replace_equal_secondary_range_utf8 (); + test_one_liner_fixit_validation_adhoc_locations_utf8 (); + test_one_liner_many_fixits_1_utf8 (); + test_one_liner_many_fixits_2_utf8 (); + test_one_liner_labels_utf8 (); +} + /* Verify that gcc_rich_location::add_location_if_nearby works. */ static void @@ -3340,13 +4054,19 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* Unit-test the line_corrections machinery. */ ASSERT_EQ (3, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (12, 12), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, CU_BYTES)); + ASSERT_EQ (column_range (12, 12), + get_affected_range (hint_0, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (18, 18), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, CU_BYTES)); + ASSERT_EQ (column_range (18, 18), + get_affected_range (hint_1, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); const fixit_hint *hint_2 = richloc.get_fixit_hint (2); - ASSERT_EQ (column_range (29, 28), get_affected_columns (hint_2)); + ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, CU_BYTES)); + ASSERT_EQ (column_range (29, 28), + get_affected_range (hint_2, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (29, 29), get_printed_columns (hint_2)); /* Add each hint in turn to a line_corrections instance, @@ -3357,6 +4077,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* The first replace hint by itself. */ lc.add_hint (hint_0); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); @@ -3366,6 +4087,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) lc.add_hint (hint_1); ASSERT_EQ (1, lc.m_corrections.length ()); ASSERT_STREQ ("const_cast<foo *> (", lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); @@ -3375,6 +4097,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) ASSERT_STREQ ("const_cast<foo *> (ptr->field)", lc.m_corrections[0]->m_text); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 41), lc.m_corrections[0]->m_printed_columns); } @@ -3477,6 +4200,246 @@ test_overlapped_fixit_printing (const line_table_case &case_) } } +/* Multibyte-aware version of preceding tests. See comments above + test_one_liner_simple_caret_utf8() too, we use the same two multibyte + characters here. */ + +static void +test_overlapped_fixit_printing_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + + const char *content + /* Display columns. + 00000000000000000000000111111111111111111111111222222222222222223 + 12344444444555555556789012344444444555555556789012345678999999990 */ + = " f\xf0\x9f\x98\x82 *f = (f\xf0\x9f\x98\x82 *)ptr->field\xcf\x80;\n"; + /* 00000000000000000000011111111111111111111112222222222333333333333 + 12344445555666677778901234566667777888899990123456789012333344445 + Byte columns. */ + + temp_source_file tmp (SELFTEST_LOCATION, ".C", content); + line_table_test ltt (case_); + + const line_map_ordinary *ord_map + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, + tmp.get_filename (), 0)); + + linemap_line_start (line_table, 1, 100); + + const location_t final_line_end + = linemap_position_for_line_and_column (line_table, ord_map, 6, 50); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + /* A test for converting a C-style cast to a C++-style cast. */ + const location_t open_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 14); + const location_t close_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 22); + const location_t expr_start + = linemap_position_for_line_and_column (line_table, ord_map, 1, 23); + const location_t expr_finish + = linemap_position_for_line_and_column (line_table, ord_map, 1, 34); + const location_t expr = make_location (expr_start, expr_start, expr_finish); + + /* Various examples of fix-it hints that aren't themselves consolidated, + but for which the *printing* may need consolidation. */ + + /* Example where 3 fix-it hints are printed as one. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "const_cast<"); + richloc.add_fixit_replace (close_paren, "> ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " const_cast<f\xf0\x9f\x98\x82" + " *> (ptr->field\xcf\x80" + ")\n", + pp_formatted_text (dc.printer)); + + /* Unit-test the line_corrections machinery. */ + ASSERT_EQ (3, richloc.get_num_fixit_hints ()); + const fixit_hint *hint_0 = richloc.get_fixit_hint (0); + ASSERT_EQ (column_range (14, 14), get_affected_range (hint_0, CU_BYTES)); + ASSERT_EQ (column_range (12, 12), + get_affected_range (hint_0, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); + const fixit_hint *hint_1 = richloc.get_fixit_hint (1); + ASSERT_EQ (column_range (22, 22), get_affected_range (hint_1, CU_BYTES)); + ASSERT_EQ (column_range (18, 18), + get_affected_range (hint_1, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); + const fixit_hint *hint_2 = richloc.get_fixit_hint (2); + ASSERT_EQ (column_range (35, 34), get_affected_range (hint_2, CU_BYTES)); + ASSERT_EQ (column_range (30, 29), + get_affected_range (hint_2, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (30, 30), get_printed_columns (hint_2)); + + /* Add each hint in turn to a line_corrections instance, + and verify that they are consolidated into one correction instance + as expected. */ + line_corrections lc (tmp.get_filename (), 1); + + /* The first replace hint by itself. */ + lc.add_hint (hint_0); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 14), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); + ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); + + /* After the second replacement hint, they are printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_1); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (", + lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (14, 22), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); + + /* After the final insertion hint, they are all printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_2); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (ptr->field\xcf\x80)", + lc.m_corrections[0]->m_text); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 34), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 29), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 42), lc.m_corrections[0]->m_printed_columns); + } + + /* Example where two are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CAST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CAST (-\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example where none are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CST ( -\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(bar\xf0\x9f\x98\x82 *)"); + source_range victim = {open_paren, close_paren}; + richloc.add_fixit_remove (victim); + + /* This case is actually handled by fixit-consolidation, + rather than by line_corrections. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " (bar\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(long\xf0\x9f\x98\x82 *)"); + source_range victim = {expr_start, expr_finish}; + richloc.add_fixit_remove (victim); + + /* These fixits are not consolidated. */ + ASSERT_EQ (2, richloc.get_num_fixit_hints ()); + + /* But the corrections are. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " (long\xf0\x9f\x98\x82" + " *)(f\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of insertion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before + (open_paren, "L\xf0\x9f\x98\x82NGER THAN THE CAST"); + richloc.add_fixit_insert_after (close_paren, "TEST"); + + /* The first insertion is long enough that if printed naively, + it would overlap with the second. + Verify that they are printed as a single replacement. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " L\xf0\x9f\x98\x82" + "NGER THAN THE CAST(f\xf0\x9f\x98\x82" + " *)TEST\n", + pp_formatted_text (dc.printer)); + } +} + /* Verify that the line_corrections machinery correctly prints overlapping fixit-hints that have been added in the wrong order. @@ -3526,10 +4489,10 @@ test_overlapped_fixit_printing_2 (const line_table_case &case_) /* These fixits should be accepted; they can't be consolidated. */ ASSERT_EQ (2, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (23, 22), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (23, 22), get_affected_range (hint_0, CU_BYTES)); ASSERT_EQ (column_range (23, 23), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (21, 20), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (21, 20), get_affected_range (hint_1, CU_BYTES)); ASSERT_EQ (column_range (21, 21), get_printed_columns (hint_1)); /* Verify that they're printed correctly. */ @@ -3856,10 +4819,12 @@ diagnostic_show_locus_c_tests () test_diagnostic_show_locus_unknown_location (); for_each_line_table_case (test_diagnostic_show_locus_one_liner); + for_each_line_table_case (test_diagnostic_show_locus_one_liner_utf8); for_each_line_table_case (test_add_location_if_nearby); for_each_line_table_case (test_diagnostic_show_locus_fixit_lines); for_each_line_table_case (test_fixit_consolidation); for_each_line_table_case (test_overlapped_fixit_printing); + for_each_line_table_case (test_overlapped_fixit_printing_utf8); for_each_line_table_case (test_overlapped_fixit_printing_2); for_each_line_table_case (test_fixit_insert_containing_newline); for_each_line_table_case (test_fixit_insert_containing_newline_2); diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c index a29bcf155e2..79f18d18380 100644 --- a/gcc/diagnostic.c +++ b/gcc/diagnostic.c @@ -360,9 +360,13 @@ diagnostic_get_location_text (diagnostic_context *context, const char *locus_cs = colorize_start (pp_show_color (pp), "locus"); const char *locus_ce = colorize_stop (pp_show_color (pp)); const char *file = s.file ? s.file : progname; - int line = strcmp (file, N_("<built-in>")) ? s.line : 0; - int col = context->show_column ? s.column : 0; - + int line = 0; + int col = 0; + if (strcmp (file, N_("<built-in>"))) + { + line = s.line; + col = context->show_column ? location_compute_display_column (s) : 0; + } const char *line_col = maybe_line_and_column (line, col); return build_message_string ("%s%s%s:%s", locus_cs, file, line_col, locus_ce); diff --git a/gcc/input.c b/gcc/input.c index 00301ef68dd..22141250d60 100644 --- a/gcc/input.c +++ b/gcc/input.c @@ -908,6 +908,22 @@ make_location (location_t caret, source_range src_range) return COMBINE_LOCATION_DATA (line_table, pure_loc, src_range, NULL); } +/* An expanded_location stores the column in byte units. This function + converts that column to display units. That requires reading the associated + source line in order to calculate the display width. If that cannot be done + for any reason, then returns the byte column as a fallback. */ +int +location_compute_display_column (expanded_location exploc) +{ + if (!(exploc.file && *exploc.file && exploc.line && exploc.column)) + return exploc.column; + char_span line = location_get_source_line (exploc.file, exploc.line); + /* If line is NULL, this function returns exploc.column which is the + desired fallback. */ + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), + exploc.column); +} + /* Dump statistics to stderr about the memory usage of the line_table set of line maps. This also displays some statistics about macro expansion. */ @@ -3590,6 +3606,90 @@ test_line_offset_overflow () ASSERT_NE (ordmap_a, ordmap_b); } +void test_cpp_utf8 () +{ + /* Verify that wcwidth of invalid UTF-8 or control bytes is 1. */ + { + int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8); + ASSERT_EQ (8, w_bad); + int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6); + ASSERT_EQ (6, w_ctrl); + } + + /* Verify that wcwidth of valid UTF-8 is as expected. */ + { + const int w_pi = cpp_display_width ("\xcf\x80", 2); + ASSERT_EQ (1, w_pi); + const int w_emoji = cpp_display_width ("\xf0\x9f\x98\x82", 4); + ASSERT_EQ (2, w_emoji); + const int w_umlaut_precomposed = cpp_display_width ("\xc3\xbf", 2); + ASSERT_EQ (1, w_umlaut_precomposed); + const int w_umlaut_combining = cpp_display_width ("y\xcc\x88", 3); + ASSERT_EQ (1, w_umlaut_combining); + const int w_han = cpp_display_width ("\xe4\xb8\xba", 3); + ASSERT_EQ (2, w_han); + const int w_ascii = cpp_display_width ("GCC", 3); + ASSERT_EQ (3, w_ascii); + const int w_mixed = cpp_display_width ("\xcf\x80 = 3.14 \xf0\x9f\x98\x82" + "\x9f! \xe4\xb8\xba y\xcc\x88", 24); + ASSERT_EQ (18, w_mixed); + } + + /* Verify that cpp_byte_column_to_display_column can go past the end, + and similar edge cases. */ + { + const char *str + /* Display columns. + 111111112345 */ + = "\xcf\x80 abc"; + /* 111122223456 + Byte columns. */ + + ASSERT_EQ (5, cpp_display_width (str, 6)); + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); + } + + /* Verify that cpp_display_column_to_byte_column can go past the end, + and similar edge cases, and check invertibility. */ + { + const char *str + /* Display columns. + 000000000000000000000000000000000000011 + 111111112222222234444444455555555678901 */ + = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; + /* 000000000000000000000000000000000111111 + 111122223333444456666777788889999012345 + Byte columns. */ + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); + + for (int byte_col = 1; byte_col <= 15; ++byte_col) + { + const int disp_col = cpp_byte_column_to_display_column (str, 15, + byte_col); + const int byte_col2 = cpp_display_column_to_byte_column (str, 15, + disp_col); + + /* If we ask for the display column in the middle of a UTF-8 + sequence, it will return the length of the partial sequence, + matching the behavior of GCC before display column support. + Otherwise check the round trip was successful. */ + if (byte_col < 4) + ASSERT_EQ (byte_col, disp_col); + else if (byte_col >= 6 && byte_col < 9) + ASSERT_EQ (3 + (byte_col - 5), disp_col); + else + ASSERT_EQ (byte_col2, byte_col); + } + } + +} + /* Run all of the selftests within this file. */ void @@ -3631,6 +3731,8 @@ input_c_tests () test_reading_source_line (); test_line_offset_overflow (); + + test_cpp_utf8 (); } } // namespace selftest diff --git a/gcc/input.h b/gcc/input.h index c459bf28553..35e02bd91d5 100644 --- a/gcc/input.h +++ b/gcc/input.h @@ -38,6 +38,7 @@ STATIC_ASSERT (BUILTINS_LOCATION < RESERVED_LOCATION_COUNT); extern bool is_location_from_builtin_token (location_t); extern expanded_location expand_location (location_t); +extern int location_compute_display_column (expanded_location); /* A class capturing the bounds of a buffer, to allow for run-time bounds-checking in a checked build. */ diff --git a/libcpp/charset.c b/libcpp/charset.c index d4574415ac1..8c1a16e6b0a 100644 --- a/libcpp/charset.c +++ b/libcpp/charset.c @@ -2265,3 +2265,106 @@ cpp_string_location_reader::get_next () m_loc += m_offset_per_column; return result; } + +/* Helper for cpp_byte_column_to_display_column and its inverse. Given a + pointer to a UTF-8-encoded character, compute its display width. *INBUFP + points on entry to the start of the UTF-8 encoding of the character, and + is updated to point just after the last byte of the encoding. *INBYTESLEFTP + contains on entry the remaining size of the buffer into which *INBUFP + points, and this is also updated accordingly. If *INBUFP does not + point to a valid UTF-8-encoded sequence, then it will be treated as a single + byte with display width 1. */ + +static inline int +compute_next_display_width (const uchar **inbufp, size_t *inbytesleftp) +{ + cppchar_t c; + if (one_utf8_to_cppchar (inbufp, inbytesleftp, &c) != 0) + { + /* Input is not convertible to UTF-8. This could be fine, e.g. in a + string literal, so don't complain. Just treat it as if it has a width + of one. */ + ++*inbufp; + --*inbytesleftp; + return 1; + } + + /* one_utf8_to_cppchar() has updated inbufp and inbytesleftp for us. */ + return cpp_wcwidth (c); +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + how many display columns are occupied by the first COLUMN bytes. COLUMN + may exceed DATA_LENGTH, in which case the phantom bytes at the end are + treated as if they have display width 1. */ + +int +cpp_byte_column_to_display_column (const char *data, int data_length, + int column) +{ + int display_col = 0; + const uchar *udata = (const uchar *) data; + const int offset = MAX (0, column - data_length); + size_t inbytesleft = column - offset; + while (inbytesleft) + display_col += compute_next_display_width (&udata, &inbytesleft); + return display_col + offset; +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + the least number of bytes that will result in at least DISPLAY_COL display + columns. The return value may exceed DATA_LENGTH if the entire string does + not occupy enough display columns. */ + +int +cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col) +{ + int column = 0; + const uchar *udata = (const uchar *) data; + size_t inbytesleft = data_length; + while (column < display_col && inbytesleft) + column += compute_next_display_width (&udata, &inbytesleft); + return data_length - inbytesleft + (display_col - column); +} + +/* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc, + because that will inspect the user's locale, and in particular in an ASCII + locale, it will not return anything useful for extended characters. But GCC + in other respects (see e.g. _cpp_default_encoding()) behaves as if + everything is UTF-8. We also make some tweaks that are useful for the way + GCC needs to use this data, e.g. tabs and other control characters should be + treated as having width 1. The lookup tables are generated from + contrib/unicode/gen_wcwidth.py and were made by simply calling glibc + wcwidth() on all codepoints, then applying the small tweaks. These tables + are not highly optimized, but for the present purpose of outputting + diagnostics, they are sufficient. */ + +#include "generated_cpp_wcwidth.h" +int cpp_wcwidth (cppchar_t c) +{ + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) + return wcwidth_widths[0]; + + /* Binary search the tables. */ + int begin = 1; + static const int end + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); + int len = end - begin; + do + { + int half = len/2; + int middle = begin + half; + if (c > wcwidth_range_ends[middle]) + { + begin = middle + 1; + len -= half + 1; + } + else + len = half; + } while (len); + + if (__builtin_expect (begin != end, true)) + return wcwidth_widths[begin]; + return 1; +} diff --git a/libcpp/generated_cpp_wcwidth.h b/libcpp/generated_cpp_wcwidth.h new file mode 100644 index 00000000000..ec8b73d3d01 --- /dev/null +++ b/libcpp/generated_cpp_wcwidth.h @@ -0,0 +1,156 @@ +/* Generated by contrib/unicode/gen_wcwidth.py, with the help of glibc's + utf8_gen.py, using version 12.1.0 of the Unicode standard. */ + +static const cppchar_t wcwidth_range_ends[] = { + 0x2ff, 0x36f, 0x482, 0x489, 0x590, 0x5bd, 0x5be, 0x5bf, + 0x5c0, 0x5c2, 0x5c3, 0x5c5, 0x5c6, 0x5c7, 0x60f, 0x61a, + 0x61b, 0x61c, 0x64a, 0x65f, 0x66f, 0x670, 0x6d5, 0x6dc, + 0x6de, 0x6e4, 0x6e6, 0x6e8, 0x6e9, 0x6ed, 0x710, 0x711, + 0x72f, 0x74a, 0x7a5, 0x7b0, 0x7ea, 0x7f3, 0x7fc, 0x7fd, + 0x815, 0x819, 0x81a, 0x823, 0x824, 0x827, 0x828, 0x82d, + 0x858, 0x85b, 0x8d2, 0x8e1, 0x8e2, 0x902, 0x939, 0x93a, + 0x93b, 0x93c, 0x940, 0x948, 0x94c, 0x94d, 0x950, 0x957, + 0x961, 0x963, 0x980, 0x981, 0x9bb, 0x9bc, 0x9c0, 0x9c4, + 0x9cc, 0x9cd, 0x9e1, 0x9e3, 0x9fd, 0x9fe, 0xa00, 0xa02, + 0xa3b, 0xa3c, 0xa40, 0xa42, 0xa46, 0xa48, 0xa4a, 0xa4d, + 0xa50, 0xa51, 0xa6f, 0xa71, 0xa74, 0xa75, 0xa80, 0xa82, + 0xabb, 0xabc, 0xac0, 0xac5, 0xac6, 0xac8, 0xacc, 0xacd, + 0xae1, 0xae3, 0xaf9, 0xaff, 0xb00, 0xb01, 0xb3b, 0xb3c, + 0xb3e, 0xb3f, 0xb40, 0xb44, 0xb4c, 0xb4d, 0xb55, 0xb56, + 0xb61, 0xb63, 0xb81, 0xb82, 0xbbf, 0xbc0, 0xbcc, 0xbcd, + 0xbff, 0xc00, 0xc03, 0xc04, 0xc3d, 0xc40, 0xc45, 0xc48, + 0xc49, 0xc4d, 0xc54, 0xc56, 0xc61, 0xc63, 0xc80, 0xc81, + 0xcbb, 0xcbc, 0xcbe, 0xcbf, 0xcc5, 0xcc6, 0xccb, 0xccd, + 0xce1, 0xce3, 0xcff, 0xd01, 0xd3a, 0xd3c, 0xd40, 0xd44, + 0xd4c, 0xd4d, 0xd61, 0xd63, 0xdc9, 0xdca, 0xdd1, 0xdd4, + 0xdd5, 0xdd6, 0xe30, 0xe31, 0xe33, 0xe3a, 0xe46, 0xe4e, + 0xeb0, 0xeb1, 0xeb3, 0xebc, 0xec7, 0xecd, 0xf17, 0xf19, + 0xf34, 0xf35, 0xf36, 0xf37, 0xf38, 0xf39, 0xf70, 0xf7e, + 0xf7f, 0xf84, 0xf85, 0xf87, 0xf8c, 0xf97, 0xf98, 0xfbc, + 0xfc5, 0xfc6, 0x102c, 0x1030, 0x1031, 0x1037, 0x1038, 0x103a, + 0x103c, 0x103e, 0x1057, 0x1059, 0x105d, 0x1060, 0x1070, 0x1074, + 0x1081, 0x1082, 0x1084, 0x1086, 0x108c, 0x108d, 0x109c, 0x109d, + 0x10ff, 0x115f, 0x11ff, 0x135c, 0x135f, 0x1711, 0x1714, 0x1731, + 0x1734, 0x1751, 0x1753, 0x1771, 0x1773, 0x17b3, 0x17b5, 0x17b6, + 0x17bd, 0x17c5, 0x17c6, 0x17c8, 0x17d3, 0x17dc, 0x17dd, 0x180a, + 0x180e, 0x1884, 0x1886, 0x18a8, 0x18a9, 0x191f, 0x1922, 0x1926, + 0x1928, 0x1931, 0x1932, 0x1938, 0x193b, 0x1a16, 0x1a18, 0x1a1a, + 0x1a1b, 0x1a55, 0x1a56, 0x1a57, 0x1a5e, 0x1a5f, 0x1a60, 0x1a61, + 0x1a62, 0x1a64, 0x1a6c, 0x1a72, 0x1a7c, 0x1a7e, 0x1a7f, 0x1aaf, + 0x1abe, 0x1aff, 0x1b03, 0x1b33, 0x1b34, 0x1b35, 0x1b3a, 0x1b3b, + 0x1b3c, 0x1b41, 0x1b42, 0x1b6a, 0x1b73, 0x1b7f, 0x1b81, 0x1ba1, + 0x1ba5, 0x1ba7, 0x1ba9, 0x1baa, 0x1bad, 0x1be5, 0x1be6, 0x1be7, + 0x1be9, 0x1bec, 0x1bed, 0x1bee, 0x1bf1, 0x1c2b, 0x1c33, 0x1c35, + 0x1c37, 0x1ccf, 0x1cd2, 0x1cd3, 0x1ce0, 0x1ce1, 0x1ce8, 0x1cec, + 0x1ced, 0x1cf3, 0x1cf4, 0x1cf7, 0x1cf9, 0x1dbf, 0x1df9, 0x1dfa, + 0x1dff, 0x200a, 0x200f, 0x2029, 0x202e, 0x205f, 0x2064, 0x2065, + 0x206f, 0x20cf, 0x20f0, 0x2319, 0x231b, 0x2328, 0x232a, 0x23e8, + 0x23ec, 0x23ef, 0x23f0, 0x23f2, 0x23f3, 0x25fc, 0x25fe, 0x2613, + 0x2615, 0x2647, 0x2653, 0x267e, 0x267f, 0x2692, 0x2693, 0x26a0, + 0x26a1, 0x26a9, 0x26ab, 0x26bc, 0x26be, 0x26c3, 0x26c5, 0x26cd, + 0x26ce, 0x26d3, 0x26d4, 0x26e9, 0x26ea, 0x26f1, 0x26f3, 0x26f4, + 0x26f5, 0x26f9, 0x26fa, 0x26fc, 0x26fd, 0x2704, 0x2705, 0x2709, + 0x270b, 0x2727, 0x2728, 0x274b, 0x274c, 0x274d, 0x274e, 0x2752, + 0x2755, 0x2756, 0x2757, 0x2794, 0x2797, 0x27af, 0x27b0, 0x27be, + 0x27bf, 0x2b1a, 0x2b1c, 0x2b4f, 0x2b50, 0x2b54, 0x2b55, 0x2cee, + 0x2cf1, 0x2d7e, 0x2d7f, 0x2ddf, 0x2dff, 0x2e7f, 0x2e99, 0x2e9a, + 0x2ef3, 0x2eff, 0x2fd5, 0x2fef, 0x2ffb, 0x2fff, 0x3029, 0x302d, + 0x303e, 0x3040, 0x3096, 0x3098, 0x309a, 0x30ff, 0x3104, 0x312f, + 0x3130, 0x318e, 0x318f, 0x31ba, 0x31bf, 0x31e3, 0x31ef, 0x321e, + 0x321f, 0x4db5, 0x4dbf, 0x9fef, 0x9fff, 0xa48c, 0xa48f, 0xa4c6, + 0xa66e, 0xa672, 0xa673, 0xa67d, 0xa69d, 0xa69f, 0xa6ef, 0xa6f1, + 0xa801, 0xa802, 0xa805, 0xa806, 0xa80a, 0xa80b, 0xa824, 0xa826, + 0xa8c3, 0xa8c5, 0xa8df, 0xa8f1, 0xa8fe, 0xa8ff, 0xa925, 0xa92d, + 0xa946, 0xa951, 0xa95f, 0xa97c, 0xa97f, 0xa982, 0xa9b2, 0xa9b3, + 0xa9b5, 0xa9b9, 0xa9bb, 0xa9bd, 0xa9e4, 0xa9e5, 0xaa28, 0xaa2e, + 0xaa30, 0xaa32, 0xaa34, 0xaa36, 0xaa42, 0xaa43, 0xaa4b, 0xaa4c, + 0xaa7b, 0xaa7c, 0xaaaf, 0xaab0, 0xaab1, 0xaab4, 0xaab6, 0xaab8, + 0xaabd, 0xaabf, 0xaac0, 0xaac1, 0xaaeb, 0xaaed, 0xaaf5, 0xaaf6, + 0xabe4, 0xabe5, 0xabe7, 0xabe8, 0xabec, 0xabed, 0xabff, 0xd7a3, + 0xf8ff, 0xfa6d, 0xfa6f, 0xfad9, 0xfb1d, 0xfb1e, 0xfdff, 0xfe0f, + 0xfe19, 0xfe1f, 0xfe2f, 0xfe52, 0xfe53, 0xfe66, 0xfe67, 0xfe6b, + 0xfefe, 0xfeff, 0xff00, 0xff60, 0xffdf, 0xffe6, 0xfff8, 0xfffb, + 0x101fc, 0x101fd, 0x102df, 0x102e0, 0x10375, 0x1037a, 0x10a00, 0x10a03, + 0x10a04, 0x10a06, 0x10a0b, 0x10a0f, 0x10a37, 0x10a3a, 0x10a3e, 0x10a3f, + 0x10ae4, 0x10ae6, 0x10d23, 0x10d27, 0x10f45, 0x10f50, 0x11000, 0x11001, + 0x11037, 0x11046, 0x1107e, 0x11081, 0x110b2, 0x110b6, 0x110b8, 0x110ba, + 0x110ff, 0x11102, 0x11126, 0x1112b, 0x1112c, 0x11134, 0x11172, 0x11173, + 0x1117f, 0x11181, 0x111b5, 0x111be, 0x111c8, 0x111cc, 0x1122e, 0x11231, + 0x11233, 0x11234, 0x11235, 0x11237, 0x1123d, 0x1123e, 0x112de, 0x112df, + 0x112e2, 0x112ea, 0x112ff, 0x11301, 0x1133a, 0x1133c, 0x1133f, 0x11340, + 0x11365, 0x1136c, 0x1136f, 0x11374, 0x11437, 0x1143f, 0x11441, 0x11444, + 0x11445, 0x11446, 0x1145d, 0x1145e, 0x114b2, 0x114b8, 0x114b9, 0x114ba, + 0x114be, 0x114c0, 0x114c1, 0x114c3, 0x115b1, 0x115b5, 0x115bb, 0x115bd, + 0x115be, 0x115c0, 0x115db, 0x115dd, 0x11632, 0x1163a, 0x1163c, 0x1163d, + 0x1163e, 0x11640, 0x116aa, 0x116ab, 0x116ac, 0x116ad, 0x116af, 0x116b5, + 0x116b6, 0x116b7, 0x1171c, 0x1171f, 0x11721, 0x11725, 0x11726, 0x1172b, + 0x1182e, 0x11837, 0x11838, 0x1183a, 0x119d3, 0x119d7, 0x119d9, 0x119db, + 0x119df, 0x119e0, 0x11a00, 0x11a0a, 0x11a32, 0x11a38, 0x11a3a, 0x11a3e, + 0x11a46, 0x11a47, 0x11a50, 0x11a56, 0x11a58, 0x11a5b, 0x11a89, 0x11a96, + 0x11a97, 0x11a99, 0x11c2f, 0x11c36, 0x11c37, 0x11c3d, 0x11c3e, 0x11c3f, + 0x11c91, 0x11ca7, 0x11ca9, 0x11cb0, 0x11cb1, 0x11cb3, 0x11cb4, 0x11cb6, + 0x11d30, 0x11d36, 0x11d39, 0x11d3a, 0x11d3b, 0x11d3d, 0x11d3e, 0x11d45, + 0x11d46, 0x11d47, 0x11d8f, 0x11d91, 0x11d94, 0x11d95, 0x11d96, 0x11d97, + 0x11ef2, 0x11ef4, 0x1342f, 0x13438, 0x16aef, 0x16af4, 0x16b2f, 0x16b36, + 0x16f4e, 0x16f4f, 0x16f8e, 0x16f92, 0x16fdf, 0x16fe3, 0x16fff, 0x187f7, + 0x187ff, 0x18af2, 0x1afff, 0x1b11e, 0x1b14f, 0x1b152, 0x1b163, 0x1b167, + 0x1b16f, 0x1b2fb, 0x1bc9c, 0x1bc9e, 0x1bc9f, 0x1bca3, 0x1d166, 0x1d169, + 0x1d172, 0x1d182, 0x1d184, 0x1d18b, 0x1d1a9, 0x1d1ad, 0x1d241, 0x1d244, + 0x1d9ff, 0x1da36, 0x1da3a, 0x1da6c, 0x1da74, 0x1da75, 0x1da83, 0x1da84, + 0x1da9a, 0x1da9f, 0x1daa0, 0x1daaf, 0x1dfff, 0x1e006, 0x1e007, 0x1e018, + 0x1e01a, 0x1e021, 0x1e022, 0x1e024, 0x1e025, 0x1e02a, 0x1e12f, 0x1e136, + 0x1e2eb, 0x1e2ef, 0x1e8cf, 0x1e8d6, 0x1e943, 0x1e94a, 0x1f003, 0x1f004, + 0x1f0ce, 0x1f0cf, 0x1f18d, 0x1f18e, 0x1f190, 0x1f19a, 0x1f1ff, 0x1f202, + 0x1f20f, 0x1f23b, 0x1f23f, 0x1f248, 0x1f24f, 0x1f251, 0x1f25f, 0x1f265, + 0x1f2ff, 0x1f320, 0x1f32c, 0x1f335, 0x1f336, 0x1f37c, 0x1f37d, 0x1f393, + 0x1f39f, 0x1f3ca, 0x1f3ce, 0x1f3d3, 0x1f3df, 0x1f3f0, 0x1f3f3, 0x1f3f4, + 0x1f3f7, 0x1f43e, 0x1f43f, 0x1f440, 0x1f441, 0x1f4fc, 0x1f4fe, 0x1f53d, + 0x1f54a, 0x1f54e, 0x1f54f, 0x1f567, 0x1f579, 0x1f57a, 0x1f594, 0x1f596, + 0x1f5a3, 0x1f5a4, 0x1f5fa, 0x1f64f, 0x1f67f, 0x1f6c5, 0x1f6cb, 0x1f6cc, + 0x1f6cf, 0x1f6d2, 0x1f6d4, 0x1f6d5, 0x1f6ea, 0x1f6ec, 0x1f6f3, 0x1f6fa, + 0x1f7df, 0x1f7eb, 0x1f90c, 0x1f971, 0x1f972, 0x1f976, 0x1f979, 0x1f9a2, + 0x1f9a4, 0x1f9aa, 0x1f9ad, 0x1f9ca, 0x1f9cc, 0x1f9ff, 0x1fa6f, 0x1fa73, + 0x1fa77, 0x1fa7a, 0x1fa7f, 0x1fa82, 0x1fa8f, 0x1fa95, 0x1ffff, 0x2a6d6, + 0x2a6ff, 0x2b734, 0x2b73f, 0x2b81d, 0x2b81f, 0x2cea1, 0x2ceaf, 0x2ebe0, + 0x2f7ff, 0x2fa1d, 0xe0000, 0xe0001, 0xe001f, 0xe007f, 0xe00ff, 0xe01ef, +}; + +static const unsigned char wcwidth_widths[] = { + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 0, 2, 1, 2, 1, 0, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, + 2, 1, 0, 2, 1, 2, 1, 2, 1, 0, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, +}; diff --git a/libcpp/include/cpplib.h b/libcpp/include/cpplib.h index ed108f17bfa..e199aecfa48 100644 --- a/libcpp/include/cpplib.h +++ b/libcpp/include/cpplib.h @@ -1320,4 +1320,15 @@ extern bool cpp_userdef_char_p extern const char * cpp_get_userdef_suffix (const cpp_token *); +/* In charset.c */ +int cpp_byte_column_to_display_column (const char *data, int data_length, + int column); +inline int cpp_display_width (const char *data, int data_length) +{ + return cpp_byte_column_to_display_column (data, data_length, data_length); +} +int cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col); +int cpp_wcwidth (cppchar_t c); + #endif /* ! LIBCPP_CPPLIB_H */ ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-11-20 16:31 ` Lewis Hyatt @ 2019-11-20 16:39 ` Lewis Hyatt 2019-11-22 3:24 ` David Malcolm 0 siblings, 1 reply; 17+ messages in thread From: Lewis Hyatt @ 2019-11-20 16:39 UTC (permalink / raw) To: David Malcolm; +Cc: gcc-patches, joseph [-- Attachment #1: Type: text/plain, Size: 160459 bytes --] My apologies, that patch had whitespace issues. Corrected version attached. On Wed, Nov 20, 2019 at 11:27:08AM -0500, Lewis Hyatt wrote: > On Tue, Nov 19, 2019 at 12:30:39PM -0500, David Malcolm wrote: > > Thanks for posting this patch; I'm sorry about how long it's taken me > > to review it. > > > > Thank you very much for the thorough review and the great suggestions. I > know it was a lot to look through... I attached an updated patch that > incorporates your comments. I also put some more responses inline > below. > > > BTW, have you done GCC contributor paperwork? > > https://gcc.gnu.org/contribute.html#legal > > > > Yes, all set there. > > > > diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py > > > new file mode 100755 > > > index 00000000000..02b28bcedcf > > > --- /dev/null > > > +++ b/contrib/unicode/gen_wcwidth.py > > > > [...snip...] > > > > If we're going with this approach (which I'll leave to Joseph), perhaps > > this directory should have a brief README (covering much of the material > > you've mentioned in the email with the patch, talking about syncing with > > glibc, regenerating the data, etc). > > > > I took a stab at that in this revised patch. > > > > diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c > > The patch uses a bool in many places to indicate what kind of column is > > being referred to. I think an enum would be more typesafe and > > self-documenting - perhaps: > > "enum column_unit" with values CU_BYTES, CU_DISPLAY_COLUMN? or > > "enum column_kind" with values CK_BYTES, CK_DISPLAY_COLUMN? > > I wonder if this might eventually grow a third value, representing the > > a count of unicode characters, but that's out of scope for this patch. > > > > That's a good idea, yeah, done. > > > I should confess that it took me a while to realize the whole > > multi-column display thing (I had an "aha" moment, then felt rather > > foolish, given that I'd been playing with the examples in the PR; it was > > on reading through the ASCII art in the new selftests and going "huh" > > that I had my epiphany on the problem your patch is solving). > > > > I think this file could use a high-level introductory comment at the top > > talking about the various meanings of "column". I liked the two example > > code points you used below, so perhaps have a comment up at the top > > talking about the distinction between byte vs display column, using > > those code points as examples (and a plain ASCII character, by way of > > contrast). Perhaps have the comment describing the enum be the big > > introductory comment. > > > > It would be good for that introductory comment to have a copy of the > > ASCII art you used in the selftests below, or similar. > > > > Done, I beefed up the introductory comments as you suggested. > > > > @@ -120,10 +143,17 @@ class layout_point > > > linenum_type m_line; > > > int m_column; > > > + int m_display_col; > > > > Does it simplify things if this is an array accessed via the enum? > > (not sure, just a thought that occurred to me) > > > > I think on balance it is simpler with the array, yeah. Done. > > > > @@ -574,20 +621,23 @@ test_layout_range_for_single_point () > > > > > > /* Tests for layout_range::contains_point. */ > > > > > > - /* Before the line. */ > > > - ASSERT_FALSE (point.contains_point (6, 1)); > > > + for (int use_display = 0; use_display <= 1; ++use_display) > > > + { > > > + /* Before the line. */ > > > + ASSERT_FALSE (point.contains_point (6, 1, use_display)); > > > > [...snip...] > > > > Here you generalize the layout_range tests to iterate over both > > meanings of "column". > > > > If I'm reading things right, implicit here is that the layout_point > > ctors within the layout range are now calling: > > m_display_col (location_compute_display_column (exploc)) > > which in this selftest is looking for a file named "test.c", > > presumably not finding it, and hitting the case of a NULL "line" > > char_span. > > > > So if there happens to be a test.c in the current directory > > containing the "right" characters, this selftest could break. > > > > Previously it's never mattered to this selftest whether or not > > there was an actual test.c, so it might be good to modify it > > to use temp_source_file (and maybe even to have some multicolumn > > chars in it, though that might be taking things too far). > > > > Assuming we're comfortable that the other selftests exercise the > multibyte logic sufficiently, it seems simplest just to use an empty > string rather than "test.c", since nothing is actually expecting to > read a file here. I did that for now, and also made sure that > location_get_display_column() will not try to open an empty filename > either. > > > > > static int > > > get_line_width_without_trailing_whitespace (const char *line, int line_width) > > > > Why is get_line_width_without_trailing_whitespace done in bytes? > > It's used for calculating the maximum number of printed columns, to try > > to cope with extra wide source lines, offsetting things to fit within the width > > of the user's terminal. > > > > It's used in two places. Once in the layout::layout() constructor to > compute the m_x_offset in display columns for wide lines, and then > again in layout::print_source_line(), which handles printing arbitrary > source lines, not necessarily the primary line that was inspected in > the constructor. So the m_x_offset needs to be in display column > units, that are then translated back to bytes for each different line > to which it applies. For this it seemed most convenient for > get_line_width_without_trailing_whitespace() to return the bytes > offset, since that's what we need in layout::print_source_line() to > find the end of the line. > > > > > @@ -1415,9 +1498,11 @@ class line_label > > > public: > > > line_label (int state_idx, int column, label_text text) > > > : m_state_idx (state_idx), m_column (column), > > > - m_text (text), m_length (strlen (text.m_buffer)), > > > - m_label_line (0) > > > - {} > > > + m_text (text), m_label_line (0) > > > + { > > > + const int bytes = strlen (text.m_buffer); > > > + m_length = cpp_display_width (text.m_buffer, bytes); > > > + } > > > > Please rename m_length to m_display_width, given that it's changing meaning. > > > > > > Done. > > > > @@ -1825,7 +1938,8 @@ public: > > > > > > /* The text to be inserted/used as replacement. */ > > > char *m_text; > > > - size_t m_len; > > > + size_t m_bytes; > > > > How about: > > > > size_t m_byte_length; /* not including 0-terminator. */ > > > > ? > > > > Done. > > > > @@ -1947,7 +2062,7 @@ line_corrections::add_hint (const fixit_hint *hint) > > > /* Consolidate into the last correction: > > > add a no-op "replace" of the "between" text, and > > > add the text from the new hint. */ > > > - int old_len = last_correction->m_len; > > > + int old_len = last_correction->m_bytes; > > > > Maybe rename to old_len, new_len to old_byte_len, new_byte_len? > > > > Done. > > > Thanks for exercising all this with selftests. > > > > Presumably this involved a big copy-and-paste from the existing > > selftests. > > > > How did you generate the expected output for the various _utf8 > > selftests? Was it a lot of tedious manual editing, or is there a handy > > way to do this? (I'm nervous about how much work it will be to update > > these if e.g. we want to experiment with new ways of printing fix-it > > hints) > > > > I just went through the existing tests one by one and adapted them > manually. I made them with the actual UTF-8 chars initially so that it > made sense visually, and then replaced to hex escapes and aligned the > lines manually at the end. Wasn't so bad this way. I don't think it > would have been especially easy to automate because there were some > non-mechanical adjustments made, e.g. to make sure to exercise edge > cases like where two strings would overlap in byte units, but not in > display units. I feel like it wouldn't be necessary to add UTF-8 > duplicates of all new future tests, hopefully -- rather could just > insure that all new test cases include a multibyte character or two? > Anyway I am happy to help with that if it comes up in the future too. > > > > + /* Example where all the labels fit on one line. */ > > > + { > > > + text_range_label label0 > > > + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); > > > + text_range_label label1 > > > + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); > > > + text_range_label label2 > > > + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" > > > + "\xcf\x80"); > > > > Can you add a comment describing these labels. > > In particular the label placement code is meant to ensure that labels > > don't overlap, so I think this is adding coverage that we're computing > > using display columns when placing labels, since otherwise foo's label > > would need to be pushed onto a new line to avoid overlapping the other > > labels. > > > > Done. > > > > + /* Verify that we can disable label-printing. */ > > > + { > > > + test_diagnostic_context dc; > > > + dc.show_labels_p = false; > > > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > > > + ASSERT_STREQ ("\n" > > > + " \xf0\x9f\x98\x82" > > > + "_foo = \xcf\x80" > > > + "_bar.\xf0\x9f\x98\x82" > > > + "_field\xcf\x80" > > > + ";\n" > > > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n", > > > + pp_formatted_text (dc.printer)); > > > + } > > > > This part of the test might be redundant. > > > > Agreed, I removed it. > > > > + ASSERT_STREQ ("\n" > > > + " \xf0\x9f\x98\x82" > > > + "_foo = \xcf\x80" > > > + "_bar.\xf0\x9f\x98\x82" > > > + "_field\xcf\x80" > > > + ";\n" > > > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" > > > + " | | |\n" > > > + " | | c\n" > > > + " aaaaa\xf0\x9f\x98\x82\xcf\x80" > > > + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", > > > + pp_formatted_text (dc.printer)); > > > > It's hard to tell from the escaped expected string, but presumably this > > matches the comment about boundary conditions, right? (compared with > > the ASCII case). > > > > Correct. What I found useful for testing, was just to add an extra > character to the expected string to make the test fail. Then the > expected output goes to stderr the way it should look with the actual > extended characters, and you can verify it tests what was intended. > > > > diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c > > > index 96b6fa30052..8638fbebb2d 100644 > > > --- a/gcc/diagnostic.c > > > +++ b/gcc/diagnostic.c > > > @@ -346,9 +346,13 @@ diagnostic_get_location_text (diagnostic_context *context, > > > const char *locus_cs = colorize_start (pp_show_color (pp), "locus"); > > > const char *locus_ce = colorize_stop (pp_show_color (pp)); > > > const char *file = s.file ? s.file : progname; > > > - int line = strcmp (file, N_("<built-in>")) ? s.line : 0; > > > - int col = context->show_column ? s.column : 0; > > > - > > > + int line = 0; > > > + int col = 0; > > > + if (strcmp (file, N_("<built-in>"))) > > > + { > > > + line = s.line; > > > + col = context->show_column ? location_compute_display_column (s) : 0; > > > + } > > > > Why does the patch use the display column here? > > > > Ideally it would be the count of unicode characters, but I think we want > > to preserve the current behavior of using a byte offset. > > > > So that column number was actually the original motivation for the PR > 49973 from several years ago. It seems to me that the discussion there > concluded that the column number should be the display column > (Joseph's comment > https://gcc.gnu.org/bugzilla/show_bug.cgi?id=49973#c10). It makes > sense to me that this column should match what you see in your editor, > which would be the display column, but I don't know if some standards > have evolved here. > > > > +int > > > +location_compute_display_column (expanded_location exploc) > > > +{ > > > + if (!(exploc.file && exploc.line && exploc.column)) > > > + return exploc.column; > > > + char_span line = location_get_source_line (exploc.file, exploc.line); > > > + /* If line is NULL, this function returns exploc.column which is the > > > + desired fallback. */ > > > + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), > > > + exploc.column); > > > +} > > > > This new function needs a leading comment (in particular spelling out the > > "file not found" error-handling). > > Done. > > > > + const char *str = "\xcf\x80 abc"; > > > + ASSERT_EQ (5, cpp_display_width (str, 6)); > > > + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); > > > + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); > > > + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); > > > + } > > > + > > > + /* Verify that cpp_display_column_to_byte_column can go past the end, > > > + and similar edge cases. */ > > > + { > > > + const char *str = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; > > > + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); > > > + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); > > > + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); > > > + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); > > > + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); > > > > I think the two "str" consts could use comments showing the numbering > > within them, like. > > > > Done. > > > Maybe a brute force test for inverse, something like: > > > > for (int display_column = 0; display_column < 20; display_column++) > > { > > int byte_column = cpp_display_column_to_byte_column (str, 15, display_column); > > ASSERT_EQ (cpp_byte_column_to_display_column (str, 15, byte_column), > > display_column); > > } > > > > or similar? > > > > What happens if you request a display column that's in the middle of a > > character? It feels like we ought to have selftest coverage for that. > > > > In this case the UTF-8 conversion fails so it treats each byte as a > display width of 1, basically falling back to the existing behavior of > GCC whenever things don't make sense. I added a selftest for the > round-trip conversion as you suggested; this test needs to make an > exception for partial codepoints, so it tests both things effectively. > > > > +int cpp_wcwidth (cppchar_t c) > > > +{ > > > + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) > > > + return wcwidth_widths[0]; > > > + > > > + /* Binary search the tables. */ > > > + int begin = 1; > > > + static const int end > > > + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); > > > + int len = end - begin; > > > + do > > > + { > > > + int half = len/2; > > > + int middle = begin + half; > > > + if (c > wcwidth_range_ends[middle]) > > > + { > > > + begin = middle + 1; > > > + len -= half + 1; > > > + } > > > + else > > > + len = half; > > > + } while (len); > > > + > > > + if (__builtin_expect (begin != end, true)) > > > + return wcwidth_widths[begin]; > > > + return 1; > > > +} > > > > Please can you add some unit-testing for this function in selftest form to input.c > > (i.e. testing a few specific code points). > > > > [...snip...] > > The second block of test_cpp_utf() in input.c contained tests for a > couple codepoints already (pi, an emoji, ascii, and invalid utf8). I > added a couple more specific codepoints, something from latin-1, a > combining character, and a Chinese character. Please let me know if > that seems good now or if there should be more. It's easy enough to > add more. > > > > > Again, thanks for this patch, and sorry again for the delay in reviewing it. > > Thanks for your time, I appreciate it! I think it would be great if > this can get in for GCC 10, since otherwise the new support for UTF-8 > identifiers would feel rather incomplete. > > -Lewis > /ChangeLog > 2019-11-20 Lewis Hyatt <lhyatt@gmail.com> > > PR preprocessor/49973 > * contrib/unicode/from_glibc/unicode_utils.py: Support script from > glibc (commit 464cd3) to extract character widths from Unicode data > files. > * contrib/unicode/from_glibc/utf8_gen.py: Likewise. > * contrib/unicode/UnicodeData.txt: Unicode v. 12.1.0 data file. > * contrib/unicode/EastAsianWidth.txt: Likewise. > * contrib/unicode/PropList.txt: Likewise. > * contrib/unicode/gen_wcwidth.py: New utility to generate > libcpp/generated_cpp_wcwidth.h with help from the glibc support > scripts and the Unicode data files. > * contrib/unicode/README: New explanatory file. > > libcpp/ChangeLog > 2019-11-20 Lewis Hyatt <lhyatt@gmail.com> > > PR preprocessor/49973 > * generated_cpp_wcwidth.h: New file generated by > ../contrib/unicode/gen_wcwidth.py, supports new cpp_wcwidth function. > * charset.c (compute_next_display_width): New function to help > implement display columns. > (cpp_byte_column_to_display_column): Likewise. > (cpp_display_column_to_byte_column): Likewise. > (cpp_wcwidth): Likewise. > * include/cpplib.h (cpp_byte_column_to_display_column): Declare. > (cpp_display_column_to_byte_column): Declare. > (cpp_wcwidth): Declare. > (cpp_display_width): New function. > > gcc/ChangeLog > 2019-11-20 Lewis Hyatt <lhyatt@gmail.com> > > PR preprocessor/49973 > * input.c (location_compute_display_column): New function to help with > multibyte awareness in diagnostics. > (test_cpp_utf8): New self-test. > (input_c_tests): Call the new test. > * input.h (location_compute_display_column): Declare. > * diagnostic.c (diagnostic_get_location_text): Use it to output the > correct column number on diagnostics for source lines containing > multibyte characters. > * diagnostic-show-locus.c: Pervasive changes to add multibyte awareness > to all classes and functions. > (enum column_unit): New enum. > (class exploc_with_display_col): New class. > (class layout_point): Convert m_column member to array m_columns[2]. > (layout_range::contains_point): Add col_unit argument. > (test_layout_range_for_single_point): Pass new argument. > (test_layout_range_for_single_line): Likewise. > (test_layout_range_for_multiple_lines): Likewise. > (line_bounds::convert_to_display_cols): New function. > (layout::get_state_at_point): Add col_unit argument. > (make_range): Use empty filename rather than dummy filename. > (class layout): m_exploc changed to exploc_with_display_col from > plain expanded_location. > (layout::layout): Add multibyte awareness. > (layout::print_source_line): Likewise. > (layout::print_line): Likewise. > (layout::print_annotation_line): Likewise. > (line_label::line_label): Likewise. > (layout::print_any_labels): Likewise. > (layout::annotation_line_showed_range_p): Likewise. > (get_printed_columns): Likewise. > (class line_label): Rename m_length to m_display_width. > (get_affected_columns): Rename to... > (get_affected_range): ...this; add col_unit argument and multibyte > awareness. > (class correction): Add m_affected_bytes and m_display_cols > members. Rename m_len to m_byte_length for clarity. Add multibyte > awareness throughout. > (correction::insertion_p): Add multibyte awareness. > (correction::compute_display_cols): New function. > (correction::ensure_terminated): Use new member name m_byte_length. > (line_corrections::add_hint): Add multibyte awareness. > (layout::print_trailing_fixits): Likewise. > (layout::get_x_bound_for_row): Likewise. > (test_one_liner_simple_caret_utf8): New self-test analogous to the one > with _utf8 suffix removed, testing multibyte awareness. > (test_one_liner_caret_and_range_utf8): Likewise. > (test_one_liner_multiple_carets_and_ranges_utf8): Likewise. > (test_one_liner_fixit_insert_before_utf8): Likewise. > (test_one_liner_fixit_insert_after_utf8): Likewise. > (test_one_liner_fixit_remove_utf8): Likewise. > (test_one_liner_fixit_replace_utf8): Likewise. > (test_one_liner_fixit_replace_non_equal_range_utf8): Likewise. > (test_one_liner_fixit_replace_equal_secondary_range_utf8): Likewise. > (test_one_liner_fixit_validation_adhoc_locations_utf8): Likewise. > (test_one_liner_many_fixits_1_utf8): Likewise. > (test_one_liner_many_fixits_2_utf8): Likewise. > (test_one_liner_labels_utf8): Likewise. > (test_diagnostic_show_locus_one_liner_utf8): Likewise. > (test_overlapped_fixit_printing_utf8): Likewise. > (test_overlapped_fixit_printing): Adapt for changes to > get_affected_columns, get_printed_columns and class corrections. > (test_overlapped_fixit_printing_2): Likewise. > (diagnostic_show_locus_c_tests): Call new tests. > diff --git a/contrib/unicode/README b/contrib/unicode/README > new file mode 100644 > index 00000000000..fbee919647b > --- /dev/null > +++ b/contrib/unicode/README > @@ -0,0 +1,36 @@ > +This directory contains a mechanism for GCC to have its own internal > +implementation of wcwidth functionality. (cpp_wcwidth () in libcpp/charset.c). > + > +The idea is to produce the necessary lookup table > +(../../libcpp/generated_cpp_wcwidth.h) in a reproducible way, starting from the > +following files that are distributed by the Unicode Consortium: > + > +ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt > +ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt > +ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt > + > +These three files have been added to source control in this directory. > + > +In order to keep in sync with glibc's wcwidth as much as possible, it is > +desirable for the logic that processes the Unicode data to be the same as > +glibc's. To that end, we also put in this directory, in the from_glibc/ > +directory, the glibc python code that implements their logic. This code was > +copied verbatim from glibc, and it can be updated at any time from the glibc > +source code repository. > + > +Finally, the script gen_wcwidth.py found here contains the GCC-specific code to > +map glibc's output to the lookup tables we require. This script should not need > +to change, unless there are structural changes to the Unicode data files or to > +the glibc code. > + > +The procedure to update GCC's wcwidth tables is the following: > + > +1. Update the three Unicode data files from the above URLs. > + > +2. Update the two glibc files in from_glibc/ from glibc's git. > + > +3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_wcwidth.h > + (where X.Y is the version of the Unicode standard corresponding to the > + Unicode data files being used, most recently, 12.0). > + > +After that, GCC's wcwidth will match the most recent glibc. > diff --git a/contrib/unicode/from_glibc/unicode_utils.py b/contrib/unicode/from_glibc/unicode_utils.py > new file mode 100644 > index 00000000000..a9e94cce418 > --- /dev/null > +++ b/contrib/unicode/from_glibc/unicode_utils.py > @@ -0,0 +1,527 @@ > +# Utilities to generate Unicode data for glibc from upstream Unicode data. > +# > +# Copyright (C) 2014-2019 Free Software Foundation, Inc. > +# This file is part of the GNU C Library. > +# > +# The GNU C 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 2.1 of the License, or (at your option) any later version. > +# > +# The GNU C 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 > +# Lesser General Public License for more details. > +# > +# You should have received a copy of the GNU Lesser General Public > +# License along with the GNU C Library; if not, see > +# <https://www.gnu.org/licenses/>. > + > +''' > +This module contains utilities used by the scripts to generate > +Unicode data for glibc from upstream Unicode data files. > +''' > + > +import sys > +import re > + > + > +# Common locale header. > +COMMENT_HEADER = """ > +% This file is part of the GNU C Library and contains locale data. > +% The Free Software Foundation does not claim any copyright interest > +% in the locale data contained in this file. The foregoing does not > +% affect the license of the GNU C Library as a whole. It does not > +% exempt you from the conditions of the license if your use would > +% otherwise be governed by that license. > +""" > + > +# Dictionary holding the entire contents of the UnicodeData.txt file > +# > +# Contents of this dictionary look like this: > +# > +# {0: {'category': 'Cc', > +# 'title': None, > +# 'digit': '', > +# 'name': '<control>', > +# 'bidi': 'BN', > +# 'combining': '0', > +# 'comment': '', > +# 'oldname': 'NULL', > +# 'decomposition': '', > +# 'upper': None, > +# 'mirrored': 'N', > +# 'lower': None, > +# 'decdigit': '', > +# 'numeric': ''}, > +# … > +# } > +UNICODE_ATTRIBUTES = {} > + > +# Dictionary holding the entire contents of the DerivedCoreProperties.txt file > +# > +# Contents of this dictionary look like this: > +# > +# {917504: ['Default_Ignorable_Code_Point'], > +# 917505: ['Case_Ignorable', 'Default_Ignorable_Code_Point'], > +# … > +# } > +DERIVED_CORE_PROPERTIES = {} > + > +# Dictionary holding the entire contents of the EastAsianWidths.txt file > +# > +# Contents of this dictionary look like this: > +# > +# {0: 'N', … , 45430: 'W', …} > +EAST_ASIAN_WIDTHS = {} > + > +def fill_attribute(code_point, fields): > + '''Stores in UNICODE_ATTRIBUTES[code_point] the values from the fields. > + > + One entry in the UNICODE_ATTRIBUTES dictionary represents one line > + in the UnicodeData.txt file. > + > + ''' > + UNICODE_ATTRIBUTES[code_point] = { > + 'name': fields[1], # Character name > + 'category': fields[2], # General category > + 'combining': fields[3], # Canonical combining classes > + 'bidi': fields[4], # Bidirectional category > + 'decomposition': fields[5], # Character decomposition mapping > + 'decdigit': fields[6], # Decimal digit value > + 'digit': fields[7], # Digit value > + 'numeric': fields[8], # Numeric value > + 'mirrored': fields[9], # mirrored > + 'oldname': fields[10], # Old Unicode 1.0 name > + 'comment': fields[11], # comment > + # Uppercase mapping > + 'upper': int(fields[12], 16) if fields[12] else None, > + # Lowercase mapping > + 'lower': int(fields[13], 16) if fields[13] else None, > + # Titlecase mapping > + 'title': int(fields[14], 16) if fields[14] else None, > + } > + > +def fill_attributes(filename): > + '''Stores the entire contents of the UnicodeData.txt file > + in the UNICODE_ATTRIBUTES dictionary. > + > + A typical line for a single code point in UnicodeData.txt looks > + like this: > + > + 0041;LATIN CAPITAL LETTER A;Lu;0;L;;;;;N;;;;0061; > + > + Code point ranges are indicated by pairs of lines like this: > + > + 4E00;<CJK Ideograph, First>;Lo;0;L;;;;;N;;;;; > + 9FCC;<CJK Ideograph, Last>;Lo;0;L;;;;;N;;;;; > + ''' > + with open(filename, mode='r') as unicode_data_file: > + fields_start = [] > + for line in unicode_data_file: > + fields = line.strip().split(';') > + if len(fields) != 15: > + sys.stderr.write( > + 'short line in file "%(f)s": %(l)s\n' %{ > + 'f': filename, 'l': line}) > + exit(1) > + if fields[2] == 'Cs': > + # Surrogates are UTF-16 artefacts, > + # not real characters. Ignore them. > + fields_start = [] > + continue > + if fields[1].endswith(', First>'): > + fields_start = fields > + fields_start[1] = fields_start[1].split(',')[0][1:] > + continue > + if fields[1].endswith(', Last>'): > + fields[1] = fields[1].split(',')[0][1:] > + if fields[1:] != fields_start[1:]: > + sys.stderr.write( > + 'broken code point range in file "%(f)s": %(l)s\n' %{ > + 'f': filename, 'l': line}) > + exit(1) > + for code_point in range( > + int(fields_start[0], 16), > + int(fields[0], 16)+1): > + fill_attribute(code_point, fields) > + fields_start = [] > + continue > + fill_attribute(int(fields[0], 16), fields) > + fields_start = [] > + > +def fill_derived_core_properties(filename): > + '''Stores the entire contents of the DerivedCoreProperties.txt file > + in the DERIVED_CORE_PROPERTIES dictionary. > + > + Lines in DerivedCoreProperties.txt are either a code point range like > + this: > + > + 0061..007A ; Lowercase # L& [26] LATIN SMALL LETTER A..LATIN SMALL LETTER Z > + > + or a single code point like this: > + > + 00AA ; Lowercase # Lo FEMININE ORDINAL INDICATOR > + > + ''' > + with open(filename, mode='r') as derived_core_properties_file: > + for line in derived_core_properties_file: > + match = re.match( > + r'^(?P<codepoint1>[0-9A-F]{4,6})' > + + r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' > + + r'\s*;\s*(?P<property>[a-zA-Z_]+)', > + line) > + if not match: > + continue > + start = match.group('codepoint1') > + end = match.group('codepoint2') > + if not end: > + end = start > + for code_point in range(int(start, 16), int(end, 16)+1): > + prop = match.group('property') > + if code_point in DERIVED_CORE_PROPERTIES: > + DERIVED_CORE_PROPERTIES[code_point].append(prop) > + else: > + DERIVED_CORE_PROPERTIES[code_point] = [prop] > + > +def fill_east_asian_widths(filename): > + '''Stores the entire contents of the EastAsianWidths.txt file > + in the EAST_ASIAN_WIDTHS dictionary. > + > + Lines in EastAsianWidths.txt are either a code point range like > + this: > + > + 9FCD..9FFF;W # Cn [51] <reserved-9FCD>..<reserved-9FFF> > + > + or a single code point like this: > + > + A015;W # Lm YI SYLLABLE WU > + ''' > + with open(filename, mode='r') as east_asian_widths_file: > + for line in east_asian_widths_file: > + match = re.match( > + r'^(?P<codepoint1>[0-9A-F]{4,6})' > + +r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' > + +r'\s*;\s*(?P<property>[a-zA-Z]+)', > + line) > + if not match: > + continue > + start = match.group('codepoint1') > + end = match.group('codepoint2') > + if not end: > + end = start > + for code_point in range(int(start, 16), int(end, 16)+1): > + EAST_ASIAN_WIDTHS[code_point] = match.group('property') > + > +def to_upper(code_point): > + '''Returns the code point of the uppercase version > + of the given code point''' > + if (UNICODE_ATTRIBUTES[code_point]['name'] > + and UNICODE_ATTRIBUTES[code_point]['upper']): > + return UNICODE_ATTRIBUTES[code_point]['upper'] > + else: > + return code_point > + > +def to_lower(code_point): > + '''Returns the code point of the lowercase version > + of the given code point''' > + if (UNICODE_ATTRIBUTES[code_point]['name'] > + and UNICODE_ATTRIBUTES[code_point]['lower']): > + return UNICODE_ATTRIBUTES[code_point]['lower'] > + else: > + return code_point > + > +def to_upper_turkish(code_point): > + '''Returns the code point of the Turkish uppercase version > + of the given code point''' > + if code_point == 0x0069: > + return 0x0130 > + return to_upper(code_point) > + > +def to_lower_turkish(code_point): > + '''Returns the code point of the Turkish lowercase version > + of the given code point''' > + if code_point == 0x0049: > + return 0x0131 > + return to_lower(code_point) > + > +def to_title(code_point): > + '''Returns the code point of the titlecase version > + of the given code point''' > + if (UNICODE_ATTRIBUTES[code_point]['name'] > + and UNICODE_ATTRIBUTES[code_point]['title']): > + return UNICODE_ATTRIBUTES[code_point]['title'] > + else: > + return code_point > + > +def is_upper(code_point): > + '''Checks whether the character with this code point is uppercase''' > + return (to_lower(code_point) != code_point > + or (code_point in DERIVED_CORE_PROPERTIES > + and 'Uppercase' in DERIVED_CORE_PROPERTIES[code_point])) > + > +def is_lower(code_point): > + '''Checks whether the character with this code point is lowercase''' > + # Some characters are defined as “Lowercase†in > + # DerivedCoreProperties.txt but do not have a mapping to upper > + # case. For example, ꜰ U+A72F “LATIN LETTER SMALL CAPITAL F†is > + # one of these. > + return (to_upper(code_point) != code_point > + # <U00DF> is lowercase, but without simple to_upper mapping. > + or code_point == 0x00DF > + or (code_point in DERIVED_CORE_PROPERTIES > + and 'Lowercase' in DERIVED_CORE_PROPERTIES[code_point])) > + > +def is_alpha(code_point): > + '''Checks whether the character with this code point is alphabetic''' > + return ((code_point in DERIVED_CORE_PROPERTIES > + and > + 'Alphabetic' in DERIVED_CORE_PROPERTIES[code_point]) > + or > + # Consider all the non-ASCII digits as alphabetic. > + # ISO C 99 forbids us to have them in category “digitâ€, > + # but we want iswalnum to return true on them. > + (UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd' > + and not (code_point >= 0x0030 and code_point <= 0x0039))) > + > +def is_digit(code_point): > + '''Checks whether the character with this code point is a digit''' > + if False: > + return (UNICODE_ATTRIBUTES[code_point]['name'] > + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd') > + # Note: U+0BE7..U+0BEF and U+1369..U+1371 are digit systems without > + # a zero. Must add <0> in front of them by hand. > + else: > + # SUSV2 gives us some freedom for the "digit" category, but ISO C 99 > + # takes it away: > + # 7.25.2.1.5: > + # The iswdigit function tests for any wide character that > + # corresponds to a decimal-digit character (as defined in 5.2.1). > + # 5.2.1: > + # the 10 decimal digits 0 1 2 3 4 5 6 7 8 9 > + return (code_point >= 0x0030 and code_point <= 0x0039) > + > +def is_outdigit(code_point): > + '''Checks whether the character with this code point is outdigit''' > + return (code_point >= 0x0030 and code_point <= 0x0039) > + > +def is_blank(code_point): > + '''Checks whether the character with this code point is blank''' > + return (code_point == 0x0009 # '\t' > + # Category Zs without mention of '<noBreak>' > + or (UNICODE_ATTRIBUTES[code_point]['name'] > + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Zs' > + and '<noBreak>' not in > + UNICODE_ATTRIBUTES[code_point]['decomposition'])) > + > +def is_space(code_point): > + '''Checks whether the character with this code point is a space''' > + # Don’t make U+00A0 a space. Non-breaking space means that all programs > + # should treat it like a punctuation character, not like a space. > + return (code_point == 0x0020 # ' ' > + or code_point == 0x000C # '\f' > + or code_point == 0x000A # '\n' > + or code_point == 0x000D # '\r' > + or code_point == 0x0009 # '\t' > + or code_point == 0x000B # '\v' > + # Categories Zl, Zp, and Zs without mention of "<noBreak>" > + or (UNICODE_ATTRIBUTES[code_point]['name'] > + and > + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'] > + or > + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zs'] > + and > + '<noBreak>' not in > + UNICODE_ATTRIBUTES[code_point]['decomposition'])))) > + > +def is_cntrl(code_point): > + '''Checks whether the character with this code point is > + a control character''' > + return (UNICODE_ATTRIBUTES[code_point]['name'] > + and (UNICODE_ATTRIBUTES[code_point]['name'] == '<control>' > + or > + UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'])) > + > +def is_xdigit(code_point): > + '''Checks whether the character with this code point is > + a hexadecimal digit''' > + if False: > + return (is_digit(code_point) > + or (code_point >= 0x0041 and code_point <= 0x0046) > + or (code_point >= 0x0061 and code_point <= 0x0066)) > + else: > + # SUSV2 gives us some freedom for the "xdigit" category, but ISO C 99 > + # takes it away: > + # 7.25.2.1.12: > + # The iswxdigit function tests for any wide character that > + # corresponds to a hexadecimal-digit character (as defined > + # in 6.4.4.1). > + # 6.4.4.1: > + # hexadecimal-digit: one of > + # 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F > + return ((code_point >= 0x0030 and code_point <= 0x0039) > + or (code_point >= 0x0041 and code_point <= 0x0046) > + or (code_point >= 0x0061 and code_point <= 0x0066)) > + > +def is_graph(code_point): > + '''Checks whether the character with this code point is > + a graphical character''' > + return (UNICODE_ATTRIBUTES[code_point]['name'] > + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' > + and not is_space(code_point)) > + > +def is_print(code_point): > + '''Checks whether the character with this code point is printable''' > + return (UNICODE_ATTRIBUTES[code_point]['name'] > + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' > + and UNICODE_ATTRIBUTES[code_point]['category'] not in ['Zl', 'Zp']) > + > +def is_punct(code_point): > + '''Checks whether the character with this code point is punctuation''' > + if False: > + return (UNICODE_ATTRIBUTES[code_point]['name'] > + and UNICODE_ATTRIBUTES[code_point]['category'].startswith('P')) > + else: > + # The traditional POSIX definition of punctuation is every graphic, > + # non-alphanumeric character. > + return (is_graph(code_point) > + and not is_alpha(code_point) > + and not is_digit(code_point)) > + > +def is_combining(code_point): > + '''Checks whether the character with this code point is > + a combining character''' > + # Up to Unicode 3.0.1 we took the Combining property from the PropList.txt > + # file. In 3.0.1 it was identical to the union of the general categories > + # "Mn", "Mc", "Me". In Unicode 3.1 this property has been dropped from the > + # PropList.txt file, so we take the latter definition. > + return (UNICODE_ATTRIBUTES[code_point]['name'] > + and > + UNICODE_ATTRIBUTES[code_point]['category'] in ['Mn', 'Mc', 'Me']) > + > +def is_combining_level3(code_point): > + '''Checks whether the character with this code point is > + a combining level3 character''' > + return (is_combining(code_point) > + and > + int(UNICODE_ATTRIBUTES[code_point]['combining']) in range(0, 200)) > + > +def ucs_symbol(code_point): > + '''Return the UCS symbol string for a Unicode character.''' > + if code_point < 0x10000: > + return '<U{:04X}>'.format(code_point) > + else: > + return '<U{:08X}>'.format(code_point) > + > +def ucs_symbol_range(code_point_low, code_point_high): > + '''Returns a string UCS symbol string for a code point range. > + > + Example: > + > + <U0041>..<U005A> > + ''' > + return ucs_symbol(code_point_low) + '..' + ucs_symbol(code_point_high) > + > +def verifications(): > + '''Tests whether the is_* functions observe the known restrictions''' > + for code_point in sorted(UNICODE_ATTRIBUTES): > + # toupper restriction: "Only characters specified for the keywords > + # lower and upper shall be specified. > + if (to_upper(code_point) != code_point > + and not (is_lower(code_point) or is_upper(code_point))): > + sys.stderr.write( > + ('%(sym)s is not upper|lower ' > + + 'but toupper(0x%(c)04X) = 0x%(uc)04X\n') %{ > + 'sym': ucs_symbol(code_point), > + 'c': code_point, > + 'uc': to_upper(code_point)}) > + # tolower restriction: "Only characters specified for the keywords > + # lower and upper shall be specified. > + if (to_lower(code_point) != code_point > + and not (is_lower(code_point) or is_upper(code_point))): > + sys.stderr.write( > + ('%(sym)s is not upper|lower ' > + + 'but tolower(0x%(c)04X) = 0x%(uc)04X\n') %{ > + 'sym': ucs_symbol(code_point), > + 'c': code_point, > + 'uc': to_lower(code_point)}) > + # alpha restriction: "Characters classified as either upper or lower > + # shall automatically belong to this class. > + if ((is_lower(code_point) or is_upper(code_point)) > + and not is_alpha(code_point)): > + sys.stderr.write('%(sym)s is upper|lower but not alpha\n' %{ > + 'sym': ucs_symbol(code_point)}) > + # alpha restriction: “No character specified for the keywords cntrl, > + # digit, punct or space shall be specified.†> + if (is_alpha(code_point) and is_cntrl(code_point)): > + sys.stderr.write('%(sym)s is alpha and cntrl\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_alpha(code_point) and is_digit(code_point)): > + sys.stderr.write('%(sym)s is alpha and digit\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_alpha(code_point) and is_punct(code_point)): > + sys.stderr.write('%(sym)s is alpha and punct\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_alpha(code_point) and is_space(code_point)): > + sys.stderr.write('%(sym)s is alpha and space\n' %{ > + 'sym': ucs_symbol(code_point)}) > + # space restriction: “No character specified for the keywords upper, > + # lower, alpha, digit, graph or xdigit shall be specified.†> + # upper, lower, alpha already checked above. > + if (is_space(code_point) and is_digit(code_point)): > + sys.stderr.write('%(sym)s is space and digit\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_space(code_point) and is_graph(code_point)): > + sys.stderr.write('%(sym)s is space and graph\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_space(code_point) and is_xdigit(code_point)): > + sys.stderr.write('%(sym)s is space and xdigit\n' %{ > + 'sym': ucs_symbol(code_point)}) > + # cntrl restriction: “No character specified for the keywords upper, > + # lower, alpha, digit, punct, graph, print or xdigit shall be > + # specified.†upper, lower, alpha already checked above. > + if (is_cntrl(code_point) and is_digit(code_point)): > + sys.stderr.write('%(sym)s is cntrl and digit\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_cntrl(code_point) and is_punct(code_point)): > + sys.stderr.write('%(sym)s is cntrl and punct\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_cntrl(code_point) and is_graph(code_point)): > + sys.stderr.write('%(sym)s is cntrl and graph\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_cntrl(code_point) and is_print(code_point)): > + sys.stderr.write('%(sym)s is cntrl and print\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_cntrl(code_point) and is_xdigit(code_point)): > + sys.stderr.write('%(sym)s is cntrl and xdigit\n' %{ > + 'sym': ucs_symbol(code_point)}) > + # punct restriction: “No character specified for the keywords upper, > + # lower, alpha, digit, cntrl, xdigit or as the <space> character shall > + # be specified.†upper, lower, alpha, cntrl already checked above. > + if (is_punct(code_point) and is_digit(code_point)): > + sys.stderr.write('%(sym)s is punct and digit\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_punct(code_point) and is_xdigit(code_point)): > + sys.stderr.write('%(sym)s is punct and xdigit\n' %{ > + 'sym': ucs_symbol(code_point)}) > + if (is_punct(code_point) and code_point == 0x0020): > + sys.stderr.write('%(sym)s is punct\n' %{ > + 'sym': ucs_symbol(code_point)}) > + # graph restriction: “No character specified for the keyword cntrl > + # shall be specified.†Already checked above. > + > + # print restriction: “No character specified for the keyword cntrl > + # shall be specified.†Already checked above. > + > + # graph - print relation: differ only in the <space> character. > + # How is this possible if there are more than one space character?! > + # I think susv2/xbd/locale.html should speak of “space charactersâ€, > + # not “space characterâ€. > + if (is_print(code_point) > + and not (is_graph(code_point) or is_space(code_point))): > + sys.stderr.write('%(sym)s is print but not graph|<space>\n' %{ > + 'sym': unicode_utils.ucs_symbol(code_point)}) > + if (not is_print(code_point) > + and (is_graph(code_point) or code_point == 0x0020)): > + sys.stderr.write('%(sym)s is graph|<space> but not print\n' %{ > + 'sym': unicode_utils.ucs_symbol(code_point)}) > diff --git a/contrib/unicode/from_glibc/utf8_gen.py b/contrib/unicode/from_glibc/utf8_gen.py > new file mode 100755 > index 00000000000..0e5583cd259 > --- /dev/null > +++ b/contrib/unicode/from_glibc/utf8_gen.py > @@ -0,0 +1,364 @@ > +#!/usr/bin/python3 > +# -*- coding: utf-8 -*- > +# Copyright (C) 2014-2019 Free Software Foundation, Inc. > +# This file is part of the GNU C Library. > +# > +# The GNU C 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 2.1 of the License, or (at your option) any later version. > +# > +# The GNU C 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 > +# Lesser General Public License for more details. > +# > +# You should have received a copy of the GNU Lesser General Public > +# License along with the GNU C Library; if not, see > +# <https://www.gnu.org/licenses/>. > + > +'''glibc/localedata/charmaps/UTF-8 file generator script > + > +This script generates a glibc/localedata/charmaps/UTF-8 file > +from Unicode data. > + > +Usage: python3 utf8_gen.py UnicodeData.txt EastAsianWidth.txt > + > +It will output UTF-8 file > +''' > + > +import argparse > +import sys > +import re > +import unicode_utils > + > +# Auxiliary tables for Hangul syllable names, see the Unicode 3.0 book, > +# sections 3.11 and 4.4. > + > +JAMO_INITIAL_SHORT_NAME = ( > + 'G', 'GG', 'N', 'D', 'DD', 'R', 'M', 'B', 'BB', 'S', 'SS', '', 'J', 'JJ', > + 'C', 'K', 'T', 'P', 'H' > +) > + > +JAMO_MEDIAL_SHORT_NAME = ( > + 'A', 'AE', 'YA', 'YAE', 'EO', 'E', 'YEO', 'YE', 'O', 'WA', 'WAE', 'OE', > + 'YO', 'U', 'WEO', 'WE', 'WI', 'YU', 'EU', 'YI', 'I' > +) > + > +JAMO_FINAL_SHORT_NAME = ( > + '', 'G', 'GG', 'GS', 'N', 'NI', 'NH', 'D', 'L', 'LG', 'LM', 'LB', 'LS', > + 'LT', 'LP', 'LH', 'M', 'B', 'BS', 'S', 'SS', 'NG', 'J', 'C', 'K', 'T', > + 'P', 'H' > +) > + > +def process_range(start, end, outfile, name): > + '''Writes a range of code points into the CHARMAP section of the > + output file > + > + ''' > + if 'Hangul Syllable' in name: > + # from glibc/localedata/ChangeLog: > + # > + # 2000-09-24 Bruno Haible <haible@clisp.cons.org> > + # * charmaps/UTF-8: Expand <Hangul Syllable> and <Private Use> ranges, > + # so they become printable and carry a width. Comment out surrogate > + # ranges. Add a WIDTH table > + # > + # So we expand the Hangul Syllables here: > + for i in range(int(start, 16), int(end, 16)+1 ): > + index2, index3 = divmod(i - 0xaC00, 28) > + index1, index2 = divmod(index2, 21) > + hangul_syllable_name = 'HANGUL SYLLABLE ' \ > + + JAMO_INITIAL_SHORT_NAME[index1] \ > + + JAMO_MEDIAL_SHORT_NAME[index2] \ > + + JAMO_FINAL_SHORT_NAME[index3] > + outfile.write('{:<11s} {:<12s} {:s}\n'.format( > + unicode_utils.ucs_symbol(i), convert_to_hex(i), > + hangul_syllable_name)) > + return > + # UnicodeData.txt file has contains code point ranges like this: > + # > + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; > + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; > + # > + # The glibc UTF-8 file splits ranges like these into shorter > + # ranges of 64 code points each: > + # > + # <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> > + # … > + # <U4D80>..<U4DB5> /xe4/xb6/x80 <CJK Ideograph Extension A> > + for i in range(int(start, 16), int(end, 16), 64 ): > + if i > (int(end, 16)-64): > + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( > + unicode_utils.ucs_symbol(i), > + unicode_utils.ucs_symbol(int(end,16)), > + convert_to_hex(i), > + name)) > + break > + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( > + unicode_utils.ucs_symbol(i), > + unicode_utils.ucs_symbol(i+63), > + convert_to_hex(i), > + name)) > + > +def process_charmap(flines, outfile): > + '''This function takes an array which contains *all* lines of > + of UnicodeData.txt and write lines to outfile as used in the > + > + CHARMAP > + … > + END CHARMAP > + > + section of the UTF-8 file in glibc/localedata/charmaps/UTF-8. > + > + Samples for input lines: > + > + 0010;<control>;Cc;0;BN;;;;;N;DATA LINK ESCAPE;;;; > + 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; > + 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; > + D800;<Non Private Use High Surrogate, First>;Cs;0;L;;;;;N;;;;; > + DB7F;<Non Private Use High Surrogate, Last>;Cs;0;L;;;;;N;;;;; > + 100000;<Plane 16 Private Use, First>;Co;0;L;;;;;N;;;;; > + 10FFFD;<Plane 16 Private Use, Last>;Co;0;L;;;;;N;;;;; > + > + Samples for output lines (Unicode-Value UTF-8-HEX Unicode-Char-Name): > + > + <U0010> /x10 DATA LINK ESCAPE > + <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> > + %<UD800> /xed/xa0/x80 <Non Private Use High Surrogate, First> > + %<UDB7F> /xed/xad/xbf <Non Private Use High Surrogate, Last> > + <U0010FFC0>..<U0010FFFD> /xf4/x8f/xbf/x80 <Plane 16 Private Use> > + > + ''' > + fields_start = [] > + for line in flines: > + fields = line.split(";") > + # Some characters have “<control>†as their name. We try to > + # use the “Unicode 1.0 Name†(10th field in > + # UnicodeData.txt) for them. > + # > + # The Characters U+0080, U+0081, U+0084 and U+0099 have > + # “<control>†as their name but do not even have aa > + # â€Unicode 1.0 Nameâ€. We could write code to take their > + # alternate names from NameAliases.txt. > + if fields[1] == "<control>" and fields[10]: > + fields[1] = fields[10] > + # Handling code point ranges like: > + # > + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; > + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; > + if fields[1].endswith(', First>') and not 'Surrogate,' in fields[1]: > + fields_start = fields > + continue > + if fields[1].endswith(', Last>') and not 'Surrogate,' in fields[1]: > + process_range(fields_start[0], fields[0], > + outfile, fields[1][:-7]+'>') > + fields_start = [] > + continue > + fields_start = [] > + if 'Surrogate,' in fields[1]: > + # Comment out the surrogates in the UTF-8 file. > + # One could of course skip them completely but > + # the original UTF-8 file in glibc had them as > + # comments, so we keep these comment lines. > + outfile.write('%') > + outfile.write('{:<11s} {:<12s} {:s}\n'.format( > + unicode_utils.ucs_symbol(int(fields[0], 16)), > + convert_to_hex(int(fields[0], 16)), > + fields[1])) > + > +def convert_to_hex(code_point): > + '''Converts a code point to a hexadecimal UTF-8 representation > + like /x**/x**/x**.''' > + # Getting UTF8 of Unicode characters. > + # In Python3, .encode('UTF-8') does not work for > + # surrogates. Therefore, we use this conversion table > + surrogates = { > + 0xD800: '/xed/xa0/x80', > + 0xDB7F: '/xed/xad/xbf', > + 0xDB80: '/xed/xae/x80', > + 0xDBFF: '/xed/xaf/xbf', > + 0xDC00: '/xed/xb0/x80', > + 0xDFFF: '/xed/xbf/xbf', > + } > + if code_point in surrogates: > + return surrogates[code_point] > + return ''.join([ > + '/x{:02x}'.format(c) for c in chr(code_point).encode('UTF-8') > + ]) > + > +def write_header_charmap(outfile): > + '''Write the header on top of the CHARMAP section to the output file''' > + outfile.write("<code_set_name> UTF-8\n") > + outfile.write("<comment_char> %\n") > + outfile.write("<escape_char> /\n") > + outfile.write("<mb_cur_min> 1\n") > + outfile.write("<mb_cur_max> 6\n\n") > + outfile.write("% CHARMAP generated using utf8_gen.py\n") > + outfile.write("% alias ISO-10646/UTF-8\n") > + outfile.write("CHARMAP\n") > + > +def write_header_width(outfile, unicode_version): > + '''Writes the header on top of the WIDTH section to the output file''' > + outfile.write('% Character width according to Unicode ' > + + '{:s}.\n'.format(unicode_version)) > + outfile.write('% - Default width is 1.\n') > + outfile.write('% - Double-width characters have width 2; generated from\n') > + outfile.write('% "grep \'^[^;]*;[WF]\' EastAsianWidth.txt"\n') > + outfile.write('% - Non-spacing characters have width 0; ' > + + 'generated from PropList.txt or\n') > + outfile.write('% "grep \'^[^;]*;[^;]*;[^;]*;[^;]*;NSM;\' ' > + + 'UnicodeData.txt"\n') > + outfile.write('% - Format control characters have width 0; ' > + + 'generated from\n') > + outfile.write("% \"grep '^[^;]*;[^;]*;Cf;' UnicodeData.txt\"\n") > +# Not needed covered by Cf > +# outfile.write("% - Zero width characters have width 0; generated from\n") > +# outfile.write("% \"grep '^[^;]*;ZERO WIDTH ' UnicodeData.txt\"\n") > + outfile.write("WIDTH\n") > + > +def process_width(outfile, ulines, elines, plines): > + '''ulines are lines from UnicodeData.txt, elines are lines from > + EastAsianWidth.txt containing characters with width “W†or “Fâ€, > + plines are lines from PropList.txt which contain characters > + with the property “Prepended_Concatenation_Markâ€. > + > + ''' > + width_dict = {} > + for line in elines: > + fields = line.split(";") > + if not '..' in fields[0]: > + code_points = (fields[0], fields[0]) > + else: > + code_points = fields[0].split("..") > + for key in range(int(code_points[0], 16), > + int(code_points[1], 16)+1): > + width_dict[key] = 2 > + > + for line in ulines: > + fields = line.split(";") > + if fields[4] == "NSM" or fields[2] in ("Cf", "Me", "Mn"): > + width_dict[int(fields[0], 16)] = 0 > + > + for line in plines: > + # Characters with the property “Prepended_Concatenation_Mark†> + # should have the width 1: > + fields = line.split(";") > + if not '..' in fields[0]: > + code_points = (fields[0], fields[0]) > + else: > + code_points = fields[0].split("..") > + for key in range(int(code_points[0], 16), > + int(code_points[1], 16)+1): > + del width_dict[key] # default width is 1 > + > + # handle special cases for compatibility > + for key in list((0x00AD,)): > + # https://www.cs.tut.fi/~jkorpela/shy.html > + if key in width_dict: > + del width_dict[key] # default width is 1 > + for key in list(range(0x1160, 0x1200)): > + width_dict[key] = 0 > + for key in list(range(0x3248, 0x3250)): > + # These are “A†which means we can decide whether to treat them > + # as “W†or “N†based on context: > + # http://www.unicode.org/mail-arch/unicode-ml/y2017-m08/0023.html > + # For us, “W†seems better. > + width_dict[key] = 2 > + for key in list(range(0x4DC0, 0x4E00)): > + width_dict[key] = 2 > + > + same_width_lists = [] > + current_width_list = [] > + for key in sorted(width_dict): > + if not current_width_list: > + current_width_list = [key] > + elif (key == current_width_list[-1] + 1 > + and width_dict[key] == width_dict[current_width_list[0]]): > + current_width_list.append(key) > + else: > + same_width_lists.append(current_width_list) > + current_width_list = [key] > + if current_width_list: > + same_width_lists.append(current_width_list) > + > + for same_width_list in same_width_lists: > + if len(same_width_list) == 1: > + outfile.write('{:s}\t{:d}\n'.format( > + unicode_utils.ucs_symbol(same_width_list[0]), > + width_dict[same_width_list[0]])) > + else: > + outfile.write('{:s}...{:s}\t{:d}\n'.format( > + unicode_utils.ucs_symbol(same_width_list[0]), > + unicode_utils.ucs_symbol(same_width_list[-1]), > + width_dict[same_width_list[0]])) > + > +if __name__ == "__main__": > + PARSER = argparse.ArgumentParser( > + description=''' > + Generate a UTF-8 file from UnicodeData.txt, EastAsianWidth.txt, and PropList.txt. > + ''') > + PARSER.add_argument( > + '-u', '--unicode_data_file', > + nargs='?', > + type=str, > + default='UnicodeData.txt', > + help=('The UnicodeData.txt file to read, ' > + + 'default: %(default)s')) > + PARSER.add_argument( > + '-e', '--east_asian_with_file', > + nargs='?', > + type=str, > + default='EastAsianWidth.txt', > + help=('The EastAsianWidth.txt file to read, ' > + + 'default: %(default)s')) > + PARSER.add_argument( > + '-p', '--prop_list_file', > + nargs='?', > + type=str, > + default='PropList.txt', > + help=('The PropList.txt file to read, ' > + + 'default: %(default)s')) > + PARSER.add_argument( > + '--unicode_version', > + nargs='?', > + required=True, > + type=str, > + help='The Unicode version of the input files used.') > + ARGS = PARSER.parse_args() > + > + with open(ARGS.unicode_data_file, mode='r') as UNIDATA_FILE: > + UNICODE_DATA_LINES = UNIDATA_FILE.readlines() > + with open(ARGS.east_asian_with_file, mode='r') as EAST_ASIAN_WIDTH_FILE: > + EAST_ASIAN_WIDTH_LINES = [] > + for LINE in EAST_ASIAN_WIDTH_FILE: > + # If characters from EastAasianWidth.txt which are from > + # from reserved ranges (i.e. not yet assigned code points) > + # are added to the WIDTH section of the UTF-8 file, then > + # “make check†produces “Unknown Character†errors for > + # these code points because such unassigned code points > + # are not in the CHARMAP section of the UTF-8 file. > + # > + # Therefore, we skip all reserved code points when reading > + # the EastAsianWidth.txt file. > + if re.match(r'.*<reserved-.+>\.\.<reserved-.+>.*', LINE): > + continue > + if re.match(r'^[^;]*;[WF]', LINE): > + EAST_ASIAN_WIDTH_LINES.append(LINE.strip()) > + with open(ARGS.prop_list_file, mode='r') as PROP_LIST_FILE: > + PROP_LIST_LINES = [] > + for LINE in PROP_LIST_FILE: > + if re.match(r'^[^;]*;[\s]*Prepended_Concatenation_Mark', LINE): > + PROP_LIST_LINES.append(LINE.strip()) > + with open('UTF-8', mode='w') as OUTFILE: > + # Processing UnicodeData.txt and write CHARMAP to UTF-8 file > + write_header_charmap(OUTFILE) > + process_charmap(UNICODE_DATA_LINES, OUTFILE) > + OUTFILE.write("END CHARMAP\n\n") > + # Processing EastAsianWidth.txt and write WIDTH to UTF-8 file > + write_header_width(OUTFILE, ARGS.unicode_version) > + process_width(OUTFILE, > + UNICODE_DATA_LINES, > + EAST_ASIAN_WIDTH_LINES, > + PROP_LIST_LINES) > + OUTFILE.write("END WIDTH\n") > diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py > new file mode 100755 > index 00000000000..02b28bcedcf > --- /dev/null > +++ b/contrib/unicode/gen_wcwidth.py > @@ -0,0 +1,106 @@ > +#!/usr/bin/env python3 > +# > +# Script to generate tables for cpp_wcwidth, leveraging glibc's utf8_gen.py. > +# > +# This file is part of GCC. > +# > +# GCC is free software; you can redistribute it and/or modify it under > +# the terms of the GNU General Public License as published by the Free > +# Software Foundation; either version 3, or (at your option) any later > +# version. > +# > +# GCC 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 Public License > +# for more details. > +# > +# You should have received a copy of the GNU General Public License > +# along with GCC; see the file COPYING3. If not see > +# <http://www.gnu.org/licenses/>. */ > + > +import sys > +import os > + > +if len(sys.argv) != 2: > + print("usage: %s <unicode version>", file=sys.stderr) > + sys.exit(1) > +unicode_version = sys.argv[1] > + > +# Parse a codepoint in the format output by glibc tools. > +def parse_ucn(s): > + if not (s.startswith("<U") and s.endswith(">")): > + raise ValueError > + return int(s[2:-1], base=16) > + > +# Process a line of width output from utf_gen.py and update global array. > +widths = [1] * (1 + 0x10FFFF) > +def process_width(line): > + # Example lines: > + # <UA8FF> 0 > + # <UA926>...<UA92D> 0 > + > + s = line.split() > + width = int(s[1]) > + r = s[0].split("...") > + if len(r) == 1: > + begin = parse_ucn(r[0]) > + end = begin + 1 > + elif len(r) == 2: > + begin = parse_ucn(r[0]) > + end = parse_ucn(r[1]) + 1 > + else: > + raise ValueError > + widths[begin:end] = [width] * (end - begin) > + > +# To keep things simple, we use glibc utf8_gen.py as-is. It only outputs to a > +# file named UTF-8, which is not configurable. Then we parse this into the form > +# we want it. > +os.system("from_glibc/utf8_gen.py --unicode_version %s" % unicode_version) > +processing = False > +for line in open("UTF-8", "r"): > + if processing: > + if line == "END WIDTH\n": > + processing = False > + else: > + try: > + process_width(line) > + except (ValueError, IndexError): > + print(e, "warning: ignored unexpected line: %s" % line, > + file=sys.stderr, end="") > + elif line == "WIDTH\n": > + processing = True > + > +# All bytes < 256 we treat as width 1. > +widths[0:255] = [1] * 255 > + > +# Condense the list to contiguous ranges. > +cur_range = [-1, 1] > +all_ranges = [] > +for i, width in enumerate(widths): > + if width == cur_range[1]: > + cur_range[0] = i > + else: > + all_ranges.append(cur_range) > + cur_range = [i, width] > + > +# Output the arrays for generated_cpp_wcwidth.h > +print("/* Generated by contrib/unicode/gen_wcwidth.py,", > + "with the help of glibc's") > +print(" utf8_gen.py, using version %s" % unicode_version, > + "of the Unicode standard. */") > +print("\nstatic const cppchar_t wcwidth_range_ends[] = {", end="") > +for i, r in enumerate(all_ranges): > + if i % 8: > + print(" ", end="") > + else: > + print("\n ", end="") > + print("0x%x," % (r[0]), end="") > +print("\n};\n") > +print("static const unsigned char wcwidth_widths[] = {", end="") > +for i, r in enumerate(all_ranges): > + if i % 24: > + print(" ", end="") > + else: > + print("\n ", end="") > + print("%d," % r[1], end="") > +print("\n};") > diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c > index cb920f6b9d0..3460da3cf32 100644 > --- a/gcc/diagnostic-show-locus.c > +++ b/gcc/diagnostic-show-locus.c > @@ -30,6 +30,7 @@ along with GCC; see the file COPYING3. If not see > #include "gcc-rich-location.h" > #include "selftest.h" > #include "selftest-diagnostic.h" > +#include "cpplib.h" > > #ifdef HAVE_TERMIOS_H > # include <termios.h> > @@ -112,18 +113,81 @@ class colorizer > const char *m_stop_color; > }; > > -/* A point within a layout_range; similar to an expanded_location, > +/* In order to handle multibyte sources properly, all of this logic needs to be > + aware of the distinction between the number of bytes and the number of > + display columns occupied by a character, which are not the same for non-ASCII > + characters. For example, the Unicode pi symbol, U+03C0, is encoded in UTF-8 > + as "\xcf\x80", and thus occupies 2 bytes of space while only occupying 1 > + display column when it is output. A typical emoji, such as U+1F602 (in > + UTF-8, "\xf0\x9f\x98\x82"), requires 4 bytes and has a display width of 2. > + > + The below example line, which is also used for selftests below, shows how the > + display column and byte column are related: > + > + 0000000001111111111222222 display > + 1234567890123456789012345 columns > + SS_foo = P_bar.SS_fieldP; > + 0000000111111111222222223 byte > + 1356789012456789134567891 columns > + > + Here SS represents the two display columns for the U+1F602 emoji, and P > + represents the one display column for the U+03C0 pi symbol. As an example, a > + diagnostic pointing to the final P on this line is at byte column 29 and > + display column 24. This reflects the fact that the three extended characters > + before the final P occupy cumulatively 5 more bytes than they do display > + columns (a difference of 2 for each of the two SSs, and one for the other P). > + > + One or the other of the two column units is more useful depending on the > + context. For instance, in order to output the caret at the correct location, > + we need to count display columns; in order to colorize a source line, we need > + to count the bytes. All locations are provided to us as byte counts, which > + we augment with the display column on demand so that it can be used when > + needed. This is not the most efficient way to do things since it requires > + looping over the whole line each time, but it should be fine for the purpose > + of outputting diagnostics. > + > + In order to keep straight which units (byte or display) are in use at a > + given time, the following enum lets us specify that explicitly. */ > + > +enum column_unit { > + /* Measured in raw bytes. */ > + CU_BYTES = 0, > + > + /* Measured in display units. */ > + CU_DISPLAY_COLS, > + > + /* For arrays indexed by column_unit. */ > + CU_NUM_UNITS > +}; > + > +/* Utility class to augment an exploc with the corresponding display column. */ > + > +class exploc_with_display_col : public expanded_location > +{ > + public: > + exploc_with_display_col (const expanded_location &exploc) > + : expanded_location (exploc), > + m_display_col (location_compute_display_column (exploc)) {} > + > + int m_display_col; > +}; > + > + > +/* A point within a layout_range; similar to an exploc_with_display_col, > but after filtering on file. */ > > class layout_point > { > public: > layout_point (const expanded_location &exploc) > - : m_line (exploc.line), > - m_column (exploc.column) {} > + : m_line (exploc.line) > + { > + m_columns[CU_BYTES] = exploc.column; > + m_columns[CU_DISPLAY_COLS] = location_compute_display_column (exploc); > + } > > linenum_type m_line; > - int m_column; > + int m_columns[CU_NUM_UNITS]; > }; > > /* A class for use by "class layout" below: a filtered location_range. */ > @@ -138,7 +202,8 @@ class layout_range > unsigned original_idx, > const range_label *label); > > - bool contains_point (linenum_type row, int column) const; > + bool contains_point (linenum_type row, int column, > + enum column_unit col_unit) const; > bool intersects_line_p (linenum_type row) const; > > layout_point m_start; > @@ -157,6 +222,17 @@ struct line_bounds > { > int m_first_non_ws; > int m_last_non_ws; > + > + void convert_to_display_cols (char_span line) > + { > + m_first_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), > + line.length (), > + m_first_non_ws); > + > + m_last_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), > + line.length (), > + m_last_non_ws); > + } > }; > > /* A range of contiguous source lines within a layout (e.g. "lines 5-10" > @@ -284,6 +360,7 @@ class layout > get_state_at_point (/* Inputs. */ > linenum_type row, int column, > int first_non_ws, int last_non_ws, > + enum column_unit col_unit, > /* Outputs. */ > point_state *out_state); > > @@ -298,7 +375,7 @@ class layout > diagnostic_context *m_context; > pretty_printer *m_pp; > location_t m_primary_loc; > - expanded_location m_exploc; > + exploc_with_display_col m_exploc; > colorizer m_colorizer; > bool m_colorize_source_p; > bool m_show_labels_p; > @@ -472,10 +549,15 @@ layout_range::layout_range (const expanded_location *start_exploc, > - 'w' indicates a point within the range > - 'F' indicates the finish of the range (which is > within it). > - - 'a' indicates a subsequent point *after* the range. */ > + - 'a' indicates a subsequent point *after* the range. > + > + COL_UNIT controls whether we check the byte column or > + the display column; one or the other is more convenient > + depending on the context. */ > > bool > -layout_range::contains_point (linenum_type row, int column) const > +layout_range::contains_point (linenum_type row, int column, > + enum column_unit col_unit) const > { > gcc_assert (m_start.m_line <= m_finish.m_line); > /* ...but the equivalent isn't true for the columns; > @@ -491,7 +573,7 @@ layout_range::contains_point (linenum_type row, int column) const > /* On same line as start of range (corresponding > to line 02 in example A and line 03 in example B). */ > { > - if (column < m_start.m_column) > + if (column < m_start.m_columns[col_unit]) > /* Points on the starting line of the range, but > before the column in which it begins. */ > return false; > @@ -505,7 +587,7 @@ layout_range::contains_point (linenum_type row, int column) const > { > /* This is a single-line range. */ > gcc_assert (row == m_finish.m_line); > - return column <= m_finish.m_column; > + return column <= m_finish.m_columns[col_unit]; > } > } > > @@ -530,7 +612,7 @@ layout_range::contains_point (linenum_type row, int column) const > > gcc_assert (row == m_finish.m_line); > > - return column <= m_finish.m_column; > + return column <= m_finish.m_columns[col_unit]; > } > > /* Does this layout_range contain any part of line ROW? */ > @@ -554,9 +636,9 @@ static layout_range > make_range (int start_line, int start_col, int end_line, int end_col) > { > const expanded_location start_exploc > - = {"test.c", start_line, start_col, NULL, false}; > + = {"", start_line, start_col, NULL, false}; > const expanded_location finish_exploc > - = {"test.c", end_line, end_col, NULL, false}; > + = {"", end_line, end_col, NULL, false}; > return layout_range (&start_exploc, &finish_exploc, SHOW_RANGE_WITHOUT_CARET, > &start_exploc, 0, NULL); > } > @@ -574,20 +656,25 @@ test_layout_range_for_single_point () > > /* Tests for layout_range::contains_point. */ > > - /* Before the line. */ > - ASSERT_FALSE (point.contains_point (6, 1)); > + for (int i = 0; i != CU_NUM_UNITS; ++i) > + { > + const enum column_unit col_unit = (enum column_unit) i; > + > + /* Before the line. */ > + ASSERT_FALSE (point.contains_point (6, 1, col_unit)); > > - /* On the line, but before start. */ > - ASSERT_FALSE (point.contains_point (7, 9)); > + /* On the line, but before start. */ > + ASSERT_FALSE (point.contains_point (7, 9, col_unit)); > > - /* At the point. */ > - ASSERT_TRUE (point.contains_point (7, 10)); > + /* At the point. */ > + ASSERT_TRUE (point.contains_point (7, 10, col_unit)); > > - /* On the line, after the point. */ > - ASSERT_FALSE (point.contains_point (7, 11)); > + /* On the line, after the point. */ > + ASSERT_FALSE (point.contains_point (7, 11, col_unit)); > > - /* After the line. */ > - ASSERT_FALSE (point.contains_point (8, 1)); > + /* After the line. */ > + ASSERT_FALSE (point.contains_point (8, 1, col_unit)); > + } > > /* Tests for layout_range::intersects_line_p. */ > ASSERT_FALSE (point.intersects_line_p (6)); > @@ -605,26 +692,31 @@ test_layout_range_for_single_line () > > /* Tests for layout_range::contains_point. */ > > - /* Before the line. */ > - ASSERT_FALSE (example_a.contains_point (1, 1)); > + for (int i = 0; i != CU_NUM_UNITS; ++i) > + { > + const enum column_unit col_unit = (enum column_unit) i; > + > + /* Before the line. */ > + ASSERT_FALSE (example_a.contains_point (1, 1, col_unit)); > > - /* On the line, but before start. */ > - ASSERT_FALSE (example_a.contains_point (2, 21)); > + /* On the line, but before start. */ > + ASSERT_FALSE (example_a.contains_point (2, 21, col_unit)); > > - /* On the line, at the start. */ > - ASSERT_TRUE (example_a.contains_point (2, 22)); > + /* On the line, at the start. */ > + ASSERT_TRUE (example_a.contains_point (2, 22, col_unit)); > > - /* On the line, within the range. */ > - ASSERT_TRUE (example_a.contains_point (2, 23)); > + /* On the line, within the range. */ > + ASSERT_TRUE (example_a.contains_point (2, 23, col_unit)); > > - /* On the line, at the end. */ > - ASSERT_TRUE (example_a.contains_point (2, 38)); > + /* On the line, at the end. */ > + ASSERT_TRUE (example_a.contains_point (2, 38, col_unit)); > > - /* On the line, after the end. */ > - ASSERT_FALSE (example_a.contains_point (2, 39)); > + /* On the line, after the end. */ > + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); > > - /* After the line. */ > - ASSERT_FALSE (example_a.contains_point (2, 39)); > + /* After the line. */ > + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); > + } > > /* Tests for layout_range::intersects_line_p. */ > ASSERT_FALSE (example_a.intersects_line_p (1)); > @@ -642,40 +734,45 @@ test_layout_range_for_multiple_lines () > > /* Tests for layout_range::contains_point. */ > > - /* Before first line. */ > - ASSERT_FALSE (example_b.contains_point (1, 1)); > + for (int i = 0; i != CU_NUM_UNITS; ++i) > + { > + const enum column_unit col_unit = (enum column_unit) i; > > - /* On the first line, but before start. */ > - ASSERT_FALSE (example_b.contains_point (3, 13)); > + /* Before first line. */ > + ASSERT_FALSE (example_b.contains_point (1, 1, col_unit)); > > - /* At the start. */ > - ASSERT_TRUE (example_b.contains_point (3, 14)); > + /* On the first line, but before start. */ > + ASSERT_FALSE (example_b.contains_point (3, 13, col_unit)); > > - /* On the first line, within the range. */ > - ASSERT_TRUE (example_b.contains_point (3, 15)); > + /* At the start. */ > + ASSERT_TRUE (example_b.contains_point (3, 14, col_unit)); > > - /* On an interior line. > - The column number should not matter; try various boundary > - values. */ > - ASSERT_TRUE (example_b.contains_point (4, 1)); > - ASSERT_TRUE (example_b.contains_point (4, 7)); > - ASSERT_TRUE (example_b.contains_point (4, 8)); > - ASSERT_TRUE (example_b.contains_point (4, 9)); > - ASSERT_TRUE (example_b.contains_point (4, 13)); > - ASSERT_TRUE (example_b.contains_point (4, 14)); > - ASSERT_TRUE (example_b.contains_point (4, 15)); > + /* On the first line, within the range. */ > + ASSERT_TRUE (example_b.contains_point (3, 15, col_unit)); > > - /* On the final line, before the end. */ > - ASSERT_TRUE (example_b.contains_point (5, 7)); > + /* On an interior line. > + The column number should not matter; try various boundary > + values. */ > + ASSERT_TRUE (example_b.contains_point (4, 1, col_unit)); > + ASSERT_TRUE (example_b.contains_point (4, 7, col_unit)); > + ASSERT_TRUE (example_b.contains_point (4, 8, col_unit)); > + ASSERT_TRUE (example_b.contains_point (4, 9, col_unit)); > + ASSERT_TRUE (example_b.contains_point (4, 13, col_unit)); > + ASSERT_TRUE (example_b.contains_point (4, 14, col_unit)); > + ASSERT_TRUE (example_b.contains_point (4, 15, col_unit)); > > - /* On the final line, at the end. */ > - ASSERT_TRUE (example_b.contains_point (5, 8)); > + /* On the final line, before the end. */ > + ASSERT_TRUE (example_b.contains_point (5, 7, col_unit)); > > - /* On the final line, after the end. */ > - ASSERT_FALSE (example_b.contains_point (5, 9)); > + /* On the final line, at the end. */ > + ASSERT_TRUE (example_b.contains_point (5, 8, col_unit)); > > - /* After the line. */ > - ASSERT_FALSE (example_b.contains_point (6, 1)); > + /* On the final line, after the end. */ > + ASSERT_FALSE (example_b.contains_point (5, 9, col_unit)); > + > + /* After the line. */ > + ASSERT_FALSE (example_b.contains_point (6, 1, col_unit)); > + } > > /* Tests for layout_range::intersects_line_p. */ > ASSERT_FALSE (example_b.intersects_line_p (2)); > @@ -687,8 +784,8 @@ test_layout_range_for_multiple_lines () > > #endif /* #if CHECKING_P */ > > -/* Given a source line LINE of length LINE_WIDTH, determine the width > - without any trailing whitespace. */ > +/* Given a source line LINE of length LINE_WIDTH bytes, determine the width > + (in bytes, not display cols) without any trailing whitespace. */ > > static int > get_line_width_without_trailing_whitespace (const char *line, int line_width) > @@ -897,17 +994,35 @@ layout::layout (diagnostic_context * context, > will be adjusted accordingly. */ > size_t max_width = m_context->caret_max_width; > char_span line = location_get_source_line (m_exploc.file, m_exploc.line); > - if (line && (size_t)m_exploc.column <= line.length ()) > + if (line && max_width) > { > - size_t right_margin = CARET_LINE_MARGIN; > - size_t column = m_exploc.column; > - if (m_show_line_numbers_p) > - column += m_linenum_width + 2; > - right_margin = MIN (line.length () - column, right_margin); > - right_margin = max_width - right_margin; > - if (line.length () >= max_width && column > right_margin) > - m_x_offset = column - right_margin; > - gcc_assert (m_x_offset >= 0); > + size_t column = m_exploc.m_display_col; > + int line_width > + = get_line_width_without_trailing_whitespace (line.get_buffer (), > + line.length ()); > + size_t eol = cpp_display_width (line.get_buffer (), line_width); > + const size_t eol_before_linenum = eol; > + > + if (column <= eol) > + { > + if (m_show_line_numbers_p) > + { > + column += m_linenum_width + 2; > + eol += m_linenum_width + 2; > + } > + size_t right_margin = CARET_LINE_MARGIN; > + right_margin = MIN (eol - column, right_margin); > + right_margin = max_width - right_margin; > + /* Note: if right_margin > max_width, we end up failing this next > + check due to wrapping, and we don't offset anything. Otherwise we > + would conclude we can't output the line at all. */ > + if (eol >= max_width && column > right_margin) > + { > + m_x_offset = column - right_margin; > + m_x_offset = MIN (m_x_offset, (int) eol_before_linenum - 1); > + } > + gcc_assert (m_x_offset >= 0); > + } > } > > if (context->show_ruler_p) > @@ -1086,7 +1201,7 @@ layout::get_expanded_location (const line_span *line_span) const > { > expanded_location exploc = m_exploc; > exploc.line = lr->m_start.m_line; > - exploc.column = lr->m_start.m_column; > + exploc.column = lr->m_start.m_columns[CU_BYTES]; > return exploc; > } > } > @@ -1254,7 +1369,9 @@ layout::calculate_line_spans () > /* Print line ROW of source code, potentially colorized at any ranges, and > populate *LBOUNDS_OUT. > LINE is the source line (not necessarily 0-terminated) and LINE_WIDTH > - is its width. */ > + is its width. This function deals only with byte offsets, not display > + columns; m_x_offset must be converted from display to byte units. In > + particular, LINE_WIDTH and LBOUNDS_OUT are in bytes. */ > > void > layout::print_source_line (linenum_type row, const char *line, int line_width, > @@ -1266,7 +1383,10 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, > whitespace. */ > line_width = get_line_width_without_trailing_whitespace (line, > line_width); > - line += m_x_offset; > + > + const int x_offset_bytes > + = cpp_display_column_to_byte_column (line, line_width, m_x_offset); > + line += x_offset_bytes; > > pp_emit_prefix (m_pp); > > @@ -1282,7 +1402,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, > int first_non_ws = INT_MAX; > int last_non_ws = 0; > int column; > - for (column = 1 + m_x_offset; column <= line_width; column++) > + for (column = 1 + x_offset_bytes; column <= line_width; column++) > { > /* Assuming colorization is enabled for the caret and underline > characters, we may also colorize the associated characters > @@ -1302,6 +1422,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, > point_state state; > in_range_p = get_state_at_point (row, column, > 0, INT_MAX, > + CU_BYTES, > &state); > if (in_range_p) > m_colorizer.set_range (state.range_idx); > @@ -1365,12 +1486,13 @@ layout::start_annotation_line (char margin_char) const > } > > /* Print a line consisting of the caret/underlines for the given > - source line. */ > + source line. This function works with display columns, rather than byte > + counts; in particular, LBOUNDS should be in display column units. */ > > void > layout::print_annotation_line (linenum_type row, const line_bounds lbounds) > { > - int x_bound = get_x_bound_for_row (row, m_exploc.column, > + int x_bound = get_x_bound_for_row (row, m_exploc.m_display_col, > lbounds.m_last_non_ws); > > start_annotation_line (); > @@ -1383,6 +1505,7 @@ layout::print_annotation_line (linenum_type row, const line_bounds lbounds) > in_range_p = get_state_at_point (row, column, > lbounds.m_first_non_ws, > lbounds.m_last_non_ws, > + CU_DISPLAY_COLS, > &state); > if (in_range_p) > { > @@ -1420,9 +1543,11 @@ class line_label > public: > line_label (int state_idx, int column, label_text text) > : m_state_idx (state_idx), m_column (column), > - m_text (text), m_length (strlen (text.m_buffer)), > - m_label_line (0), m_has_vbar (true) > - {} > + m_text (text), m_label_line (0), m_has_vbar (true) > + { > + const int bytes = strlen (text.m_buffer); > + m_display_width = cpp_display_width (text.m_buffer, bytes); > + } > > /* Sorting is primarily by column, then by state index. */ > static int comparator (const void *p1, const void *p2) > @@ -1441,7 +1566,7 @@ public: > int m_state_idx; > int m_column; > label_text m_text; > - size_t m_length; > + size_t m_display_width; > int m_label_line; > bool m_has_vbar; > }; > @@ -1468,7 +1593,8 @@ layout::print_any_labels (linenum_type row) > > /* Reject labels that aren't fully visible due to clipping > by m_x_offset. */ > - if (range->m_caret.m_column <= m_x_offset) > + const int disp_col = range->m_caret.m_columns[CU_DISPLAY_COLS]; > + if (disp_col <= m_x_offset) > continue; > > label_text text; > @@ -1480,7 +1606,7 @@ layout::print_any_labels (linenum_type row) > if (text.m_buffer == NULL) > continue; > > - labels.safe_push (line_label (i, range->m_caret.m_column, text)); > + labels.safe_push (line_label (i, disp_col, text)); > } > } > > @@ -1530,7 +1656,7 @@ layout::print_any_labels (linenum_type row) > FOR_EACH_VEC_ELT_REVERSE (labels, i, label) > { > /* Would this label "touch" or overlap the next label? */ > - if (label->m_column + label->m_length >= (size_t)next_column) > + if (label->m_column + label->m_display_width >= (size_t)next_column) > { > max_label_line++; > > @@ -1569,7 +1695,7 @@ layout::print_any_labels (linenum_type row) > m_colorizer.set_range (label->m_state_idx); > pp_string (m_pp, label->m_text.m_buffer); > m_colorizer.set_normal_text (); > - column += label->m_length; > + column += label->m_display_width; > } > else if (label->m_has_vbar) > { > @@ -1636,7 +1762,7 @@ layout::print_leading_fixits (linenum_type row) > /* Subroutine of layout::print_trailing_fixits. > > Determine if the annotation line printed for LINE contained > - the exact range from START_COLUMN to FINISH_COLUMN. */ > + the exact range from START_COLUMN to FINISH_COLUMN (in display units). */ > > bool > layout::annotation_line_showed_range_p (linenum_type line, int start_column, > @@ -1646,9 +1772,9 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, > int i; > FOR_EACH_VEC_ELT (m_layout_ranges, i, range) > if (range->m_start.m_line == line > - && range->m_start.m_column == start_column > + && range->m_start.m_columns[CU_DISPLAY_COLS] == start_column > && range->m_finish.m_line == line > - && range->m_finish.m_column == finish_column) > + && range->m_finish.m_columns[CU_DISPLAY_COLS] == finish_column) > return true; > return false; > } > @@ -1735,7 +1861,7 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, > > and is thus printed as desired. */ > > -/* A range of columns within a line. */ > +/* A range of (byte or display) columns within a line. */ > > class column_range > { > @@ -1755,32 +1881,51 @@ public: > int finish; > }; > > -/* Get the range of columns that HINT would affect. */ > - > +/* Get the range of bytes or display columns that HINT would affect. */ > static column_range > -get_affected_columns (const fixit_hint *hint) > +get_affected_range (const fixit_hint *hint, enum column_unit col_unit) > { > - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); > - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; > + expanded_location exploc_start = expand_location (hint->get_start_loc ()); > + expanded_location exploc_finish = expand_location (hint->get_next_loc ()); > + --exploc_finish.column; > > + int start_column; > + int finish_column; > + if (col_unit == CU_DISPLAY_COLS) > + { > + start_column = location_compute_display_column (exploc_start); > + if (hint->insertion_p ()) > + finish_column = start_column - 1; > + else > + finish_column = location_compute_display_column (exploc_finish); > + } > + else > + { > + start_column = exploc_start.column; > + finish_column = exploc_finish.column; > + } > return column_range (start_column, finish_column); > } > > -/* Get the range of columns that would be printed for HINT. */ > +/* Get the range of display columns that would be printed for HINT. */ > > static column_range > get_printed_columns (const fixit_hint *hint) > { > - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); > - int final_hint_column = start_column + hint->get_length () - 1; > + expanded_location exploc = expand_location (hint->get_start_loc ()); > + int start_column = location_compute_display_column (exploc); > + int hint_width = cpp_display_width (hint->get_string (), > + hint->get_length ()); > + int final_hint_column = start_column + hint_width - 1; > if (hint->insertion_p ()) > { > return column_range (start_column, final_hint_column); > } > else > { > - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; > - > + exploc = expand_location (hint->get_next_loc ()); > + --exploc.column; > + int finish_column = location_compute_display_column (exploc); > return column_range (start_column, > MAX (finish_column, final_hint_column)); > } > @@ -1794,27 +1939,35 @@ get_printed_columns (const fixit_hint *hint) > class correction > { > public: > - correction (column_range affected_columns, > + correction (column_range affected_bytes, > + column_range affected_columns, > column_range printed_columns, > const char *new_text, size_t new_text_len) > - : m_affected_columns (affected_columns), > + : m_affected_bytes (affected_bytes), > + m_affected_columns (affected_columns), > m_printed_columns (printed_columns), > m_text (xstrdup (new_text)), > - m_len (new_text_len), > + m_byte_length (new_text_len), > m_alloc_sz (new_text_len + 1) > { > + compute_display_cols (); > } > > ~correction () { free (m_text); } > > bool insertion_p () const > { > - return m_affected_columns.start == m_affected_columns.finish + 1; > + return m_affected_bytes.start == m_affected_bytes.finish + 1; > } > > void ensure_capacity (size_t len); > void ensure_terminated (); > > + void compute_display_cols () > + { > + m_display_cols = cpp_display_width (m_text, m_byte_length); > + } > + > void overwrite (int dst_offset, const char_span &src_span) > { > gcc_assert (dst_offset >= 0); > @@ -1827,6 +1980,7 @@ public: > is to be inserted, and finish is offset by the length of > the replacement. > If replace, then the range of columns affected. */ > + column_range m_affected_bytes; > column_range m_affected_columns; > > /* If insert, then start: the column before which the text > @@ -1837,7 +1991,8 @@ public: > > /* The text to be inserted/used as replacement. */ > char *m_text; > - size_t m_len; > + size_t m_byte_length; /* Not including null-terminator. */ > + int m_display_cols; > size_t m_alloc_sz; > }; > > @@ -1862,8 +2017,8 @@ void > correction::ensure_terminated () > { > /* 0-terminate the buffer. */ > - gcc_assert (m_len < m_alloc_sz); > - m_text[m_len] = '\0'; > + gcc_assert (m_byte_length < m_alloc_sz); > + m_text[m_byte_length] = '\0'; > } > > /* A list of corrections affecting a particular line. > @@ -1925,7 +2080,8 @@ source_line::source_line (const char *filename, int line) > void > line_corrections::add_hint (const fixit_hint *hint) > { > - column_range affected_columns = get_affected_columns (hint); > + column_range affected_bytes = get_affected_range (hint, CU_BYTES); > + column_range affected_columns = get_affected_range (hint, CU_DISPLAY_COLS); > column_range printed_columns = get_printed_columns (hint); > > /* Potentially consolidate. */ > @@ -1936,8 +2092,8 @@ line_corrections::add_hint (const fixit_hint *hint) > > /* The following consolidation code assumes that the fix-it hints > have been sorted by start (done within layout's ctor). */ > - gcc_assert (affected_columns.start > - >= last_correction->m_affected_columns.start); > + gcc_assert (affected_bytes.start > + >= last_correction->m_affected_bytes.start); > gcc_assert (printed_columns.start > >= last_correction->m_printed_columns.start); > > @@ -1949,8 +2105,8 @@ line_corrections::add_hint (const fixit_hint *hint) > Attempt to inject a "replace" correction from immediately > after the end of the last hint to immediately before the start > of the next hint. */ > - column_range between (last_correction->m_affected_columns.finish + 1, > - printed_columns.start - 1); > + column_range between (last_correction->m_affected_bytes.finish + 1, > + affected_bytes.start - 1); > > /* Try to read the source. */ > source_line line (m_filename, m_row); > @@ -1959,33 +2115,39 @@ line_corrections::add_hint (const fixit_hint *hint) > /* Consolidate into the last correction: > add a no-op "replace" of the "between" text, and > add the text from the new hint. */ > - int old_len = last_correction->m_len; > - gcc_assert (old_len >= 0); > - int between_len = between.finish + 1 - between.start; > - gcc_assert (between_len >= 0); > - int new_len = old_len + between_len + hint->get_length (); > - gcc_assert (new_len >= 0); > - last_correction->ensure_capacity (new_len); > + int old_byte_len = last_correction->m_byte_length; > + gcc_assert (old_byte_len >= 0); > + int between_byte_len = between.finish + 1 - between.start; > + gcc_assert (between_byte_len >= 0); > + int new_byte_len > + = old_byte_len + between_byte_len + hint->get_length (); > + gcc_assert (new_byte_len >= 0); > + last_correction->ensure_capacity (new_byte_len); > last_correction->overwrite > - (old_len, > + (old_byte_len, > line.as_span ().subspan (between.start - 1, > between.finish + 1 - between.start)); > - last_correction->overwrite (old_len + between_len, > + last_correction->overwrite (old_byte_len + between_byte_len, > char_span (hint->get_string (), > hint->get_length ())); > - last_correction->m_len = new_len; > + last_correction->m_byte_length = new_byte_len; > last_correction->ensure_terminated (); > + last_correction->m_affected_bytes.finish > + = affected_bytes.finish; > last_correction->m_affected_columns.finish > = affected_columns.finish; > + int prev_display_cols = last_correction->m_display_cols; > + last_correction->compute_display_cols (); > last_correction->m_printed_columns.finish > - += between_len + hint->get_length (); > + += last_correction->m_display_cols - prev_display_cols; > return; > } > } > } > > /* If no consolidation happened, add a new correction instance. */ > - m_corrections.safe_push (new correction (affected_columns, > + m_corrections.safe_push (new correction (affected_bytes, > + affected_columns, > printed_columns, > hint->get_string (), > hint->get_length ())); > @@ -2034,7 +2196,7 @@ layout::print_trailing_fixits (linenum_type row) > m_colorizer.set_fixit_insert (); > pp_string (m_pp, c->m_text); > m_colorizer.set_normal_text (); > - column += c->m_len; > + column += c->m_display_cols; > } > else > { > @@ -2046,7 +2208,7 @@ layout::print_trailing_fixits (linenum_type row) > int finish_column = c->m_affected_columns.finish; > if (!annotation_line_showed_range_p (row, start_column, > finish_column) > - || c->m_len == 0) > + || c->m_byte_length == 0) > { > move_to_column (&column, start_column, true); > m_colorizer.set_fixit_delete (); > @@ -2057,13 +2219,13 @@ layout::print_trailing_fixits (linenum_type row) > /* Print the replacement text. REPLACE also covers > removals, so only do this extra work (potentially starting > a new line) if we have actual replacement text. */ > - if (c->m_len > 0) > + if (c->m_byte_length > 0) > { > move_to_column (&column, start_column, true); > m_colorizer.set_fixit_insert (); > pp_string (m_pp, c->m_text); > m_colorizer.set_normal_text (); > - column += c->m_len; > + column += c->m_display_cols; > } > } > } > @@ -2084,12 +2246,14 @@ layout::print_newline () > /* Return true if (ROW/COLUMN) is within a range of the layout. > If it returns true, OUT_STATE is written to, with the > range index, and whether we should draw the caret at > - (ROW/COLUMN) (as opposed to an underline). */ > + (ROW/COLUMN) (as opposed to an underline). COL_UNIT controls > + whether all inputs and outputs are in bytes or display column units. */ > > bool > layout::get_state_at_point (/* Inputs. */ > linenum_type row, int column, > int first_non_ws, int last_non_ws, > + enum column_unit col_unit, > /* Outputs. */ > point_state *out_state) > { > @@ -2102,7 +2266,7 @@ layout::get_state_at_point (/* Inputs. */ > source colorization. */ > continue; > > - if (range->contains_point (row, column)) > + if (range->contains_point (row, column, col_unit)) > { > out_state->range_idx = i; > > @@ -2110,7 +2274,7 @@ layout::get_state_at_point (/* Inputs. */ > out_state->draw_caret_p = false; > if (range->m_range_display_kind == SHOW_RANGE_WITH_CARET > && row == range->m_caret.m_line > - && column == range->m_caret.m_column) > + && column == range->m_caret.m_columns[col_unit]) > out_state->draw_caret_p = true; > > /* Within a multiline range, don't display any underline > @@ -2130,11 +2294,11 @@ layout::get_state_at_point (/* Inputs. */ > > /* Helper function for use by layout::print_line when printing the > annotation line under the source line. > - Get the column beyond the rightmost one that could contain a caret or > - range marker, given that we stop rendering at trailing whitespace. > + Get the display column beyond the rightmost one that could contain a caret > + or range marker, given that we stop rendering at trailing whitespace. > ROW is the source line within the given file. > - CARET_COLUMN is the column of range 0's caret. > - LAST_NON_WS_COLUMN is the last column containing a non-whitespace > + CARET_COLUMN is the display column of range 0's caret. > + LAST_NON_WS_COLUMN is the last display column containing a non-whitespace > character of source (as determined when printing the source line). */ > > int > @@ -2153,8 +2317,9 @@ layout::get_x_bound_for_row (linenum_type row, int caret_column, > { > /* On the final line within a range; ensure that > we render up to the end of the range. */ > - if (result <= range->m_finish.m_column) > - result = range->m_finish.m_column + 1; > + const int disp_col = range->m_finish.m_columns[CU_DISPLAY_COLS]; > + if (result <= disp_col) > + result = disp_col + 1; > } > else if (row < range->m_finish.m_line) > { > @@ -2245,7 +2410,11 @@ layout::print_line (linenum_type row) > print_leading_fixits (row); > print_source_line (row, line.get_buffer (), line.length (), &lbounds); > if (should_print_annotation_line_p (row)) > - print_annotation_line (row, lbounds); > + { > + if (lbounds.m_first_non_ws != INT_MAX) > + lbounds.convert_to_display_cols (line); > + print_annotation_line (row, lbounds); > + } > if (m_show_labels_p) > print_any_labels (row); > print_trailing_fixits (row); > @@ -2965,6 +3134,551 @@ test_diagnostic_show_locus_one_liner (const line_table_case &case_) > test_one_liner_labels (); > } > > +/* Version of all one-liner tests exercising multibyte awareness. For > + simplicity we stick to using two multibyte characters in the test, U+1F602 > + == "\xf0\x9f\x98\x82", which uses 4 bytes and 2 display columns, and U+03C0 > + == "\xcf\x80", which uses 2 bytes and 1 display column. Note: all of the > + below asserts would be easier to read if we used UTF-8 directly in the > + string constants, but it seems better not to demand the host compiler > + support this, when it isn't otherwise necessary. Instead, whenever an > + extended character appears in a string, we put a line break after it so that > + all succeeding characters can appear visually at the correct display column. > + > + All of these work on the following 1-line source file: > + > + .0000000001111111111222222 display > + .1234567890123456789012345 columns > + "SS_foo = P_bar.SS_fieldP;\n" > + .0000000111111111222222223 byte > + .1356789012456789134567891 columns > + > + which is set up by test_diagnostic_show_locus_one_liner and calls > + them. Here SS represents the two display columns for the U+1F602 emoji and > + P represents the one display column for the U+03C0 pi symbol. */ > + > +/* Just a caret. */ > + > +static void > +test_one_liner_simple_caret_utf8 () > +{ > + test_diagnostic_context dc; > + location_t caret = linemap_position_for_column (line_table, 18); > + rich_location richloc (line_table, caret); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Caret and range. */ > +static void > +test_one_liner_caret_and_range_utf8 () > +{ > + test_diagnostic_context dc; > + location_t caret = linemap_position_for_column (line_table, 18); > + location_t start = linemap_position_for_column (line_table, 12); > + location_t finish = linemap_position_for_column (line_table, 30); > + location_t loc = make_location (caret, start, finish); > + rich_location richloc (line_table, loc); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ~~~~~^~~~~~~~~~\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Multiple ranges and carets. */ > + > +static void > +test_one_liner_multiple_carets_and_ranges_utf8 () > +{ > + test_diagnostic_context dc; > + location_t foo > + = make_location (linemap_position_for_column (line_table, 7), > + linemap_position_for_column (line_table, 1), > + linemap_position_for_column (line_table, 8)); > + dc.caret_chars[0] = 'A'; > + > + location_t bar > + = make_location (linemap_position_for_column (line_table, 16), > + linemap_position_for_column (line_table, 12), > + linemap_position_for_column (line_table, 17)); > + dc.caret_chars[1] = 'B'; > + > + location_t field > + = make_location (linemap_position_for_column (line_table, 26), > + linemap_position_for_column (line_table, 19), > + linemap_position_for_column (line_table, 30)); > + dc.caret_chars[2] = 'C'; > + rich_location richloc (line_table, foo); > + richloc.add_range (bar, SHOW_RANGE_WITH_CARET); > + richloc.add_range (field, SHOW_RANGE_WITH_CARET); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ~~~~A~ ~~~B~ ~~~~~C~~~\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Insertion fix-it hint: adding an "&" to the front of "P_bar.field". */ > + > +static void > +test_one_liner_fixit_insert_before_utf8 () > +{ > + test_diagnostic_context dc; > + location_t caret = linemap_position_for_column (line_table, 12); > + rich_location richloc (line_table, caret); > + richloc.add_fixit_insert_before ("&"); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^\n" > + " &\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Insertion fix-it hint: adding a "[0]" after "SS_foo". */ > + > +static void > +test_one_liner_fixit_insert_after_utf8 () > +{ > + test_diagnostic_context dc; > + location_t start = linemap_position_for_column (line_table, 1); > + location_t finish = linemap_position_for_column (line_table, 8); > + location_t foo = make_location (start, start, finish); > + rich_location richloc (line_table, foo); > + richloc.add_fixit_insert_after ("[0]"); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~\n" > + " [0]\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Removal fix-it hint: removal of the ".SS_fieldP". */ > + > +static void > +test_one_liner_fixit_remove_utf8 () > +{ > + test_diagnostic_context dc; > + location_t start = linemap_position_for_column (line_table, 18); > + location_t finish = linemap_position_for_column (line_table, 30); > + location_t dot = make_location (start, start, finish); > + rich_location richloc (line_table, dot); > + richloc.add_fixit_remove (); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~\n" > + " ----------\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP". */ > + > +static void > +test_one_liner_fixit_replace_utf8 () > +{ > + test_diagnostic_context dc; > + location_t start = linemap_position_for_column (line_table, 19); > + location_t finish = linemap_position_for_column (line_table, 30); > + location_t field = make_location (start, start, finish); > + rich_location richloc (line_table, field); > + richloc.add_fixit_replace ("m_\xf0\x9f\x98\x82_field\xcf\x80"); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~~~~\n" > + " m_\xf0\x9f\x98\x82" > + "_field\xcf\x80\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", > + but where the caret was elsewhere. */ > + > +static void > +test_one_liner_fixit_replace_non_equal_range_utf8 () > +{ > + test_diagnostic_context dc; > + location_t equals = linemap_position_for_column (line_table, 10); > + location_t start = linemap_position_for_column (line_table, 19); > + location_t finish = linemap_position_for_column (line_table, 30); > + rich_location richloc (line_table, equals); > + source_range range; > + range.m_start = start; > + range.m_finish = finish; > + richloc.add_fixit_replace (range, "m_\xf0\x9f\x98\x82_field\xcf\x80"); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + /* The replacement range is not indicated in the annotation line, so > + it should be indicated via an additional underline. */ > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^\n" > + " ---------\n" > + " m_\xf0\x9f\x98\x82" > + "_field\xcf\x80\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", > + where the caret was elsewhere, but where a secondary range > + exactly covers "field". */ > + > +static void > +test_one_liner_fixit_replace_equal_secondary_range_utf8 () > +{ > + test_diagnostic_context dc; > + location_t equals = linemap_position_for_column (line_table, 10); > + location_t start = linemap_position_for_column (line_table, 19); > + location_t finish = linemap_position_for_column (line_table, 30); > + rich_location richloc (line_table, equals); > + location_t field = make_location (start, start, finish); > + richloc.add_range (field); > + richloc.add_fixit_replace (field, "m_\xf0\x9f\x98\x82_field\xcf\x80"); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + /* The replacement range is indicated in the annotation line, > + so it shouldn't be indicated via an additional underline. */ > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^ ~~~~~~~~~\n" > + " m_\xf0\x9f\x98\x82" > + "_field\xcf\x80\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Verify that we can use ad-hoc locations when adding fixits to a > + rich_location. */ > + > +static void > +test_one_liner_fixit_validation_adhoc_locations_utf8 () > +{ > + /* Generate a range that's too long to be packed, so must > + be stored as an ad-hoc location (given the defaults > + of 5 bits or 0 bits of packed range); 41 columns > 2**5. */ > + const location_t c12 = linemap_position_for_column (line_table, 12); > + const location_t c52 = linemap_position_for_column (line_table, 52); > + const location_t loc = make_location (c12, c12, c52); > + > + if (c52 > LINE_MAP_MAX_LOCATION_WITH_COLS) > + return; > + > + ASSERT_TRUE (IS_ADHOC_LOC (loc)); > + > + /* Insert. */ > + { > + rich_location richloc (line_table, loc); > + richloc.add_fixit_insert_before (loc, "test"); > + /* It should not have been discarded by the validator. */ > + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); > + > + test_diagnostic_context dc; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~~~~~~ \n" > + " test\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Remove. */ > + { > + rich_location richloc (line_table, loc); > + source_range range = source_range::from_locations (loc, c52); > + richloc.add_fixit_remove (range); > + /* It should not have been discarded by the validator. */ > + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); > + > + test_diagnostic_context dc; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~~~~~~ \n" > + " -------------------------------------\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Replace. */ > + { > + rich_location richloc (line_table, loc); > + source_range range = source_range::from_locations (loc, c52); > + richloc.add_fixit_replace (range, "test"); > + /* It should not have been discarded by the validator. */ > + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); > + > + test_diagnostic_context dc; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~~~~~~ \n" > + " test\n", > + pp_formatted_text (dc.printer)); > + } > +} > + > +/* Test of consolidating insertions at the same location. */ > + > +static void > +test_one_liner_many_fixits_1_utf8 () > +{ > + test_diagnostic_context dc; > + location_t equals = linemap_position_for_column (line_table, 10); > + rich_location richloc (line_table, equals); > + for (int i = 0; i < 19; i++) > + richloc.add_fixit_insert_before (i & 1 ? "@" : "\xcf\x80"); > + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^\n" > + " \xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@" > + "\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Ensure that we can add an arbitrary number of fix-it hints to a > + rich_location, even if they are not consolidated. */ > + > +static void > +test_one_liner_many_fixits_2_utf8 () > +{ > + test_diagnostic_context dc; > + location_t equals = linemap_position_for_column (line_table, 10); > + rich_location richloc (line_table, equals); > + const int nlocs = 19; > + int locs[nlocs] = {1, 5, 7, 9, 11, 14, 16, 18, 23, 25, 27, 29, 32, > + 34, 36, 38, 40, 42, 44}; > + for (int i = 0; i != nlocs; ++i) > + { > + location_t loc = linemap_position_for_column (line_table, locs[i]); > + richloc.add_fixit_insert_before (loc, i & 1 ? "@" : "\xcf\x80"); > + } > + > + ASSERT_EQ (nlocs, richloc.get_num_fixit_hints ()); > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^\n" > + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @" > + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80\n", > + pp_formatted_text (dc.printer)); > +} > + > +/* Test of labeling the ranges within a rich_location. */ > + > +static void > +test_one_liner_labels_utf8 () > +{ > + location_t foo > + = make_location (linemap_position_for_column (line_table, 1), > + linemap_position_for_column (line_table, 1), > + linemap_position_for_column (line_table, 8)); > + location_t bar > + = make_location (linemap_position_for_column (line_table, 12), > + linemap_position_for_column (line_table, 12), > + linemap_position_for_column (line_table, 17)); > + location_t field > + = make_location (linemap_position_for_column (line_table, 19), > + linemap_position_for_column (line_table, 19), > + linemap_position_for_column (line_table, 30)); > + > + /* Example where all the labels fit on one line. */ > + { > + /* These three labels contain multibyte characters such that their byte > + lengths are respectively (12, 10, 18), but their display widths are only > + (6, 5, 9). All three fit on the line when considering the display > + widths, but not when considering the byte widths, so verify that we do > + indeed put them all on one line. */ > + text_range_label label0 > + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); > + text_range_label label1 > + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); > + text_range_label label2 > + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" > + "\xcf\x80"); > + gcc_rich_location richloc (foo, &label0); > + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); > + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); > + > + { > + test_diagnostic_context dc; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" > + " | | |\n" > + " \xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80" > + " \xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" > + " \xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82" > + "\xf0\x9f\x98\x82\xcf\x80\xcf\x80\n", > + pp_formatted_text (dc.printer)); > + } > + > + } > + > + /* Example where the labels need extra lines. */ > + { > + text_range_label label0 ("label 0\xf0\x9f\x98\x82"); > + text_range_label label1 ("label 1\xcf\x80"); > + text_range_label label2 ("label 2\xcf\x80"); > + gcc_rich_location richloc (foo, &label0); > + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); > + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); > + > + test_diagnostic_context dc; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" > + " | | |\n" > + " | | label 2\xcf\x80\n" > + " | label 1\xcf\x80\n" > + " label 0\xf0\x9f\x98\x82\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Example of boundary conditions: label 0 and 1 have just enough clearance, > + but label 1 just touches label 2. */ > + { > + text_range_label label0 ("aaaaa\xf0\x9f\x98\x82\xcf\x80"); > + text_range_label label1 ("bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82"); > + text_range_label label2 ("c"); > + gcc_rich_location richloc (foo, &label0); > + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); > + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); > + > + test_diagnostic_context dc; > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " \xf0\x9f\x98\x82" > + "_foo = \xcf\x80" > + "_bar.\xf0\x9f\x98\x82" > + "_field\xcf\x80" > + ";\n" > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" > + " | | |\n" > + " | | c\n" > + " aaaaa\xf0\x9f\x98\x82\xcf\x80" > + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", > + pp_formatted_text (dc.printer)); > + } > +} > + > +/* Run the various one-liner tests. */ > + > +static void > +test_diagnostic_show_locus_one_liner_utf8 (const line_table_case &case_) > +{ > + /* Create a tempfile and write some text to it. */ > + const char *content > + /* Display columns. > + 0000000000000000000000011111111111111111111111111111112222222222222 > + 1111111122222222345678900000000123456666666677777777890123444444445 */ > + = "\xf0\x9f\x98\x82_foo = \xcf\x80_bar.\xf0\x9f\x98\x82_field\xcf\x80;\n"; > + /* 0000000000000000000001111111111111111111222222222222222222222233333 > + 1111222233334444567890122223333456789999000011112222345678999900001 > + Byte columns. */ > + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); > + line_table_test ltt (case_); > + > + linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1); > + > + location_t line_end = linemap_position_for_column (line_table, 31); > + > + /* Don't attempt to run the tests if column data might be unavailable. */ > + if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) > + return; > + > + ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end)); > + ASSERT_EQ (1, LOCATION_LINE (line_end)); > + ASSERT_EQ (31, LOCATION_COLUMN (line_end)); > + > + char_span lspan = location_get_source_line (tmp.get_filename (), 1); > + ASSERT_EQ (25, cpp_display_width (lspan.get_buffer (), lspan.length ())); > + ASSERT_EQ (25, location_compute_display_column (expand_location (line_end))); > + > + test_one_liner_simple_caret_utf8 (); > + test_one_liner_caret_and_range_utf8 (); > + test_one_liner_multiple_carets_and_ranges_utf8 (); > + test_one_liner_fixit_insert_before_utf8 (); > + test_one_liner_fixit_insert_after_utf8 (); > + test_one_liner_fixit_remove_utf8 (); > + test_one_liner_fixit_replace_utf8 (); > + test_one_liner_fixit_replace_non_equal_range_utf8 (); > + test_one_liner_fixit_replace_equal_secondary_range_utf8 (); > + test_one_liner_fixit_validation_adhoc_locations_utf8 (); > + test_one_liner_many_fixits_1_utf8 (); > + test_one_liner_many_fixits_2_utf8 (); > + test_one_liner_labels_utf8 (); > +} > + > /* Verify that gcc_rich_location::add_location_if_nearby works. */ > > static void > @@ -3340,13 +4054,19 @@ test_overlapped_fixit_printing (const line_table_case &case_) > /* Unit-test the line_corrections machinery. */ > ASSERT_EQ (3, richloc.get_num_fixit_hints ()); > const fixit_hint *hint_0 = richloc.get_fixit_hint (0); > - ASSERT_EQ (column_range (12, 12), get_affected_columns (hint_0)); > + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, CU_BYTES)); > + ASSERT_EQ (column_range (12, 12), > + get_affected_range (hint_0, CU_DISPLAY_COLS)); > ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); > const fixit_hint *hint_1 = richloc.get_fixit_hint (1); > - ASSERT_EQ (column_range (18, 18), get_affected_columns (hint_1)); > + ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, CU_BYTES)); > + ASSERT_EQ (column_range (18, 18), > + get_affected_range (hint_1, CU_DISPLAY_COLS)); > ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); > const fixit_hint *hint_2 = richloc.get_fixit_hint (2); > - ASSERT_EQ (column_range (29, 28), get_affected_columns (hint_2)); > + ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, CU_BYTES)); > + ASSERT_EQ (column_range (29, 28), > + get_affected_range (hint_2, CU_DISPLAY_COLS)); > ASSERT_EQ (column_range (29, 29), get_printed_columns (hint_2)); > > /* Add each hint in turn to a line_corrections instance, > @@ -3357,6 +4077,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) > /* The first replace hint by itself. */ > lc.add_hint (hint_0); > ASSERT_EQ (1, lc.m_corrections.length ()); > + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_bytes); > ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); > ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); > ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); > @@ -3366,6 +4087,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) > lc.add_hint (hint_1); > ASSERT_EQ (1, lc.m_corrections.length ()); > ASSERT_STREQ ("const_cast<foo *> (", lc.m_corrections[0]->m_text); > + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_bytes); > ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); > ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); > > @@ -3375,6 +4097,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) > ASSERT_STREQ ("const_cast<foo *> (ptr->field)", > lc.m_corrections[0]->m_text); > ASSERT_EQ (1, lc.m_corrections.length ()); > + ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_bytes); > ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_columns); > ASSERT_EQ (column_range (12, 41), lc.m_corrections[0]->m_printed_columns); > } > @@ -3477,6 +4200,246 @@ test_overlapped_fixit_printing (const line_table_case &case_) > } > } > > +/* Multibyte-aware version of preceding tests. See comments above > + test_one_liner_simple_caret_utf8() too, we use the same two multibyte > + characters here. */ > + > +static void > +test_overlapped_fixit_printing_utf8 (const line_table_case &case_) > +{ > + /* Create a tempfile and write some text to it. */ > + > + const char *content > + /* Display columns. > + 00000000000000000000000111111111111111111111111222222222222222223 > + 12344444444555555556789012344444444555555556789012345678999999990 */ > + = " f\xf0\x9f\x98\x82 *f = (f\xf0\x9f\x98\x82 *)ptr->field\xcf\x80;\n"; > + /* 00000000000000000000011111111111111111111112222222222333333333333 > + 12344445555666677778901234566667777888899990123456789012333344445 > + Byte columns. */ > + > + temp_source_file tmp (SELFTEST_LOCATION, ".C", content); > + line_table_test ltt (case_); > + > + const line_map_ordinary *ord_map > + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, > + tmp.get_filename (), 0)); > + > + linemap_line_start (line_table, 1, 100); > + > + const location_t final_line_end > + = linemap_position_for_line_and_column (line_table, ord_map, 6, 50); > + > + /* Don't attempt to run the tests if column data might be unavailable. */ > + if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) > + return; > + > + /* A test for converting a C-style cast to a C++-style cast. */ > + const location_t open_paren > + = linemap_position_for_line_and_column (line_table, ord_map, 1, 14); > + const location_t close_paren > + = linemap_position_for_line_and_column (line_table, ord_map, 1, 22); > + const location_t expr_start > + = linemap_position_for_line_and_column (line_table, ord_map, 1, 23); > + const location_t expr_finish > + = linemap_position_for_line_and_column (line_table, ord_map, 1, 34); > + const location_t expr = make_location (expr_start, expr_start, expr_finish); > + > + /* Various examples of fix-it hints that aren't themselves consolidated, > + but for which the *printing* may need consolidation. */ > + > + /* Example where 3 fix-it hints are printed as one. */ > + { > + test_diagnostic_context dc; > + rich_location richloc (line_table, expr); > + richloc.add_fixit_replace (open_paren, "const_cast<"); > + richloc.add_fixit_replace (close_paren, "> ("); > + richloc.add_fixit_insert_after (")"); > + > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " f\xf0\x9f\x98\x82" > + " *f = (f\xf0\x9f\x98\x82" > + " *)ptr->field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~\n" > + " ------------------\n" > + " const_cast<f\xf0\x9f\x98\x82" > + " *> (ptr->field\xcf\x80" > + ")\n", > + pp_formatted_text (dc.printer)); > + > + /* Unit-test the line_corrections machinery. */ > + ASSERT_EQ (3, richloc.get_num_fixit_hints ()); > + const fixit_hint *hint_0 = richloc.get_fixit_hint (0); > + ASSERT_EQ (column_range (14, 14), get_affected_range (hint_0, CU_BYTES)); > + ASSERT_EQ (column_range (12, 12), > + get_affected_range (hint_0, CU_DISPLAY_COLS)); > + ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); > + const fixit_hint *hint_1 = richloc.get_fixit_hint (1); > + ASSERT_EQ (column_range (22, 22), get_affected_range (hint_1, CU_BYTES)); > + ASSERT_EQ (column_range (18, 18), > + get_affected_range (hint_1, CU_DISPLAY_COLS)); > + ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); > + const fixit_hint *hint_2 = richloc.get_fixit_hint (2); > + ASSERT_EQ (column_range (35, 34), get_affected_range (hint_2, CU_BYTES)); > + ASSERT_EQ (column_range (30, 29), > + get_affected_range (hint_2, CU_DISPLAY_COLS)); > + ASSERT_EQ (column_range (30, 30), get_printed_columns (hint_2)); > + > + /* Add each hint in turn to a line_corrections instance, > + and verify that they are consolidated into one correction instance > + as expected. */ > + line_corrections lc (tmp.get_filename (), 1); > + > + /* The first replace hint by itself. */ > + lc.add_hint (hint_0); > + ASSERT_EQ (1, lc.m_corrections.length ()); > + ASSERT_EQ (column_range (14, 14), lc.m_corrections[0]->m_affected_bytes); > + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); > + ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); > + ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); > + > + /* After the second replacement hint, they are printed together > + as a replacement (along with the text between them). */ > + lc.add_hint (hint_1); > + ASSERT_EQ (1, lc.m_corrections.length ()); > + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (", > + lc.m_corrections[0]->m_text); > + ASSERT_EQ (column_range (14, 22), lc.m_corrections[0]->m_affected_bytes); > + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); > + ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); > + > + /* After the final insertion hint, they are all printed together > + as a replacement (along with the text between them). */ > + lc.add_hint (hint_2); > + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (ptr->field\xcf\x80)", > + lc.m_corrections[0]->m_text); > + ASSERT_EQ (1, lc.m_corrections.length ()); > + ASSERT_EQ (column_range (14, 34), lc.m_corrections[0]->m_affected_bytes); > + ASSERT_EQ (column_range (12, 29), lc.m_corrections[0]->m_affected_columns); > + ASSERT_EQ (column_range (12, 42), lc.m_corrections[0]->m_printed_columns); > + } > + > + /* Example where two are consolidated during printing. */ > + { > + test_diagnostic_context dc; > + rich_location richloc (line_table, expr); > + richloc.add_fixit_replace (open_paren, "CAST ("); > + richloc.add_fixit_replace (close_paren, ") ("); > + richloc.add_fixit_insert_after (")"); > + > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " f\xf0\x9f\x98\x82" > + " *f = (f\xf0\x9f\x98\x82" > + " *)ptr->field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~\n" > + " -\n" > + " CAST (-\n" > + " ) ( )\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Example where none are consolidated during printing. */ > + { > + test_diagnostic_context dc; > + rich_location richloc (line_table, expr); > + richloc.add_fixit_replace (open_paren, "CST ("); > + richloc.add_fixit_replace (close_paren, ") ("); > + richloc.add_fixit_insert_after (")"); > + > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " f\xf0\x9f\x98\x82" > + " *f = (f\xf0\x9f\x98\x82" > + " *)ptr->field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~\n" > + " -\n" > + " CST ( -\n" > + " ) ( )\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Example of deletion fix-it hints. */ > + { > + test_diagnostic_context dc; > + rich_location richloc (line_table, expr); > + richloc.add_fixit_insert_before (open_paren, "(bar\xf0\x9f\x98\x82 *)"); > + source_range victim = {open_paren, close_paren}; > + richloc.add_fixit_remove (victim); > + > + /* This case is actually handled by fixit-consolidation, > + rather than by line_corrections. */ > + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); > + > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " f\xf0\x9f\x98\x82" > + " *f = (f\xf0\x9f\x98\x82" > + " *)ptr->field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~\n" > + " -------\n" > + " (bar\xf0\x9f\x98\x82" > + " *)\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Example of deletion fix-it hints that would overlap. */ > + { > + test_diagnostic_context dc; > + rich_location richloc (line_table, expr); > + richloc.add_fixit_insert_before (open_paren, "(long\xf0\x9f\x98\x82 *)"); > + source_range victim = {expr_start, expr_finish}; > + richloc.add_fixit_remove (victim); > + > + /* These fixits are not consolidated. */ > + ASSERT_EQ (2, richloc.get_num_fixit_hints ()); > + > + /* But the corrections are. */ > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " f\xf0\x9f\x98\x82" > + " *f = (f\xf0\x9f\x98\x82" > + " *)ptr->field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~\n" > + " ------------------\n" > + " (long\xf0\x9f\x98\x82" > + " *)(f\xf0\x9f\x98\x82" > + " *)\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Example of insertion fix-it hints that would overlap. */ > + { > + test_diagnostic_context dc; > + rich_location richloc (line_table, expr); > + richloc.add_fixit_insert_before > + (open_paren, "L\xf0\x9f\x98\x82NGER THAN THE CAST"); > + richloc.add_fixit_insert_after (close_paren, "TEST"); > + > + /* The first insertion is long enough that if printed naively, > + it would overlap with the second. > + Verify that they are printed as a single replacement. */ > + diagnostic_show_locus (&dc, &richloc, DK_ERROR); > + ASSERT_STREQ ("\n" > + " f\xf0\x9f\x98\x82" > + " *f = (f\xf0\x9f\x98\x82" > + " *)ptr->field\xcf\x80" > + ";\n" > + " ^~~~~~~~~~~\n" > + " -------\n" > + " L\xf0\x9f\x98\x82" > + "NGER THAN THE CAST(f\xf0\x9f\x98\x82" > + " *)TEST\n", > + pp_formatted_text (dc.printer)); > + } > +} > + > /* Verify that the line_corrections machinery correctly prints > overlapping fixit-hints that have been added in the wrong > order. > @@ -3526,10 +4489,10 @@ test_overlapped_fixit_printing_2 (const line_table_case &case_) > /* These fixits should be accepted; they can't be consolidated. */ > ASSERT_EQ (2, richloc.get_num_fixit_hints ()); > const fixit_hint *hint_0 = richloc.get_fixit_hint (0); > - ASSERT_EQ (column_range (23, 22), get_affected_columns (hint_0)); > + ASSERT_EQ (column_range (23, 22), get_affected_range (hint_0, CU_BYTES)); > ASSERT_EQ (column_range (23, 23), get_printed_columns (hint_0)); > const fixit_hint *hint_1 = richloc.get_fixit_hint (1); > - ASSERT_EQ (column_range (21, 20), get_affected_columns (hint_1)); > + ASSERT_EQ (column_range (21, 20), get_affected_range (hint_1, CU_BYTES)); > ASSERT_EQ (column_range (21, 21), get_printed_columns (hint_1)); > > /* Verify that they're printed correctly. */ > @@ -3856,10 +4819,12 @@ diagnostic_show_locus_c_tests () > test_diagnostic_show_locus_unknown_location (); > > for_each_line_table_case (test_diagnostic_show_locus_one_liner); > + for_each_line_table_case (test_diagnostic_show_locus_one_liner_utf8); > for_each_line_table_case (test_add_location_if_nearby); > for_each_line_table_case (test_diagnostic_show_locus_fixit_lines); > for_each_line_table_case (test_fixit_consolidation); > for_each_line_table_case (test_overlapped_fixit_printing); > + for_each_line_table_case (test_overlapped_fixit_printing_utf8); > for_each_line_table_case (test_overlapped_fixit_printing_2); > for_each_line_table_case (test_fixit_insert_containing_newline); > for_each_line_table_case (test_fixit_insert_containing_newline_2); > diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c > index a29bcf155e2..79f18d18380 100644 > --- a/gcc/diagnostic.c > +++ b/gcc/diagnostic.c > @@ -360,9 +360,13 @@ diagnostic_get_location_text (diagnostic_context *context, > const char *locus_cs = colorize_start (pp_show_color (pp), "locus"); > const char *locus_ce = colorize_stop (pp_show_color (pp)); > const char *file = s.file ? s.file : progname; > - int line = strcmp (file, N_("<built-in>")) ? s.line : 0; > - int col = context->show_column ? s.column : 0; > - > + int line = 0; > + int col = 0; > + if (strcmp (file, N_("<built-in>"))) > + { > + line = s.line; > + col = context->show_column ? location_compute_display_column (s) : 0; > + } > const char *line_col = maybe_line_and_column (line, col); > return build_message_string ("%s%s%s:%s", locus_cs, file, > line_col, locus_ce); > diff --git a/gcc/input.c b/gcc/input.c > index 00301ef68dd..22141250d60 100644 > --- a/gcc/input.c > +++ b/gcc/input.c > @@ -908,6 +908,22 @@ make_location (location_t caret, source_range src_range) > return COMBINE_LOCATION_DATA (line_table, pure_loc, src_range, NULL); > } > > +/* An expanded_location stores the column in byte units. This function > + converts that column to display units. That requires reading the associated > + source line in order to calculate the display width. If that cannot be done > + for any reason, then returns the byte column as a fallback. */ > +int > +location_compute_display_column (expanded_location exploc) > +{ > + if (!(exploc.file && *exploc.file && exploc.line && exploc.column)) > + return exploc.column; > + char_span line = location_get_source_line (exploc.file, exploc.line); > + /* If line is NULL, this function returns exploc.column which is the > + desired fallback. */ > + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), > + exploc.column); > +} > + > /* Dump statistics to stderr about the memory usage of the line_table > set of line maps. This also displays some statistics about macro > expansion. */ > @@ -3590,6 +3606,90 @@ test_line_offset_overflow () > ASSERT_NE (ordmap_a, ordmap_b); > } > > +void test_cpp_utf8 () > +{ > + /* Verify that wcwidth of invalid UTF-8 or control bytes is 1. */ > + { > + int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8); > + ASSERT_EQ (8, w_bad); > + int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6); > + ASSERT_EQ (6, w_ctrl); > + } > + > + /* Verify that wcwidth of valid UTF-8 is as expected. */ > + { > + const int w_pi = cpp_display_width ("\xcf\x80", 2); > + ASSERT_EQ (1, w_pi); > + const int w_emoji = cpp_display_width ("\xf0\x9f\x98\x82", 4); > + ASSERT_EQ (2, w_emoji); > + const int w_umlaut_precomposed = cpp_display_width ("\xc3\xbf", 2); > + ASSERT_EQ (1, w_umlaut_precomposed); > + const int w_umlaut_combining = cpp_display_width ("y\xcc\x88", 3); > + ASSERT_EQ (1, w_umlaut_combining); > + const int w_han = cpp_display_width ("\xe4\xb8\xba", 3); > + ASSERT_EQ (2, w_han); > + const int w_ascii = cpp_display_width ("GCC", 3); > + ASSERT_EQ (3, w_ascii); > + const int w_mixed = cpp_display_width ("\xcf\x80 = 3.14 \xf0\x9f\x98\x82" > + "\x9f! \xe4\xb8\xba y\xcc\x88", 24); > + ASSERT_EQ (18, w_mixed); > + } > + > + /* Verify that cpp_byte_column_to_display_column can go past the end, > + and similar edge cases. */ > + { > + const char *str > + /* Display columns. > + 111111112345 */ > + = "\xcf\x80 abc"; > + /* 111122223456 > + Byte columns. */ > + > + ASSERT_EQ (5, cpp_display_width (str, 6)); > + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); > + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); > + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); > + } > + > + /* Verify that cpp_display_column_to_byte_column can go past the end, > + and similar edge cases, and check invertibility. */ > + { > + const char *str > + /* Display columns. > + 000000000000000000000000000000000000011 > + 111111112222222234444444455555555678901 */ > + = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; > + /* 000000000000000000000000000000000111111 > + 111122223333444456666777788889999012345 > + Byte columns. */ > + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); > + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); > + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); > + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); > + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); > + > + for (int byte_col = 1; byte_col <= 15; ++byte_col) > + { > + const int disp_col = cpp_byte_column_to_display_column (str, 15, > + byte_col); > + const int byte_col2 = cpp_display_column_to_byte_column (str, 15, > + disp_col); > + > + /* If we ask for the display column in the middle of a UTF-8 > + sequence, it will return the length of the partial sequence, > + matching the behavior of GCC before display column support. > + Otherwise check the round trip was successful. */ > + if (byte_col < 4) > + ASSERT_EQ (byte_col, disp_col); > + else if (byte_col >= 6 && byte_col < 9) > + ASSERT_EQ (3 + (byte_col - 5), disp_col); > + else > + ASSERT_EQ (byte_col2, byte_col); > + } > + } > + > +} > + > /* Run all of the selftests within this file. */ > > void > @@ -3631,6 +3731,8 @@ input_c_tests () > test_reading_source_line (); > > test_line_offset_overflow (); > + > + test_cpp_utf8 (); > } > > } // namespace selftest > diff --git a/gcc/input.h b/gcc/input.h > index c459bf28553..35e02bd91d5 100644 > --- a/gcc/input.h > +++ b/gcc/input.h > @@ -38,6 +38,7 @@ STATIC_ASSERT (BUILTINS_LOCATION < RESERVED_LOCATION_COUNT); > > extern bool is_location_from_builtin_token (location_t); > extern expanded_location expand_location (location_t); > +extern int location_compute_display_column (expanded_location); > > /* A class capturing the bounds of a buffer, to allow for run-time > bounds-checking in a checked build. */ > diff --git a/libcpp/charset.c b/libcpp/charset.c > index d4574415ac1..8c1a16e6b0a 100644 > --- a/libcpp/charset.c > +++ b/libcpp/charset.c > @@ -2265,3 +2265,106 @@ cpp_string_location_reader::get_next () > m_loc += m_offset_per_column; > return result; > } > + > +/* Helper for cpp_byte_column_to_display_column and its inverse. Given a > + pointer to a UTF-8-encoded character, compute its display width. *INBUFP > + points on entry to the start of the UTF-8 encoding of the character, and > + is updated to point just after the last byte of the encoding. *INBYTESLEFTP > + contains on entry the remaining size of the buffer into which *INBUFP > + points, and this is also updated accordingly. If *INBUFP does not > + point to a valid UTF-8-encoded sequence, then it will be treated as a single > + byte with display width 1. */ > + > +static inline int > +compute_next_display_width (const uchar **inbufp, size_t *inbytesleftp) > +{ > + cppchar_t c; > + if (one_utf8_to_cppchar (inbufp, inbytesleftp, &c) != 0) > + { > + /* Input is not convertible to UTF-8. This could be fine, e.g. in a > + string literal, so don't complain. Just treat it as if it has a width > + of one. */ > + ++*inbufp; > + --*inbytesleftp; > + return 1; > + } > + > + /* one_utf8_to_cppchar() has updated inbufp and inbytesleftp for us. */ > + return cpp_wcwidth (c); > +} > + > +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute > + how many display columns are occupied by the first COLUMN bytes. COLUMN > + may exceed DATA_LENGTH, in which case the phantom bytes at the end are > + treated as if they have display width 1. */ > + > +int > +cpp_byte_column_to_display_column (const char *data, int data_length, > + int column) > +{ > + int display_col = 0; > + const uchar *udata = (const uchar *) data; > + const int offset = MAX (0, column - data_length); > + size_t inbytesleft = column - offset; > + while (inbytesleft) > + display_col += compute_next_display_width (&udata, &inbytesleft); > + return display_col + offset; > +} > + > +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute > + the least number of bytes that will result in at least DISPLAY_COL display > + columns. The return value may exceed DATA_LENGTH if the entire string does > + not occupy enough display columns. */ > + > +int > +cpp_display_column_to_byte_column (const char *data, int data_length, > + int display_col) > +{ > + int column = 0; > + const uchar *udata = (const uchar *) data; > + size_t inbytesleft = data_length; > + while (column < display_col && inbytesleft) > + column += compute_next_display_width (&udata, &inbytesleft); > + return data_length - inbytesleft + (display_col - column); > +} > + > +/* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc, > + because that will inspect the user's locale, and in particular in an ASCII > + locale, it will not return anything useful for extended characters. But GCC > + in other respects (see e.g. _cpp_default_encoding()) behaves as if > + everything is UTF-8. We also make some tweaks that are useful for the way > + GCC needs to use this data, e.g. tabs and other control characters should be > + treated as having width 1. The lookup tables are generated from > + contrib/unicode/gen_wcwidth.py and were made by simply calling glibc > + wcwidth() on all codepoints, then applying the small tweaks. These tables > + are not highly optimized, but for the present purpose of outputting > + diagnostics, they are sufficient. */ > + > +#include "generated_cpp_wcwidth.h" > +int cpp_wcwidth (cppchar_t c) > +{ > + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) > + return wcwidth_widths[0]; > + > + /* Binary search the tables. */ > + int begin = 1; > + static const int end > + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); > + int len = end - begin; > + do > + { > + int half = len/2; > + int middle = begin + half; > + if (c > wcwidth_range_ends[middle]) > + { > + begin = middle + 1; > + len -= half + 1; > + } > + else > + len = half; > + } while (len); > + > + if (__builtin_expect (begin != end, true)) > + return wcwidth_widths[begin]; > + return 1; > +} > diff --git a/libcpp/generated_cpp_wcwidth.h b/libcpp/generated_cpp_wcwidth.h > new file mode 100644 > index 00000000000..ec8b73d3d01 > --- /dev/null > +++ b/libcpp/generated_cpp_wcwidth.h > @@ -0,0 +1,156 @@ > +/* Generated by contrib/unicode/gen_wcwidth.py, with the help of glibc's > + utf8_gen.py, using version 12.1.0 of the Unicode standard. */ > + > +static const cppchar_t wcwidth_range_ends[] = { > + 0x2ff, 0x36f, 0x482, 0x489, 0x590, 0x5bd, 0x5be, 0x5bf, > + 0x5c0, 0x5c2, 0x5c3, 0x5c5, 0x5c6, 0x5c7, 0x60f, 0x61a, > + 0x61b, 0x61c, 0x64a, 0x65f, 0x66f, 0x670, 0x6d5, 0x6dc, > + 0x6de, 0x6e4, 0x6e6, 0x6e8, 0x6e9, 0x6ed, 0x710, 0x711, > + 0x72f, 0x74a, 0x7a5, 0x7b0, 0x7ea, 0x7f3, 0x7fc, 0x7fd, > + 0x815, 0x819, 0x81a, 0x823, 0x824, 0x827, 0x828, 0x82d, > + 0x858, 0x85b, 0x8d2, 0x8e1, 0x8e2, 0x902, 0x939, 0x93a, > + 0x93b, 0x93c, 0x940, 0x948, 0x94c, 0x94d, 0x950, 0x957, > + 0x961, 0x963, 0x980, 0x981, 0x9bb, 0x9bc, 0x9c0, 0x9c4, > + 0x9cc, 0x9cd, 0x9e1, 0x9e3, 0x9fd, 0x9fe, 0xa00, 0xa02, > + 0xa3b, 0xa3c, 0xa40, 0xa42, 0xa46, 0xa48, 0xa4a, 0xa4d, > + 0xa50, 0xa51, 0xa6f, 0xa71, 0xa74, 0xa75, 0xa80, 0xa82, > + 0xabb, 0xabc, 0xac0, 0xac5, 0xac6, 0xac8, 0xacc, 0xacd, > + 0xae1, 0xae3, 0xaf9, 0xaff, 0xb00, 0xb01, 0xb3b, 0xb3c, > + 0xb3e, 0xb3f, 0xb40, 0xb44, 0xb4c, 0xb4d, 0xb55, 0xb56, > + 0xb61, 0xb63, 0xb81, 0xb82, 0xbbf, 0xbc0, 0xbcc, 0xbcd, > + 0xbff, 0xc00, 0xc03, 0xc04, 0xc3d, 0xc40, 0xc45, 0xc48, > + 0xc49, 0xc4d, 0xc54, 0xc56, 0xc61, 0xc63, 0xc80, 0xc81, > + 0xcbb, 0xcbc, 0xcbe, 0xcbf, 0xcc5, 0xcc6, 0xccb, 0xccd, > + 0xce1, 0xce3, 0xcff, 0xd01, 0xd3a, 0xd3c, 0xd40, 0xd44, > + 0xd4c, 0xd4d, 0xd61, 0xd63, 0xdc9, 0xdca, 0xdd1, 0xdd4, > + 0xdd5, 0xdd6, 0xe30, 0xe31, 0xe33, 0xe3a, 0xe46, 0xe4e, > + 0xeb0, 0xeb1, 0xeb3, 0xebc, 0xec7, 0xecd, 0xf17, 0xf19, > + 0xf34, 0xf35, 0xf36, 0xf37, 0xf38, 0xf39, 0xf70, 0xf7e, > + 0xf7f, 0xf84, 0xf85, 0xf87, 0xf8c, 0xf97, 0xf98, 0xfbc, > + 0xfc5, 0xfc6, 0x102c, 0x1030, 0x1031, 0x1037, 0x1038, 0x103a, > + 0x103c, 0x103e, 0x1057, 0x1059, 0x105d, 0x1060, 0x1070, 0x1074, > + 0x1081, 0x1082, 0x1084, 0x1086, 0x108c, 0x108d, 0x109c, 0x109d, > + 0x10ff, 0x115f, 0x11ff, 0x135c, 0x135f, 0x1711, 0x1714, 0x1731, > + 0x1734, 0x1751, 0x1753, 0x1771, 0x1773, 0x17b3, 0x17b5, 0x17b6, > + 0x17bd, 0x17c5, 0x17c6, 0x17c8, 0x17d3, 0x17dc, 0x17dd, 0x180a, > + 0x180e, 0x1884, 0x1886, 0x18a8, 0x18a9, 0x191f, 0x1922, 0x1926, > + 0x1928, 0x1931, 0x1932, 0x1938, 0x193b, 0x1a16, 0x1a18, 0x1a1a, > + 0x1a1b, 0x1a55, 0x1a56, 0x1a57, 0x1a5e, 0x1a5f, 0x1a60, 0x1a61, > + 0x1a62, 0x1a64, 0x1a6c, 0x1a72, 0x1a7c, 0x1a7e, 0x1a7f, 0x1aaf, > + 0x1abe, 0x1aff, 0x1b03, 0x1b33, 0x1b34, 0x1b35, 0x1b3a, 0x1b3b, > + 0x1b3c, 0x1b41, 0x1b42, 0x1b6a, 0x1b73, 0x1b7f, 0x1b81, 0x1ba1, > + 0x1ba5, 0x1ba7, 0x1ba9, 0x1baa, 0x1bad, 0x1be5, 0x1be6, 0x1be7, > + 0x1be9, 0x1bec, 0x1bed, 0x1bee, 0x1bf1, 0x1c2b, 0x1c33, 0x1c35, > + 0x1c37, 0x1ccf, 0x1cd2, 0x1cd3, 0x1ce0, 0x1ce1, 0x1ce8, 0x1cec, > + 0x1ced, 0x1cf3, 0x1cf4, 0x1cf7, 0x1cf9, 0x1dbf, 0x1df9, 0x1dfa, > + 0x1dff, 0x200a, 0x200f, 0x2029, 0x202e, 0x205f, 0x2064, 0x2065, > + 0x206f, 0x20cf, 0x20f0, 0x2319, 0x231b, 0x2328, 0x232a, 0x23e8, > + 0x23ec, 0x23ef, 0x23f0, 0x23f2, 0x23f3, 0x25fc, 0x25fe, 0x2613, > + 0x2615, 0x2647, 0x2653, 0x267e, 0x267f, 0x2692, 0x2693, 0x26a0, > + 0x26a1, 0x26a9, 0x26ab, 0x26bc, 0x26be, 0x26c3, 0x26c5, 0x26cd, > + 0x26ce, 0x26d3, 0x26d4, 0x26e9, 0x26ea, 0x26f1, 0x26f3, 0x26f4, > + 0x26f5, 0x26f9, 0x26fa, 0x26fc, 0x26fd, 0x2704, 0x2705, 0x2709, > + 0x270b, 0x2727, 0x2728, 0x274b, 0x274c, 0x274d, 0x274e, 0x2752, > + 0x2755, 0x2756, 0x2757, 0x2794, 0x2797, 0x27af, 0x27b0, 0x27be, > + 0x27bf, 0x2b1a, 0x2b1c, 0x2b4f, 0x2b50, 0x2b54, 0x2b55, 0x2cee, > + 0x2cf1, 0x2d7e, 0x2d7f, 0x2ddf, 0x2dff, 0x2e7f, 0x2e99, 0x2e9a, > + 0x2ef3, 0x2eff, 0x2fd5, 0x2fef, 0x2ffb, 0x2fff, 0x3029, 0x302d, > + 0x303e, 0x3040, 0x3096, 0x3098, 0x309a, 0x30ff, 0x3104, 0x312f, > + 0x3130, 0x318e, 0x318f, 0x31ba, 0x31bf, 0x31e3, 0x31ef, 0x321e, > + 0x321f, 0x4db5, 0x4dbf, 0x9fef, 0x9fff, 0xa48c, 0xa48f, 0xa4c6, > + 0xa66e, 0xa672, 0xa673, 0xa67d, 0xa69d, 0xa69f, 0xa6ef, 0xa6f1, > + 0xa801, 0xa802, 0xa805, 0xa806, 0xa80a, 0xa80b, 0xa824, 0xa826, > + 0xa8c3, 0xa8c5, 0xa8df, 0xa8f1, 0xa8fe, 0xa8ff, 0xa925, 0xa92d, > + 0xa946, 0xa951, 0xa95f, 0xa97c, 0xa97f, 0xa982, 0xa9b2, 0xa9b3, > + 0xa9b5, 0xa9b9, 0xa9bb, 0xa9bd, 0xa9e4, 0xa9e5, 0xaa28, 0xaa2e, > + 0xaa30, 0xaa32, 0xaa34, 0xaa36, 0xaa42, 0xaa43, 0xaa4b, 0xaa4c, > + 0xaa7b, 0xaa7c, 0xaaaf, 0xaab0, 0xaab1, 0xaab4, 0xaab6, 0xaab8, > + 0xaabd, 0xaabf, 0xaac0, 0xaac1, 0xaaeb, 0xaaed, 0xaaf5, 0xaaf6, > + 0xabe4, 0xabe5, 0xabe7, 0xabe8, 0xabec, 0xabed, 0xabff, 0xd7a3, > + 0xf8ff, 0xfa6d, 0xfa6f, 0xfad9, 0xfb1d, 0xfb1e, 0xfdff, 0xfe0f, > + 0xfe19, 0xfe1f, 0xfe2f, 0xfe52, 0xfe53, 0xfe66, 0xfe67, 0xfe6b, > + 0xfefe, 0xfeff, 0xff00, 0xff60, 0xffdf, 0xffe6, 0xfff8, 0xfffb, > + 0x101fc, 0x101fd, 0x102df, 0x102e0, 0x10375, 0x1037a, 0x10a00, 0x10a03, > + 0x10a04, 0x10a06, 0x10a0b, 0x10a0f, 0x10a37, 0x10a3a, 0x10a3e, 0x10a3f, > + 0x10ae4, 0x10ae6, 0x10d23, 0x10d27, 0x10f45, 0x10f50, 0x11000, 0x11001, > + 0x11037, 0x11046, 0x1107e, 0x11081, 0x110b2, 0x110b6, 0x110b8, 0x110ba, > + 0x110ff, 0x11102, 0x11126, 0x1112b, 0x1112c, 0x11134, 0x11172, 0x11173, > + 0x1117f, 0x11181, 0x111b5, 0x111be, 0x111c8, 0x111cc, 0x1122e, 0x11231, > + 0x11233, 0x11234, 0x11235, 0x11237, 0x1123d, 0x1123e, 0x112de, 0x112df, > + 0x112e2, 0x112ea, 0x112ff, 0x11301, 0x1133a, 0x1133c, 0x1133f, 0x11340, > + 0x11365, 0x1136c, 0x1136f, 0x11374, 0x11437, 0x1143f, 0x11441, 0x11444, > + 0x11445, 0x11446, 0x1145d, 0x1145e, 0x114b2, 0x114b8, 0x114b9, 0x114ba, > + 0x114be, 0x114c0, 0x114c1, 0x114c3, 0x115b1, 0x115b5, 0x115bb, 0x115bd, > + 0x115be, 0x115c0, 0x115db, 0x115dd, 0x11632, 0x1163a, 0x1163c, 0x1163d, > + 0x1163e, 0x11640, 0x116aa, 0x116ab, 0x116ac, 0x116ad, 0x116af, 0x116b5, > + 0x116b6, 0x116b7, 0x1171c, 0x1171f, 0x11721, 0x11725, 0x11726, 0x1172b, > + 0x1182e, 0x11837, 0x11838, 0x1183a, 0x119d3, 0x119d7, 0x119d9, 0x119db, > + 0x119df, 0x119e0, 0x11a00, 0x11a0a, 0x11a32, 0x11a38, 0x11a3a, 0x11a3e, > + 0x11a46, 0x11a47, 0x11a50, 0x11a56, 0x11a58, 0x11a5b, 0x11a89, 0x11a96, > + 0x11a97, 0x11a99, 0x11c2f, 0x11c36, 0x11c37, 0x11c3d, 0x11c3e, 0x11c3f, > + 0x11c91, 0x11ca7, 0x11ca9, 0x11cb0, 0x11cb1, 0x11cb3, 0x11cb4, 0x11cb6, > + 0x11d30, 0x11d36, 0x11d39, 0x11d3a, 0x11d3b, 0x11d3d, 0x11d3e, 0x11d45, > + 0x11d46, 0x11d47, 0x11d8f, 0x11d91, 0x11d94, 0x11d95, 0x11d96, 0x11d97, > + 0x11ef2, 0x11ef4, 0x1342f, 0x13438, 0x16aef, 0x16af4, 0x16b2f, 0x16b36, > + 0x16f4e, 0x16f4f, 0x16f8e, 0x16f92, 0x16fdf, 0x16fe3, 0x16fff, 0x187f7, > + 0x187ff, 0x18af2, 0x1afff, 0x1b11e, 0x1b14f, 0x1b152, 0x1b163, 0x1b167, > + 0x1b16f, 0x1b2fb, 0x1bc9c, 0x1bc9e, 0x1bc9f, 0x1bca3, 0x1d166, 0x1d169, > + 0x1d172, 0x1d182, 0x1d184, 0x1d18b, 0x1d1a9, 0x1d1ad, 0x1d241, 0x1d244, > + 0x1d9ff, 0x1da36, 0x1da3a, 0x1da6c, 0x1da74, 0x1da75, 0x1da83, 0x1da84, > + 0x1da9a, 0x1da9f, 0x1daa0, 0x1daaf, 0x1dfff, 0x1e006, 0x1e007, 0x1e018, > + 0x1e01a, 0x1e021, 0x1e022, 0x1e024, 0x1e025, 0x1e02a, 0x1e12f, 0x1e136, > + 0x1e2eb, 0x1e2ef, 0x1e8cf, 0x1e8d6, 0x1e943, 0x1e94a, 0x1f003, 0x1f004, > + 0x1f0ce, 0x1f0cf, 0x1f18d, 0x1f18e, 0x1f190, 0x1f19a, 0x1f1ff, 0x1f202, > + 0x1f20f, 0x1f23b, 0x1f23f, 0x1f248, 0x1f24f, 0x1f251, 0x1f25f, 0x1f265, > + 0x1f2ff, 0x1f320, 0x1f32c, 0x1f335, 0x1f336, 0x1f37c, 0x1f37d, 0x1f393, > + 0x1f39f, 0x1f3ca, 0x1f3ce, 0x1f3d3, 0x1f3df, 0x1f3f0, 0x1f3f3, 0x1f3f4, > + 0x1f3f7, 0x1f43e, 0x1f43f, 0x1f440, 0x1f441, 0x1f4fc, 0x1f4fe, 0x1f53d, > + 0x1f54a, 0x1f54e, 0x1f54f, 0x1f567, 0x1f579, 0x1f57a, 0x1f594, 0x1f596, > + 0x1f5a3, 0x1f5a4, 0x1f5fa, 0x1f64f, 0x1f67f, 0x1f6c5, 0x1f6cb, 0x1f6cc, > + 0x1f6cf, 0x1f6d2, 0x1f6d4, 0x1f6d5, 0x1f6ea, 0x1f6ec, 0x1f6f3, 0x1f6fa, > + 0x1f7df, 0x1f7eb, 0x1f90c, 0x1f971, 0x1f972, 0x1f976, 0x1f979, 0x1f9a2, > + 0x1f9a4, 0x1f9aa, 0x1f9ad, 0x1f9ca, 0x1f9cc, 0x1f9ff, 0x1fa6f, 0x1fa73, > + 0x1fa77, 0x1fa7a, 0x1fa7f, 0x1fa82, 0x1fa8f, 0x1fa95, 0x1ffff, 0x2a6d6, > + 0x2a6ff, 0x2b734, 0x2b73f, 0x2b81d, 0x2b81f, 0x2cea1, 0x2ceaf, 0x2ebe0, > + 0x2f7ff, 0x2fa1d, 0xe0000, 0xe0001, 0xe001f, 0xe007f, 0xe00ff, 0xe01ef, > +}; > + > +static const unsigned char wcwidth_widths[] = { > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, > + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, > + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, > + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, > + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, > + 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, > + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, > + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, > + 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 0, 2, 1, 2, 1, 0, 2, 1, 2, > + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, > + 2, 1, 0, 2, 1, 2, 1, 2, 1, 0, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, > + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, > + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, > + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, > + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, > + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, > +}; > diff --git a/libcpp/include/cpplib.h b/libcpp/include/cpplib.h > index ed108f17bfa..e199aecfa48 100644 > --- a/libcpp/include/cpplib.h > +++ b/libcpp/include/cpplib.h > @@ -1320,4 +1320,15 @@ extern bool cpp_userdef_char_p > extern const char * cpp_get_userdef_suffix > (const cpp_token *); > > +/* In charset.c */ > +int cpp_byte_column_to_display_column (const char *data, int data_length, > + int column); > +inline int cpp_display_width (const char *data, int data_length) > +{ > + return cpp_byte_column_to_display_column (data, data_length, data_length); > +} > +int cpp_display_column_to_byte_column (const char *data, int data_length, > + int display_col); > +int cpp_wcwidth (cppchar_t c); > + > #endif /* ! LIBCPP_CPPLIB_H */ [-- Attachment #2: display_cols_v3.patch --] [-- Type: text/x-patch, Size: 132862 bytes --] diff --git a/contrib/unicode/README b/contrib/unicode/README new file mode 100644 index 00000000000..fbee919647b --- /dev/null +++ b/contrib/unicode/README @@ -0,0 +1,36 @@ +This directory contains a mechanism for GCC to have its own internal +implementation of wcwidth functionality. (cpp_wcwidth () in libcpp/charset.c). + +The idea is to produce the necessary lookup table +(../../libcpp/generated_cpp_wcwidth.h) in a reproducible way, starting from the +following files that are distributed by the Unicode Consortium: + +ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt +ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt +ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt + +These three files have been added to source control in this directory. + +In order to keep in sync with glibc's wcwidth as much as possible, it is +desirable for the logic that processes the Unicode data to be the same as +glibc's. To that end, we also put in this directory, in the from_glibc/ +directory, the glibc python code that implements their logic. This code was +copied verbatim from glibc, and it can be updated at any time from the glibc +source code repository. + +Finally, the script gen_wcwidth.py found here contains the GCC-specific code to +map glibc's output to the lookup tables we require. This script should not need +to change, unless there are structural changes to the Unicode data files or to +the glibc code. + +The procedure to update GCC's wcwidth tables is the following: + +1. Update the three Unicode data files from the above URLs. + +2. Update the two glibc files in from_glibc/ from glibc's git. + +3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_wcwidth.h + (where X.Y is the version of the Unicode standard corresponding to the + Unicode data files being used, most recently, 12.0). + +After that, GCC's wcwidth will match the most recent glibc. diff --git a/contrib/unicode/from_glibc/unicode_utils.py b/contrib/unicode/from_glibc/unicode_utils.py new file mode 100644 index 00000000000..a9e94cce418 --- /dev/null +++ b/contrib/unicode/from_glibc/unicode_utils.py @@ -0,0 +1,527 @@ +# Utilities to generate Unicode data for glibc from upstream Unicode data. +# +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +''' +This module contains utilities used by the scripts to generate +Unicode data for glibc from upstream Unicode data files. +''' + +import sys +import re + + +# Common locale header. +COMMENT_HEADER = """ +% This file is part of the GNU C Library and contains locale data. +% The Free Software Foundation does not claim any copyright interest +% in the locale data contained in this file. The foregoing does not +% affect the license of the GNU C Library as a whole. It does not +% exempt you from the conditions of the license if your use would +% otherwise be governed by that license. +""" + +# Dictionary holding the entire contents of the UnicodeData.txt file +# +# Contents of this dictionary look like this: +# +# {0: {'category': 'Cc', +# 'title': None, +# 'digit': '', +# 'name': '<control>', +# 'bidi': 'BN', +# 'combining': '0', +# 'comment': '', +# 'oldname': 'NULL', +# 'decomposition': '', +# 'upper': None, +# 'mirrored': 'N', +# 'lower': None, +# 'decdigit': '', +# 'numeric': ''}, +# … +# } +UNICODE_ATTRIBUTES = {} + +# Dictionary holding the entire contents of the DerivedCoreProperties.txt file +# +# Contents of this dictionary look like this: +# +# {917504: ['Default_Ignorable_Code_Point'], +# 917505: ['Case_Ignorable', 'Default_Ignorable_Code_Point'], +# … +# } +DERIVED_CORE_PROPERTIES = {} + +# Dictionary holding the entire contents of the EastAsianWidths.txt file +# +# Contents of this dictionary look like this: +# +# {0: 'N', … , 45430: 'W', …} +EAST_ASIAN_WIDTHS = {} + +def fill_attribute(code_point, fields): + '''Stores in UNICODE_ATTRIBUTES[code_point] the values from the fields. + + One entry in the UNICODE_ATTRIBUTES dictionary represents one line + in the UnicodeData.txt file. + + ''' + UNICODE_ATTRIBUTES[code_point] = { + 'name': fields[1], # Character name + 'category': fields[2], # General category + 'combining': fields[3], # Canonical combining classes + 'bidi': fields[4], # Bidirectional category + 'decomposition': fields[5], # Character decomposition mapping + 'decdigit': fields[6], # Decimal digit value + 'digit': fields[7], # Digit value + 'numeric': fields[8], # Numeric value + 'mirrored': fields[9], # mirrored + 'oldname': fields[10], # Old Unicode 1.0 name + 'comment': fields[11], # comment + # Uppercase mapping + 'upper': int(fields[12], 16) if fields[12] else None, + # Lowercase mapping + 'lower': int(fields[13], 16) if fields[13] else None, + # Titlecase mapping + 'title': int(fields[14], 16) if fields[14] else None, + } + +def fill_attributes(filename): + '''Stores the entire contents of the UnicodeData.txt file + in the UNICODE_ATTRIBUTES dictionary. + + A typical line for a single code point in UnicodeData.txt looks + like this: + + 0041;LATIN CAPITAL LETTER A;Lu;0;L;;;;;N;;;;0061; + + Code point ranges are indicated by pairs of lines like this: + + 4E00;<CJK Ideograph, First>;Lo;0;L;;;;;N;;;;; + 9FCC;<CJK Ideograph, Last>;Lo;0;L;;;;;N;;;;; + ''' + with open(filename, mode='r') as unicode_data_file: + fields_start = [] + for line in unicode_data_file: + fields = line.strip().split(';') + if len(fields) != 15: + sys.stderr.write( + 'short line in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + if fields[2] == 'Cs': + # Surrogates are UTF-16 artefacts, + # not real characters. Ignore them. + fields_start = [] + continue + if fields[1].endswith(', First>'): + fields_start = fields + fields_start[1] = fields_start[1].split(',')[0][1:] + continue + if fields[1].endswith(', Last>'): + fields[1] = fields[1].split(',')[0][1:] + if fields[1:] != fields_start[1:]: + sys.stderr.write( + 'broken code point range in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + for code_point in range( + int(fields_start[0], 16), + int(fields[0], 16)+1): + fill_attribute(code_point, fields) + fields_start = [] + continue + fill_attribute(int(fields[0], 16), fields) + fields_start = [] + +def fill_derived_core_properties(filename): + '''Stores the entire contents of the DerivedCoreProperties.txt file + in the DERIVED_CORE_PROPERTIES dictionary. + + Lines in DerivedCoreProperties.txt are either a code point range like + this: + + 0061..007A ; Lowercase # L& [26] LATIN SMALL LETTER A..LATIN SMALL LETTER Z + + or a single code point like this: + + 00AA ; Lowercase # Lo FEMININE ORDINAL INDICATOR + + ''' + with open(filename, mode='r') as derived_core_properties_file: + for line in derived_core_properties_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + + r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + + r'\s*;\s*(?P<property>[a-zA-Z_]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + prop = match.group('property') + if code_point in DERIVED_CORE_PROPERTIES: + DERIVED_CORE_PROPERTIES[code_point].append(prop) + else: + DERIVED_CORE_PROPERTIES[code_point] = [prop] + +def fill_east_asian_widths(filename): + '''Stores the entire contents of the EastAsianWidths.txt file + in the EAST_ASIAN_WIDTHS dictionary. + + Lines in EastAsianWidths.txt are either a code point range like + this: + + 9FCD..9FFF;W # Cn [51] <reserved-9FCD>..<reserved-9FFF> + + or a single code point like this: + + A015;W # Lm YI SYLLABLE WU + ''' + with open(filename, mode='r') as east_asian_widths_file: + for line in east_asian_widths_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + +r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + +r'\s*;\s*(?P<property>[a-zA-Z]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + EAST_ASIAN_WIDTHS[code_point] = match.group('property') + +def to_upper(code_point): + '''Returns the code point of the uppercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['upper']): + return UNICODE_ATTRIBUTES[code_point]['upper'] + else: + return code_point + +def to_lower(code_point): + '''Returns the code point of the lowercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['lower']): + return UNICODE_ATTRIBUTES[code_point]['lower'] + else: + return code_point + +def to_upper_turkish(code_point): + '''Returns the code point of the Turkish uppercase version + of the given code point''' + if code_point == 0x0069: + return 0x0130 + return to_upper(code_point) + +def to_lower_turkish(code_point): + '''Returns the code point of the Turkish lowercase version + of the given code point''' + if code_point == 0x0049: + return 0x0131 + return to_lower(code_point) + +def to_title(code_point): + '''Returns the code point of the titlecase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['title']): + return UNICODE_ATTRIBUTES[code_point]['title'] + else: + return code_point + +def is_upper(code_point): + '''Checks whether the character with this code point is uppercase''' + return (to_lower(code_point) != code_point + or (code_point in DERIVED_CORE_PROPERTIES + and 'Uppercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_lower(code_point): + '''Checks whether the character with this code point is lowercase''' + # Some characters are defined as “Lowercase†in + # DerivedCoreProperties.txt but do not have a mapping to upper + # case. For example, ꜰ U+A72F “LATIN LETTER SMALL CAPITAL F†is + # one of these. + return (to_upper(code_point) != code_point + # <U00DF> is lowercase, but without simple to_upper mapping. + or code_point == 0x00DF + or (code_point in DERIVED_CORE_PROPERTIES + and 'Lowercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_alpha(code_point): + '''Checks whether the character with this code point is alphabetic''' + return ((code_point in DERIVED_CORE_PROPERTIES + and + 'Alphabetic' in DERIVED_CORE_PROPERTIES[code_point]) + or + # Consider all the non-ASCII digits as alphabetic. + # ISO C 99 forbids us to have them in category “digitâ€, + # but we want iswalnum to return true on them. + (UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd' + and not (code_point >= 0x0030 and code_point <= 0x0039))) + +def is_digit(code_point): + '''Checks whether the character with this code point is a digit''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd') + # Note: U+0BE7..U+0BEF and U+1369..U+1371 are digit systems without + # a zero. Must add <0> in front of them by hand. + else: + # SUSV2 gives us some freedom for the "digit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.5: + # The iswdigit function tests for any wide character that + # corresponds to a decimal-digit character (as defined in 5.2.1). + # 5.2.1: + # the 10 decimal digits 0 1 2 3 4 5 6 7 8 9 + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_outdigit(code_point): + '''Checks whether the character with this code point is outdigit''' + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_blank(code_point): + '''Checks whether the character with this code point is blank''' + return (code_point == 0x0009 # '\t' + # Category Zs without mention of '<noBreak>' + or (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Zs' + and '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])) + +def is_space(code_point): + '''Checks whether the character with this code point is a space''' + # Don’t make U+00A0 a space. Non-breaking space means that all programs + # should treat it like a punctuation character, not like a space. + return (code_point == 0x0020 # ' ' + or code_point == 0x000C # '\f' + or code_point == 0x000A # '\n' + or code_point == 0x000D # '\r' + or code_point == 0x0009 # '\t' + or code_point == 0x000B # '\v' + # Categories Zl, Zp, and Zs without mention of "<noBreak>" + or (UNICODE_ATTRIBUTES[code_point]['name'] + and + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'] + or + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zs'] + and + '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])))) + +def is_cntrl(code_point): + '''Checks whether the character with this code point is + a control character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and (UNICODE_ATTRIBUTES[code_point]['name'] == '<control>' + or + UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'])) + +def is_xdigit(code_point): + '''Checks whether the character with this code point is + a hexadecimal digit''' + if False: + return (is_digit(code_point) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + else: + # SUSV2 gives us some freedom for the "xdigit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.12: + # The iswxdigit function tests for any wide character that + # corresponds to a hexadecimal-digit character (as defined + # in 6.4.4.1). + # 6.4.4.1: + # hexadecimal-digit: one of + # 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F + return ((code_point >= 0x0030 and code_point <= 0x0039) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + +def is_graph(code_point): + '''Checks whether the character with this code point is + a graphical character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and not is_space(code_point)) + +def is_print(code_point): + '''Checks whether the character with this code point is printable''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and UNICODE_ATTRIBUTES[code_point]['category'] not in ['Zl', 'Zp']) + +def is_punct(code_point): + '''Checks whether the character with this code point is punctuation''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'].startswith('P')) + else: + # The traditional POSIX definition of punctuation is every graphic, + # non-alphanumeric character. + return (is_graph(code_point) + and not is_alpha(code_point) + and not is_digit(code_point)) + +def is_combining(code_point): + '''Checks whether the character with this code point is + a combining character''' + # Up to Unicode 3.0.1 we took the Combining property from the PropList.txt + # file. In 3.0.1 it was identical to the union of the general categories + # "Mn", "Mc", "Me". In Unicode 3.1 this property has been dropped from the + # PropList.txt file, so we take the latter definition. + return (UNICODE_ATTRIBUTES[code_point]['name'] + and + UNICODE_ATTRIBUTES[code_point]['category'] in ['Mn', 'Mc', 'Me']) + +def is_combining_level3(code_point): + '''Checks whether the character with this code point is + a combining level3 character''' + return (is_combining(code_point) + and + int(UNICODE_ATTRIBUTES[code_point]['combining']) in range(0, 200)) + +def ucs_symbol(code_point): + '''Return the UCS symbol string for a Unicode character.''' + if code_point < 0x10000: + return '<U{:04X}>'.format(code_point) + else: + return '<U{:08X}>'.format(code_point) + +def ucs_symbol_range(code_point_low, code_point_high): + '''Returns a string UCS symbol string for a code point range. + + Example: + + <U0041>..<U005A> + ''' + return ucs_symbol(code_point_low) + '..' + ucs_symbol(code_point_high) + +def verifications(): + '''Tests whether the is_* functions observe the known restrictions''' + for code_point in sorted(UNICODE_ATTRIBUTES): + # toupper restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_upper(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but toupper(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_upper(code_point)}) + # tolower restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_lower(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but tolower(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_lower(code_point)}) + # alpha restriction: "Characters classified as either upper or lower + # shall automatically belong to this class. + if ((is_lower(code_point) or is_upper(code_point)) + and not is_alpha(code_point)): + sys.stderr.write('%(sym)s is upper|lower but not alpha\n' %{ + 'sym': ucs_symbol(code_point)}) + # alpha restriction: “No character specified for the keywords cntrl, + # digit, punct or space shall be specified.†+ if (is_alpha(code_point) and is_cntrl(code_point)): + sys.stderr.write('%(sym)s is alpha and cntrl\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is alpha and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is alpha and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_space(code_point)): + sys.stderr.write('%(sym)s is alpha and space\n' %{ + 'sym': ucs_symbol(code_point)}) + # space restriction: “No character specified for the keywords upper, + # lower, alpha, digit, graph or xdigit shall be specified.†+ # upper, lower, alpha already checked above. + if (is_space(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is space and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is space and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is space and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # cntrl restriction: “No character specified for the keywords upper, + # lower, alpha, digit, punct, graph, print or xdigit shall be + # specified.†upper, lower, alpha already checked above. + if (is_cntrl(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is cntrl and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is cntrl and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is cntrl and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_print(code_point)): + sys.stderr.write('%(sym)s is cntrl and print\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is cntrl and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # punct restriction: “No character specified for the keywords upper, + # lower, alpha, digit, cntrl, xdigit or as the <space> character shall + # be specified.†upper, lower, alpha, cntrl already checked above. + if (is_punct(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is punct and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is punct and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and code_point == 0x0020): + sys.stderr.write('%(sym)s is punct\n' %{ + 'sym': ucs_symbol(code_point)}) + # graph restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # print restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # graph - print relation: differ only in the <space> character. + # How is this possible if there are more than one space character?! + # I think susv2/xbd/locale.html should speak of “space charactersâ€, + # not “space characterâ€. + if (is_print(code_point) + and not (is_graph(code_point) or is_space(code_point))): + sys.stderr.write('%(sym)s is print but not graph|<space>\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) + if (not is_print(code_point) + and (is_graph(code_point) or code_point == 0x0020)): + sys.stderr.write('%(sym)s is graph|<space> but not print\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) diff --git a/contrib/unicode/from_glibc/utf8_gen.py b/contrib/unicode/from_glibc/utf8_gen.py new file mode 100755 index 00000000000..0e5583cd259 --- /dev/null +++ b/contrib/unicode/from_glibc/utf8_gen.py @@ -0,0 +1,364 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +'''glibc/localedata/charmaps/UTF-8 file generator script + +This script generates a glibc/localedata/charmaps/UTF-8 file +from Unicode data. + +Usage: python3 utf8_gen.py UnicodeData.txt EastAsianWidth.txt + +It will output UTF-8 file +''' + +import argparse +import sys +import re +import unicode_utils + +# Auxiliary tables for Hangul syllable names, see the Unicode 3.0 book, +# sections 3.11 and 4.4. + +JAMO_INITIAL_SHORT_NAME = ( + 'G', 'GG', 'N', 'D', 'DD', 'R', 'M', 'B', 'BB', 'S', 'SS', '', 'J', 'JJ', + 'C', 'K', 'T', 'P', 'H' +) + +JAMO_MEDIAL_SHORT_NAME = ( + 'A', 'AE', 'YA', 'YAE', 'EO', 'E', 'YEO', 'YE', 'O', 'WA', 'WAE', 'OE', + 'YO', 'U', 'WEO', 'WE', 'WI', 'YU', 'EU', 'YI', 'I' +) + +JAMO_FINAL_SHORT_NAME = ( + '', 'G', 'GG', 'GS', 'N', 'NI', 'NH', 'D', 'L', 'LG', 'LM', 'LB', 'LS', + 'LT', 'LP', 'LH', 'M', 'B', 'BS', 'S', 'SS', 'NG', 'J', 'C', 'K', 'T', + 'P', 'H' +) + +def process_range(start, end, outfile, name): + '''Writes a range of code points into the CHARMAP section of the + output file + + ''' + if 'Hangul Syllable' in name: + # from glibc/localedata/ChangeLog: + # + # 2000-09-24 Bruno Haible <haible@clisp.cons.org> + # * charmaps/UTF-8: Expand <Hangul Syllable> and <Private Use> ranges, + # so they become printable and carry a width. Comment out surrogate + # ranges. Add a WIDTH table + # + # So we expand the Hangul Syllables here: + for i in range(int(start, 16), int(end, 16)+1 ): + index2, index3 = divmod(i - 0xaC00, 28) + index1, index2 = divmod(index2, 21) + hangul_syllable_name = 'HANGUL SYLLABLE ' \ + + JAMO_INITIAL_SHORT_NAME[index1] \ + + JAMO_MEDIAL_SHORT_NAME[index2] \ + + JAMO_FINAL_SHORT_NAME[index3] + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), convert_to_hex(i), + hangul_syllable_name)) + return + # UnicodeData.txt file has contains code point ranges like this: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + # + # The glibc UTF-8 file splits ranges like these into shorter + # ranges of 64 code points each: + # + # <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + # … + # <U4D80>..<U4DB5> /xe4/xb6/x80 <CJK Ideograph Extension A> + for i in range(int(start, 16), int(end, 16), 64 ): + if i > (int(end, 16)-64): + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(int(end,16)), + convert_to_hex(i), + name)) + break + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(i+63), + convert_to_hex(i), + name)) + +def process_charmap(flines, outfile): + '''This function takes an array which contains *all* lines of + of UnicodeData.txt and write lines to outfile as used in the + + CHARMAP + … + END CHARMAP + + section of the UTF-8 file in glibc/localedata/charmaps/UTF-8. + + Samples for input lines: + + 0010;<control>;Cc;0;BN;;;;;N;DATA LINK ESCAPE;;;; + 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + D800;<Non Private Use High Surrogate, First>;Cs;0;L;;;;;N;;;;; + DB7F;<Non Private Use High Surrogate, Last>;Cs;0;L;;;;;N;;;;; + 100000;<Plane 16 Private Use, First>;Co;0;L;;;;;N;;;;; + 10FFFD;<Plane 16 Private Use, Last>;Co;0;L;;;;;N;;;;; + + Samples for output lines (Unicode-Value UTF-8-HEX Unicode-Char-Name): + + <U0010> /x10 DATA LINK ESCAPE + <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + %<UD800> /xed/xa0/x80 <Non Private Use High Surrogate, First> + %<UDB7F> /xed/xad/xbf <Non Private Use High Surrogate, Last> + <U0010FFC0>..<U0010FFFD> /xf4/x8f/xbf/x80 <Plane 16 Private Use> + + ''' + fields_start = [] + for line in flines: + fields = line.split(";") + # Some characters have “<control>†as their name. We try to + # use the “Unicode 1.0 Name†(10th field in + # UnicodeData.txt) for them. + # + # The Characters U+0080, U+0081, U+0084 and U+0099 have + # “<control>†as their name but do not even have aa + # â€Unicode 1.0 Nameâ€. We could write code to take their + # alternate names from NameAliases.txt. + if fields[1] == "<control>" and fields[10]: + fields[1] = fields[10] + # Handling code point ranges like: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + if fields[1].endswith(', First>') and not 'Surrogate,' in fields[1]: + fields_start = fields + continue + if fields[1].endswith(', Last>') and not 'Surrogate,' in fields[1]: + process_range(fields_start[0], fields[0], + outfile, fields[1][:-7]+'>') + fields_start = [] + continue + fields_start = [] + if 'Surrogate,' in fields[1]: + # Comment out the surrogates in the UTF-8 file. + # One could of course skip them completely but + # the original UTF-8 file in glibc had them as + # comments, so we keep these comment lines. + outfile.write('%') + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(int(fields[0], 16)), + convert_to_hex(int(fields[0], 16)), + fields[1])) + +def convert_to_hex(code_point): + '''Converts a code point to a hexadecimal UTF-8 representation + like /x**/x**/x**.''' + # Getting UTF8 of Unicode characters. + # In Python3, .encode('UTF-8') does not work for + # surrogates. Therefore, we use this conversion table + surrogates = { + 0xD800: '/xed/xa0/x80', + 0xDB7F: '/xed/xad/xbf', + 0xDB80: '/xed/xae/x80', + 0xDBFF: '/xed/xaf/xbf', + 0xDC00: '/xed/xb0/x80', + 0xDFFF: '/xed/xbf/xbf', + } + if code_point in surrogates: + return surrogates[code_point] + return ''.join([ + '/x{:02x}'.format(c) for c in chr(code_point).encode('UTF-8') + ]) + +def write_header_charmap(outfile): + '''Write the header on top of the CHARMAP section to the output file''' + outfile.write("<code_set_name> UTF-8\n") + outfile.write("<comment_char> %\n") + outfile.write("<escape_char> /\n") + outfile.write("<mb_cur_min> 1\n") + outfile.write("<mb_cur_max> 6\n\n") + outfile.write("% CHARMAP generated using utf8_gen.py\n") + outfile.write("% alias ISO-10646/UTF-8\n") + outfile.write("CHARMAP\n") + +def write_header_width(outfile, unicode_version): + '''Writes the header on top of the WIDTH section to the output file''' + outfile.write('% Character width according to Unicode ' + + '{:s}.\n'.format(unicode_version)) + outfile.write('% - Default width is 1.\n') + outfile.write('% - Double-width characters have width 2; generated from\n') + outfile.write('% "grep \'^[^;]*;[WF]\' EastAsianWidth.txt"\n') + outfile.write('% - Non-spacing characters have width 0; ' + + 'generated from PropList.txt or\n') + outfile.write('% "grep \'^[^;]*;[^;]*;[^;]*;[^;]*;NSM;\' ' + + 'UnicodeData.txt"\n') + outfile.write('% - Format control characters have width 0; ' + + 'generated from\n') + outfile.write("% \"grep '^[^;]*;[^;]*;Cf;' UnicodeData.txt\"\n") +# Not needed covered by Cf +# outfile.write("% - Zero width characters have width 0; generated from\n") +# outfile.write("% \"grep '^[^;]*;ZERO WIDTH ' UnicodeData.txt\"\n") + outfile.write("WIDTH\n") + +def process_width(outfile, ulines, elines, plines): + '''ulines are lines from UnicodeData.txt, elines are lines from + EastAsianWidth.txt containing characters with width “W†or “Fâ€, + plines are lines from PropList.txt which contain characters + with the property “Prepended_Concatenation_Markâ€. + + ''' + width_dict = {} + for line in elines: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + width_dict[key] = 2 + + for line in ulines: + fields = line.split(";") + if fields[4] == "NSM" or fields[2] in ("Cf", "Me", "Mn"): + width_dict[int(fields[0], 16)] = 0 + + for line in plines: + # Characters with the property “Prepended_Concatenation_Mark†+ # should have the width 1: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + del width_dict[key] # default width is 1 + + # handle special cases for compatibility + for key in list((0x00AD,)): + # https://www.cs.tut.fi/~jkorpela/shy.html + if key in width_dict: + del width_dict[key] # default width is 1 + for key in list(range(0x1160, 0x1200)): + width_dict[key] = 0 + for key in list(range(0x3248, 0x3250)): + # These are “A†which means we can decide whether to treat them + # as “W†or “N†based on context: + # http://www.unicode.org/mail-arch/unicode-ml/y2017-m08/0023.html + # For us, “W†seems better. + width_dict[key] = 2 + for key in list(range(0x4DC0, 0x4E00)): + width_dict[key] = 2 + + same_width_lists = [] + current_width_list = [] + for key in sorted(width_dict): + if not current_width_list: + current_width_list = [key] + elif (key == current_width_list[-1] + 1 + and width_dict[key] == width_dict[current_width_list[0]]): + current_width_list.append(key) + else: + same_width_lists.append(current_width_list) + current_width_list = [key] + if current_width_list: + same_width_lists.append(current_width_list) + + for same_width_list in same_width_lists: + if len(same_width_list) == 1: + outfile.write('{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + width_dict[same_width_list[0]])) + else: + outfile.write('{:s}...{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + unicode_utils.ucs_symbol(same_width_list[-1]), + width_dict[same_width_list[0]])) + +if __name__ == "__main__": + PARSER = argparse.ArgumentParser( + description=''' + Generate a UTF-8 file from UnicodeData.txt, EastAsianWidth.txt, and PropList.txt. + ''') + PARSER.add_argument( + '-u', '--unicode_data_file', + nargs='?', + type=str, + default='UnicodeData.txt', + help=('The UnicodeData.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-e', '--east_asian_with_file', + nargs='?', + type=str, + default='EastAsianWidth.txt', + help=('The EastAsianWidth.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-p', '--prop_list_file', + nargs='?', + type=str, + default='PropList.txt', + help=('The PropList.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '--unicode_version', + nargs='?', + required=True, + type=str, + help='The Unicode version of the input files used.') + ARGS = PARSER.parse_args() + + with open(ARGS.unicode_data_file, mode='r') as UNIDATA_FILE: + UNICODE_DATA_LINES = UNIDATA_FILE.readlines() + with open(ARGS.east_asian_with_file, mode='r') as EAST_ASIAN_WIDTH_FILE: + EAST_ASIAN_WIDTH_LINES = [] + for LINE in EAST_ASIAN_WIDTH_FILE: + # If characters from EastAasianWidth.txt which are from + # from reserved ranges (i.e. not yet assigned code points) + # are added to the WIDTH section of the UTF-8 file, then + # “make check†produces “Unknown Character†errors for + # these code points because such unassigned code points + # are not in the CHARMAP section of the UTF-8 file. + # + # Therefore, we skip all reserved code points when reading + # the EastAsianWidth.txt file. + if re.match(r'.*<reserved-.+>\.\.<reserved-.+>.*', LINE): + continue + if re.match(r'^[^;]*;[WF]', LINE): + EAST_ASIAN_WIDTH_LINES.append(LINE.strip()) + with open(ARGS.prop_list_file, mode='r') as PROP_LIST_FILE: + PROP_LIST_LINES = [] + for LINE in PROP_LIST_FILE: + if re.match(r'^[^;]*;[\s]*Prepended_Concatenation_Mark', LINE): + PROP_LIST_LINES.append(LINE.strip()) + with open('UTF-8', mode='w') as OUTFILE: + # Processing UnicodeData.txt and write CHARMAP to UTF-8 file + write_header_charmap(OUTFILE) + process_charmap(UNICODE_DATA_LINES, OUTFILE) + OUTFILE.write("END CHARMAP\n\n") + # Processing EastAsianWidth.txt and write WIDTH to UTF-8 file + write_header_width(OUTFILE, ARGS.unicode_version) + process_width(OUTFILE, + UNICODE_DATA_LINES, + EAST_ASIAN_WIDTH_LINES, + PROP_LIST_LINES) + OUTFILE.write("END WIDTH\n") diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py new file mode 100755 index 00000000000..02b28bcedcf --- /dev/null +++ b/contrib/unicode/gen_wcwidth.py @@ -0,0 +1,106 @@ +#!/usr/bin/env python3 +# +# Script to generate tables for cpp_wcwidth, leveraging glibc's utf8_gen.py. +# +# This file is part of GCC. +# +# GCC is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation; either version 3, or (at your option) any later +# version. +# +# GCC 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 Public License +# for more details. +# +# You should have received a copy of the GNU General Public License +# along with GCC; see the file COPYING3. If not see +# <http://www.gnu.org/licenses/>. */ + +import sys +import os + +if len(sys.argv) != 2: + print("usage: %s <unicode version>", file=sys.stderr) + sys.exit(1) +unicode_version = sys.argv[1] + +# Parse a codepoint in the format output by glibc tools. +def parse_ucn(s): + if not (s.startswith("<U") and s.endswith(">")): + raise ValueError + return int(s[2:-1], base=16) + +# Process a line of width output from utf_gen.py and update global array. +widths = [1] * (1 + 0x10FFFF) +def process_width(line): + # Example lines: + # <UA8FF> 0 + # <UA926>...<UA92D> 0 + + s = line.split() + width = int(s[1]) + r = s[0].split("...") + if len(r) == 1: + begin = parse_ucn(r[0]) + end = begin + 1 + elif len(r) == 2: + begin = parse_ucn(r[0]) + end = parse_ucn(r[1]) + 1 + else: + raise ValueError + widths[begin:end] = [width] * (end - begin) + +# To keep things simple, we use glibc utf8_gen.py as-is. It only outputs to a +# file named UTF-8, which is not configurable. Then we parse this into the form +# we want it. +os.system("from_glibc/utf8_gen.py --unicode_version %s" % unicode_version) +processing = False +for line in open("UTF-8", "r"): + if processing: + if line == "END WIDTH\n": + processing = False + else: + try: + process_width(line) + except (ValueError, IndexError): + print(e, "warning: ignored unexpected line: %s" % line, + file=sys.stderr, end="") + elif line == "WIDTH\n": + processing = True + +# All bytes < 256 we treat as width 1. +widths[0:255] = [1] * 255 + +# Condense the list to contiguous ranges. +cur_range = [-1, 1] +all_ranges = [] +for i, width in enumerate(widths): + if width == cur_range[1]: + cur_range[0] = i + else: + all_ranges.append(cur_range) + cur_range = [i, width] + +# Output the arrays for generated_cpp_wcwidth.h +print("/* Generated by contrib/unicode/gen_wcwidth.py,", + "with the help of glibc's") +print(" utf8_gen.py, using version %s" % unicode_version, + "of the Unicode standard. */") +print("\nstatic const cppchar_t wcwidth_range_ends[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 8: + print(" ", end="") + else: + print("\n ", end="") + print("0x%x," % (r[0]), end="") +print("\n};\n") +print("static const unsigned char wcwidth_widths[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 24: + print(" ", end="") + else: + print("\n ", end="") + print("%d," % r[1], end="") +print("\n};") diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c index cb920f6b9d0..3460da3cf32 100644 --- a/gcc/diagnostic-show-locus.c +++ b/gcc/diagnostic-show-locus.c @@ -30,6 +30,7 @@ along with GCC; see the file COPYING3. If not see #include "gcc-rich-location.h" #include "selftest.h" #include "selftest-diagnostic.h" +#include "cpplib.h" #ifdef HAVE_TERMIOS_H # include <termios.h> @@ -112,18 +113,81 @@ class colorizer const char *m_stop_color; }; -/* A point within a layout_range; similar to an expanded_location, +/* In order to handle multibyte sources properly, all of this logic needs to be + aware of the distinction between the number of bytes and the number of + display columns occupied by a character, which are not the same for non-ASCII + characters. For example, the Unicode pi symbol, U+03C0, is encoded in UTF-8 + as "\xcf\x80", and thus occupies 2 bytes of space while only occupying 1 + display column when it is output. A typical emoji, such as U+1F602 (in + UTF-8, "\xf0\x9f\x98\x82"), requires 4 bytes and has a display width of 2. + + The below example line, which is also used for selftests below, shows how the + display column and byte column are related: + + 0000000001111111111222222 display + 1234567890123456789012345 columns + SS_foo = P_bar.SS_fieldP; + 0000000111111111222222223 byte + 1356789012456789134567891 columns + + Here SS represents the two display columns for the U+1F602 emoji, and P + represents the one display column for the U+03C0 pi symbol. As an example, a + diagnostic pointing to the final P on this line is at byte column 29 and + display column 24. This reflects the fact that the three extended characters + before the final P occupy cumulatively 5 more bytes than they do display + columns (a difference of 2 for each of the two SSs, and one for the other P). + + One or the other of the two column units is more useful depending on the + context. For instance, in order to output the caret at the correct location, + we need to count display columns; in order to colorize a source line, we need + to count the bytes. All locations are provided to us as byte counts, which + we augment with the display column on demand so that it can be used when + needed. This is not the most efficient way to do things since it requires + looping over the whole line each time, but it should be fine for the purpose + of outputting diagnostics. + + In order to keep straight which units (byte or display) are in use at a + given time, the following enum lets us specify that explicitly. */ + +enum column_unit { + /* Measured in raw bytes. */ + CU_BYTES = 0, + + /* Measured in display units. */ + CU_DISPLAY_COLS, + + /* For arrays indexed by column_unit. */ + CU_NUM_UNITS +}; + +/* Utility class to augment an exploc with the corresponding display column. */ + +class exploc_with_display_col : public expanded_location +{ + public: + exploc_with_display_col (const expanded_location &exploc) + : expanded_location (exploc), + m_display_col (location_compute_display_column (exploc)) {} + + int m_display_col; +}; + + +/* A point within a layout_range; similar to an exploc_with_display_col, but after filtering on file. */ class layout_point { public: layout_point (const expanded_location &exploc) - : m_line (exploc.line), - m_column (exploc.column) {} + : m_line (exploc.line) + { + m_columns[CU_BYTES] = exploc.column; + m_columns[CU_DISPLAY_COLS] = location_compute_display_column (exploc); + } linenum_type m_line; - int m_column; + int m_columns[CU_NUM_UNITS]; }; /* A class for use by "class layout" below: a filtered location_range. */ @@ -138,7 +202,8 @@ class layout_range unsigned original_idx, const range_label *label); - bool contains_point (linenum_type row, int column) const; + bool contains_point (linenum_type row, int column, + enum column_unit col_unit) const; bool intersects_line_p (linenum_type row) const; layout_point m_start; @@ -157,6 +222,17 @@ struct line_bounds { int m_first_non_ws; int m_last_non_ws; + + void convert_to_display_cols (char_span line) + { + m_first_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_first_non_ws); + + m_last_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_last_non_ws); + } }; /* A range of contiguous source lines within a layout (e.g. "lines 5-10" @@ -284,6 +360,7 @@ class layout get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + enum column_unit col_unit, /* Outputs. */ point_state *out_state); @@ -298,7 +375,7 @@ class layout diagnostic_context *m_context; pretty_printer *m_pp; location_t m_primary_loc; - expanded_location m_exploc; + exploc_with_display_col m_exploc; colorizer m_colorizer; bool m_colorize_source_p; bool m_show_labels_p; @@ -472,10 +549,15 @@ layout_range::layout_range (const expanded_location *start_exploc, - 'w' indicates a point within the range - 'F' indicates the finish of the range (which is within it). - - 'a' indicates a subsequent point *after* the range. */ + - 'a' indicates a subsequent point *after* the range. + + COL_UNIT controls whether we check the byte column or + the display column; one or the other is more convenient + depending on the context. */ bool -layout_range::contains_point (linenum_type row, int column) const +layout_range::contains_point (linenum_type row, int column, + enum column_unit col_unit) const { gcc_assert (m_start.m_line <= m_finish.m_line); /* ...but the equivalent isn't true for the columns; @@ -491,7 +573,7 @@ layout_range::contains_point (linenum_type row, int column) const /* On same line as start of range (corresponding to line 02 in example A and line 03 in example B). */ { - if (column < m_start.m_column) + if (column < m_start.m_columns[col_unit]) /* Points on the starting line of the range, but before the column in which it begins. */ return false; @@ -505,7 +587,7 @@ layout_range::contains_point (linenum_type row, int column) const { /* This is a single-line range. */ gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.m_columns[col_unit]; } } @@ -530,7 +612,7 @@ layout_range::contains_point (linenum_type row, int column) const gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.m_columns[col_unit]; } /* Does this layout_range contain any part of line ROW? */ @@ -554,9 +636,9 @@ static layout_range make_range (int start_line, int start_col, int end_line, int end_col) { const expanded_location start_exploc - = {"test.c", start_line, start_col, NULL, false}; + = {"", start_line, start_col, NULL, false}; const expanded_location finish_exploc - = {"test.c", end_line, end_col, NULL, false}; + = {"", end_line, end_col, NULL, false}; return layout_range (&start_exploc, &finish_exploc, SHOW_RANGE_WITHOUT_CARET, &start_exploc, 0, NULL); } @@ -574,20 +656,25 @@ test_layout_range_for_single_point () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (point.contains_point (6, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before the line. */ + ASSERT_FALSE (point.contains_point (6, 1, col_unit)); - /* On the line, but before start. */ - ASSERT_FALSE (point.contains_point (7, 9)); + /* On the line, but before start. */ + ASSERT_FALSE (point.contains_point (7, 9, col_unit)); - /* At the point. */ - ASSERT_TRUE (point.contains_point (7, 10)); + /* At the point. */ + ASSERT_TRUE (point.contains_point (7, 10, col_unit)); - /* On the line, after the point. */ - ASSERT_FALSE (point.contains_point (7, 11)); + /* On the line, after the point. */ + ASSERT_FALSE (point.contains_point (7, 11, col_unit)); - /* After the line. */ - ASSERT_FALSE (point.contains_point (8, 1)); + /* After the line. */ + ASSERT_FALSE (point.contains_point (8, 1, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (point.intersects_line_p (6)); @@ -605,26 +692,31 @@ test_layout_range_for_single_line () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (example_a.contains_point (1, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before the line. */ + ASSERT_FALSE (example_a.contains_point (1, 1, col_unit)); - /* On the line, but before start. */ - ASSERT_FALSE (example_a.contains_point (2, 21)); + /* On the line, but before start. */ + ASSERT_FALSE (example_a.contains_point (2, 21, col_unit)); - /* On the line, at the start. */ - ASSERT_TRUE (example_a.contains_point (2, 22)); + /* On the line, at the start. */ + ASSERT_TRUE (example_a.contains_point (2, 22, col_unit)); - /* On the line, within the range. */ - ASSERT_TRUE (example_a.contains_point (2, 23)); + /* On the line, within the range. */ + ASSERT_TRUE (example_a.contains_point (2, 23, col_unit)); - /* On the line, at the end. */ - ASSERT_TRUE (example_a.contains_point (2, 38)); + /* On the line, at the end. */ + ASSERT_TRUE (example_a.contains_point (2, 38, col_unit)); - /* On the line, after the end. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* On the line, after the end. */ + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); - /* After the line. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* After the line. */ + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_a.intersects_line_p (1)); @@ -642,40 +734,45 @@ test_layout_range_for_multiple_lines () /* Tests for layout_range::contains_point. */ - /* Before first line. */ - ASSERT_FALSE (example_b.contains_point (1, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; - /* On the first line, but before start. */ - ASSERT_FALSE (example_b.contains_point (3, 13)); + /* Before first line. */ + ASSERT_FALSE (example_b.contains_point (1, 1, col_unit)); - /* At the start. */ - ASSERT_TRUE (example_b.contains_point (3, 14)); + /* On the first line, but before start. */ + ASSERT_FALSE (example_b.contains_point (3, 13, col_unit)); - /* On the first line, within the range. */ - ASSERT_TRUE (example_b.contains_point (3, 15)); + /* At the start. */ + ASSERT_TRUE (example_b.contains_point (3, 14, col_unit)); - /* On an interior line. - The column number should not matter; try various boundary - values. */ - ASSERT_TRUE (example_b.contains_point (4, 1)); - ASSERT_TRUE (example_b.contains_point (4, 7)); - ASSERT_TRUE (example_b.contains_point (4, 8)); - ASSERT_TRUE (example_b.contains_point (4, 9)); - ASSERT_TRUE (example_b.contains_point (4, 13)); - ASSERT_TRUE (example_b.contains_point (4, 14)); - ASSERT_TRUE (example_b.contains_point (4, 15)); + /* On the first line, within the range. */ + ASSERT_TRUE (example_b.contains_point (3, 15, col_unit)); - /* On the final line, before the end. */ - ASSERT_TRUE (example_b.contains_point (5, 7)); + /* On an interior line. + The column number should not matter; try various boundary + values. */ + ASSERT_TRUE (example_b.contains_point (4, 1, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 7, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 8, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 9, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 13, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 14, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 15, col_unit)); - /* On the final line, at the end. */ - ASSERT_TRUE (example_b.contains_point (5, 8)); + /* On the final line, before the end. */ + ASSERT_TRUE (example_b.contains_point (5, 7, col_unit)); - /* On the final line, after the end. */ - ASSERT_FALSE (example_b.contains_point (5, 9)); + /* On the final line, at the end. */ + ASSERT_TRUE (example_b.contains_point (5, 8, col_unit)); - /* After the line. */ - ASSERT_FALSE (example_b.contains_point (6, 1)); + /* On the final line, after the end. */ + ASSERT_FALSE (example_b.contains_point (5, 9, col_unit)); + + /* After the line. */ + ASSERT_FALSE (example_b.contains_point (6, 1, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_b.intersects_line_p (2)); @@ -687,8 +784,8 @@ test_layout_range_for_multiple_lines () #endif /* #if CHECKING_P */ -/* Given a source line LINE of length LINE_WIDTH, determine the width - without any trailing whitespace. */ +/* Given a source line LINE of length LINE_WIDTH bytes, determine the width + (in bytes, not display cols) without any trailing whitespace. */ static int get_line_width_without_trailing_whitespace (const char *line, int line_width) @@ -897,17 +994,35 @@ layout::layout (diagnostic_context * context, will be adjusted accordingly. */ size_t max_width = m_context->caret_max_width; char_span line = location_get_source_line (m_exploc.file, m_exploc.line); - if (line && (size_t)m_exploc.column <= line.length ()) + if (line && max_width) { - size_t right_margin = CARET_LINE_MARGIN; - size_t column = m_exploc.column; - if (m_show_line_numbers_p) - column += m_linenum_width + 2; - right_margin = MIN (line.length () - column, right_margin); - right_margin = max_width - right_margin; - if (line.length () >= max_width && column > right_margin) - m_x_offset = column - right_margin; - gcc_assert (m_x_offset >= 0); + size_t column = m_exploc.m_display_col; + int line_width + = get_line_width_without_trailing_whitespace (line.get_buffer (), + line.length ()); + size_t eol = cpp_display_width (line.get_buffer (), line_width); + const size_t eol_before_linenum = eol; + + if (column <= eol) + { + if (m_show_line_numbers_p) + { + column += m_linenum_width + 2; + eol += m_linenum_width + 2; + } + size_t right_margin = CARET_LINE_MARGIN; + right_margin = MIN (eol - column, right_margin); + right_margin = max_width - right_margin; + /* Note: if right_margin > max_width, we end up failing this next + check due to wrapping, and we don't offset anything. Otherwise we + would conclude we can't output the line at all. */ + if (eol >= max_width && column > right_margin) + { + m_x_offset = column - right_margin; + m_x_offset = MIN (m_x_offset, (int) eol_before_linenum - 1); + } + gcc_assert (m_x_offset >= 0); + } } if (context->show_ruler_p) @@ -1086,7 +1201,7 @@ layout::get_expanded_location (const line_span *line_span) const { expanded_location exploc = m_exploc; exploc.line = lr->m_start.m_line; - exploc.column = lr->m_start.m_column; + exploc.column = lr->m_start.m_columns[CU_BYTES]; return exploc; } } @@ -1254,7 +1369,9 @@ layout::calculate_line_spans () /* Print line ROW of source code, potentially colorized at any ranges, and populate *LBOUNDS_OUT. LINE is the source line (not necessarily 0-terminated) and LINE_WIDTH - is its width. */ + is its width. This function deals only with byte offsets, not display + columns; m_x_offset must be converted from display to byte units. In + particular, LINE_WIDTH and LBOUNDS_OUT are in bytes. */ void layout::print_source_line (linenum_type row, const char *line, int line_width, @@ -1266,7 +1383,10 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, whitespace. */ line_width = get_line_width_without_trailing_whitespace (line, line_width); - line += m_x_offset; + + const int x_offset_bytes + = cpp_display_column_to_byte_column (line, line_width, m_x_offset); + line += x_offset_bytes; pp_emit_prefix (m_pp); @@ -1282,7 +1402,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, int first_non_ws = INT_MAX; int last_non_ws = 0; int column; - for (column = 1 + m_x_offset; column <= line_width; column++) + for (column = 1 + x_offset_bytes; column <= line_width; column++) { /* Assuming colorization is enabled for the caret and underline characters, we may also colorize the associated characters @@ -1302,6 +1422,7 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, point_state state; in_range_p = get_state_at_point (row, column, 0, INT_MAX, + CU_BYTES, &state); if (in_range_p) m_colorizer.set_range (state.range_idx); @@ -1365,12 +1486,13 @@ layout::start_annotation_line (char margin_char) const } /* Print a line consisting of the caret/underlines for the given - source line. */ + source line. This function works with display columns, rather than byte + counts; in particular, LBOUNDS should be in display column units. */ void layout::print_annotation_line (linenum_type row, const line_bounds lbounds) { - int x_bound = get_x_bound_for_row (row, m_exploc.column, + int x_bound = get_x_bound_for_row (row, m_exploc.m_display_col, lbounds.m_last_non_ws); start_annotation_line (); @@ -1383,6 +1505,7 @@ layout::print_annotation_line (linenum_type row, const line_bounds lbounds) in_range_p = get_state_at_point (row, column, lbounds.m_first_non_ws, lbounds.m_last_non_ws, + CU_DISPLAY_COLS, &state); if (in_range_p) { @@ -1420,9 +1543,11 @@ class line_label public: line_label (int state_idx, int column, label_text text) : m_state_idx (state_idx), m_column (column), - m_text (text), m_length (strlen (text.m_buffer)), - m_label_line (0), m_has_vbar (true) - {} + m_text (text), m_label_line (0), m_has_vbar (true) + { + const int bytes = strlen (text.m_buffer); + m_display_width = cpp_display_width (text.m_buffer, bytes); + } /* Sorting is primarily by column, then by state index. */ static int comparator (const void *p1, const void *p2) @@ -1441,7 +1566,7 @@ public: int m_state_idx; int m_column; label_text m_text; - size_t m_length; + size_t m_display_width; int m_label_line; bool m_has_vbar; }; @@ -1468,7 +1593,8 @@ layout::print_any_labels (linenum_type row) /* Reject labels that aren't fully visible due to clipping by m_x_offset. */ - if (range->m_caret.m_column <= m_x_offset) + const int disp_col = range->m_caret.m_columns[CU_DISPLAY_COLS]; + if (disp_col <= m_x_offset) continue; label_text text; @@ -1480,7 +1606,7 @@ layout::print_any_labels (linenum_type row) if (text.m_buffer == NULL) continue; - labels.safe_push (line_label (i, range->m_caret.m_column, text)); + labels.safe_push (line_label (i, disp_col, text)); } } @@ -1530,7 +1656,7 @@ layout::print_any_labels (linenum_type row) FOR_EACH_VEC_ELT_REVERSE (labels, i, label) { /* Would this label "touch" or overlap the next label? */ - if (label->m_column + label->m_length >= (size_t)next_column) + if (label->m_column + label->m_display_width >= (size_t)next_column) { max_label_line++; @@ -1569,7 +1695,7 @@ layout::print_any_labels (linenum_type row) m_colorizer.set_range (label->m_state_idx); pp_string (m_pp, label->m_text.m_buffer); m_colorizer.set_normal_text (); - column += label->m_length; + column += label->m_display_width; } else if (label->m_has_vbar) { @@ -1636,7 +1762,7 @@ layout::print_leading_fixits (linenum_type row) /* Subroutine of layout::print_trailing_fixits. Determine if the annotation line printed for LINE contained - the exact range from START_COLUMN to FINISH_COLUMN. */ + the exact range from START_COLUMN to FINISH_COLUMN (in display units). */ bool layout::annotation_line_showed_range_p (linenum_type line, int start_column, @@ -1646,9 +1772,9 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, int i; FOR_EACH_VEC_ELT (m_layout_ranges, i, range) if (range->m_start.m_line == line - && range->m_start.m_column == start_column + && range->m_start.m_columns[CU_DISPLAY_COLS] == start_column && range->m_finish.m_line == line - && range->m_finish.m_column == finish_column) + && range->m_finish.m_columns[CU_DISPLAY_COLS] == finish_column) return true; return false; } @@ -1735,7 +1861,7 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, and is thus printed as desired. */ -/* A range of columns within a line. */ +/* A range of (byte or display) columns within a line. */ class column_range { @@ -1755,32 +1881,51 @@ public: int finish; }; -/* Get the range of columns that HINT would affect. */ - +/* Get the range of bytes or display columns that HINT would affect. */ static column_range -get_affected_columns (const fixit_hint *hint) +get_affected_range (const fixit_hint *hint, enum column_unit col_unit) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; + expanded_location exploc_start = expand_location (hint->get_start_loc ()); + expanded_location exploc_finish = expand_location (hint->get_next_loc ()); + --exploc_finish.column; + int start_column; + int finish_column; + if (col_unit == CU_DISPLAY_COLS) + { + start_column = location_compute_display_column (exploc_start); + if (hint->insertion_p ()) + finish_column = start_column - 1; + else + finish_column = location_compute_display_column (exploc_finish); + } + else + { + start_column = exploc_start.column; + finish_column = exploc_finish.column; + } return column_range (start_column, finish_column); } -/* Get the range of columns that would be printed for HINT. */ +/* Get the range of display columns that would be printed for HINT. */ static column_range get_printed_columns (const fixit_hint *hint) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int final_hint_column = start_column + hint->get_length () - 1; + expanded_location exploc = expand_location (hint->get_start_loc ()); + int start_column = location_compute_display_column (exploc); + int hint_width = cpp_display_width (hint->get_string (), + hint->get_length ()); + int final_hint_column = start_column + hint_width - 1; if (hint->insertion_p ()) { return column_range (start_column, final_hint_column); } else { - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; - + exploc = expand_location (hint->get_next_loc ()); + --exploc.column; + int finish_column = location_compute_display_column (exploc); return column_range (start_column, MAX (finish_column, final_hint_column)); } @@ -1794,27 +1939,35 @@ get_printed_columns (const fixit_hint *hint) class correction { public: - correction (column_range affected_columns, + correction (column_range affected_bytes, + column_range affected_columns, column_range printed_columns, const char *new_text, size_t new_text_len) - : m_affected_columns (affected_columns), + : m_affected_bytes (affected_bytes), + m_affected_columns (affected_columns), m_printed_columns (printed_columns), m_text (xstrdup (new_text)), - m_len (new_text_len), + m_byte_length (new_text_len), m_alloc_sz (new_text_len + 1) { + compute_display_cols (); } ~correction () { free (m_text); } bool insertion_p () const { - return m_affected_columns.start == m_affected_columns.finish + 1; + return m_affected_bytes.start == m_affected_bytes.finish + 1; } void ensure_capacity (size_t len); void ensure_terminated (); + void compute_display_cols () + { + m_display_cols = cpp_display_width (m_text, m_byte_length); + } + void overwrite (int dst_offset, const char_span &src_span) { gcc_assert (dst_offset >= 0); @@ -1827,6 +1980,7 @@ public: is to be inserted, and finish is offset by the length of the replacement. If replace, then the range of columns affected. */ + column_range m_affected_bytes; column_range m_affected_columns; /* If insert, then start: the column before which the text @@ -1837,7 +1991,8 @@ public: /* The text to be inserted/used as replacement. */ char *m_text; - size_t m_len; + size_t m_byte_length; /* Not including null-terminator. */ + int m_display_cols; size_t m_alloc_sz; }; @@ -1862,8 +2017,8 @@ void correction::ensure_terminated () { /* 0-terminate the buffer. */ - gcc_assert (m_len < m_alloc_sz); - m_text[m_len] = '\0'; + gcc_assert (m_byte_length < m_alloc_sz); + m_text[m_byte_length] = '\0'; } /* A list of corrections affecting a particular line. @@ -1925,7 +2080,8 @@ source_line::source_line (const char *filename, int line) void line_corrections::add_hint (const fixit_hint *hint) { - column_range affected_columns = get_affected_columns (hint); + column_range affected_bytes = get_affected_range (hint, CU_BYTES); + column_range affected_columns = get_affected_range (hint, CU_DISPLAY_COLS); column_range printed_columns = get_printed_columns (hint); /* Potentially consolidate. */ @@ -1936,8 +2092,8 @@ line_corrections::add_hint (const fixit_hint *hint) /* The following consolidation code assumes that the fix-it hints have been sorted by start (done within layout's ctor). */ - gcc_assert (affected_columns.start - >= last_correction->m_affected_columns.start); + gcc_assert (affected_bytes.start + >= last_correction->m_affected_bytes.start); gcc_assert (printed_columns.start >= last_correction->m_printed_columns.start); @@ -1949,8 +2105,8 @@ line_corrections::add_hint (const fixit_hint *hint) Attempt to inject a "replace" correction from immediately after the end of the last hint to immediately before the start of the next hint. */ - column_range between (last_correction->m_affected_columns.finish + 1, - printed_columns.start - 1); + column_range between (last_correction->m_affected_bytes.finish + 1, + affected_bytes.start - 1); /* Try to read the source. */ source_line line (m_filename, m_row); @@ -1959,33 +2115,39 @@ line_corrections::add_hint (const fixit_hint *hint) /* Consolidate into the last correction: add a no-op "replace" of the "between" text, and add the text from the new hint. */ - int old_len = last_correction->m_len; - gcc_assert (old_len >= 0); - int between_len = between.finish + 1 - between.start; - gcc_assert (between_len >= 0); - int new_len = old_len + between_len + hint->get_length (); - gcc_assert (new_len >= 0); - last_correction->ensure_capacity (new_len); + int old_byte_len = last_correction->m_byte_length; + gcc_assert (old_byte_len >= 0); + int between_byte_len = between.finish + 1 - between.start; + gcc_assert (between_byte_len >= 0); + int new_byte_len + = old_byte_len + between_byte_len + hint->get_length (); + gcc_assert (new_byte_len >= 0); + last_correction->ensure_capacity (new_byte_len); last_correction->overwrite - (old_len, + (old_byte_len, line.as_span ().subspan (between.start - 1, between.finish + 1 - between.start)); - last_correction->overwrite (old_len + between_len, + last_correction->overwrite (old_byte_len + between_byte_len, char_span (hint->get_string (), hint->get_length ())); - last_correction->m_len = new_len; + last_correction->m_byte_length = new_byte_len; last_correction->ensure_terminated (); + last_correction->m_affected_bytes.finish + = affected_bytes.finish; last_correction->m_affected_columns.finish = affected_columns.finish; + int prev_display_cols = last_correction->m_display_cols; + last_correction->compute_display_cols (); last_correction->m_printed_columns.finish - += between_len + hint->get_length (); + += last_correction->m_display_cols - prev_display_cols; return; } } } /* If no consolidation happened, add a new correction instance. */ - m_corrections.safe_push (new correction (affected_columns, + m_corrections.safe_push (new correction (affected_bytes, + affected_columns, printed_columns, hint->get_string (), hint->get_length ())); @@ -2034,7 +2196,7 @@ layout::print_trailing_fixits (linenum_type row) m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } else { @@ -2046,7 +2208,7 @@ layout::print_trailing_fixits (linenum_type row) int finish_column = c->m_affected_columns.finish; if (!annotation_line_showed_range_p (row, start_column, finish_column) - || c->m_len == 0) + || c->m_byte_length == 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_delete (); @@ -2057,13 +2219,13 @@ layout::print_trailing_fixits (linenum_type row) /* Print the replacement text. REPLACE also covers removals, so only do this extra work (potentially starting a new line) if we have actual replacement text. */ - if (c->m_len > 0) + if (c->m_byte_length > 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } } } @@ -2084,12 +2246,14 @@ layout::print_newline () /* Return true if (ROW/COLUMN) is within a range of the layout. If it returns true, OUT_STATE is written to, with the range index, and whether we should draw the caret at - (ROW/COLUMN) (as opposed to an underline). */ + (ROW/COLUMN) (as opposed to an underline). COL_UNIT controls + whether all inputs and outputs are in bytes or display column units. */ bool layout::get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + enum column_unit col_unit, /* Outputs. */ point_state *out_state) { @@ -2102,7 +2266,7 @@ layout::get_state_at_point (/* Inputs. */ source colorization. */ continue; - if (range->contains_point (row, column)) + if (range->contains_point (row, column, col_unit)) { out_state->range_idx = i; @@ -2110,7 +2274,7 @@ layout::get_state_at_point (/* Inputs. */ out_state->draw_caret_p = false; if (range->m_range_display_kind == SHOW_RANGE_WITH_CARET && row == range->m_caret.m_line - && column == range->m_caret.m_column) + && column == range->m_caret.m_columns[col_unit]) out_state->draw_caret_p = true; /* Within a multiline range, don't display any underline @@ -2130,11 +2294,11 @@ layout::get_state_at_point (/* Inputs. */ /* Helper function for use by layout::print_line when printing the annotation line under the source line. - Get the column beyond the rightmost one that could contain a caret or - range marker, given that we stop rendering at trailing whitespace. + Get the display column beyond the rightmost one that could contain a caret + or range marker, given that we stop rendering at trailing whitespace. ROW is the source line within the given file. - CARET_COLUMN is the column of range 0's caret. - LAST_NON_WS_COLUMN is the last column containing a non-whitespace + CARET_COLUMN is the display column of range 0's caret. + LAST_NON_WS_COLUMN is the last display column containing a non-whitespace character of source (as determined when printing the source line). */ int @@ -2153,8 +2317,9 @@ layout::get_x_bound_for_row (linenum_type row, int caret_column, { /* On the final line within a range; ensure that we render up to the end of the range. */ - if (result <= range->m_finish.m_column) - result = range->m_finish.m_column + 1; + const int disp_col = range->m_finish.m_columns[CU_DISPLAY_COLS]; + if (result <= disp_col) + result = disp_col + 1; } else if (row < range->m_finish.m_line) { @@ -2245,7 +2410,11 @@ layout::print_line (linenum_type row) print_leading_fixits (row); print_source_line (row, line.get_buffer (), line.length (), &lbounds); if (should_print_annotation_line_p (row)) - print_annotation_line (row, lbounds); + { + if (lbounds.m_first_non_ws != INT_MAX) + lbounds.convert_to_display_cols (line); + print_annotation_line (row, lbounds); + } if (m_show_labels_p) print_any_labels (row); print_trailing_fixits (row); @@ -2965,6 +3134,551 @@ test_diagnostic_show_locus_one_liner (const line_table_case &case_) test_one_liner_labels (); } +/* Version of all one-liner tests exercising multibyte awareness. For + simplicity we stick to using two multibyte characters in the test, U+1F602 + == "\xf0\x9f\x98\x82", which uses 4 bytes and 2 display columns, and U+03C0 + == "\xcf\x80", which uses 2 bytes and 1 display column. Note: all of the + below asserts would be easier to read if we used UTF-8 directly in the + string constants, but it seems better not to demand the host compiler + support this, when it isn't otherwise necessary. Instead, whenever an + extended character appears in a string, we put a line break after it so that + all succeeding characters can appear visually at the correct display column. + + All of these work on the following 1-line source file: + + .0000000001111111111222222 display + .1234567890123456789012345 columns + "SS_foo = P_bar.SS_fieldP;\n" + .0000000111111111222222223 byte + .1356789012456789134567891 columns + + which is set up by test_diagnostic_show_locus_one_liner and calls + them. Here SS represents the two display columns for the U+1F602 emoji and + P represents the one display column for the U+03C0 pi symbol. */ + +/* Just a caret. */ + +static void +test_one_liner_simple_caret_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + rich_location richloc (line_table, caret); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n", + pp_formatted_text (dc.printer)); +} + +/* Caret and range. */ +static void +test_one_liner_caret_and_range_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + location_t start = linemap_position_for_column (line_table, 12); + location_t finish = linemap_position_for_column (line_table, 30); + location_t loc = make_location (caret, start, finish); + rich_location richloc (line_table, loc); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~~^~~~~~~~~~\n", + pp_formatted_text (dc.printer)); +} + +/* Multiple ranges and carets. */ + +static void +test_one_liner_multiple_carets_and_ranges_utf8 () +{ + test_diagnostic_context dc; + location_t foo + = make_location (linemap_position_for_column (line_table, 7), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + dc.caret_chars[0] = 'A'; + + location_t bar + = make_location (linemap_position_for_column (line_table, 16), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + dc.caret_chars[1] = 'B'; + + location_t field + = make_location (linemap_position_for_column (line_table, 26), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + dc.caret_chars[2] = 'C'; + rich_location richloc (line_table, foo); + richloc.add_range (bar, SHOW_RANGE_WITH_CARET); + richloc.add_range (field, SHOW_RANGE_WITH_CARET); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~A~ ~~~B~ ~~~~~C~~~\n", + pp_formatted_text (dc.printer)); +} + +/* Insertion fix-it hint: adding an "&" to the front of "P_bar.field". */ + +static void +test_one_liner_fixit_insert_before_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 12); + rich_location richloc (line_table, caret); + richloc.add_fixit_insert_before ("&"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " &\n", + pp_formatted_text (dc.printer)); +} + +/* Insertion fix-it hint: adding a "[0]" after "SS_foo". */ + +static void +test_one_liner_fixit_insert_after_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 1); + location_t finish = linemap_position_for_column (line_table, 8); + location_t foo = make_location (start, start, finish); + rich_location richloc (line_table, foo); + richloc.add_fixit_insert_after ("[0]"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~\n" + " [0]\n", + pp_formatted_text (dc.printer)); +} + +/* Removal fix-it hint: removal of the ".SS_fieldP". */ + +static void +test_one_liner_fixit_remove_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 18); + location_t finish = linemap_position_for_column (line_table, 30); + location_t dot = make_location (start, start, finish); + rich_location richloc (line_table, dot); + richloc.add_fixit_remove (); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~\n" + " ----------\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP". */ + +static void +test_one_liner_fixit_replace_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + location_t field = make_location (start, start, finish); + rich_location richloc (line_table, field); + richloc.add_fixit_replace ("m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + but where the caret was elsewhere. */ + +static void +test_one_liner_fixit_replace_non_equal_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + source_range range; + range.m_start = start; + range.m_finish = finish; + richloc.add_fixit_replace (range, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is not indicated in the annotation line, so + it should be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " ---------\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + where the caret was elsewhere, but where a secondary range + exactly covers "field". */ + +static void +test_one_liner_fixit_replace_equal_secondary_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + location_t field = make_location (start, start, finish); + richloc.add_range (field); + richloc.add_fixit_replace (field, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is indicated in the annotation line, + so it shouldn't be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^ ~~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Verify that we can use ad-hoc locations when adding fixits to a + rich_location. */ + +static void +test_one_liner_fixit_validation_adhoc_locations_utf8 () +{ + /* Generate a range that's too long to be packed, so must + be stored as an ad-hoc location (given the defaults + of 5 bits or 0 bits of packed range); 41 columns > 2**5. */ + const location_t c12 = linemap_position_for_column (line_table, 12); + const location_t c52 = linemap_position_for_column (line_table, 52); + const location_t loc = make_location (c12, c12, c52); + + if (c52 > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_TRUE (IS_ADHOC_LOC (loc)); + + /* Insert. */ + { + rich_location richloc (line_table, loc); + richloc.add_fixit_insert_before (loc, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } + + /* Remove. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_remove (range); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " -------------------------------------\n", + pp_formatted_text (dc.printer)); + } + + /* Replace. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_replace (range, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } +} + +/* Test of consolidating insertions at the same location. */ + +static void +test_one_liner_many_fixits_1_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + for (int i = 0; i < 19; i++) + richloc.add_fixit_insert_before (i & 1 ? "@" : "\xcf\x80"); + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@" + "\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Ensure that we can add an arbitrary number of fix-it hints to a + rich_location, even if they are not consolidated. */ + +static void +test_one_liner_many_fixits_2_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + const int nlocs = 19; + int locs[nlocs] = {1, 5, 7, 9, 11, 14, 16, 18, 23, 25, 27, 29, 32, + 34, 36, 38, 40, 42, 44}; + for (int i = 0; i != nlocs; ++i) + { + location_t loc = linemap_position_for_column (line_table, locs[i]); + richloc.add_fixit_insert_before (loc, i & 1 ? "@" : "\xcf\x80"); + } + + ASSERT_EQ (nlocs, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Test of labeling the ranges within a rich_location. */ + +static void +test_one_liner_labels_utf8 () +{ + location_t foo + = make_location (linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + location_t bar + = make_location (linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + location_t field + = make_location (linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + + /* Example where all the labels fit on one line. */ + { + /* These three labels contain multibyte characters such that their byte + lengths are respectively (12, 10, 18), but their display widths are only + (6, 5, 9). All three fit on the line when considering the display + widths, but not when considering the byte widths, so verify that we do + indeed put them all on one line. */ + text_range_label label0 + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); + text_range_label label1 + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label2 + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + "\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + { + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " \xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80" + " \xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + " \xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82" + "\xf0\x9f\x98\x82\xcf\x80\xcf\x80\n", + pp_formatted_text (dc.printer)); + } + + } + + /* Example where the labels need extra lines. */ + { + text_range_label label0 ("label 0\xf0\x9f\x98\x82"); + text_range_label label1 ("label 1\xcf\x80"); + text_range_label label2 ("label 2\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | label 2\xcf\x80\n" + " | label 1\xcf\x80\n" + " label 0\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } + + /* Example of boundary conditions: label 0 and 1 have just enough clearance, + but label 1 just touches label 2. */ + { + text_range_label label0 ("aaaaa\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label1 ("bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82"); + text_range_label label2 ("c"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | c\n" + " aaaaa\xf0\x9f\x98\x82\xcf\x80" + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } +} + +/* Run the various one-liner tests. */ + +static void +test_diagnostic_show_locus_one_liner_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + const char *content + /* Display columns. + 0000000000000000000000011111111111111111111111111111112222222222222 + 1111111122222222345678900000000123456666666677777777890123444444445 */ + = "\xf0\x9f\x98\x82_foo = \xcf\x80_bar.\xf0\x9f\x98\x82_field\xcf\x80;\n"; + /* 0000000000000000000001111111111111111111222222222222222222222233333 + 1111222233334444567890122223333456789999000011112222345678999900001 + Byte columns. */ + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1); + + location_t line_end = linemap_position_for_column (line_table, 31); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end)); + ASSERT_EQ (1, LOCATION_LINE (line_end)); + ASSERT_EQ (31, LOCATION_COLUMN (line_end)); + + char_span lspan = location_get_source_line (tmp.get_filename (), 1); + ASSERT_EQ (25, cpp_display_width (lspan.get_buffer (), lspan.length ())); + ASSERT_EQ (25, location_compute_display_column (expand_location (line_end))); + + test_one_liner_simple_caret_utf8 (); + test_one_liner_caret_and_range_utf8 (); + test_one_liner_multiple_carets_and_ranges_utf8 (); + test_one_liner_fixit_insert_before_utf8 (); + test_one_liner_fixit_insert_after_utf8 (); + test_one_liner_fixit_remove_utf8 (); + test_one_liner_fixit_replace_utf8 (); + test_one_liner_fixit_replace_non_equal_range_utf8 (); + test_one_liner_fixit_replace_equal_secondary_range_utf8 (); + test_one_liner_fixit_validation_adhoc_locations_utf8 (); + test_one_liner_many_fixits_1_utf8 (); + test_one_liner_many_fixits_2_utf8 (); + test_one_liner_labels_utf8 (); +} + /* Verify that gcc_rich_location::add_location_if_nearby works. */ static void @@ -3340,13 +4054,19 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* Unit-test the line_corrections machinery. */ ASSERT_EQ (3, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (12, 12), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, CU_BYTES)); + ASSERT_EQ (column_range (12, 12), + get_affected_range (hint_0, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (18, 18), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, CU_BYTES)); + ASSERT_EQ (column_range (18, 18), + get_affected_range (hint_1, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); const fixit_hint *hint_2 = richloc.get_fixit_hint (2); - ASSERT_EQ (column_range (29, 28), get_affected_columns (hint_2)); + ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, CU_BYTES)); + ASSERT_EQ (column_range (29, 28), + get_affected_range (hint_2, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (29, 29), get_printed_columns (hint_2)); /* Add each hint in turn to a line_corrections instance, @@ -3357,6 +4077,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* The first replace hint by itself. */ lc.add_hint (hint_0); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); @@ -3366,6 +4087,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) lc.add_hint (hint_1); ASSERT_EQ (1, lc.m_corrections.length ()); ASSERT_STREQ ("const_cast<foo *> (", lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); @@ -3375,6 +4097,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) ASSERT_STREQ ("const_cast<foo *> (ptr->field)", lc.m_corrections[0]->m_text); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 41), lc.m_corrections[0]->m_printed_columns); } @@ -3477,6 +4200,246 @@ test_overlapped_fixit_printing (const line_table_case &case_) } } +/* Multibyte-aware version of preceding tests. See comments above + test_one_liner_simple_caret_utf8() too, we use the same two multibyte + characters here. */ + +static void +test_overlapped_fixit_printing_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + + const char *content + /* Display columns. + 00000000000000000000000111111111111111111111111222222222222222223 + 12344444444555555556789012344444444555555556789012345678999999990 */ + = " f\xf0\x9f\x98\x82 *f = (f\xf0\x9f\x98\x82 *)ptr->field\xcf\x80;\n"; + /* 00000000000000000000011111111111111111111112222222222333333333333 + 12344445555666677778901234566667777888899990123456789012333344445 + Byte columns. */ + + temp_source_file tmp (SELFTEST_LOCATION, ".C", content); + line_table_test ltt (case_); + + const line_map_ordinary *ord_map + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, + tmp.get_filename (), 0)); + + linemap_line_start (line_table, 1, 100); + + const location_t final_line_end + = linemap_position_for_line_and_column (line_table, ord_map, 6, 50); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + /* A test for converting a C-style cast to a C++-style cast. */ + const location_t open_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 14); + const location_t close_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 22); + const location_t expr_start + = linemap_position_for_line_and_column (line_table, ord_map, 1, 23); + const location_t expr_finish + = linemap_position_for_line_and_column (line_table, ord_map, 1, 34); + const location_t expr = make_location (expr_start, expr_start, expr_finish); + + /* Various examples of fix-it hints that aren't themselves consolidated, + but for which the *printing* may need consolidation. */ + + /* Example where 3 fix-it hints are printed as one. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "const_cast<"); + richloc.add_fixit_replace (close_paren, "> ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " const_cast<f\xf0\x9f\x98\x82" + " *> (ptr->field\xcf\x80" + ")\n", + pp_formatted_text (dc.printer)); + + /* Unit-test the line_corrections machinery. */ + ASSERT_EQ (3, richloc.get_num_fixit_hints ()); + const fixit_hint *hint_0 = richloc.get_fixit_hint (0); + ASSERT_EQ (column_range (14, 14), get_affected_range (hint_0, CU_BYTES)); + ASSERT_EQ (column_range (12, 12), + get_affected_range (hint_0, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); + const fixit_hint *hint_1 = richloc.get_fixit_hint (1); + ASSERT_EQ (column_range (22, 22), get_affected_range (hint_1, CU_BYTES)); + ASSERT_EQ (column_range (18, 18), + get_affected_range (hint_1, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); + const fixit_hint *hint_2 = richloc.get_fixit_hint (2); + ASSERT_EQ (column_range (35, 34), get_affected_range (hint_2, CU_BYTES)); + ASSERT_EQ (column_range (30, 29), + get_affected_range (hint_2, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (30, 30), get_printed_columns (hint_2)); + + /* Add each hint in turn to a line_corrections instance, + and verify that they are consolidated into one correction instance + as expected. */ + line_corrections lc (tmp.get_filename (), 1); + + /* The first replace hint by itself. */ + lc.add_hint (hint_0); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 14), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); + ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); + + /* After the second replacement hint, they are printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_1); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (", + lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (14, 22), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); + + /* After the final insertion hint, they are all printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_2); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (ptr->field\xcf\x80)", + lc.m_corrections[0]->m_text); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 34), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 29), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 42), lc.m_corrections[0]->m_printed_columns); + } + + /* Example where two are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CAST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CAST (-\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example where none are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CST ( -\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(bar\xf0\x9f\x98\x82 *)"); + source_range victim = {open_paren, close_paren}; + richloc.add_fixit_remove (victim); + + /* This case is actually handled by fixit-consolidation, + rather than by line_corrections. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " (bar\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(long\xf0\x9f\x98\x82 *)"); + source_range victim = {expr_start, expr_finish}; + richloc.add_fixit_remove (victim); + + /* These fixits are not consolidated. */ + ASSERT_EQ (2, richloc.get_num_fixit_hints ()); + + /* But the corrections are. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " (long\xf0\x9f\x98\x82" + " *)(f\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of insertion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before + (open_paren, "L\xf0\x9f\x98\x82NGER THAN THE CAST"); + richloc.add_fixit_insert_after (close_paren, "TEST"); + + /* The first insertion is long enough that if printed naively, + it would overlap with the second. + Verify that they are printed as a single replacement. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " L\xf0\x9f\x98\x82" + "NGER THAN THE CAST(f\xf0\x9f\x98\x82" + " *)TEST\n", + pp_formatted_text (dc.printer)); + } +} + /* Verify that the line_corrections machinery correctly prints overlapping fixit-hints that have been added in the wrong order. @@ -3526,10 +4489,10 @@ test_overlapped_fixit_printing_2 (const line_table_case &case_) /* These fixits should be accepted; they can't be consolidated. */ ASSERT_EQ (2, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (23, 22), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (23, 22), get_affected_range (hint_0, CU_BYTES)); ASSERT_EQ (column_range (23, 23), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (21, 20), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (21, 20), get_affected_range (hint_1, CU_BYTES)); ASSERT_EQ (column_range (21, 21), get_printed_columns (hint_1)); /* Verify that they're printed correctly. */ @@ -3856,10 +4819,12 @@ diagnostic_show_locus_c_tests () test_diagnostic_show_locus_unknown_location (); for_each_line_table_case (test_diagnostic_show_locus_one_liner); + for_each_line_table_case (test_diagnostic_show_locus_one_liner_utf8); for_each_line_table_case (test_add_location_if_nearby); for_each_line_table_case (test_diagnostic_show_locus_fixit_lines); for_each_line_table_case (test_fixit_consolidation); for_each_line_table_case (test_overlapped_fixit_printing); + for_each_line_table_case (test_overlapped_fixit_printing_utf8); for_each_line_table_case (test_overlapped_fixit_printing_2); for_each_line_table_case (test_fixit_insert_containing_newline); for_each_line_table_case (test_fixit_insert_containing_newline_2); diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c index a29bcf155e2..79f18d18380 100644 --- a/gcc/diagnostic.c +++ b/gcc/diagnostic.c @@ -360,9 +360,13 @@ diagnostic_get_location_text (diagnostic_context *context, const char *locus_cs = colorize_start (pp_show_color (pp), "locus"); const char *locus_ce = colorize_stop (pp_show_color (pp)); const char *file = s.file ? s.file : progname; - int line = strcmp (file, N_("<built-in>")) ? s.line : 0; - int col = context->show_column ? s.column : 0; - + int line = 0; + int col = 0; + if (strcmp (file, N_("<built-in>"))) + { + line = s.line; + col = context->show_column ? location_compute_display_column (s) : 0; + } const char *line_col = maybe_line_and_column (line, col); return build_message_string ("%s%s%s:%s", locus_cs, file, line_col, locus_ce); diff --git a/gcc/input.c b/gcc/input.c index 00301ef68dd..22141250d60 100644 --- a/gcc/input.c +++ b/gcc/input.c @@ -908,6 +908,22 @@ make_location (location_t caret, source_range src_range) return COMBINE_LOCATION_DATA (line_table, pure_loc, src_range, NULL); } +/* An expanded_location stores the column in byte units. This function + converts that column to display units. That requires reading the associated + source line in order to calculate the display width. If that cannot be done + for any reason, then returns the byte column as a fallback. */ +int +location_compute_display_column (expanded_location exploc) +{ + if (!(exploc.file && *exploc.file && exploc.line && exploc.column)) + return exploc.column; + char_span line = location_get_source_line (exploc.file, exploc.line); + /* If line is NULL, this function returns exploc.column which is the + desired fallback. */ + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), + exploc.column); +} + /* Dump statistics to stderr about the memory usage of the line_table set of line maps. This also displays some statistics about macro expansion. */ @@ -3590,6 +3606,90 @@ test_line_offset_overflow () ASSERT_NE (ordmap_a, ordmap_b); } +void test_cpp_utf8 () +{ + /* Verify that wcwidth of invalid UTF-8 or control bytes is 1. */ + { + int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8); + ASSERT_EQ (8, w_bad); + int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6); + ASSERT_EQ (6, w_ctrl); + } + + /* Verify that wcwidth of valid UTF-8 is as expected. */ + { + const int w_pi = cpp_display_width ("\xcf\x80", 2); + ASSERT_EQ (1, w_pi); + const int w_emoji = cpp_display_width ("\xf0\x9f\x98\x82", 4); + ASSERT_EQ (2, w_emoji); + const int w_umlaut_precomposed = cpp_display_width ("\xc3\xbf", 2); + ASSERT_EQ (1, w_umlaut_precomposed); + const int w_umlaut_combining = cpp_display_width ("y\xcc\x88", 3); + ASSERT_EQ (1, w_umlaut_combining); + const int w_han = cpp_display_width ("\xe4\xb8\xba", 3); + ASSERT_EQ (2, w_han); + const int w_ascii = cpp_display_width ("GCC", 3); + ASSERT_EQ (3, w_ascii); + const int w_mixed = cpp_display_width ("\xcf\x80 = 3.14 \xf0\x9f\x98\x82" + "\x9f! \xe4\xb8\xba y\xcc\x88", 24); + ASSERT_EQ (18, w_mixed); + } + + /* Verify that cpp_byte_column_to_display_column can go past the end, + and similar edge cases. */ + { + const char *str + /* Display columns. + 111111112345 */ + = "\xcf\x80 abc"; + /* 111122223456 + Byte columns. */ + + ASSERT_EQ (5, cpp_display_width (str, 6)); + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); + } + + /* Verify that cpp_display_column_to_byte_column can go past the end, + and similar edge cases, and check invertibility. */ + { + const char *str + /* Display columns. + 000000000000000000000000000000000000011 + 111111112222222234444444455555555678901 */ + = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; + /* 000000000000000000000000000000000111111 + 111122223333444456666777788889999012345 + Byte columns. */ + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); + + for (int byte_col = 1; byte_col <= 15; ++byte_col) + { + const int disp_col = cpp_byte_column_to_display_column (str, 15, + byte_col); + const int byte_col2 = cpp_display_column_to_byte_column (str, 15, + disp_col); + + /* If we ask for the display column in the middle of a UTF-8 + sequence, it will return the length of the partial sequence, + matching the behavior of GCC before display column support. + Otherwise check the round trip was successful. */ + if (byte_col < 4) + ASSERT_EQ (byte_col, disp_col); + else if (byte_col >= 6 && byte_col < 9) + ASSERT_EQ (3 + (byte_col - 5), disp_col); + else + ASSERT_EQ (byte_col2, byte_col); + } + } + +} + /* Run all of the selftests within this file. */ void @@ -3631,6 +3731,8 @@ input_c_tests () test_reading_source_line (); test_line_offset_overflow (); + + test_cpp_utf8 (); } } // namespace selftest diff --git a/gcc/input.h b/gcc/input.h index c459bf28553..35e02bd91d5 100644 --- a/gcc/input.h +++ b/gcc/input.h @@ -38,6 +38,7 @@ STATIC_ASSERT (BUILTINS_LOCATION < RESERVED_LOCATION_COUNT); extern bool is_location_from_builtin_token (location_t); extern expanded_location expand_location (location_t); +extern int location_compute_display_column (expanded_location); /* A class capturing the bounds of a buffer, to allow for run-time bounds-checking in a checked build. */ diff --git a/libcpp/charset.c b/libcpp/charset.c index d4574415ac1..8c1a16e6b0a 100644 --- a/libcpp/charset.c +++ b/libcpp/charset.c @@ -2265,3 +2265,106 @@ cpp_string_location_reader::get_next () m_loc += m_offset_per_column; return result; } + +/* Helper for cpp_byte_column_to_display_column and its inverse. Given a + pointer to a UTF-8-encoded character, compute its display width. *INBUFP + points on entry to the start of the UTF-8 encoding of the character, and + is updated to point just after the last byte of the encoding. *INBYTESLEFTP + contains on entry the remaining size of the buffer into which *INBUFP + points, and this is also updated accordingly. If *INBUFP does not + point to a valid UTF-8-encoded sequence, then it will be treated as a single + byte with display width 1. */ + +static inline int +compute_next_display_width (const uchar **inbufp, size_t *inbytesleftp) +{ + cppchar_t c; + if (one_utf8_to_cppchar (inbufp, inbytesleftp, &c) != 0) + { + /* Input is not convertible to UTF-8. This could be fine, e.g. in a + string literal, so don't complain. Just treat it as if it has a width + of one. */ + ++*inbufp; + --*inbytesleftp; + return 1; + } + + /* one_utf8_to_cppchar() has updated inbufp and inbytesleftp for us. */ + return cpp_wcwidth (c); +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + how many display columns are occupied by the first COLUMN bytes. COLUMN + may exceed DATA_LENGTH, in which case the phantom bytes at the end are + treated as if they have display width 1. */ + +int +cpp_byte_column_to_display_column (const char *data, int data_length, + int column) +{ + int display_col = 0; + const uchar *udata = (const uchar *) data; + const int offset = MAX (0, column - data_length); + size_t inbytesleft = column - offset; + while (inbytesleft) + display_col += compute_next_display_width (&udata, &inbytesleft); + return display_col + offset; +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + the least number of bytes that will result in at least DISPLAY_COL display + columns. The return value may exceed DATA_LENGTH if the entire string does + not occupy enough display columns. */ + +int +cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col) +{ + int column = 0; + const uchar *udata = (const uchar *) data; + size_t inbytesleft = data_length; + while (column < display_col && inbytesleft) + column += compute_next_display_width (&udata, &inbytesleft); + return data_length - inbytesleft + (display_col - column); +} + +/* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc, + because that will inspect the user's locale, and in particular in an ASCII + locale, it will not return anything useful for extended characters. But GCC + in other respects (see e.g. _cpp_default_encoding()) behaves as if + everything is UTF-8. We also make some tweaks that are useful for the way + GCC needs to use this data, e.g. tabs and other control characters should be + treated as having width 1. The lookup tables are generated from + contrib/unicode/gen_wcwidth.py and were made by simply calling glibc + wcwidth() on all codepoints, then applying the small tweaks. These tables + are not highly optimized, but for the present purpose of outputting + diagnostics, they are sufficient. */ + +#include "generated_cpp_wcwidth.h" +int cpp_wcwidth (cppchar_t c) +{ + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) + return wcwidth_widths[0]; + + /* Binary search the tables. */ + int begin = 1; + static const int end + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); + int len = end - begin; + do + { + int half = len/2; + int middle = begin + half; + if (c > wcwidth_range_ends[middle]) + { + begin = middle + 1; + len -= half + 1; + } + else + len = half; + } while (len); + + if (__builtin_expect (begin != end, true)) + return wcwidth_widths[begin]; + return 1; +} diff --git a/libcpp/generated_cpp_wcwidth.h b/libcpp/generated_cpp_wcwidth.h new file mode 100644 index 00000000000..ec8b73d3d01 --- /dev/null +++ b/libcpp/generated_cpp_wcwidth.h @@ -0,0 +1,156 @@ +/* Generated by contrib/unicode/gen_wcwidth.py, with the help of glibc's + utf8_gen.py, using version 12.1.0 of the Unicode standard. */ + +static const cppchar_t wcwidth_range_ends[] = { + 0x2ff, 0x36f, 0x482, 0x489, 0x590, 0x5bd, 0x5be, 0x5bf, + 0x5c0, 0x5c2, 0x5c3, 0x5c5, 0x5c6, 0x5c7, 0x60f, 0x61a, + 0x61b, 0x61c, 0x64a, 0x65f, 0x66f, 0x670, 0x6d5, 0x6dc, + 0x6de, 0x6e4, 0x6e6, 0x6e8, 0x6e9, 0x6ed, 0x710, 0x711, + 0x72f, 0x74a, 0x7a5, 0x7b0, 0x7ea, 0x7f3, 0x7fc, 0x7fd, + 0x815, 0x819, 0x81a, 0x823, 0x824, 0x827, 0x828, 0x82d, + 0x858, 0x85b, 0x8d2, 0x8e1, 0x8e2, 0x902, 0x939, 0x93a, + 0x93b, 0x93c, 0x940, 0x948, 0x94c, 0x94d, 0x950, 0x957, + 0x961, 0x963, 0x980, 0x981, 0x9bb, 0x9bc, 0x9c0, 0x9c4, + 0x9cc, 0x9cd, 0x9e1, 0x9e3, 0x9fd, 0x9fe, 0xa00, 0xa02, + 0xa3b, 0xa3c, 0xa40, 0xa42, 0xa46, 0xa48, 0xa4a, 0xa4d, + 0xa50, 0xa51, 0xa6f, 0xa71, 0xa74, 0xa75, 0xa80, 0xa82, + 0xabb, 0xabc, 0xac0, 0xac5, 0xac6, 0xac8, 0xacc, 0xacd, + 0xae1, 0xae3, 0xaf9, 0xaff, 0xb00, 0xb01, 0xb3b, 0xb3c, + 0xb3e, 0xb3f, 0xb40, 0xb44, 0xb4c, 0xb4d, 0xb55, 0xb56, + 0xb61, 0xb63, 0xb81, 0xb82, 0xbbf, 0xbc0, 0xbcc, 0xbcd, + 0xbff, 0xc00, 0xc03, 0xc04, 0xc3d, 0xc40, 0xc45, 0xc48, + 0xc49, 0xc4d, 0xc54, 0xc56, 0xc61, 0xc63, 0xc80, 0xc81, + 0xcbb, 0xcbc, 0xcbe, 0xcbf, 0xcc5, 0xcc6, 0xccb, 0xccd, + 0xce1, 0xce3, 0xcff, 0xd01, 0xd3a, 0xd3c, 0xd40, 0xd44, + 0xd4c, 0xd4d, 0xd61, 0xd63, 0xdc9, 0xdca, 0xdd1, 0xdd4, + 0xdd5, 0xdd6, 0xe30, 0xe31, 0xe33, 0xe3a, 0xe46, 0xe4e, + 0xeb0, 0xeb1, 0xeb3, 0xebc, 0xec7, 0xecd, 0xf17, 0xf19, + 0xf34, 0xf35, 0xf36, 0xf37, 0xf38, 0xf39, 0xf70, 0xf7e, + 0xf7f, 0xf84, 0xf85, 0xf87, 0xf8c, 0xf97, 0xf98, 0xfbc, + 0xfc5, 0xfc6, 0x102c, 0x1030, 0x1031, 0x1037, 0x1038, 0x103a, + 0x103c, 0x103e, 0x1057, 0x1059, 0x105d, 0x1060, 0x1070, 0x1074, + 0x1081, 0x1082, 0x1084, 0x1086, 0x108c, 0x108d, 0x109c, 0x109d, + 0x10ff, 0x115f, 0x11ff, 0x135c, 0x135f, 0x1711, 0x1714, 0x1731, + 0x1734, 0x1751, 0x1753, 0x1771, 0x1773, 0x17b3, 0x17b5, 0x17b6, + 0x17bd, 0x17c5, 0x17c6, 0x17c8, 0x17d3, 0x17dc, 0x17dd, 0x180a, + 0x180e, 0x1884, 0x1886, 0x18a8, 0x18a9, 0x191f, 0x1922, 0x1926, + 0x1928, 0x1931, 0x1932, 0x1938, 0x193b, 0x1a16, 0x1a18, 0x1a1a, + 0x1a1b, 0x1a55, 0x1a56, 0x1a57, 0x1a5e, 0x1a5f, 0x1a60, 0x1a61, + 0x1a62, 0x1a64, 0x1a6c, 0x1a72, 0x1a7c, 0x1a7e, 0x1a7f, 0x1aaf, + 0x1abe, 0x1aff, 0x1b03, 0x1b33, 0x1b34, 0x1b35, 0x1b3a, 0x1b3b, + 0x1b3c, 0x1b41, 0x1b42, 0x1b6a, 0x1b73, 0x1b7f, 0x1b81, 0x1ba1, + 0x1ba5, 0x1ba7, 0x1ba9, 0x1baa, 0x1bad, 0x1be5, 0x1be6, 0x1be7, + 0x1be9, 0x1bec, 0x1bed, 0x1bee, 0x1bf1, 0x1c2b, 0x1c33, 0x1c35, + 0x1c37, 0x1ccf, 0x1cd2, 0x1cd3, 0x1ce0, 0x1ce1, 0x1ce8, 0x1cec, + 0x1ced, 0x1cf3, 0x1cf4, 0x1cf7, 0x1cf9, 0x1dbf, 0x1df9, 0x1dfa, + 0x1dff, 0x200a, 0x200f, 0x2029, 0x202e, 0x205f, 0x2064, 0x2065, + 0x206f, 0x20cf, 0x20f0, 0x2319, 0x231b, 0x2328, 0x232a, 0x23e8, + 0x23ec, 0x23ef, 0x23f0, 0x23f2, 0x23f3, 0x25fc, 0x25fe, 0x2613, + 0x2615, 0x2647, 0x2653, 0x267e, 0x267f, 0x2692, 0x2693, 0x26a0, + 0x26a1, 0x26a9, 0x26ab, 0x26bc, 0x26be, 0x26c3, 0x26c5, 0x26cd, + 0x26ce, 0x26d3, 0x26d4, 0x26e9, 0x26ea, 0x26f1, 0x26f3, 0x26f4, + 0x26f5, 0x26f9, 0x26fa, 0x26fc, 0x26fd, 0x2704, 0x2705, 0x2709, + 0x270b, 0x2727, 0x2728, 0x274b, 0x274c, 0x274d, 0x274e, 0x2752, + 0x2755, 0x2756, 0x2757, 0x2794, 0x2797, 0x27af, 0x27b0, 0x27be, + 0x27bf, 0x2b1a, 0x2b1c, 0x2b4f, 0x2b50, 0x2b54, 0x2b55, 0x2cee, + 0x2cf1, 0x2d7e, 0x2d7f, 0x2ddf, 0x2dff, 0x2e7f, 0x2e99, 0x2e9a, + 0x2ef3, 0x2eff, 0x2fd5, 0x2fef, 0x2ffb, 0x2fff, 0x3029, 0x302d, + 0x303e, 0x3040, 0x3096, 0x3098, 0x309a, 0x30ff, 0x3104, 0x312f, + 0x3130, 0x318e, 0x318f, 0x31ba, 0x31bf, 0x31e3, 0x31ef, 0x321e, + 0x321f, 0x4db5, 0x4dbf, 0x9fef, 0x9fff, 0xa48c, 0xa48f, 0xa4c6, + 0xa66e, 0xa672, 0xa673, 0xa67d, 0xa69d, 0xa69f, 0xa6ef, 0xa6f1, + 0xa801, 0xa802, 0xa805, 0xa806, 0xa80a, 0xa80b, 0xa824, 0xa826, + 0xa8c3, 0xa8c5, 0xa8df, 0xa8f1, 0xa8fe, 0xa8ff, 0xa925, 0xa92d, + 0xa946, 0xa951, 0xa95f, 0xa97c, 0xa97f, 0xa982, 0xa9b2, 0xa9b3, + 0xa9b5, 0xa9b9, 0xa9bb, 0xa9bd, 0xa9e4, 0xa9e5, 0xaa28, 0xaa2e, + 0xaa30, 0xaa32, 0xaa34, 0xaa36, 0xaa42, 0xaa43, 0xaa4b, 0xaa4c, + 0xaa7b, 0xaa7c, 0xaaaf, 0xaab0, 0xaab1, 0xaab4, 0xaab6, 0xaab8, + 0xaabd, 0xaabf, 0xaac0, 0xaac1, 0xaaeb, 0xaaed, 0xaaf5, 0xaaf6, + 0xabe4, 0xabe5, 0xabe7, 0xabe8, 0xabec, 0xabed, 0xabff, 0xd7a3, + 0xf8ff, 0xfa6d, 0xfa6f, 0xfad9, 0xfb1d, 0xfb1e, 0xfdff, 0xfe0f, + 0xfe19, 0xfe1f, 0xfe2f, 0xfe52, 0xfe53, 0xfe66, 0xfe67, 0xfe6b, + 0xfefe, 0xfeff, 0xff00, 0xff60, 0xffdf, 0xffe6, 0xfff8, 0xfffb, + 0x101fc, 0x101fd, 0x102df, 0x102e0, 0x10375, 0x1037a, 0x10a00, 0x10a03, + 0x10a04, 0x10a06, 0x10a0b, 0x10a0f, 0x10a37, 0x10a3a, 0x10a3e, 0x10a3f, + 0x10ae4, 0x10ae6, 0x10d23, 0x10d27, 0x10f45, 0x10f50, 0x11000, 0x11001, + 0x11037, 0x11046, 0x1107e, 0x11081, 0x110b2, 0x110b6, 0x110b8, 0x110ba, + 0x110ff, 0x11102, 0x11126, 0x1112b, 0x1112c, 0x11134, 0x11172, 0x11173, + 0x1117f, 0x11181, 0x111b5, 0x111be, 0x111c8, 0x111cc, 0x1122e, 0x11231, + 0x11233, 0x11234, 0x11235, 0x11237, 0x1123d, 0x1123e, 0x112de, 0x112df, + 0x112e2, 0x112ea, 0x112ff, 0x11301, 0x1133a, 0x1133c, 0x1133f, 0x11340, + 0x11365, 0x1136c, 0x1136f, 0x11374, 0x11437, 0x1143f, 0x11441, 0x11444, + 0x11445, 0x11446, 0x1145d, 0x1145e, 0x114b2, 0x114b8, 0x114b9, 0x114ba, + 0x114be, 0x114c0, 0x114c1, 0x114c3, 0x115b1, 0x115b5, 0x115bb, 0x115bd, + 0x115be, 0x115c0, 0x115db, 0x115dd, 0x11632, 0x1163a, 0x1163c, 0x1163d, + 0x1163e, 0x11640, 0x116aa, 0x116ab, 0x116ac, 0x116ad, 0x116af, 0x116b5, + 0x116b6, 0x116b7, 0x1171c, 0x1171f, 0x11721, 0x11725, 0x11726, 0x1172b, + 0x1182e, 0x11837, 0x11838, 0x1183a, 0x119d3, 0x119d7, 0x119d9, 0x119db, + 0x119df, 0x119e0, 0x11a00, 0x11a0a, 0x11a32, 0x11a38, 0x11a3a, 0x11a3e, + 0x11a46, 0x11a47, 0x11a50, 0x11a56, 0x11a58, 0x11a5b, 0x11a89, 0x11a96, + 0x11a97, 0x11a99, 0x11c2f, 0x11c36, 0x11c37, 0x11c3d, 0x11c3e, 0x11c3f, + 0x11c91, 0x11ca7, 0x11ca9, 0x11cb0, 0x11cb1, 0x11cb3, 0x11cb4, 0x11cb6, + 0x11d30, 0x11d36, 0x11d39, 0x11d3a, 0x11d3b, 0x11d3d, 0x11d3e, 0x11d45, + 0x11d46, 0x11d47, 0x11d8f, 0x11d91, 0x11d94, 0x11d95, 0x11d96, 0x11d97, + 0x11ef2, 0x11ef4, 0x1342f, 0x13438, 0x16aef, 0x16af4, 0x16b2f, 0x16b36, + 0x16f4e, 0x16f4f, 0x16f8e, 0x16f92, 0x16fdf, 0x16fe3, 0x16fff, 0x187f7, + 0x187ff, 0x18af2, 0x1afff, 0x1b11e, 0x1b14f, 0x1b152, 0x1b163, 0x1b167, + 0x1b16f, 0x1b2fb, 0x1bc9c, 0x1bc9e, 0x1bc9f, 0x1bca3, 0x1d166, 0x1d169, + 0x1d172, 0x1d182, 0x1d184, 0x1d18b, 0x1d1a9, 0x1d1ad, 0x1d241, 0x1d244, + 0x1d9ff, 0x1da36, 0x1da3a, 0x1da6c, 0x1da74, 0x1da75, 0x1da83, 0x1da84, + 0x1da9a, 0x1da9f, 0x1daa0, 0x1daaf, 0x1dfff, 0x1e006, 0x1e007, 0x1e018, + 0x1e01a, 0x1e021, 0x1e022, 0x1e024, 0x1e025, 0x1e02a, 0x1e12f, 0x1e136, + 0x1e2eb, 0x1e2ef, 0x1e8cf, 0x1e8d6, 0x1e943, 0x1e94a, 0x1f003, 0x1f004, + 0x1f0ce, 0x1f0cf, 0x1f18d, 0x1f18e, 0x1f190, 0x1f19a, 0x1f1ff, 0x1f202, + 0x1f20f, 0x1f23b, 0x1f23f, 0x1f248, 0x1f24f, 0x1f251, 0x1f25f, 0x1f265, + 0x1f2ff, 0x1f320, 0x1f32c, 0x1f335, 0x1f336, 0x1f37c, 0x1f37d, 0x1f393, + 0x1f39f, 0x1f3ca, 0x1f3ce, 0x1f3d3, 0x1f3df, 0x1f3f0, 0x1f3f3, 0x1f3f4, + 0x1f3f7, 0x1f43e, 0x1f43f, 0x1f440, 0x1f441, 0x1f4fc, 0x1f4fe, 0x1f53d, + 0x1f54a, 0x1f54e, 0x1f54f, 0x1f567, 0x1f579, 0x1f57a, 0x1f594, 0x1f596, + 0x1f5a3, 0x1f5a4, 0x1f5fa, 0x1f64f, 0x1f67f, 0x1f6c5, 0x1f6cb, 0x1f6cc, + 0x1f6cf, 0x1f6d2, 0x1f6d4, 0x1f6d5, 0x1f6ea, 0x1f6ec, 0x1f6f3, 0x1f6fa, + 0x1f7df, 0x1f7eb, 0x1f90c, 0x1f971, 0x1f972, 0x1f976, 0x1f979, 0x1f9a2, + 0x1f9a4, 0x1f9aa, 0x1f9ad, 0x1f9ca, 0x1f9cc, 0x1f9ff, 0x1fa6f, 0x1fa73, + 0x1fa77, 0x1fa7a, 0x1fa7f, 0x1fa82, 0x1fa8f, 0x1fa95, 0x1ffff, 0x2a6d6, + 0x2a6ff, 0x2b734, 0x2b73f, 0x2b81d, 0x2b81f, 0x2cea1, 0x2ceaf, 0x2ebe0, + 0x2f7ff, 0x2fa1d, 0xe0000, 0xe0001, 0xe001f, 0xe007f, 0xe00ff, 0xe01ef, +}; + +static const unsigned char wcwidth_widths[] = { + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 0, 2, 1, 2, 1, 0, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, + 2, 1, 0, 2, 1, 2, 1, 2, 1, 0, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, +}; diff --git a/libcpp/include/cpplib.h b/libcpp/include/cpplib.h index ed108f17bfa..e199aecfa48 100644 --- a/libcpp/include/cpplib.h +++ b/libcpp/include/cpplib.h @@ -1320,4 +1320,15 @@ extern bool cpp_userdef_char_p extern const char * cpp_get_userdef_suffix (const cpp_token *); +/* In charset.c */ +int cpp_byte_column_to_display_column (const char *data, int data_length, + int column); +inline int cpp_display_width (const char *data, int data_length) +{ + return cpp_byte_column_to_display_column (data, data_length, data_length); +} +int cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col); +int cpp_wcwidth (cppchar_t c); + #endif /* ! LIBCPP_CPPLIB_H */ ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-11-20 16:39 ` Lewis Hyatt @ 2019-11-22 3:24 ` David Malcolm 2019-11-22 11:06 ` David Malcolm 2019-11-26 17:12 ` Lewis Hyatt 0 siblings, 2 replies; 17+ messages in thread From: David Malcolm @ 2019-11-22 3:24 UTC (permalink / raw) To: Lewis Hyatt; +Cc: gcc-patches, joseph On Wed, 2019-11-20 at 11:35 -0500, Lewis Hyatt wrote: > My apologies, that patch had whitespace issues. Corrected version > attached. > > On Wed, Nov 20, 2019 at 11:27:08AM -0500, Lewis Hyatt wrote: > > On Tue, Nov 19, 2019 at 12:30:39PM -0500, David Malcolm wrote: > > > Thanks for posting this patch; I'm sorry about how long it's > > > taken me > > > to review it. > > > > > > > Thank you very much for the thorough review and the great > > suggestions. I > > know it was a lot to look through... I attached an updated patch > > that > > incorporates your comments. I also put some more responses inline > > below. > > Thanks for the updated patch. Various comments inline throughout. [...] > > > I should confess that it took me a while to realize the whole > > > multi-column display thing (I had an "aha" moment, then felt > > > rather > > > foolish, given that I'd been playing with the examples in the PR; > > > it was > > > on reading through the ASCII art in the new selftests and going > > > "huh" > > > that I had my epiphany on the problem your patch is solving). > > > > > > I think this file could use a high-level introductory comment at > > > the top > > > talking about the various meanings of "column". I liked the two > > > example > > > code points you used below, so perhaps have a comment up at the > > > top > > > talking about the distinction between byte vs display column, > > > using > > > those code points as examples (and a plain ASCII character, by > > > way of > > > contrast). Perhaps have the comment describing the enum be the > > > big > > > introductory comment. > > > > > > It would be good for that introductory comment to have a copy of > > > the > > > ASCII art you used in the selftests below, or similar. > > > > > > > Done, I beefed up the introductory comments as you suggested. Thanks. [...snip...] > > > > @@ -574,20 +621,23 @@ test_layout_range_for_single_point () > > > > > > > > /* Tests for layout_range::contains_point. */ > > > > > > > > - /* Before the line. */ > > > > - ASSERT_FALSE (point.contains_point (6, 1)); > > > > + for (int use_display = 0; use_display <= 1; ++use_display) > > > > + { > > > > + /* Before the line. */ > > > > + ASSERT_FALSE (point.contains_point (6, 1, use_display)); > > > > > > [...snip...] > > > > > > Here you generalize the layout_range tests to iterate over both > > > meanings of "column". > > > > > > If I'm reading things right, implicit here is that the > > > layout_point > > > ctors within the layout range are now calling: > > > m_display_col (location_compute_display_column (exploc)) > > > which in this selftest is looking for a file named "test.c", > > > presumably not finding it, and hitting the case of a NULL "line" > > > char_span. > > > > > > So if there happens to be a test.c in the current directory > > > containing the "right" characters, this selftest could break. > > > > > > Previously it's never mattered to this selftest whether or not > > > there was an actual test.c, so it might be good to modify it > > > to use temp_source_file (and maybe even to have some multicolumn > > > chars in it, though that might be taking things too far). > > > > > > > Assuming we're comfortable that the other selftests exercise the > > multibyte logic sufficiently, it seems simplest just to use an > > empty > > string rather than "test.c", since nothing is actually expecting to > > read a file here. Fair enough. > > I did that for now, and also made sure that > > location_get_display_column() will not try to open an empty > > filename > > either. location_compute_display_column FWIW > > > > static int > > > > get_line_width_without_trailing_whitespace (const char *line, > > > > int line_width) > > > > > > Why is get_line_width_without_trailing_whitespace done in bytes? > > > It's used for calculating the maximum number of printed columns, > > > to try > > > to cope with extra wide source lines, offsetting things to fit > > > within the width > > > of the user's terminal. > > > > > > > It's used in two places. Once in the layout::layout() constructor > > to > > compute the m_x_offset in display columns for wide lines, and then > > again in layout::print_source_line(), which handles printing > > arbitrary > > source lines, not necessarily the primary line that was inspected > > in > > the constructor. So the m_x_offset needs to be in display column > > units, that are then translated back to bytes for each different > > line > > to which it applies. For this it seemed most convenient for > > get_line_width_without_trailing_whitespace() to return the bytes > > offset, since that's what we need in layout::print_source_line() to > > find the end of the line. Ah. Thanks. I think the code would be clearer if the patch also renamed layout's m_x_offset - say to "m_x_offset_display"? [...snip...] > > > Thanks for exercising all this with selftests. > > > > > > Presumably this involved a big copy-and-paste from the existing > > > selftests. > > > > > > How did you generate the expected output for the various _utf8 > > > selftests? Was it a lot of tedious manual editing, or is there a > > > handy > > > way to do this? (I'm nervous about how much work it will be to > > > update > > > these if e.g. we want to experiment with new ways of printing > > > fix-it > > > hints) > > > > > > > I just went through the existing tests one by one and adapted them > > manually. I made them with the actual UTF-8 chars initially so that > > it > > made sense visually, and then replaced to hex escapes and aligned > > the > > lines manually at the end. Wasn't so bad this way. I don't think it > > would have been especially easy to automate because there were some > > non-mechanical adjustments made, e.g. to make sure to exercise edge > > cases like where two strings would overlap in byte units, but not > > in > > display units. I feel like it wouldn't be necessary to add UTF-8 > > duplicates of all new future tests, hopefully -- rather could just > > insure that all new test cases include a multibyte character or > > two? > > Anyway I am happy to help with that if it comes up in the future > > too. OK. [...snip...] > > > > + ASSERT_STREQ ("\n" > > > > + " \xf0\x9f\x98\x82" > > > > + "_foo = \xcf\x80" > > > > + "_bar.\xf0\x9f\x98\x82" > > > > + "_field\xcf\x80" > > > > + ";\n" > > > > + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" > > > > + " | | |\n" > > > > + " | | c\n" > > > > + " aaaaa\xf0\x9f\x98\x82\xcf\x80" > > > > + " > > > > bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", > > > > + pp_formatted_text (dc.printer)); > > > > > > It's hard to tell from the escaped expected string, but > > > presumably this > > > matches the comment about boundary conditions, right? (compared > > > with > > > the ASCII case). > > > > > > > Correct. What I found useful for testing, was just to add an extra > > character to the expected string to make the test fail. Then the > > expected output goes to stderr the way it should look with the > > actual > > extended characters, and you can verify it tests what was intended. Excellent (indeed, that's what I did when I wrote the ASCII cases). > > > > diff --git a/gcc/diagnostic.c b/gcc/diagnostic.c > > > > index 96b6fa30052..8638fbebb2d 100644 > > > > --- a/gcc/diagnostic.c > > > > +++ b/gcc/diagnostic.c > > > > @@ -346,9 +346,13 @@ diagnostic_get_location_text > > > > (diagnostic_context *context, > > > > const char *locus_cs = colorize_start (pp_show_color (pp), > > > > "locus"); > > > > const char *locus_ce = colorize_stop (pp_show_color (pp)); > > > > const char *file = s.file ? s.file : progname; > > > > - int line = strcmp (file, N_("<built-in>")) ? s.line : 0; > > > > - int col = context->show_column ? s.column : 0; > > > > - > > > > + int line = 0; > > > > + int col = 0; > > > > + if (strcmp (file, N_("<built-in>"))) > > > > + { > > > > + line = s.line; > > > > + col = context->show_column ? > > > > location_compute_display_column (s) : 0; > > > > + } > > > > > > Why does the patch use the display column here? > > > > > > Ideally it would be the count of unicode characters, but I think > > > we want > > > to preserve the current behavior of using a byte offset. > > > > > > > So that column number was actually the original motivation for the > > PR > > 49973 from several years ago. It seems to me that the discussion > > there > > concluded that the column number should be the display column > > (Joseph's comment > > https://gcc.gnu.org/bugzilla/show_bug.cgi?id=49973#c10). It makes > > sense to me that this column should match what you see in your > > editor, > > which would be the display column, but I don't know if some > > standards > > have evolved here. This is the column number as reported in the diagnostic i.e the COL_NUM when printing e.g. warning: FILENAME:LINE_NUM:COL_NUM: some message It seems to me that PR 49973 and this patch cover two separate things: (a) bytes vs display columns in diagnostic-show-locus.c (b) the "COL_NUM" mentioned above. I'd prefer to omit (b) from the patch, and have the focus of the patch be (a), to tackle (b) in a separate patch. [There's also the meaning of column numbers in the JSON output, and in the output of -fdiagnostics-parseable-fixits (which is intended to mimic clang's output format)] It's unclear to me what the reported COL_NUM should be. There are various possibilities: Units: (A) [status quo] report a count of bytes within the line (B) report a count of unicode characters (C) report a count of unicode graphemes (D) report based on the wcwidth of the characters etc Origin/baseline: (A) [status quo] use 1 for the leftmost column (B) use 0 for the leftmost column Tab-handling: (A) [status quo] don't give any kind of special status to tab characters (B) implement tab stops, somehow. For example, get_visual_column in c-family/c-indentation implements tab stops based on bytes. (so at least 4*2*2 = 16 possible meanings, ugh) See also e.g.: https://github.com/oasis-tcs/sarif-spec/issues/178 The GNU Coding Standards say Line numbers should start from 1 at the beginning of the file, and column numbers should start from 1 at the beginning of the line. (Both of these conventions are chosen for compatibility.) Calculate column numbers assuming that space and all ASCII printing characters have equal width, and assuming tab stops every 8 columns. For non-ASCII characters, Unicode character widths should be used when in a UTF-8 locale; GNU libc and GNU gnulib provide suitable wcwidth functions. (https://www.gnu.org/prep/standards/standards.html#Errors) I think if we do change the meaning of the "COL_NUM" output, we should probably add an option for it, to help with the transition (so that people can easily revert to the old behavior). Perhaps something like: -fdiagnostics-column-unit=[bytes|gnu] bytes: [status-quo]; 1-based count of bytes, not respecting tab stops gnu: as per GNU Coding Standards above and have gcc 10 default to "gnu" (or whatever we call it), so that people can override it back to "bytes". (again, I'm thinking aloud here) But please can you split that out as a separate patch? (it's arguably still in time for GCC 10, as it's from a patch was posted before the stage 1 deadline). [...] > > > Maybe a brute force test for inverse, something like: > > > > > > for (int display_column = 0; display_column < 20; > > > display_column++) > > > { > > > int byte_column = cpp_display_column_to_byte_column (str, 15, > > > display_column); > > > ASSERT_EQ (cpp_byte_column_to_display_column (str, 15, > > > byte_column), > > > display_column); > > > } > > > > > > or similar? > > > > > > What happens if you request a display column that's in the middle > > > of a > > > character? It feels like we ought to have selftest coverage for > > > that. > > > > > > > In this case the UTF-8 conversion fails so it treats each byte as a > > display width of 1, basically falling back to the existing behavior > > of > > GCC whenever things don't make sense. I added a selftest for the > > round-trip conversion as you suggested; this test needs to make an > > exception for partial codepoints, so it tests both things > > effectively. Thanks. > > > > +int cpp_wcwidth (cppchar_t c) > > > > +{ > > > > + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) > > > > + return wcwidth_widths[0]; > > > > + > > > > + /* Binary search the tables. */ > > > > + int begin = 1; > > > > + static const int end > > > > + = sizeof wcwidth_range_ends / sizeof > > > > (*wcwidth_range_ends); > > > > + int len = end - begin; > > > > + do > > > > + { > > > > + int half = len/2; > > > > + int middle = begin + half; > > > > + if (c > wcwidth_range_ends[middle]) > > > > + { > > > > + begin = middle + 1; > > > > + len -= half + 1; > > > > + } > > > > + else > > > > + len = half; > > > > + } while (len); > > > > + > > > > + if (__builtin_expect (begin != end, true)) > > > > + return wcwidth_widths[begin]; > > > > + return 1; > > > > +} > > > > > > Please can you add some unit-testing for this function in > > > selftest form to input.c > > > (i.e. testing a few specific code points). > > > > > > [...snip...] > > > > The second block of test_cpp_utf() in input.c contained tests for a > > couple codepoints already (pi, an emoji, ascii, and invalid utf8). > > I > > added a couple more specific codepoints, something from latin-1, a > > combining character, and a Chinese character. Please let me know if > > that seems good now or if there should be more. It's easy enough to > > add more. That's great, thanks. > > > Again, thanks for this patch, and sorry again for the delay in > > > reviewing it. > > > > Thanks for your time, I appreciate it! I think it would be great if > > this can get in for GCC 10, since otherwise the new support for > > UTF-8 > > identifiers would feel rather incomplete. > > > > -Lewis AIUI, it's OK for us to iterate on a patch like this that was posted before the stage 1 deadline, for a while into stage 3, at least. Working through the updated patch... > diff --git a/contrib/unicode/README b/contrib/unicode/README > new file mode 100644 > index 00000000000..fbee919647b > --- /dev/null > +++ b/contrib/unicode/README > @@ -0,0 +1,36 @@ > +This directory contains a mechanism for GCC to have its own internal > +implementation of wcwidth functionality. (cpp_wcwidth () in libcpp/charset.c). > + > +The idea is to produce the necessary lookup table > +(../../libcpp/generated_cpp_wcwidth.h) in a reproducible way, starting from the > +following files that are distributed by the Unicode Consortium: > + > +ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt > +ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt > +ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt > + > +These three files have been added to source control in this directory. Presumably the licence for these files is: https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/unicode-gen/unicode-license.txt We should include a copy of that license, like glibc does. > +In order to keep in sync with glibc's wcwidth as much as possible, it is > +desirable for the logic that processes the Unicode data to be the same as > +glibc's. To that end, we also put in this directory, in the from_glibc/ > +directory, the glibc python code that implements their logic. This code was > +copied verbatim from glibc, and it can be updated at any time from the glibc > +source code repository. Specifially from glibc's localedata/unicode-gen/, presumably? Please can the README state that. [...] > diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c > index cb920f6b9d0..3460da3cf32 100644 > --- a/gcc/diagnostic-show-locus.c > +++ b/gcc/diagnostic-show-locus.c [...] > @@ -112,18 +113,81 @@ class colorizer > const char *m_stop_color; > }; > > -/* A point within a layout_range; similar to an expanded_location, > +/* In order to handle multibyte sources properly, all of this logic needs to be > + aware of the distinction between the number of bytes and the number of > + display columns occupied by a character, which are not the same for non-ASCII > + characters. For example, the Unicode pi symbol, U+03C0, is encoded in UTF-8 > + as "\xcf\x80", and thus occupies 2 bytes of space while only occupying 1 > + display column when it is output. A typical emoji, such as U+1F602 (in > + UTF-8, "\xf0\x9f\x98\x82"), requires 4 bytes and has a display width of 2. > + > + The below example line, which is also used for selftests below, shows how the > + display column and byte column are related: I don't love the term "byte column" here, but it's probably the least bad name to describe the status quo concept. > + > + 0000000001111111111222222 display > + 1234567890123456789012345 columns > + SS_foo = P_bar.SS_fieldP; > + 0000000111111111222222223 byte > + 1356789012456789134567891 columns > + > + Here SS represents the two display columns for the U+1F602 emoji, and P > + represents the one display column for the U+03C0 pi symbol. As an example, a > + diagnostic pointing to the final P on this line is at byte column 29 and > + display column 24. This reflects the fact that the three extended characters > + before the final P occupy cumulatively 5 more bytes than they do display > + columns (a difference of 2 for each of the two SSs, and one for the other P). > + > + One or the other of the two column units is more useful depending on the > + context. For instance, in order to output the caret at the correct location, > + we need to count display columns; in order to colorize a source line, we need > + to count the bytes. All locations are provided to us as byte counts, which > + we augment with the display column on demand so that it can be used when > + needed. This is not the most efficient way to do things since it requires > + looping over the whole line each time, but it should be fine for the purpose > + of outputting diagnostics. > + > + In order to keep straight which units (byte or display) are in use at a > + given time, the following enum lets us specify that explicitly. */ > + > +enum column_unit { > + /* Measured in raw bytes. */ > + CU_BYTES = 0, > + > + /* Measured in display units. */ > + CU_DISPLAY_COLS, > + > + /* For arrays indexed by column_unit. */ > + CU_NUM_UNITS > +}; [...snip...] > @@ -554,9 +636,9 @@ static layout_range > make_range (int start_line, int start_col, int end_line, int end_col) > { > const expanded_location start_exploc > - = {"test.c", start_line, start_col, NULL, false}; > + = {"", start_line, start_col, NULL, false}; > const expanded_location finish_exploc > - = {"test.c", end_line, end_col, NULL, false}; > + = {"", end_line, end_col, NULL, false}; > return layout_range (&start_exploc, &finish_exploc, SHOW_RANGE_WITHOUT_CARET, > &start_exploc, 0, NULL); > } Please can you add a comment explaining the significance of the empty string here (summarizing the discussion above, so it's in the source rather than just in this list archive). > @@ -687,8 +784,8 @@ test_layout_range_for_multiple_lines () > > #endif /* #if CHECKING_P */ > > -/* Given a source line LINE of length LINE_WIDTH, determine the width > - without any trailing whitespace. */ > +/* Given a source line LINE of length LINE_WIDTH bytes, determine the width > + (in bytes, not display cols) without any trailing whitespace. */ > > static int > get_line_width_without_trailing_whitespace (const char *line, int line_width) We really should rename that "line_width" param to "line_width_bytes" or similar. > @@ -897,17 +994,35 @@ layout::layout (diagnostic_context * context, > will be adjusted accordingly. */ > size_t max_width = m_context->caret_max_width; > char_span line = location_get_source_line (m_exploc.file, m_exploc.line); > - if (line && (size_t)m_exploc.column <= line.length ()) > + if (line && max_width) > { > - size_t right_margin = CARET_LINE_MARGIN; > - size_t column = m_exploc.column; > - if (m_show_line_numbers_p) > - column += m_linenum_width + 2; > - right_margin = MIN (line.length () - column, right_margin); > - right_margin = max_width - right_margin; > - if (line.length () >= max_width && column > right_margin) > - m_x_offset = column - right_margin; > - gcc_assert (m_x_offset >= 0); > + size_t column = m_exploc.m_display_col; > + int line_width > + = get_line_width_without_trailing_whitespace (line.get_buffer (), > + line.length ()); > + size_t eol = cpp_display_width (line.get_buffer (), line_width); > + const size_t eol_before_linenum = eol; > + > + if (column <= eol) > + { > + if (m_show_line_numbers_p) > + { > + column += m_linenum_width + 2; > + eol += m_linenum_width + 2; > + } > + size_t right_margin = CARET_LINE_MARGIN; > + right_margin = MIN (eol - column, right_margin); > + right_margin = max_width - right_margin; > + /* Note: if right_margin > max_width, we end up failing this next > + check due to wrapping, and we don't offset anything. Otherwise we > + would conclude we can't output the line at all. */ > + if (eol >= max_width && column > right_margin) > + { > + m_x_offset = column - right_margin; > + m_x_offset = MIN (m_x_offset, (int) eol_before_linenum - 1); > + } > + gcc_assert (m_x_offset >= 0); > + } > } As noted above, m_x_offset should be renamed to clarify its units ("m_x_offset_display"?) Can you move this calculation of the offset to a subroutine please. (I wonder if it can be unit-tested, but don't feel obliged to). [...snip...] Thanks again for the updated patch; this feels close to being ready. [FWIW, part of me would love to express the two different units in the C++ type system (using templates) so that the compiler can check them, rather than relying on naming conventions... but let's get this patch finished without trying to be too clever, especially as we can only rely on C++98] Dave ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-11-22 3:24 ` David Malcolm @ 2019-11-22 11:06 ` David Malcolm 2019-11-26 17:12 ` Lewis Hyatt 1 sibling, 0 replies; 17+ messages in thread From: David Malcolm @ 2019-11-22 11:06 UTC (permalink / raw) To: Lewis Hyatt; +Cc: gcc-patches, joseph On Thu, 2019-11-21 at 21:43 -0500, David Malcolm wrote: > This is the column number as reported in the diagnostic i.e the > COL_NUM > when printing e.g. > warning: FILENAME:LINE_NUM:COL_NUM: some message > > It seems to me that PR 49973 and this patch cover two separate > things: On re-reading, I think I worded this poorly "both PR 49973 and this patch", I meant to say (I didn't want to say that the patch isn't for PR 49973, it's just that that PR covers two things, if that makes sense). > (a) bytes vs display columns in diagnostic-show-locus.c > (b) the "COL_NUM" mentioned above. > > I'd prefer to omit (b) from the patch, and have the focus of the > patch > be (a), to tackle (b) in a separate patch. ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-11-22 3:24 ` David Malcolm 2019-11-22 11:06 ` David Malcolm @ 2019-11-26 17:12 ` Lewis Hyatt 2019-12-06 15:54 ` David Malcolm 1 sibling, 1 reply; 17+ messages in thread From: Lewis Hyatt @ 2019-11-26 17:12 UTC (permalink / raw) To: David Malcolm; +Cc: gcc-patches, joseph [-- Attachment #1: Type: text/plain, Size: 12794 bytes --] On Thu, Nov 21, 2019 at 09:43:58PM -0500, David Malcolm wrote: > Thanks for the updated patch. > > Various comments inline throughout. > New version 4 patch attached, and responses below too. > > > > Why is get_line_width_without_trailing_whitespace done in bytes? > > > > It's used for calculating the maximum number of printed columns, > > > > to try > > > > to cope with extra wide source lines, offsetting things to fit > > > > within the width > > > > of the user's terminal. > > > > > > > > > > It's used in two places. Once in the layout::layout() constructor > > > to > > > compute the m_x_offset in display columns for wide lines, and then > > > again in layout::print_source_line(), which handles printing > > > arbitrary > > > source lines, not necessarily the primary line that was inspected > > > in > > > the constructor. So the m_x_offset needs to be in display column > > > units, that are then translated back to bytes for each different > > > line > > > to which it applies. For this it seemed most convenient for > > > get_line_width_without_trailing_whitespace() to return the bytes > > > offset, since that's what we need in layout::print_source_line() to > > > find the end of the line. > > Ah. Thanks. > > I think the code would be clearer if the patch also renamed > layout's m_x_offset - say to "m_x_offset_display"? > Done. > This is the column number as reported in the diagnostic i.e the COL_NUM > when printing e.g. > warning: FILENAME:LINE_NUM:COL_NUM: some message > > It seems to me that PR 49973 and this patch cover two separate things: > (a) bytes vs display columns in diagnostic-show-locus.c > (b) the "COL_NUM" mentioned above. > > I'd prefer to omit (b) from the patch, and have the focus of the patch > be (a), to tackle (b) in a separate patch. > > [There's also the meaning of column numbers in the JSON output, and in > the output of -fdiagnostics-parseable-fixits (which is intended to mimic > clang's output format)] > > It's unclear to me what the reported COL_NUM should be. > There are various possibilities: > > Units: > (A) [status quo] report a count of bytes within the line > (B) report a count of unicode characters > (C) report a count of unicode graphemes > (D) report based on the wcwidth of the characters > etc > > Origin/baseline: > (A) [status quo] use 1 for the leftmost column > (B) use 0 for the leftmost column > > Tab-handling: > (A) [status quo] don't give any kind of special status to tab characters > (B) implement tab stops, somehow. For example, get_visual_column in > c-family/c-indentation implements tab stops based on bytes. > > (so at least 4*2*2 = 16 possible meanings, ugh) > > See also e.g.: > https://github.com/oasis-tcs/sarif-spec/issues/178 > > The GNU Coding Standards say > > Line numbers should start from 1 at the beginning of the file, and > column numbers should start from 1 at the beginning of the line. > (Both of these conventions are chosen for compatibility.) Calculate > column numbers assuming that space and all ASCII printing characters > have equal width, and assuming tab stops every 8 columns. For > non-ASCII characters, Unicode character widths should be used when in > a UTF-8 locale; GNU libc and GNU gnulib provide suitable wcwidth > functions. > (https://www.gnu.org/prep/standards/standards.html#Errors) > > I think if we do change the meaning of the "COL_NUM" output, we should > probably add an option for it, to help with the transition (so that > people can easily revert to the old behavior). > > Perhaps something like: > > -fdiagnostics-column-unit=[bytes|gnu] > > bytes: [status-quo]; 1-based count of bytes, not respecting tab stops > gnu: as per GNU Coding Standards above > > and have gcc 10 default to "gnu" (or whatever we call it), so that > people can override it back to "bytes". > > (again, I'm thinking aloud here) > > But please can you split that out as a separate patch? (it's arguably > still in time for GCC 10, as it's from a patch was posted before the > stage 1 deadline). > I don't have any basis for an informed opinion on this myself. Unlike the diagnostic-show-locus stuff, which looks visibly incorrect without this patch, the column number is just a convention that is arguably fine how it is. FWIW, clang seems to output in bytes as GCC does. I removed this change from this patch. If there is agreement on how it should be changed in a separate patch, I'm happy to make that too; feels like a user-controllable option will almost certainly be part of it. > AIUI, it's OK for us to iterate on a patch like this that was posted > before the stage 1 deadline, for a while into stage 3, at least. Oh great, thanks for clarifying. > > diff --git a/contrib/unicode/README b/contrib/unicode/README > > new file mode 100644 > > index 00000000000..fbee919647b > > --- /dev/null > > +++ b/contrib/unicode/README > > @@ -0,0 +1,36 @@ > > +This directory contains a mechanism for GCC to have its own internal > > +implementation of wcwidth functionality. (cpp_wcwidth () in libcpp/charset.c). > > + > > +The idea is to produce the necessary lookup table > > +(../../libcpp/generated_cpp_wcwidth.h) in a reproducible way, starting from the > > +following files that are distributed by the Unicode Consortium: > > + > > +ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt > > +ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt > > +ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt > > + > > +These three files have been added to source control in this directory. > > Presumably the licence for these files is: > https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/unicode-gen/unicode-license.txt > > We should include a copy of that license, like glibc does. > Done, thanks for the link. > > +In order to keep in sync with glibc's wcwidth as much as possible, it is > > +desirable for the logic that processes the Unicode data to be the same as > > +glibc's. To that end, we also put in this directory, in the from_glibc/ > > +directory, the glibc python code that implements their logic. This code was > > +copied verbatim from glibc, and it can be updated at any time from the glibc > > +source code repository. > > Specifially from glibc's localedata/unicode-gen/, presumably? > Please can the README state that. > Done, added the commit ID from glibc as well. > > @@ -554,9 +636,9 @@ static layout_range > > make_range (int start_line, int start_col, int end_line, int end_col) > > { > > const expanded_location start_exploc > > - = {"test.c", start_line, start_col, NULL, false}; > > + = {"", start_line, start_col, NULL, false}; > > const expanded_location finish_exploc > > - = {"test.c", end_line, end_col, NULL, false}; > > + = {"", end_line, end_col, NULL, false}; > > return layout_range (&start_exploc, &finish_exploc, SHOW_RANGE_WITHOUT_CARET, > > &start_exploc, 0, NULL); > > } > > Please can you add a comment explaining the significance of the empty > string here (summarizing the discussion above, so it's in the source > rather than just in this list archive). > Done. > > @@ -687,8 +784,8 @@ test_layout_range_for_multiple_lines () > > > > #endif /* #if CHECKING_P */ > > > > -/* Given a source line LINE of length LINE_WIDTH, determine the width > > - without any trailing whitespace. */ > > +/* Given a source line LINE of length LINE_WIDTH bytes, determine the width > > + (in bytes, not display cols) without any trailing whitespace. */ > > > > static int > > get_line_width_without_trailing_whitespace (const char *line, int line_width) > > We really should rename that "line_width" param to "line_width_bytes" or similar. > Done. I changed a few others similarly. > > @@ -897,17 +994,35 @@ layout::layout (diagnostic_context * context, > > will be adjusted accordingly. */ > > size_t max_width = m_context->caret_max_width; > > char_span line = location_get_source_line (m_exploc.file, m_exploc.line); > > - if (line && (size_t)m_exploc.column <= line.length ()) > > + if (line && max_width) > > { > > - size_t right_margin = CARET_LINE_MARGIN; > > - size_t column = m_exploc.column; > > - if (m_show_line_numbers_p) > > - column += m_linenum_width + 2; > > - right_margin = MIN (line.length () - column, right_margin); > > - right_margin = max_width - right_margin; > > - if (line.length () >= max_width && column > right_margin) > > - m_x_offset = column - right_margin; > > - gcc_assert (m_x_offset >= 0); > > + size_t column = m_exploc.m_display_col; > > + int line_width > > + = get_line_width_without_trailing_whitespace (line.get_buffer (), > > + line.length ()); > > + size_t eol = cpp_display_width (line.get_buffer (), line_width); > > + const size_t eol_before_linenum = eol; > > + > > + if (column <= eol) > > + { > > + if (m_show_line_numbers_p) > > + { > > + column += m_linenum_width + 2; > > + eol += m_linenum_width + 2; > > + } > > + size_t right_margin = CARET_LINE_MARGIN; > > + right_margin = MIN (eol - column, right_margin); > > + right_margin = max_width - right_margin; > > + /* Note: if right_margin > max_width, we end up failing this next > > + check due to wrapping, and we don't offset anything. Otherwise we > > + would conclude we can't output the line at all. */ > > + if (eol >= max_width && column > right_margin) > > + { > > + m_x_offset = column - right_margin; > > + m_x_offset = MIN (m_x_offset, (int) eol_before_linenum - 1); > > + } > > + gcc_assert (m_x_offset >= 0); > > + } > > } > > As noted above, m_x_offset should be renamed to clarify its units > ("m_x_offset_display"?) > > Can you move this calculation of the offset to a subroutine please. > (I wonder if it can be unit-tested, but don't feel obliged to). > Done. I also split the calculation of m_linenum_width into a subroutine for consistency, and added new selftests that cover both. One thing that came up when setting up the selftests. The existing code offsets the caret position by (m_linenum_width + 2) when comparing it to the physical end of the display. I think this should be (m_linenum_width + 3), because the line number is followed by the three-character string " | " prior to the start of the source line. I went ahead and made that change. It did require a corresponding change to resolve some new testsuites failure afterwards, in this file: gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c The expected output just needs to shift left by one column, which I did in this version of the patch as well. It seems to make sense to me, but I wanted to mention in case I am missing something subtle here. I made a similar adjustment in case line numbers are not being output; here we still output a space before every line so it feels like that should be taken into account. This calculation still does not attempt to take into account whether pp_print_prefix () will do anything, not sure if that is desired or not, but it was the existing behavior. I am glad you brought this up, as the logic is a little tricky and another issue was fixed when I separated it out and worked through the tests: some source lines cannot be offset by exactly as many display columns as dictated by m_x_offset_display. For instance, if the offset is 1 column, and the portion of the line to be deleted ends with a character of wcwidth 2, then it ends up offsetting too much. I added code to pad with a space in this case to make it line up again. This is in the selftests as well. > Thanks again for the updated patch; this feels close to being ready. > > [FWIW, part of me would love to express the two different units in the > C++ type system (using templates) so that the compiler can check them, > rather than relying on naming conventions... but let's get this patch > finished without trying to be too clever, especially as we can only > rely on C++98] > > Dave > > Thanks, I'm glad it is nearly acceptable. I see on the list that C++11 will be an option for GCC 11, which is a big step IMHO. BTW, bootstrap and reg-test were performed in linux x86-64. Test results are the same before and after: FAIL 104 104 PASS 454289 454289 UNSUPPORTED 10722 10722 UNTESTED 205 205 XFAIL 1652 1652 XPASS 35 35 Also I wanted to remind that the three Unicode data files: contrib/unicode/EastAsianWidth.txt contrib/unicode/PropList.txt contrib/unicode/UnicodeData.txt are to be committed along with this this patch but I did not include them in the email since they are so large. Thanks again for your time, assuming you have the patience to look at this again :). -Lewis [-- Attachment #2: ChangeLog.txt --] [-- Type: text/plain, Size: 5218 bytes --] /ChangeLog 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * contrib/unicode/from_glibc/unicode_utils.py: Support script from glibc (commit 464cd3) to extract character widths from Unicode data files. * contrib/unicode/from_glibc/utf8_gen.py: Likewise. * contrib/unicode/UnicodeData.txt: Unicode v. 12.1.0 data file. * contrib/unicode/EastAsianWidth.txt: Likewise. * contrib/unicode/PropList.txt: Likewise. * contrib/unicode/gen_wcwidth.py: New utility to generate libcpp/generated_cpp_wcwidth.h with help from the glibc support scripts and the Unicode data files. * contrib/unicode/README: New explanatory file. libcpp/ChangeLog 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * generated_cpp_wcwidth.h: New file generated by ../contrib/unicode/gen_wcwidth.py, supports new cpp_wcwidth function. * charset.c (compute_next_display_width): New function to help implement display columns. (cpp_byte_column_to_display_column): Likewise. (cpp_display_column_to_byte_column): Likewise. (cpp_wcwidth): Likewise. * include/cpplib.h (cpp_byte_column_to_display_column): Declare. (cpp_display_column_to_byte_column): Declare. (cpp_wcwidth): Declare. (cpp_display_width): New function. gcc/ChangeLog 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * input.c (location_compute_display_column): New function to help with multibyte awareness in diagnostics. (test_cpp_utf8): New self-test. (input_c_tests): Call the new test. * input.h (location_compute_display_column): Declare. * diagnostic-show-locus.c: Pervasive changes to add multibyte awareness to all classes and functions. (enum column_unit): New enum. (class exploc_with_display_col): New class. (class layout_point): Convert m_column member to array m_columns[2]. (layout_range::contains_point): Add col_unit argument. (test_layout_range_for_single_point): Pass new argument. (test_layout_range_for_single_line): Likewise. (test_layout_range_for_multiple_lines): Likewise. (line_bounds::convert_to_display_cols): New function. (layout::get_state_at_point): Add col_unit argument. (make_range): Use empty filename rather than dummy filename. (get_line_width_without_trailing_whitespace): Rename to... (get_line_bytes_without_trailing_whitespace): ...this. (test_get_line_width_without_trailing_whitespace): Rename to... (test_get_line_bytes_without_trailing_whitespace): ...this. (class layout): m_exploc changed to exploc_with_display_col from plain expanded_location. (layout::get_linenum_width): New accessor member function. (layout::get_x_offset_display): Likewise. (layout::calculate_linenum_width): New subroutine for the constuctor. (layout::calculate_x_offset_display): Likewise. (layout::layout): Use the new subroutines. Add multibyte awareness. (layout::print_source_line): Add multibyte awareness. (layout::print_line): Likewise. (layout::print_annotation_line): Likewise. (line_label::line_label): Likewise. (layout::print_any_labels): Likewise. (layout::annotation_line_showed_range_p): Likewise. (get_printed_columns): Likewise. (class line_label): Rename m_length to m_display_width. (get_affected_columns): Rename to... (get_affected_range): ...this; add col_unit argument and multibyte awareness. (class correction): Add m_affected_bytes and m_display_cols members. Rename m_len to m_byte_length for clarity. Add multibyte awareness throughout. (correction::insertion_p): Add multibyte awareness. (correction::compute_display_cols): New function. (correction::ensure_terminated): Use new member name m_byte_length. (line_corrections::add_hint): Add multibyte awareness. (layout::print_trailing_fixits): Likewise. (layout::get_x_bound_for_row): Likewise. (test_one_liner_simple_caret_utf8): New self-test analogous to the one with _utf8 suffix removed, testing multibyte awareness. (test_one_liner_caret_and_range_utf8): Likewise. (test_one_liner_multiple_carets_and_ranges_utf8): Likewise. (test_one_liner_fixit_insert_before_utf8): Likewise. (test_one_liner_fixit_insert_after_utf8): Likewise. (test_one_liner_fixit_remove_utf8): Likewise. (test_one_liner_fixit_replace_utf8): Likewise. (test_one_liner_fixit_replace_non_equal_range_utf8): Likewise. (test_one_liner_fixit_replace_equal_secondary_range_utf8): Likewise. (test_one_liner_fixit_validation_adhoc_locations_utf8): Likewise. (test_one_liner_many_fixits_1_utf8): Likewise. (test_one_liner_many_fixits_2_utf8): Likewise. (test_one_liner_labels_utf8): Likewise. (test_diagnostic_show_locus_one_liner_utf8): Likewise. (test_overlapped_fixit_printing_utf8): Likewise. (test_overlapped_fixit_printing): Adapt for changes to get_affected_columns, get_printed_columns and class corrections. (test_overlapped_fixit_printing_2): Likewise. (test_linenum_sep): New constant. (test_left_margin): Likewise. (test_offset_impl): Helper function for new test. (test_layout_x_offset_display_utf8): New test. (diagnostic_show_locus_c_tests): Call new tests. gcc/testsuite/ChangeLog: 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> * gcc.dg/plugin/diagnostic_plugin_test_show_locus.c (test_show_locus): Adjust expected output based on new behavior. [-- Attachment #3: display_cols_v4.patch --] [-- Type: text/x-patch, Size: 163013 bytes --] diff --git a/contrib/unicode/README b/contrib/unicode/README new file mode 100644 index 00000000000..3456a383224 --- /dev/null +++ b/contrib/unicode/README @@ -0,0 +1,44 @@ +This directory contains a mechanism for GCC to have its own internal +implementation of wcwidth functionality. (cpp_wcwidth () in libcpp/charset.c). + +The idea is to produce the necessary lookup table +(../../libcpp/generated_cpp_wcwidth.h) in a reproducible way, starting from the +following files that are distributed by the Unicode Consortium: + +ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt +ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt +ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt + +These three files have been added to source control in this directory; +please see unicode-license.txt for the relevant copyright information. + +In order to keep in sync with glibc's wcwidth as much as possible, it is +desirable for the logic that processes the Unicode data to be the same as +glibc's. To that end, we also put in this directory, in the from_glibc/ +directory, the glibc python code that implements their logic. This code was +copied verbatim from glibc, and it can be updated at any time from the glibc +source code repository. The files copied from that respository are: + +localedata/unicode-gen/unicode_utils.py +localedata/unicode-gen/utf8_gen.py + +And the most recent versions added to GCC are from glibc git commit: +2a764c6ee848dfe92cb2921ed3b14085f15d9e79 + +Finally, the script gen_wcwidth.py found here contains the GCC-specific code to +map glibc's output to the lookup tables we require. This script should not need +to change, unless there are structural changes to the Unicode data files or to +the glibc code. + +The procedure to update GCC's wcwidth tables is the following: + +1. Update the three Unicode data files from the above URLs. + +2. Update the two glibc files in from_glibc/ from glibc's git. Update + the commit number above in this README. + +3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_wcwidth.h + (where X.Y is the version of the Unicode standard corresponding to the + Unicode data files being used, most recently, 12.1). + +After that, GCC's wcwidth will match the most recent glibc. diff --git a/contrib/unicode/from_glibc/unicode_utils.py b/contrib/unicode/from_glibc/unicode_utils.py new file mode 100644 index 00000000000..a9e94cce418 --- /dev/null +++ b/contrib/unicode/from_glibc/unicode_utils.py @@ -0,0 +1,527 @@ +# Utilities to generate Unicode data for glibc from upstream Unicode data. +# +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +''' +This module contains utilities used by the scripts to generate +Unicode data for glibc from upstream Unicode data files. +''' + +import sys +import re + + +# Common locale header. +COMMENT_HEADER = """ +% This file is part of the GNU C Library and contains locale data. +% The Free Software Foundation does not claim any copyright interest +% in the locale data contained in this file. The foregoing does not +% affect the license of the GNU C Library as a whole. It does not +% exempt you from the conditions of the license if your use would +% otherwise be governed by that license. +""" + +# Dictionary holding the entire contents of the UnicodeData.txt file +# +# Contents of this dictionary look like this: +# +# {0: {'category': 'Cc', +# 'title': None, +# 'digit': '', +# 'name': '<control>', +# 'bidi': 'BN', +# 'combining': '0', +# 'comment': '', +# 'oldname': 'NULL', +# 'decomposition': '', +# 'upper': None, +# 'mirrored': 'N', +# 'lower': None, +# 'decdigit': '', +# 'numeric': ''}, +# … +# } +UNICODE_ATTRIBUTES = {} + +# Dictionary holding the entire contents of the DerivedCoreProperties.txt file +# +# Contents of this dictionary look like this: +# +# {917504: ['Default_Ignorable_Code_Point'], +# 917505: ['Case_Ignorable', 'Default_Ignorable_Code_Point'], +# … +# } +DERIVED_CORE_PROPERTIES = {} + +# Dictionary holding the entire contents of the EastAsianWidths.txt file +# +# Contents of this dictionary look like this: +# +# {0: 'N', … , 45430: 'W', …} +EAST_ASIAN_WIDTHS = {} + +def fill_attribute(code_point, fields): + '''Stores in UNICODE_ATTRIBUTES[code_point] the values from the fields. + + One entry in the UNICODE_ATTRIBUTES dictionary represents one line + in the UnicodeData.txt file. + + ''' + UNICODE_ATTRIBUTES[code_point] = { + 'name': fields[1], # Character name + 'category': fields[2], # General category + 'combining': fields[3], # Canonical combining classes + 'bidi': fields[4], # Bidirectional category + 'decomposition': fields[5], # Character decomposition mapping + 'decdigit': fields[6], # Decimal digit value + 'digit': fields[7], # Digit value + 'numeric': fields[8], # Numeric value + 'mirrored': fields[9], # mirrored + 'oldname': fields[10], # Old Unicode 1.0 name + 'comment': fields[11], # comment + # Uppercase mapping + 'upper': int(fields[12], 16) if fields[12] else None, + # Lowercase mapping + 'lower': int(fields[13], 16) if fields[13] else None, + # Titlecase mapping + 'title': int(fields[14], 16) if fields[14] else None, + } + +def fill_attributes(filename): + '''Stores the entire contents of the UnicodeData.txt file + in the UNICODE_ATTRIBUTES dictionary. + + A typical line for a single code point in UnicodeData.txt looks + like this: + + 0041;LATIN CAPITAL LETTER A;Lu;0;L;;;;;N;;;;0061; + + Code point ranges are indicated by pairs of lines like this: + + 4E00;<CJK Ideograph, First>;Lo;0;L;;;;;N;;;;; + 9FCC;<CJK Ideograph, Last>;Lo;0;L;;;;;N;;;;; + ''' + with open(filename, mode='r') as unicode_data_file: + fields_start = [] + for line in unicode_data_file: + fields = line.strip().split(';') + if len(fields) != 15: + sys.stderr.write( + 'short line in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + if fields[2] == 'Cs': + # Surrogates are UTF-16 artefacts, + # not real characters. Ignore them. + fields_start = [] + continue + if fields[1].endswith(', First>'): + fields_start = fields + fields_start[1] = fields_start[1].split(',')[0][1:] + continue + if fields[1].endswith(', Last>'): + fields[1] = fields[1].split(',')[0][1:] + if fields[1:] != fields_start[1:]: + sys.stderr.write( + 'broken code point range in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + for code_point in range( + int(fields_start[0], 16), + int(fields[0], 16)+1): + fill_attribute(code_point, fields) + fields_start = [] + continue + fill_attribute(int(fields[0], 16), fields) + fields_start = [] + +def fill_derived_core_properties(filename): + '''Stores the entire contents of the DerivedCoreProperties.txt file + in the DERIVED_CORE_PROPERTIES dictionary. + + Lines in DerivedCoreProperties.txt are either a code point range like + this: + + 0061..007A ; Lowercase # L& [26] LATIN SMALL LETTER A..LATIN SMALL LETTER Z + + or a single code point like this: + + 00AA ; Lowercase # Lo FEMININE ORDINAL INDICATOR + + ''' + with open(filename, mode='r') as derived_core_properties_file: + for line in derived_core_properties_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + + r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + + r'\s*;\s*(?P<property>[a-zA-Z_]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + prop = match.group('property') + if code_point in DERIVED_CORE_PROPERTIES: + DERIVED_CORE_PROPERTIES[code_point].append(prop) + else: + DERIVED_CORE_PROPERTIES[code_point] = [prop] + +def fill_east_asian_widths(filename): + '''Stores the entire contents of the EastAsianWidths.txt file + in the EAST_ASIAN_WIDTHS dictionary. + + Lines in EastAsianWidths.txt are either a code point range like + this: + + 9FCD..9FFF;W # Cn [51] <reserved-9FCD>..<reserved-9FFF> + + or a single code point like this: + + A015;W # Lm YI SYLLABLE WU + ''' + with open(filename, mode='r') as east_asian_widths_file: + for line in east_asian_widths_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + +r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + +r'\s*;\s*(?P<property>[a-zA-Z]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + EAST_ASIAN_WIDTHS[code_point] = match.group('property') + +def to_upper(code_point): + '''Returns the code point of the uppercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['upper']): + return UNICODE_ATTRIBUTES[code_point]['upper'] + else: + return code_point + +def to_lower(code_point): + '''Returns the code point of the lowercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['lower']): + return UNICODE_ATTRIBUTES[code_point]['lower'] + else: + return code_point + +def to_upper_turkish(code_point): + '''Returns the code point of the Turkish uppercase version + of the given code point''' + if code_point == 0x0069: + return 0x0130 + return to_upper(code_point) + +def to_lower_turkish(code_point): + '''Returns the code point of the Turkish lowercase version + of the given code point''' + if code_point == 0x0049: + return 0x0131 + return to_lower(code_point) + +def to_title(code_point): + '''Returns the code point of the titlecase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['title']): + return UNICODE_ATTRIBUTES[code_point]['title'] + else: + return code_point + +def is_upper(code_point): + '''Checks whether the character with this code point is uppercase''' + return (to_lower(code_point) != code_point + or (code_point in DERIVED_CORE_PROPERTIES + and 'Uppercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_lower(code_point): + '''Checks whether the character with this code point is lowercase''' + # Some characters are defined as “Lowercase†in + # DerivedCoreProperties.txt but do not have a mapping to upper + # case. For example, ꜰ U+A72F “LATIN LETTER SMALL CAPITAL F†is + # one of these. + return (to_upper(code_point) != code_point + # <U00DF> is lowercase, but without simple to_upper mapping. + or code_point == 0x00DF + or (code_point in DERIVED_CORE_PROPERTIES + and 'Lowercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_alpha(code_point): + '''Checks whether the character with this code point is alphabetic''' + return ((code_point in DERIVED_CORE_PROPERTIES + and + 'Alphabetic' in DERIVED_CORE_PROPERTIES[code_point]) + or + # Consider all the non-ASCII digits as alphabetic. + # ISO C 99 forbids us to have them in category “digitâ€, + # but we want iswalnum to return true on them. + (UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd' + and not (code_point >= 0x0030 and code_point <= 0x0039))) + +def is_digit(code_point): + '''Checks whether the character with this code point is a digit''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd') + # Note: U+0BE7..U+0BEF and U+1369..U+1371 are digit systems without + # a zero. Must add <0> in front of them by hand. + else: + # SUSV2 gives us some freedom for the "digit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.5: + # The iswdigit function tests for any wide character that + # corresponds to a decimal-digit character (as defined in 5.2.1). + # 5.2.1: + # the 10 decimal digits 0 1 2 3 4 5 6 7 8 9 + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_outdigit(code_point): + '''Checks whether the character with this code point is outdigit''' + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_blank(code_point): + '''Checks whether the character with this code point is blank''' + return (code_point == 0x0009 # '\t' + # Category Zs without mention of '<noBreak>' + or (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Zs' + and '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])) + +def is_space(code_point): + '''Checks whether the character with this code point is a space''' + # Don’t make U+00A0 a space. Non-breaking space means that all programs + # should treat it like a punctuation character, not like a space. + return (code_point == 0x0020 # ' ' + or code_point == 0x000C # '\f' + or code_point == 0x000A # '\n' + or code_point == 0x000D # '\r' + or code_point == 0x0009 # '\t' + or code_point == 0x000B # '\v' + # Categories Zl, Zp, and Zs without mention of "<noBreak>" + or (UNICODE_ATTRIBUTES[code_point]['name'] + and + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'] + or + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zs'] + and + '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])))) + +def is_cntrl(code_point): + '''Checks whether the character with this code point is + a control character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and (UNICODE_ATTRIBUTES[code_point]['name'] == '<control>' + or + UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'])) + +def is_xdigit(code_point): + '''Checks whether the character with this code point is + a hexadecimal digit''' + if False: + return (is_digit(code_point) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + else: + # SUSV2 gives us some freedom for the "xdigit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.12: + # The iswxdigit function tests for any wide character that + # corresponds to a hexadecimal-digit character (as defined + # in 6.4.4.1). + # 6.4.4.1: + # hexadecimal-digit: one of + # 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F + return ((code_point >= 0x0030 and code_point <= 0x0039) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + +def is_graph(code_point): + '''Checks whether the character with this code point is + a graphical character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and not is_space(code_point)) + +def is_print(code_point): + '''Checks whether the character with this code point is printable''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and UNICODE_ATTRIBUTES[code_point]['category'] not in ['Zl', 'Zp']) + +def is_punct(code_point): + '''Checks whether the character with this code point is punctuation''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'].startswith('P')) + else: + # The traditional POSIX definition of punctuation is every graphic, + # non-alphanumeric character. + return (is_graph(code_point) + and not is_alpha(code_point) + and not is_digit(code_point)) + +def is_combining(code_point): + '''Checks whether the character with this code point is + a combining character''' + # Up to Unicode 3.0.1 we took the Combining property from the PropList.txt + # file. In 3.0.1 it was identical to the union of the general categories + # "Mn", "Mc", "Me". In Unicode 3.1 this property has been dropped from the + # PropList.txt file, so we take the latter definition. + return (UNICODE_ATTRIBUTES[code_point]['name'] + and + UNICODE_ATTRIBUTES[code_point]['category'] in ['Mn', 'Mc', 'Me']) + +def is_combining_level3(code_point): + '''Checks whether the character with this code point is + a combining level3 character''' + return (is_combining(code_point) + and + int(UNICODE_ATTRIBUTES[code_point]['combining']) in range(0, 200)) + +def ucs_symbol(code_point): + '''Return the UCS symbol string for a Unicode character.''' + if code_point < 0x10000: + return '<U{:04X}>'.format(code_point) + else: + return '<U{:08X}>'.format(code_point) + +def ucs_symbol_range(code_point_low, code_point_high): + '''Returns a string UCS symbol string for a code point range. + + Example: + + <U0041>..<U005A> + ''' + return ucs_symbol(code_point_low) + '..' + ucs_symbol(code_point_high) + +def verifications(): + '''Tests whether the is_* functions observe the known restrictions''' + for code_point in sorted(UNICODE_ATTRIBUTES): + # toupper restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_upper(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but toupper(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_upper(code_point)}) + # tolower restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_lower(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but tolower(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_lower(code_point)}) + # alpha restriction: "Characters classified as either upper or lower + # shall automatically belong to this class. + if ((is_lower(code_point) or is_upper(code_point)) + and not is_alpha(code_point)): + sys.stderr.write('%(sym)s is upper|lower but not alpha\n' %{ + 'sym': ucs_symbol(code_point)}) + # alpha restriction: “No character specified for the keywords cntrl, + # digit, punct or space shall be specified.†+ if (is_alpha(code_point) and is_cntrl(code_point)): + sys.stderr.write('%(sym)s is alpha and cntrl\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is alpha and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is alpha and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_space(code_point)): + sys.stderr.write('%(sym)s is alpha and space\n' %{ + 'sym': ucs_symbol(code_point)}) + # space restriction: “No character specified for the keywords upper, + # lower, alpha, digit, graph or xdigit shall be specified.†+ # upper, lower, alpha already checked above. + if (is_space(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is space and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is space and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is space and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # cntrl restriction: “No character specified for the keywords upper, + # lower, alpha, digit, punct, graph, print or xdigit shall be + # specified.†upper, lower, alpha already checked above. + if (is_cntrl(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is cntrl and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is cntrl and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is cntrl and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_print(code_point)): + sys.stderr.write('%(sym)s is cntrl and print\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is cntrl and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # punct restriction: “No character specified for the keywords upper, + # lower, alpha, digit, cntrl, xdigit or as the <space> character shall + # be specified.†upper, lower, alpha, cntrl already checked above. + if (is_punct(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is punct and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is punct and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and code_point == 0x0020): + sys.stderr.write('%(sym)s is punct\n' %{ + 'sym': ucs_symbol(code_point)}) + # graph restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # print restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # graph - print relation: differ only in the <space> character. + # How is this possible if there are more than one space character?! + # I think susv2/xbd/locale.html should speak of “space charactersâ€, + # not “space characterâ€. + if (is_print(code_point) + and not (is_graph(code_point) or is_space(code_point))): + sys.stderr.write('%(sym)s is print but not graph|<space>\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) + if (not is_print(code_point) + and (is_graph(code_point) or code_point == 0x0020)): + sys.stderr.write('%(sym)s is graph|<space> but not print\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) diff --git a/contrib/unicode/from_glibc/utf8_gen.py b/contrib/unicode/from_glibc/utf8_gen.py new file mode 100755 index 00000000000..0e5583cd259 --- /dev/null +++ b/contrib/unicode/from_glibc/utf8_gen.py @@ -0,0 +1,364 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +'''glibc/localedata/charmaps/UTF-8 file generator script + +This script generates a glibc/localedata/charmaps/UTF-8 file +from Unicode data. + +Usage: python3 utf8_gen.py UnicodeData.txt EastAsianWidth.txt + +It will output UTF-8 file +''' + +import argparse +import sys +import re +import unicode_utils + +# Auxiliary tables for Hangul syllable names, see the Unicode 3.0 book, +# sections 3.11 and 4.4. + +JAMO_INITIAL_SHORT_NAME = ( + 'G', 'GG', 'N', 'D', 'DD', 'R', 'M', 'B', 'BB', 'S', 'SS', '', 'J', 'JJ', + 'C', 'K', 'T', 'P', 'H' +) + +JAMO_MEDIAL_SHORT_NAME = ( + 'A', 'AE', 'YA', 'YAE', 'EO', 'E', 'YEO', 'YE', 'O', 'WA', 'WAE', 'OE', + 'YO', 'U', 'WEO', 'WE', 'WI', 'YU', 'EU', 'YI', 'I' +) + +JAMO_FINAL_SHORT_NAME = ( + '', 'G', 'GG', 'GS', 'N', 'NI', 'NH', 'D', 'L', 'LG', 'LM', 'LB', 'LS', + 'LT', 'LP', 'LH', 'M', 'B', 'BS', 'S', 'SS', 'NG', 'J', 'C', 'K', 'T', + 'P', 'H' +) + +def process_range(start, end, outfile, name): + '''Writes a range of code points into the CHARMAP section of the + output file + + ''' + if 'Hangul Syllable' in name: + # from glibc/localedata/ChangeLog: + # + # 2000-09-24 Bruno Haible <haible@clisp.cons.org> + # * charmaps/UTF-8: Expand <Hangul Syllable> and <Private Use> ranges, + # so they become printable and carry a width. Comment out surrogate + # ranges. Add a WIDTH table + # + # So we expand the Hangul Syllables here: + for i in range(int(start, 16), int(end, 16)+1 ): + index2, index3 = divmod(i - 0xaC00, 28) + index1, index2 = divmod(index2, 21) + hangul_syllable_name = 'HANGUL SYLLABLE ' \ + + JAMO_INITIAL_SHORT_NAME[index1] \ + + JAMO_MEDIAL_SHORT_NAME[index2] \ + + JAMO_FINAL_SHORT_NAME[index3] + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), convert_to_hex(i), + hangul_syllable_name)) + return + # UnicodeData.txt file has contains code point ranges like this: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + # + # The glibc UTF-8 file splits ranges like these into shorter + # ranges of 64 code points each: + # + # <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + # … + # <U4D80>..<U4DB5> /xe4/xb6/x80 <CJK Ideograph Extension A> + for i in range(int(start, 16), int(end, 16), 64 ): + if i > (int(end, 16)-64): + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(int(end,16)), + convert_to_hex(i), + name)) + break + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(i+63), + convert_to_hex(i), + name)) + +def process_charmap(flines, outfile): + '''This function takes an array which contains *all* lines of + of UnicodeData.txt and write lines to outfile as used in the + + CHARMAP + … + END CHARMAP + + section of the UTF-8 file in glibc/localedata/charmaps/UTF-8. + + Samples for input lines: + + 0010;<control>;Cc;0;BN;;;;;N;DATA LINK ESCAPE;;;; + 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + D800;<Non Private Use High Surrogate, First>;Cs;0;L;;;;;N;;;;; + DB7F;<Non Private Use High Surrogate, Last>;Cs;0;L;;;;;N;;;;; + 100000;<Plane 16 Private Use, First>;Co;0;L;;;;;N;;;;; + 10FFFD;<Plane 16 Private Use, Last>;Co;0;L;;;;;N;;;;; + + Samples for output lines (Unicode-Value UTF-8-HEX Unicode-Char-Name): + + <U0010> /x10 DATA LINK ESCAPE + <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + %<UD800> /xed/xa0/x80 <Non Private Use High Surrogate, First> + %<UDB7F> /xed/xad/xbf <Non Private Use High Surrogate, Last> + <U0010FFC0>..<U0010FFFD> /xf4/x8f/xbf/x80 <Plane 16 Private Use> + + ''' + fields_start = [] + for line in flines: + fields = line.split(";") + # Some characters have “<control>†as their name. We try to + # use the “Unicode 1.0 Name†(10th field in + # UnicodeData.txt) for them. + # + # The Characters U+0080, U+0081, U+0084 and U+0099 have + # “<control>†as their name but do not even have aa + # â€Unicode 1.0 Nameâ€. We could write code to take their + # alternate names from NameAliases.txt. + if fields[1] == "<control>" and fields[10]: + fields[1] = fields[10] + # Handling code point ranges like: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + if fields[1].endswith(', First>') and not 'Surrogate,' in fields[1]: + fields_start = fields + continue + if fields[1].endswith(', Last>') and not 'Surrogate,' in fields[1]: + process_range(fields_start[0], fields[0], + outfile, fields[1][:-7]+'>') + fields_start = [] + continue + fields_start = [] + if 'Surrogate,' in fields[1]: + # Comment out the surrogates in the UTF-8 file. + # One could of course skip them completely but + # the original UTF-8 file in glibc had them as + # comments, so we keep these comment lines. + outfile.write('%') + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(int(fields[0], 16)), + convert_to_hex(int(fields[0], 16)), + fields[1])) + +def convert_to_hex(code_point): + '''Converts a code point to a hexadecimal UTF-8 representation + like /x**/x**/x**.''' + # Getting UTF8 of Unicode characters. + # In Python3, .encode('UTF-8') does not work for + # surrogates. Therefore, we use this conversion table + surrogates = { + 0xD800: '/xed/xa0/x80', + 0xDB7F: '/xed/xad/xbf', + 0xDB80: '/xed/xae/x80', + 0xDBFF: '/xed/xaf/xbf', + 0xDC00: '/xed/xb0/x80', + 0xDFFF: '/xed/xbf/xbf', + } + if code_point in surrogates: + return surrogates[code_point] + return ''.join([ + '/x{:02x}'.format(c) for c in chr(code_point).encode('UTF-8') + ]) + +def write_header_charmap(outfile): + '''Write the header on top of the CHARMAP section to the output file''' + outfile.write("<code_set_name> UTF-8\n") + outfile.write("<comment_char> %\n") + outfile.write("<escape_char> /\n") + outfile.write("<mb_cur_min> 1\n") + outfile.write("<mb_cur_max> 6\n\n") + outfile.write("% CHARMAP generated using utf8_gen.py\n") + outfile.write("% alias ISO-10646/UTF-8\n") + outfile.write("CHARMAP\n") + +def write_header_width(outfile, unicode_version): + '''Writes the header on top of the WIDTH section to the output file''' + outfile.write('% Character width according to Unicode ' + + '{:s}.\n'.format(unicode_version)) + outfile.write('% - Default width is 1.\n') + outfile.write('% - Double-width characters have width 2; generated from\n') + outfile.write('% "grep \'^[^;]*;[WF]\' EastAsianWidth.txt"\n') + outfile.write('% - Non-spacing characters have width 0; ' + + 'generated from PropList.txt or\n') + outfile.write('% "grep \'^[^;]*;[^;]*;[^;]*;[^;]*;NSM;\' ' + + 'UnicodeData.txt"\n') + outfile.write('% - Format control characters have width 0; ' + + 'generated from\n') + outfile.write("% \"grep '^[^;]*;[^;]*;Cf;' UnicodeData.txt\"\n") +# Not needed covered by Cf +# outfile.write("% - Zero width characters have width 0; generated from\n") +# outfile.write("% \"grep '^[^;]*;ZERO WIDTH ' UnicodeData.txt\"\n") + outfile.write("WIDTH\n") + +def process_width(outfile, ulines, elines, plines): + '''ulines are lines from UnicodeData.txt, elines are lines from + EastAsianWidth.txt containing characters with width “W†or “Fâ€, + plines are lines from PropList.txt which contain characters + with the property “Prepended_Concatenation_Markâ€. + + ''' + width_dict = {} + for line in elines: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + width_dict[key] = 2 + + for line in ulines: + fields = line.split(";") + if fields[4] == "NSM" or fields[2] in ("Cf", "Me", "Mn"): + width_dict[int(fields[0], 16)] = 0 + + for line in plines: + # Characters with the property “Prepended_Concatenation_Mark†+ # should have the width 1: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + del width_dict[key] # default width is 1 + + # handle special cases for compatibility + for key in list((0x00AD,)): + # https://www.cs.tut.fi/~jkorpela/shy.html + if key in width_dict: + del width_dict[key] # default width is 1 + for key in list(range(0x1160, 0x1200)): + width_dict[key] = 0 + for key in list(range(0x3248, 0x3250)): + # These are “A†which means we can decide whether to treat them + # as “W†or “N†based on context: + # http://www.unicode.org/mail-arch/unicode-ml/y2017-m08/0023.html + # For us, “W†seems better. + width_dict[key] = 2 + for key in list(range(0x4DC0, 0x4E00)): + width_dict[key] = 2 + + same_width_lists = [] + current_width_list = [] + for key in sorted(width_dict): + if not current_width_list: + current_width_list = [key] + elif (key == current_width_list[-1] + 1 + and width_dict[key] == width_dict[current_width_list[0]]): + current_width_list.append(key) + else: + same_width_lists.append(current_width_list) + current_width_list = [key] + if current_width_list: + same_width_lists.append(current_width_list) + + for same_width_list in same_width_lists: + if len(same_width_list) == 1: + outfile.write('{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + width_dict[same_width_list[0]])) + else: + outfile.write('{:s}...{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + unicode_utils.ucs_symbol(same_width_list[-1]), + width_dict[same_width_list[0]])) + +if __name__ == "__main__": + PARSER = argparse.ArgumentParser( + description=''' + Generate a UTF-8 file from UnicodeData.txt, EastAsianWidth.txt, and PropList.txt. + ''') + PARSER.add_argument( + '-u', '--unicode_data_file', + nargs='?', + type=str, + default='UnicodeData.txt', + help=('The UnicodeData.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-e', '--east_asian_with_file', + nargs='?', + type=str, + default='EastAsianWidth.txt', + help=('The EastAsianWidth.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-p', '--prop_list_file', + nargs='?', + type=str, + default='PropList.txt', + help=('The PropList.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '--unicode_version', + nargs='?', + required=True, + type=str, + help='The Unicode version of the input files used.') + ARGS = PARSER.parse_args() + + with open(ARGS.unicode_data_file, mode='r') as UNIDATA_FILE: + UNICODE_DATA_LINES = UNIDATA_FILE.readlines() + with open(ARGS.east_asian_with_file, mode='r') as EAST_ASIAN_WIDTH_FILE: + EAST_ASIAN_WIDTH_LINES = [] + for LINE in EAST_ASIAN_WIDTH_FILE: + # If characters from EastAasianWidth.txt which are from + # from reserved ranges (i.e. not yet assigned code points) + # are added to the WIDTH section of the UTF-8 file, then + # “make check†produces “Unknown Character†errors for + # these code points because such unassigned code points + # are not in the CHARMAP section of the UTF-8 file. + # + # Therefore, we skip all reserved code points when reading + # the EastAsianWidth.txt file. + if re.match(r'.*<reserved-.+>\.\.<reserved-.+>.*', LINE): + continue + if re.match(r'^[^;]*;[WF]', LINE): + EAST_ASIAN_WIDTH_LINES.append(LINE.strip()) + with open(ARGS.prop_list_file, mode='r') as PROP_LIST_FILE: + PROP_LIST_LINES = [] + for LINE in PROP_LIST_FILE: + if re.match(r'^[^;]*;[\s]*Prepended_Concatenation_Mark', LINE): + PROP_LIST_LINES.append(LINE.strip()) + with open('UTF-8', mode='w') as OUTFILE: + # Processing UnicodeData.txt and write CHARMAP to UTF-8 file + write_header_charmap(OUTFILE) + process_charmap(UNICODE_DATA_LINES, OUTFILE) + OUTFILE.write("END CHARMAP\n\n") + # Processing EastAsianWidth.txt and write WIDTH to UTF-8 file + write_header_width(OUTFILE, ARGS.unicode_version) + process_width(OUTFILE, + UNICODE_DATA_LINES, + EAST_ASIAN_WIDTH_LINES, + PROP_LIST_LINES) + OUTFILE.write("END WIDTH\n") diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py new file mode 100755 index 00000000000..02b28bcedcf --- /dev/null +++ b/contrib/unicode/gen_wcwidth.py @@ -0,0 +1,106 @@ +#!/usr/bin/env python3 +# +# Script to generate tables for cpp_wcwidth, leveraging glibc's utf8_gen.py. +# +# This file is part of GCC. +# +# GCC is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation; either version 3, or (at your option) any later +# version. +# +# GCC 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 Public License +# for more details. +# +# You should have received a copy of the GNU General Public License +# along with GCC; see the file COPYING3. If not see +# <http://www.gnu.org/licenses/>. */ + +import sys +import os + +if len(sys.argv) != 2: + print("usage: %s <unicode version>", file=sys.stderr) + sys.exit(1) +unicode_version = sys.argv[1] + +# Parse a codepoint in the format output by glibc tools. +def parse_ucn(s): + if not (s.startswith("<U") and s.endswith(">")): + raise ValueError + return int(s[2:-1], base=16) + +# Process a line of width output from utf_gen.py and update global array. +widths = [1] * (1 + 0x10FFFF) +def process_width(line): + # Example lines: + # <UA8FF> 0 + # <UA926>...<UA92D> 0 + + s = line.split() + width = int(s[1]) + r = s[0].split("...") + if len(r) == 1: + begin = parse_ucn(r[0]) + end = begin + 1 + elif len(r) == 2: + begin = parse_ucn(r[0]) + end = parse_ucn(r[1]) + 1 + else: + raise ValueError + widths[begin:end] = [width] * (end - begin) + +# To keep things simple, we use glibc utf8_gen.py as-is. It only outputs to a +# file named UTF-8, which is not configurable. Then we parse this into the form +# we want it. +os.system("from_glibc/utf8_gen.py --unicode_version %s" % unicode_version) +processing = False +for line in open("UTF-8", "r"): + if processing: + if line == "END WIDTH\n": + processing = False + else: + try: + process_width(line) + except (ValueError, IndexError): + print(e, "warning: ignored unexpected line: %s" % line, + file=sys.stderr, end="") + elif line == "WIDTH\n": + processing = True + +# All bytes < 256 we treat as width 1. +widths[0:255] = [1] * 255 + +# Condense the list to contiguous ranges. +cur_range = [-1, 1] +all_ranges = [] +for i, width in enumerate(widths): + if width == cur_range[1]: + cur_range[0] = i + else: + all_ranges.append(cur_range) + cur_range = [i, width] + +# Output the arrays for generated_cpp_wcwidth.h +print("/* Generated by contrib/unicode/gen_wcwidth.py,", + "with the help of glibc's") +print(" utf8_gen.py, using version %s" % unicode_version, + "of the Unicode standard. */") +print("\nstatic const cppchar_t wcwidth_range_ends[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 8: + print(" ", end="") + else: + print("\n ", end="") + print("0x%x," % (r[0]), end="") +print("\n};\n") +print("static const unsigned char wcwidth_widths[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 24: + print(" ", end="") + else: + print("\n ", end="") + print("%d," % r[1], end="") +print("\n};") diff --git a/contrib/unicode/unicode-license.txt b/contrib/unicode/unicode-license.txt new file mode 100644 index 00000000000..bdbb0a5c32d --- /dev/null +++ b/contrib/unicode/unicode-license.txt @@ -0,0 +1,50 @@ +UNICODE, INC. LICENSE AGREEMENT - DATA FILES AND SOFTWARE + + Unicode Data Files include all data files under the directories +http://www.unicode.org/Public/, http://www.unicode.org/reports/, and +http://www.unicode.org/cldr/data/. Unicode Data Files do not include PDF +online code charts under the directory http://www.unicode.org/Public/. +Software includes any source code published in the Unicode Standard or under +the directories http://www.unicode.org/Public/, +http://www.unicode.org/reports/, and http://www.unicode.org/cldr/data/. + + NOTICE TO USER: Carefully read the following legal agreement. BY +DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING UNICODE INC.'S DATA FILES +("DATA FILES"), AND/OR SOFTWARE ("SOFTWARE"), YOU UNEQUIVOCALLY ACCEPT, AND +AGREE TO BE BOUND BY, ALL OF THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF +YOU DO NOT AGREE, DO NOT DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE THE DATA +FILES OR SOFTWARE. + + COPYRIGHT AND PERMISSION NOTICE + + Copyright © 1991-2013 Unicode, Inc. All rights reserved. Distributed under +the Terms of Use in http://www.unicode.org/copyright.html. + + Permission is hereby granted, free of charge, to any person obtaining a +copy of the Unicode data files and any associated documentation (the "Data +Files") or Unicode software and any associated documentation (the "Software") +to deal in the Data Files or Software without restriction, including without +limitation the rights to use, copy, modify, merge, publish, distribute, and/or +sell copies of the Data Files or Software, and to permit persons to whom the +Data Files or Software are furnished to do so, provided that (a) the above +copyright notice(s) and this permission notice appear with all copies of the +Data Files or Software, (b) both the above copyright notice(s) and this +permission notice appear in associated documentation, and (c) there is clear +notice in each modified Data File or in the Software as well as in the +documentation associated with the Data File(s) or Software that the data or +software has been modified. + + THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD +PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN +THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL +DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR +PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS +ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE +DATA FILES OR SOFTWARE. + + Except as contained in this notice, the name of a copyright holder shall +not be used in advertising or otherwise to promote the sale, use or other +dealings in these Data Files or Software without prior written authorization +of the copyright holder. diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c index cb920f6b9d0..472cb604c8b 100644 --- a/gcc/diagnostic-show-locus.c +++ b/gcc/diagnostic-show-locus.c @@ -30,6 +30,7 @@ along with GCC; see the file COPYING3. If not see #include "gcc-rich-location.h" #include "selftest.h" #include "selftest-diagnostic.h" +#include "cpplib.h" #ifdef HAVE_TERMIOS_H # include <termios.h> @@ -112,18 +113,81 @@ class colorizer const char *m_stop_color; }; -/* A point within a layout_range; similar to an expanded_location, +/* In order to handle multibyte sources properly, all of this logic needs to be + aware of the distinction between the number of bytes and the number of + display columns occupied by a character, which are not the same for non-ASCII + characters. For example, the Unicode pi symbol, U+03C0, is encoded in UTF-8 + as "\xcf\x80", and thus occupies 2 bytes of space while only occupying 1 + display column when it is output. A typical emoji, such as U+1F602 (in + UTF-8, "\xf0\x9f\x98\x82"), requires 4 bytes and has a display width of 2. + + The below example line, which is also used for selftests below, shows how the + display column and byte column are related: + + 0000000001111111111222222 display + 1234567890123456789012345 columns + SS_foo = P_bar.SS_fieldP; + 0000000111111111222222223 byte + 1356789012456789134567891 columns + + Here SS represents the two display columns for the U+1F602 emoji, and P + represents the one display column for the U+03C0 pi symbol. As an example, a + diagnostic pointing to the final P on this line is at byte column 29 and + display column 24. This reflects the fact that the three extended characters + before the final P occupy cumulatively 5 more bytes than they do display + columns (a difference of 2 for each of the two SSs, and one for the other P). + + One or the other of the two column units is more useful depending on the + context. For instance, in order to output the caret at the correct location, + we need to count display columns; in order to colorize a source line, we need + to count the bytes. All locations are provided to us as byte counts, which + we augment with the display column on demand so that it can be used when + needed. This is not the most efficient way to do things since it requires + looping over the whole line each time, but it should be fine for the purpose + of outputting diagnostics. + + In order to keep straight which units (byte or display) are in use at a + given time, the following enum lets us specify that explicitly. */ + +enum column_unit { + /* Measured in raw bytes. */ + CU_BYTES = 0, + + /* Measured in display units. */ + CU_DISPLAY_COLS, + + /* For arrays indexed by column_unit. */ + CU_NUM_UNITS +}; + +/* Utility class to augment an exploc with the corresponding display column. */ + +class exploc_with_display_col : public expanded_location +{ + public: + exploc_with_display_col (const expanded_location &exploc) + : expanded_location (exploc), + m_display_col (location_compute_display_column (exploc)) {} + + int m_display_col; +}; + + +/* A point within a layout_range; similar to an exploc_with_display_col, but after filtering on file. */ class layout_point { public: layout_point (const expanded_location &exploc) - : m_line (exploc.line), - m_column (exploc.column) {} + : m_line (exploc.line) + { + m_columns[CU_BYTES] = exploc.column; + m_columns[CU_DISPLAY_COLS] = location_compute_display_column (exploc); + } linenum_type m_line; - int m_column; + int m_columns[CU_NUM_UNITS]; }; /* A class for use by "class layout" below: a filtered location_range. */ @@ -138,7 +202,8 @@ class layout_range unsigned original_idx, const range_label *label); - bool contains_point (linenum_type row, int column) const; + bool contains_point (linenum_type row, int column, + enum column_unit col_unit) const; bool intersects_line_p (linenum_type row) const; layout_point m_start; @@ -157,6 +222,17 @@ struct line_bounds { int m_first_non_ws; int m_last_non_ws; + + void convert_to_display_cols (char_span line) + { + m_first_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_first_non_ws); + + m_last_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_last_non_ws); + } }; /* A range of contiguous source lines within a layout (e.g. "lines 5-10" @@ -252,6 +328,9 @@ class layout int get_num_line_spans () const { return m_line_spans.length (); } const line_span *get_line_span (int idx) const { return &m_line_spans[idx]; } + int get_linenum_width () const { return m_linenum_width; } + int get_x_offset_display () const { return m_x_offset_display; } + void print_gap_in_line_numbering (); bool print_heading_for_line_span_index_p (int line_span_idx) const; @@ -262,7 +341,7 @@ class layout private: bool will_show_line_p (linenum_type row) const; void print_leading_fixits (linenum_type row); - void print_source_line (linenum_type row, const char *line, int line_width, + void print_source_line (linenum_type row, const char *line, int line_bytes, line_bounds *lbounds_out); bool should_print_annotation_line_p (linenum_type row) const; void start_annotation_line (char margin_char = ' ') const; @@ -277,6 +356,8 @@ class layout bool validate_fixit_hint_p (const fixit_hint *hint); void calculate_line_spans (); + void calculate_linenum_width (); + void calculate_x_offset_display (); void print_newline (); @@ -284,6 +365,7 @@ class layout get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + enum column_unit col_unit, /* Outputs. */ point_state *out_state); @@ -298,7 +380,7 @@ class layout diagnostic_context *m_context; pretty_printer *m_pp; location_t m_primary_loc; - expanded_location m_exploc; + exploc_with_display_col m_exploc; colorizer m_colorizer; bool m_colorize_source_p; bool m_show_labels_p; @@ -307,7 +389,7 @@ class layout auto_vec <const fixit_hint *> m_fixit_hints; auto_vec <line_span> m_line_spans; int m_linenum_width; - int m_x_offset; + int m_x_offset_display; }; /* Implementation of "class colorizer". */ @@ -472,10 +554,15 @@ layout_range::layout_range (const expanded_location *start_exploc, - 'w' indicates a point within the range - 'F' indicates the finish of the range (which is within it). - - 'a' indicates a subsequent point *after* the range. */ + - 'a' indicates a subsequent point *after* the range. + + COL_UNIT controls whether we check the byte column or + the display column; one or the other is more convenient + depending on the context. */ bool -layout_range::contains_point (linenum_type row, int column) const +layout_range::contains_point (linenum_type row, int column, + enum column_unit col_unit) const { gcc_assert (m_start.m_line <= m_finish.m_line); /* ...but the equivalent isn't true for the columns; @@ -491,7 +578,7 @@ layout_range::contains_point (linenum_type row, int column) const /* On same line as start of range (corresponding to line 02 in example A and line 03 in example B). */ { - if (column < m_start.m_column) + if (column < m_start.m_columns[col_unit]) /* Points on the starting line of the range, but before the column in which it begins. */ return false; @@ -505,7 +592,7 @@ layout_range::contains_point (linenum_type row, int column) const { /* This is a single-line range. */ gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.m_columns[col_unit]; } } @@ -530,7 +617,7 @@ layout_range::contains_point (linenum_type row, int column) const gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.m_columns[col_unit]; } /* Does this layout_range contain any part of line ROW? */ @@ -548,15 +635,22 @@ layout_range::intersects_line_p (linenum_type row) const #if CHECKING_P -/* A helper function for testing layout_range. */ +/* Create some expanded locations for testing layout_range. The filename + member of the explocs is set to the empty string. This member will only be + inspected by the calls to location_compute_display_column() made from the + layout_point constructors. That function will check for an empty filename + argument and not attempt to open it, rather treating the non-existent data + as if the display width were the same as the byte count. Tests exercising a + real difference between byte count and display width are performed later, + e.g. in test_diagnostic_show_locus_one_liner_utf8(). */ static layout_range make_range (int start_line, int start_col, int end_line, int end_col) { const expanded_location start_exploc - = {"test.c", start_line, start_col, NULL, false}; + = {"", start_line, start_col, NULL, false}; const expanded_location finish_exploc - = {"test.c", end_line, end_col, NULL, false}; + = {"", end_line, end_col, NULL, false}; return layout_range (&start_exploc, &finish_exploc, SHOW_RANGE_WITHOUT_CARET, &start_exploc, 0, NULL); } @@ -574,20 +668,25 @@ test_layout_range_for_single_point () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (point.contains_point (6, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before the line. */ + ASSERT_FALSE (point.contains_point (6, 1, col_unit)); - /* On the line, but before start. */ - ASSERT_FALSE (point.contains_point (7, 9)); + /* On the line, but before start. */ + ASSERT_FALSE (point.contains_point (7, 9, col_unit)); - /* At the point. */ - ASSERT_TRUE (point.contains_point (7, 10)); + /* At the point. */ + ASSERT_TRUE (point.contains_point (7, 10, col_unit)); - /* On the line, after the point. */ - ASSERT_FALSE (point.contains_point (7, 11)); + /* On the line, after the point. */ + ASSERT_FALSE (point.contains_point (7, 11, col_unit)); - /* After the line. */ - ASSERT_FALSE (point.contains_point (8, 1)); + /* After the line. */ + ASSERT_FALSE (point.contains_point (8, 1, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (point.intersects_line_p (6)); @@ -605,26 +704,31 @@ test_layout_range_for_single_line () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (example_a.contains_point (1, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before the line. */ + ASSERT_FALSE (example_a.contains_point (1, 1, col_unit)); - /* On the line, but before start. */ - ASSERT_FALSE (example_a.contains_point (2, 21)); + /* On the line, but before start. */ + ASSERT_FALSE (example_a.contains_point (2, 21, col_unit)); - /* On the line, at the start. */ - ASSERT_TRUE (example_a.contains_point (2, 22)); + /* On the line, at the start. */ + ASSERT_TRUE (example_a.contains_point (2, 22, col_unit)); - /* On the line, within the range. */ - ASSERT_TRUE (example_a.contains_point (2, 23)); + /* On the line, within the range. */ + ASSERT_TRUE (example_a.contains_point (2, 23, col_unit)); - /* On the line, at the end. */ - ASSERT_TRUE (example_a.contains_point (2, 38)); + /* On the line, at the end. */ + ASSERT_TRUE (example_a.contains_point (2, 38, col_unit)); - /* On the line, after the end. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* On the line, after the end. */ + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); - /* After the line. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* After the line. */ + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_a.intersects_line_p (1)); @@ -642,40 +746,45 @@ test_layout_range_for_multiple_lines () /* Tests for layout_range::contains_point. */ - /* Before first line. */ - ASSERT_FALSE (example_b.contains_point (1, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before first line. */ + ASSERT_FALSE (example_b.contains_point (1, 1, col_unit)); - /* On the first line, but before start. */ - ASSERT_FALSE (example_b.contains_point (3, 13)); + /* On the first line, but before start. */ + ASSERT_FALSE (example_b.contains_point (3, 13, col_unit)); - /* At the start. */ - ASSERT_TRUE (example_b.contains_point (3, 14)); + /* At the start. */ + ASSERT_TRUE (example_b.contains_point (3, 14, col_unit)); - /* On the first line, within the range. */ - ASSERT_TRUE (example_b.contains_point (3, 15)); + /* On the first line, within the range. */ + ASSERT_TRUE (example_b.contains_point (3, 15, col_unit)); - /* On an interior line. - The column number should not matter; try various boundary - values. */ - ASSERT_TRUE (example_b.contains_point (4, 1)); - ASSERT_TRUE (example_b.contains_point (4, 7)); - ASSERT_TRUE (example_b.contains_point (4, 8)); - ASSERT_TRUE (example_b.contains_point (4, 9)); - ASSERT_TRUE (example_b.contains_point (4, 13)); - ASSERT_TRUE (example_b.contains_point (4, 14)); - ASSERT_TRUE (example_b.contains_point (4, 15)); + /* On an interior line. + The column number should not matter; try various boundary + values. */ + ASSERT_TRUE (example_b.contains_point (4, 1, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 7, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 8, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 9, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 13, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 14, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 15, col_unit)); - /* On the final line, before the end. */ - ASSERT_TRUE (example_b.contains_point (5, 7)); + /* On the final line, before the end. */ + ASSERT_TRUE (example_b.contains_point (5, 7, col_unit)); - /* On the final line, at the end. */ - ASSERT_TRUE (example_b.contains_point (5, 8)); + /* On the final line, at the end. */ + ASSERT_TRUE (example_b.contains_point (5, 8, col_unit)); - /* On the final line, after the end. */ - ASSERT_FALSE (example_b.contains_point (5, 9)); + /* On the final line, after the end. */ + ASSERT_FALSE (example_b.contains_point (5, 9, col_unit)); - /* After the line. */ - ASSERT_FALSE (example_b.contains_point (6, 1)); + /* After the line. */ + ASSERT_FALSE (example_b.contains_point (6, 1, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_b.intersects_line_p (2)); @@ -687,13 +796,13 @@ test_layout_range_for_multiple_lines () #endif /* #if CHECKING_P */ -/* Given a source line LINE of length LINE_WIDTH, determine the width - without any trailing whitespace. */ +/* Given a source line LINE of length LINE_BYTES bytes, determine the length + (still in bytes, not display cols) without any trailing whitespace. */ static int -get_line_width_without_trailing_whitespace (const char *line, int line_width) +get_line_bytes_without_trailing_whitespace (const char *line, int line_bytes) { - int result = line_width; + int result = line_bytes; while (result > 0) { char ch = line[result - 1]; @@ -703,7 +812,7 @@ get_line_width_without_trailing_whitespace (const char *line, int line_width) break; } gcc_assert (result >= 0); - gcc_assert (result <= line_width); + gcc_assert (result <= line_bytes); gcc_assert (result == 0 || (line[result - 1] != ' ' && line[result -1] != '\t' @@ -713,21 +822,21 @@ get_line_width_without_trailing_whitespace (const char *line, int line_width) #if CHECKING_P -/* A helper function for testing get_line_width_without_trailing_whitespace. */ +/* A helper function for testing get_line_bytes_without_trailing_whitespace. */ static void -assert_eq (const char *line, int expected_width) +assert_eq (const char *line, int expected_bytes) { int actual_value - = get_line_width_without_trailing_whitespace (line, strlen (line)); - ASSERT_EQ (actual_value, expected_width); + = get_line_bytes_without_trailing_whitespace (line, strlen (line)); + ASSERT_EQ (actual_value, expected_bytes); } -/* Verify that get_line_width_without_trailing_whitespace is sane for +/* Verify that get_line_bytes_without_trailing_whitespace is sane for various inputs. It is not required to handle newlines. */ static void -test_get_line_width_without_trailing_whitespace () +test_get_line_bytes_without_trailing_whitespace () { assert_eq ("", 0); assert_eq (" ", 0); @@ -835,7 +944,7 @@ fixit_cmp (const void *p_a, const void *p_b) sanely print, populating m_layout_ranges and m_fixit_hints. Determine the range of lines that we will print, splitting them up into an ordered list of disjoint spans of contiguous line numbers. - Determine m_x_offset, to ensure that the primary caret + Determine m_x_offset_display, to ensure that the primary caret will fit within the max_width provided by the diagnostic_context. */ layout::layout (diagnostic_context * context, @@ -853,7 +962,7 @@ layout::layout (diagnostic_context * context, m_fixit_hints (richloc->get_num_fixit_hints ()), m_line_spans (1 + richloc->get_num_locations ()), m_linenum_width (0), - m_x_offset (0) + m_x_offset_display (0) { for (unsigned int idx = 0; idx < richloc->get_num_locations (); idx++) { @@ -875,45 +984,16 @@ layout::layout (diagnostic_context * context, /* Sort m_fixit_hints. */ m_fixit_hints.qsort (fixit_cmp); - /* Populate m_line_spans. */ + /* Populate the indicated members. */ calculate_line_spans (); - - /* Determine m_linenum_width. */ - gcc_assert (m_line_spans.length () > 0); - const line_span *last_span = &m_line_spans[m_line_spans.length () - 1]; - int highest_line = last_span->m_last_line; - if (highest_line < 0) - highest_line = 0; - m_linenum_width = num_digits (highest_line); - /* If we're showing jumps in the line-numbering, allow at least 3 chars. */ - if (m_line_spans.length () > 1) - m_linenum_width = MAX (m_linenum_width, 3); - /* If there's a minimum margin width, apply it (subtracting 1 for the space - after the line number. */ - m_linenum_width = MAX (m_linenum_width, context->min_margin_width - 1); - - /* Adjust m_x_offset. - Center the primary caret to fit in max_width; all columns - will be adjusted accordingly. */ - size_t max_width = m_context->caret_max_width; - char_span line = location_get_source_line (m_exploc.file, m_exploc.line); - if (line && (size_t)m_exploc.column <= line.length ()) - { - size_t right_margin = CARET_LINE_MARGIN; - size_t column = m_exploc.column; - if (m_show_line_numbers_p) - column += m_linenum_width + 2; - right_margin = MIN (line.length () - column, right_margin); - right_margin = max_width - right_margin; - if (line.length () >= max_width && column > right_margin) - m_x_offset = column - right_margin; - gcc_assert (m_x_offset >= 0); - } + calculate_linenum_width (); + calculate_x_offset_display (); if (context->show_ruler_p) - show_ruler (m_x_offset + max_width); + show_ruler (m_x_offset_display + m_context->caret_max_width); } + /* Attempt to add LOC_RANGE to m_layout_ranges, filtering them to those that we can sanely print. @@ -1086,7 +1166,7 @@ layout::get_expanded_location (const line_span *line_span) const { expanded_location exploc = m_exploc; exploc.line = lr->m_start.m_line; - exploc.column = lr->m_start.m_column; + exploc.column = lr->m_start.m_columns[CU_BYTES]; return exploc; } } @@ -1251,25 +1331,122 @@ layout::calculate_line_spans () } } +/* Determine how many display columns need to be reserved for line numbers, + based on the largest line number that will be needed, and populate + m_linenum_width. */ + +void +layout::calculate_linenum_width () +{ + gcc_assert (m_line_spans.length () > 0); + const line_span *last_span = &m_line_spans[m_line_spans.length () - 1]; + int highest_line = last_span->m_last_line; + if (highest_line < 0) + highest_line = 0; + m_linenum_width = num_digits (highest_line); + /* If we're showing jumps in the line-numbering, allow at least 3 chars. */ + if (m_line_spans.length () > 1) + m_linenum_width = MAX (m_linenum_width, 3); + /* If there's a minimum margin width, apply it (subtracting 1 for the space + after the line number. */ + m_linenum_width = MAX (m_linenum_width, m_context->min_margin_width - 1); +} + +/* Calculate m_x_offset_display, which improves readability in case the source + line of interest is longer than the user's display. All lines output will be + shifted to the left (so that their beginning is no longer displayed) by + m_x_offset_display display columns, so that the caret is in a reasonable + location. */ + +void +layout::calculate_x_offset_display () +{ + m_x_offset_display = 0; + + const int max_width = m_context->caret_max_width; + if (!max_width) + { + /* Nothing to do, the width is not capped. */ + return; + } + + const char_span line = location_get_source_line (m_exploc.file, + m_exploc.line); + if (!line) + { + /* Nothing to do, we couldn't find the source line. */ + return; + } + int caret_display_column = m_exploc.m_display_col; + const int line_bytes + = get_line_bytes_without_trailing_whitespace (line.get_buffer (), + line.length ()); + int eol_display_column + = cpp_display_width (line.get_buffer (), line_bytes); + if (caret_display_column > eol_display_column + || !caret_display_column) + { + /* This does not make sense, so don't try to do anything in this case. */ + return; + } + + /* Adjust caret and eol positions to include the left margin. If we are + outputting line numbers, then the left margin is equal to m_linenum_width + plus three for the " | " which follows it. Otherwise the left margin width + is equal to 1, because layout::print_source_line() will prefix each line + with a space. */ + const int source_display_cols = eol_display_column; + int left_margin_size = 1; + if (m_show_line_numbers_p) + left_margin_size = m_linenum_width + 3; + caret_display_column += left_margin_size; + eol_display_column += left_margin_size; + + if (eol_display_column <= max_width) + { + /* Nothing to do, everything fits in the display. */ + return; + } + + /* The line is too long for the display. Calculate an offset such that the + caret is not too close to the right edge of the screen. It will be + CARET_LINE_MARGIN display columns from the right edge, unless it is closer + than that to the end of the source line anyway. */ + int right_margin_size = CARET_LINE_MARGIN; + right_margin_size = MIN (eol_display_column - caret_display_column, + right_margin_size); + if (right_margin_size + left_margin_size >= max_width) + { + /* The max_width is very small, so anything we try to do will not be very + effective; just punt in this case and output with no offset. */ + return; + } + const int max_caret_display_column = max_width - right_margin_size; + if (caret_display_column > max_caret_display_column) + { + m_x_offset_display = caret_display_column - max_caret_display_column; + /* Make sure we don't offset the line into oblivion. */ + static const int min_cols_visible = 2; + if (source_display_cols - m_x_offset_display < min_cols_visible) + m_x_offset_display = 0; + } +} + /* Print line ROW of source code, potentially colorized at any ranges, and populate *LBOUNDS_OUT. - LINE is the source line (not necessarily 0-terminated) and LINE_WIDTH - is its width. */ + LINE is the source line (not necessarily 0-terminated) and LINE_BYTES + is its length in bytes. + This function deals only with byte offsets, not display columns, so + m_x_offset_display must be converted from display to byte units. In + particular, LINE_BYTES and LBOUNDS_OUT are in bytes. */ void -layout::print_source_line (linenum_type row, const char *line, int line_width, +layout::print_source_line (linenum_type row, const char *line, int line_bytes, line_bounds *lbounds_out) { m_colorizer.set_normal_text (); - /* We will stop printing the source line at any trailing - whitespace. */ - line_width = get_line_width_without_trailing_whitespace (line, - line_width); - line += m_x_offset; - pp_emit_prefix (m_pp); - if (m_show_line_numbers_p) { int width = num_digits (row); @@ -1279,10 +1456,31 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, } else pp_space (m_pp); + + /* We will stop printing the source line at any trailing whitespace, and start + printing it as per m_x_offset_display. */ + line_bytes = get_line_bytes_without_trailing_whitespace (line, + line_bytes); + int x_offset_bytes = 0; + if (m_x_offset_display) + { + x_offset_bytes = cpp_display_column_to_byte_column (line, line_bytes, + m_x_offset_display); + /* In case the leading portion of the line that will be skipped over ends + with a character with wcwidth > 1, then it is possible we skipped too + much, so account for that by padding with spaces. */ + const int overage + = cpp_byte_column_to_display_column (line, line_bytes, x_offset_bytes) + - m_x_offset_display; + for (int column = 0; column < overage; ++column) + pp_space (m_pp); + line += x_offset_bytes; + } + + /* Print the line. */ int first_non_ws = INT_MAX; int last_non_ws = 0; - int column; - for (column = 1 + m_x_offset; column <= line_width; column++) + for (int col_byte = 1 + x_offset_bytes; col_byte <= line_bytes; col_byte++) { /* Assuming colorization is enabled for the caret and underline characters, we may also colorize the associated characters @@ -1300,8 +1498,9 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, { bool in_range_p; point_state state; - in_range_p = get_state_at_point (row, column, + in_range_p = get_state_at_point (row, col_byte, 0, INT_MAX, + CU_BYTES, &state); if (in_range_p) m_colorizer.set_range (state.range_idx); @@ -1313,9 +1512,9 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, c = ' '; if (c != ' ') { - last_non_ws = column; + last_non_ws = col_byte; if (first_non_ws == INT_MAX) - first_non_ws = column; + first_non_ws = col_byte; } pp_character (m_pp, c); line++; @@ -1365,24 +1564,26 @@ layout::start_annotation_line (char margin_char) const } /* Print a line consisting of the caret/underlines for the given - source line. */ + source line. This function works with display columns, rather than byte + counts; in particular, LBOUNDS should be in display column units. */ void layout::print_annotation_line (linenum_type row, const line_bounds lbounds) { - int x_bound = get_x_bound_for_row (row, m_exploc.column, + int x_bound = get_x_bound_for_row (row, m_exploc.m_display_col, lbounds.m_last_non_ws); start_annotation_line (); pp_space (m_pp); - for (int column = 1 + m_x_offset; column < x_bound; column++) + for (int column = 1 + m_x_offset_display; column < x_bound; column++) { bool in_range_p; point_state state; in_range_p = get_state_at_point (row, column, lbounds.m_first_non_ws, lbounds.m_last_non_ws, + CU_DISPLAY_COLS, &state); if (in_range_p) { @@ -1420,9 +1621,11 @@ class line_label public: line_label (int state_idx, int column, label_text text) : m_state_idx (state_idx), m_column (column), - m_text (text), m_length (strlen (text.m_buffer)), - m_label_line (0), m_has_vbar (true) - {} + m_text (text), m_label_line (0), m_has_vbar (true) + { + const int bytes = strlen (text.m_buffer); + m_display_width = cpp_display_width (text.m_buffer, bytes); + } /* Sorting is primarily by column, then by state index. */ static int comparator (const void *p1, const void *p2) @@ -1441,7 +1644,7 @@ public: int m_state_idx; int m_column; label_text m_text; - size_t m_length; + size_t m_display_width; int m_label_line; bool m_has_vbar; }; @@ -1467,8 +1670,9 @@ layout::print_any_labels (linenum_type row) continue; /* Reject labels that aren't fully visible due to clipping - by m_x_offset. */ - if (range->m_caret.m_column <= m_x_offset) + by m_x_offset_display. */ + const int disp_col = range->m_caret.m_columns[CU_DISPLAY_COLS]; + if (disp_col <= m_x_offset_display) continue; label_text text; @@ -1480,7 +1684,7 @@ layout::print_any_labels (linenum_type row) if (text.m_buffer == NULL) continue; - labels.safe_push (line_label (i, range->m_caret.m_column, text)); + labels.safe_push (line_label (i, disp_col, text)); } } @@ -1530,7 +1734,7 @@ layout::print_any_labels (linenum_type row) FOR_EACH_VEC_ELT_REVERSE (labels, i, label) { /* Would this label "touch" or overlap the next label? */ - if (label->m_column + label->m_length >= (size_t)next_column) + if (label->m_column + label->m_display_width >= (size_t)next_column) { max_label_line++; @@ -1554,7 +1758,7 @@ layout::print_any_labels (linenum_type row) { start_annotation_line (); pp_space (m_pp); - int column = 1 + m_x_offset; + int column = 1 + m_x_offset_display; line_label *label; FOR_EACH_VEC_ELT (labels, i, label) { @@ -1569,7 +1773,7 @@ layout::print_any_labels (linenum_type row) m_colorizer.set_range (label->m_state_idx); pp_string (m_pp, label->m_text.m_buffer); m_colorizer.set_normal_text (); - column += label->m_length; + column += label->m_display_width; } else if (label->m_has_vbar) { @@ -1636,7 +1840,7 @@ layout::print_leading_fixits (linenum_type row) /* Subroutine of layout::print_trailing_fixits. Determine if the annotation line printed for LINE contained - the exact range from START_COLUMN to FINISH_COLUMN. */ + the exact range from START_COLUMN to FINISH_COLUMN (in display units). */ bool layout::annotation_line_showed_range_p (linenum_type line, int start_column, @@ -1646,9 +1850,9 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, int i; FOR_EACH_VEC_ELT (m_layout_ranges, i, range) if (range->m_start.m_line == line - && range->m_start.m_column == start_column + && range->m_start.m_columns[CU_DISPLAY_COLS] == start_column && range->m_finish.m_line == line - && range->m_finish.m_column == finish_column) + && range->m_finish.m_columns[CU_DISPLAY_COLS] == finish_column) return true; return false; } @@ -1735,7 +1939,7 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, and is thus printed as desired. */ -/* A range of columns within a line. */ +/* A range of (byte or display) columns within a line. */ class column_range { @@ -1755,32 +1959,51 @@ public: int finish; }; -/* Get the range of columns that HINT would affect. */ - +/* Get the range of bytes or display columns that HINT would affect. */ static column_range -get_affected_columns (const fixit_hint *hint) +get_affected_range (const fixit_hint *hint, enum column_unit col_unit) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; + expanded_location exploc_start = expand_location (hint->get_start_loc ()); + expanded_location exploc_finish = expand_location (hint->get_next_loc ()); + --exploc_finish.column; + int start_column; + int finish_column; + if (col_unit == CU_DISPLAY_COLS) + { + start_column = location_compute_display_column (exploc_start); + if (hint->insertion_p ()) + finish_column = start_column - 1; + else + finish_column = location_compute_display_column (exploc_finish); + } + else + { + start_column = exploc_start.column; + finish_column = exploc_finish.column; + } return column_range (start_column, finish_column); } -/* Get the range of columns that would be printed for HINT. */ +/* Get the range of display columns that would be printed for HINT. */ static column_range get_printed_columns (const fixit_hint *hint) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int final_hint_column = start_column + hint->get_length () - 1; + expanded_location exploc = expand_location (hint->get_start_loc ()); + int start_column = location_compute_display_column (exploc); + int hint_width = cpp_display_width (hint->get_string (), + hint->get_length ()); + int final_hint_column = start_column + hint_width - 1; if (hint->insertion_p ()) { return column_range (start_column, final_hint_column); } else { - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; - + exploc = expand_location (hint->get_next_loc ()); + --exploc.column; + int finish_column = location_compute_display_column (exploc); return column_range (start_column, MAX (finish_column, final_hint_column)); } @@ -1794,27 +2017,35 @@ get_printed_columns (const fixit_hint *hint) class correction { public: - correction (column_range affected_columns, + correction (column_range affected_bytes, + column_range affected_columns, column_range printed_columns, const char *new_text, size_t new_text_len) - : m_affected_columns (affected_columns), + : m_affected_bytes (affected_bytes), + m_affected_columns (affected_columns), m_printed_columns (printed_columns), m_text (xstrdup (new_text)), - m_len (new_text_len), + m_byte_length (new_text_len), m_alloc_sz (new_text_len + 1) { + compute_display_cols (); } ~correction () { free (m_text); } bool insertion_p () const { - return m_affected_columns.start == m_affected_columns.finish + 1; + return m_affected_bytes.start == m_affected_bytes.finish + 1; } void ensure_capacity (size_t len); void ensure_terminated (); + void compute_display_cols () + { + m_display_cols = cpp_display_width (m_text, m_byte_length); + } + void overwrite (int dst_offset, const char_span &src_span) { gcc_assert (dst_offset >= 0); @@ -1827,6 +2058,7 @@ public: is to be inserted, and finish is offset by the length of the replacement. If replace, then the range of columns affected. */ + column_range m_affected_bytes; column_range m_affected_columns; /* If insert, then start: the column before which the text @@ -1837,7 +2069,8 @@ public: /* The text to be inserted/used as replacement. */ char *m_text; - size_t m_len; + size_t m_byte_length; /* Not including null-terminator. */ + int m_display_cols; size_t m_alloc_sz; }; @@ -1862,8 +2095,8 @@ void correction::ensure_terminated () { /* 0-terminate the buffer. */ - gcc_assert (m_len < m_alloc_sz); - m_text[m_len] = '\0'; + gcc_assert (m_byte_length < m_alloc_sz); + m_text[m_byte_length] = '\0'; } /* A list of corrections affecting a particular line. @@ -1925,7 +2158,8 @@ source_line::source_line (const char *filename, int line) void line_corrections::add_hint (const fixit_hint *hint) { - column_range affected_columns = get_affected_columns (hint); + column_range affected_bytes = get_affected_range (hint, CU_BYTES); + column_range affected_columns = get_affected_range (hint, CU_DISPLAY_COLS); column_range printed_columns = get_printed_columns (hint); /* Potentially consolidate. */ @@ -1936,8 +2170,8 @@ line_corrections::add_hint (const fixit_hint *hint) /* The following consolidation code assumes that the fix-it hints have been sorted by start (done within layout's ctor). */ - gcc_assert (affected_columns.start - >= last_correction->m_affected_columns.start); + gcc_assert (affected_bytes.start + >= last_correction->m_affected_bytes.start); gcc_assert (printed_columns.start >= last_correction->m_printed_columns.start); @@ -1949,8 +2183,8 @@ line_corrections::add_hint (const fixit_hint *hint) Attempt to inject a "replace" correction from immediately after the end of the last hint to immediately before the start of the next hint. */ - column_range between (last_correction->m_affected_columns.finish + 1, - printed_columns.start - 1); + column_range between (last_correction->m_affected_bytes.finish + 1, + affected_bytes.start - 1); /* Try to read the source. */ source_line line (m_filename, m_row); @@ -1959,33 +2193,39 @@ line_corrections::add_hint (const fixit_hint *hint) /* Consolidate into the last correction: add a no-op "replace" of the "between" text, and add the text from the new hint. */ - int old_len = last_correction->m_len; - gcc_assert (old_len >= 0); - int between_len = between.finish + 1 - between.start; - gcc_assert (between_len >= 0); - int new_len = old_len + between_len + hint->get_length (); - gcc_assert (new_len >= 0); - last_correction->ensure_capacity (new_len); + int old_byte_len = last_correction->m_byte_length; + gcc_assert (old_byte_len >= 0); + int between_byte_len = between.finish + 1 - between.start; + gcc_assert (between_byte_len >= 0); + int new_byte_len + = old_byte_len + between_byte_len + hint->get_length (); + gcc_assert (new_byte_len >= 0); + last_correction->ensure_capacity (new_byte_len); last_correction->overwrite - (old_len, + (old_byte_len, line.as_span ().subspan (between.start - 1, between.finish + 1 - between.start)); - last_correction->overwrite (old_len + between_len, + last_correction->overwrite (old_byte_len + between_byte_len, char_span (hint->get_string (), hint->get_length ())); - last_correction->m_len = new_len; + last_correction->m_byte_length = new_byte_len; last_correction->ensure_terminated (); + last_correction->m_affected_bytes.finish + = affected_bytes.finish; last_correction->m_affected_columns.finish = affected_columns.finish; + int prev_display_cols = last_correction->m_display_cols; + last_correction->compute_display_cols (); last_correction->m_printed_columns.finish - += between_len + hint->get_length (); + += last_correction->m_display_cols - prev_display_cols; return; } } } /* If no consolidation happened, add a new correction instance. */ - m_corrections.safe_push (new correction (affected_columns, + m_corrections.safe_push (new correction (affected_bytes, + affected_columns, printed_columns, hint->get_string (), hint->get_length ())); @@ -2018,7 +2258,7 @@ layout::print_trailing_fixits (linenum_type row) /* Now print the corrections. */ unsigned i; correction *c; - int column = m_x_offset; + int column = m_x_offset_display; if (!corrections.m_corrections.is_empty ()) start_annotation_line (); @@ -2034,7 +2274,7 @@ layout::print_trailing_fixits (linenum_type row) m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } else { @@ -2046,7 +2286,7 @@ layout::print_trailing_fixits (linenum_type row) int finish_column = c->m_affected_columns.finish; if (!annotation_line_showed_range_p (row, start_column, finish_column) - || c->m_len == 0) + || c->m_byte_length == 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_delete (); @@ -2057,13 +2297,13 @@ layout::print_trailing_fixits (linenum_type row) /* Print the replacement text. REPLACE also covers removals, so only do this extra work (potentially starting a new line) if we have actual replacement text. */ - if (c->m_len > 0) + if (c->m_byte_length > 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } } } @@ -2084,12 +2324,14 @@ layout::print_newline () /* Return true if (ROW/COLUMN) is within a range of the layout. If it returns true, OUT_STATE is written to, with the range index, and whether we should draw the caret at - (ROW/COLUMN) (as opposed to an underline). */ + (ROW/COLUMN) (as opposed to an underline). COL_UNIT controls + whether all inputs and outputs are in bytes or display column units. */ bool layout::get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + enum column_unit col_unit, /* Outputs. */ point_state *out_state) { @@ -2102,7 +2344,7 @@ layout::get_state_at_point (/* Inputs. */ source colorization. */ continue; - if (range->contains_point (row, column)) + if (range->contains_point (row, column, col_unit)) { out_state->range_idx = i; @@ -2110,7 +2352,7 @@ layout::get_state_at_point (/* Inputs. */ out_state->draw_caret_p = false; if (range->m_range_display_kind == SHOW_RANGE_WITH_CARET && row == range->m_caret.m_line - && column == range->m_caret.m_column) + && column == range->m_caret.m_columns[col_unit]) out_state->draw_caret_p = true; /* Within a multiline range, don't display any underline @@ -2130,11 +2372,11 @@ layout::get_state_at_point (/* Inputs. */ /* Helper function for use by layout::print_line when printing the annotation line under the source line. - Get the column beyond the rightmost one that could contain a caret or - range marker, given that we stop rendering at trailing whitespace. + Get the display column beyond the rightmost one that could contain a caret + or range marker, given that we stop rendering at trailing whitespace. ROW is the source line within the given file. - CARET_COLUMN is the column of range 0's caret. - LAST_NON_WS_COLUMN is the last column containing a non-whitespace + CARET_COLUMN is the display column of range 0's caret. + LAST_NON_WS_COLUMN is the last display column containing a non-whitespace character of source (as determined when printing the source line). */ int @@ -2153,8 +2395,9 @@ layout::get_x_bound_for_row (linenum_type row, int caret_column, { /* On the final line within a range; ensure that we render up to the end of the range. */ - if (result <= range->m_finish.m_column) - result = range->m_finish.m_column + 1; + const int disp_col = range->m_finish.m_columns[CU_DISPLAY_COLS]; + if (result <= disp_col) + result = disp_col + 1; } else if (row < range->m_finish.m_line) { @@ -2183,7 +2426,7 @@ layout::move_to_column (int *column, int dest_column, bool add_left_margin) print_newline (); if (add_left_margin) start_annotation_line (); - *column = m_x_offset; + *column = m_x_offset_display; } while (*column < dest_column) @@ -2204,7 +2447,7 @@ layout::show_ruler (int max_column) const { start_annotation_line (); pp_space (m_pp); - for (int column = 1 + m_x_offset; column <= max_column; column++) + for (int column = 1 + m_x_offset_display; column <= max_column; column++) if (column % 10 == 0) pp_character (m_pp, '0' + (column / 100) % 10); else @@ -2215,7 +2458,7 @@ layout::show_ruler (int max_column) const /* Tens. */ start_annotation_line (); pp_space (m_pp); - for (int column = 1 + m_x_offset; column <= max_column; column++) + for (int column = 1 + m_x_offset_display; column <= max_column; column++) if (column % 10 == 0) pp_character (m_pp, '0' + (column / 10) % 10); else @@ -2225,7 +2468,7 @@ layout::show_ruler (int max_column) const /* Units. */ start_annotation_line (); pp_space (m_pp); - for (int column = 1 + m_x_offset; column <= max_column; column++) + for (int column = 1 + m_x_offset_display; column <= max_column; column++) pp_character (m_pp, '0' + (column % 10)); pp_newline (m_pp); } @@ -2245,7 +2488,11 @@ layout::print_line (linenum_type row) print_leading_fixits (row); print_source_line (row, line.get_buffer (), line.length (), &lbounds); if (should_print_annotation_line_p (row)) - print_annotation_line (row, lbounds); + { + if (lbounds.m_first_non_ws != INT_MAX) + lbounds.convert_to_display_cols (line); + print_annotation_line (row, lbounds); + } if (m_show_labels_p) print_any_labels (row); print_trailing_fixits (row); @@ -2339,6 +2586,162 @@ namespace selftest { /* Selftests for diagnostic_show_locus. */ +/* For precise tests of the layout, make clear where the source line will + start. test_left_margin sets the total byte count from the left side of the + screen to the start of source lines, after the line number and the separator, + which consists of the three characters " | ". */ +static const int test_linenum_sep = 3; +static const int test_left_margin = 7; + +/* Helper function for test_layout_x_offset_display_utf8(). */ +static void +test_offset_impl (int caret_byte_col, int max_width, + int expected_x_offset_display, + int left_margin = test_left_margin) +{ + test_diagnostic_context dc; + dc.caret_max_width = max_width; + /* diagnostic_context::min_margin_width sets the minimum space reserved for + the line number plus one space after. */ + dc.min_margin_width = left_margin - test_linenum_sep + 1; + dc.show_line_numbers_p = true; + rich_location richloc (line_table, + linemap_position_for_column (line_table, + caret_byte_col)); + layout test_layout (&dc, &richloc, DK_ERROR); + ASSERT_EQ (left_margin - test_linenum_sep, + test_layout.get_linenum_width ()); + ASSERT_EQ (expected_x_offset_display, + test_layout.get_x_offset_display ()); +} + +/* Test that layout::calculate_x_offset_display() works. */ +static void +test_layout_x_offset_display_utf8 (const line_table_case &case_) +{ + + const char *content + = "This line is very long, so that we can use it to test the logic for " + "clipping long lines. Also this: \xf0\x9f\x98\x82\xf0\x9f\x98\x82 is a " + "pair of emojis that occupies 8 bytes and 4 display columns, starting at " + "column #102.\n"; + + const int line_bytes = strlen (content) - 1; + const int line_display_cols = line_bytes - 2*2; + const int emoji_col = 102; + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1); + + location_t line_end = linemap_position_for_column (line_table, line_bytes); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end)); + ASSERT_EQ (1, LOCATION_LINE (line_end)); + ASSERT_EQ (line_bytes, LOCATION_COLUMN (line_end)); + + char_span lspan = location_get_source_line (tmp.get_filename (), 1); + ASSERT_EQ (line_display_cols, + cpp_display_width (lspan.get_buffer (), lspan.length ())); + ASSERT_EQ (line_display_cols, + location_compute_display_column (expand_location (line_end))); + ASSERT_EQ (0, memcmp (lspan.get_buffer () + (emoji_col - 1), + "\xf0\x9f\x98\x82\xf0\x9f\x98\x82", 8)); + + /* (caret_byte, max_width, expected_x_offset_display, [left_margin]) */ + + /* No constraint on the width -> no offset. */ + test_offset_impl (emoji_col, 0, 0); + + /* Caret is before the beginning -> no offset. */ + test_offset_impl (0, 100, 0); + + /* Caret is past the end of the line -> no offset. */ + test_offset_impl (line_bytes+1, 100, 0); + + /* Line fits in the display -> no offset. */ + test_offset_impl (line_bytes, line_display_cols + test_left_margin, 0); + test_offset_impl (emoji_col, line_display_cols + test_left_margin, 0); + + /* Line is too long for the display but caret location is OK + anyway -> no offset. */ + static const int small_width = 24; + test_offset_impl (1, small_width, 0); + + /* Width constraint is very small -> no offset. */ + test_offset_impl (emoji_col, CARET_LINE_MARGIN, 0); + + /* Line would be offset, but due to large line numbers, offsetting + would remove the whole line -> no offset. */ + static const int huge_left_margin = 100; + test_offset_impl (emoji_col, huge_left_margin, 0, huge_left_margin); + + /* Line is the same length as the display, but the line number makes it too + long, so offset is required. Caret is at the end so padding on the right + is not in effect. */ + for (int excess = 1; excess <= 3; ++excess) + test_offset_impl (line_bytes, line_display_cols + test_left_margin - excess, + excess); + + /* Line is much too long for the display, caret is near the end -> + offset should be such that the line fits in the display and caret + remains the same distance from the end that it was. */ + for (int caret_offset = 0, max_offset = MIN (CARET_LINE_MARGIN, 10); + caret_offset <= max_offset; ++caret_offset) + test_offset_impl (line_bytes - caret_offset, small_width, + line_display_cols + test_left_margin - small_width); + + /* As previous case but caret is closer to the middle; now we want it to end + up CARET_LINE_MARGIN bytes from the end. */ + ASSERT_GT (line_display_cols - emoji_col, CARET_LINE_MARGIN); + test_offset_impl (emoji_col, small_width, + emoji_col + test_left_margin + - (small_width - CARET_LINE_MARGIN)); + + /* Test that the source line is offset as expected when printed. */ + { + test_diagnostic_context dc; + dc.caret_max_width = small_width - 6; + dc.min_margin_width = test_left_margin - test_linenum_sep + 1; + dc.show_line_numbers_p = true; + rich_location richloc (line_table, + linemap_position_for_column (line_table, + emoji_col)); + layout test_layout (&dc, &richloc, DK_ERROR); + test_layout.print_line (1); + ASSERT_STREQ (" 1 | \xf0\x9f\x98\x82\xf0\x9f\x98\x82 is a pair of emojis " + "that occupies 8 bytes and 4 display columns, starting at " + "column #102.\n" + " | ^\n\n", + pp_formatted_text (dc.printer)); + } + + /* Similar to the previous example, but now the offset called for would split + the first emoji in the middle of the UTF-8 sequence. Check that we replace + it with a padding space in this case. */ + { + test_diagnostic_context dc; + dc.caret_max_width = small_width - 5; + dc.min_margin_width = test_left_margin - test_linenum_sep + 1; + dc.show_line_numbers_p = true; + rich_location richloc (line_table, + linemap_position_for_column (line_table, + emoji_col + 2)); + layout test_layout (&dc, &richloc, DK_ERROR); + test_layout.print_line (1); + ASSERT_STREQ (" 1 | \xf0\x9f\x98\x82 is a pair of emojis " + "that occupies 8 bytes and 4 display columns, starting at " + "column #102.\n" + " | ^\n\n", + pp_formatted_text (dc.printer)); + } + +} + /* Verify that diagnostic_show_locus works sanely on UNKNOWN_LOCATION. */ static void @@ -2965,97 +3368,642 @@ test_diagnostic_show_locus_one_liner (const line_table_case &case_) test_one_liner_labels (); } -/* Verify that gcc_rich_location::add_location_if_nearby works. */ - -static void -test_add_location_if_nearby (const line_table_case &case_) -{ - /* Create a tempfile and write some text to it. - ...000000000111111111122222222223333333333. - ...123456789012345678901234567890123456789. */ - const char *content - = ("struct same_line { double x; double y; ;\n" /* line 1. */ - "struct different_line\n" /* line 2. */ - "{\n" /* line 3. */ - " double x;\n" /* line 4. */ - " double y;\n" /* line 5. */ - ";\n"); /* line 6. */ - temp_source_file tmp (SELFTEST_LOCATION, ".c", content); - line_table_test ltt (case_); +/* Version of all one-liner tests exercising multibyte awareness. For + simplicity we stick to using two multibyte characters in the test, U+1F602 + == "\xf0\x9f\x98\x82", which uses 4 bytes and 2 display columns, and U+03C0 + == "\xcf\x80", which uses 2 bytes and 1 display column. Note: all of the + below asserts would be easier to read if we used UTF-8 directly in the + string constants, but it seems better not to demand the host compiler + support this, when it isn't otherwise necessary. Instead, whenever an + extended character appears in a string, we put a line break after it so that + all succeeding characters can appear visually at the correct display column. - const line_map_ordinary *ord_map - = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, - tmp.get_filename (), 0)); + All of these work on the following 1-line source file: - linemap_line_start (line_table, 1, 100); + .0000000001111111111222222 display + .1234567890123456789012345 columns + "SS_foo = P_bar.SS_fieldP;\n" + .0000000111111111222222223 byte + .1356789012456789134567891 columns - const location_t final_line_end - = linemap_position_for_line_and_column (line_table, ord_map, 6, 7); + which is set up by test_diagnostic_show_locus_one_liner and calls + them. Here SS represents the two display columns for the U+1F602 emoji and + P represents the one display column for the U+03C0 pi symbol. */ - /* Don't attempt to run the tests if column data might be unavailable. */ - if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) - return; +/* Just a caret. */ - /* Test of add_location_if_nearby on the same line as the - primary location. */ - { - const location_t missing_close_brace_1_39 - = linemap_position_for_line_and_column (line_table, ord_map, 1, 39); - const location_t matching_open_brace_1_18 - = linemap_position_for_line_and_column (line_table, ord_map, 1, 18); - gcc_rich_location richloc (missing_close_brace_1_39); - bool added = richloc.add_location_if_nearby (matching_open_brace_1_18); - ASSERT_TRUE (added); - ASSERT_EQ (2, richloc.get_num_locations ()); - test_diagnostic_context dc; - diagnostic_show_locus (&dc, &richloc, DK_ERROR); - ASSERT_STREQ ("\n" - " struct same_line { double x; double y; ;\n" - " ~ ^\n", - pp_formatted_text (dc.printer)); - } +static void +test_one_liner_simple_caret_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + rich_location richloc (line_table, caret); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n", + pp_formatted_text (dc.printer)); +} - /* Test of add_location_if_nearby on a different line to the - primary location. */ - { - const location_t missing_close_brace_6_1 - = linemap_position_for_line_and_column (line_table, ord_map, 6, 1); - const location_t matching_open_brace_3_1 - = linemap_position_for_line_and_column (line_table, ord_map, 3, 1); - gcc_rich_location richloc (missing_close_brace_6_1); - bool added = richloc.add_location_if_nearby (matching_open_brace_3_1); - ASSERT_FALSE (added); - ASSERT_EQ (1, richloc.get_num_locations ()); - } +/* Caret and range. */ +static void +test_one_liner_caret_and_range_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + location_t start = linemap_position_for_column (line_table, 12); + location_t finish = linemap_position_for_column (line_table, 30); + location_t loc = make_location (caret, start, finish); + rich_location richloc (line_table, loc); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~~^~~~~~~~~~\n", + pp_formatted_text (dc.printer)); } -/* Verify that we print fixits even if they only affect lines - outside those covered by the ranges in the rich_location. */ +/* Multiple ranges and carets. */ static void -test_diagnostic_show_locus_fixit_lines (const line_table_case &case_) +test_one_liner_multiple_carets_and_ranges_utf8 () { - /* Create a tempfile and write some text to it. - ...000000000111111111122222222223333333333. - ...123456789012345678901234567890123456789. */ - const char *content - = ("struct point { double x; double y; };\n" /* line 1. */ - "struct point origin = {x: 0.0,\n" /* line 2. */ - " y\n" /* line 3. */ - "\n" /* line 4. */ - "\n" /* line 5. */ - " : 0.0};\n"); /* line 6. */ - temp_source_file tmp (SELFTEST_LOCATION, ".c", content); - line_table_test ltt (case_); + test_diagnostic_context dc; + location_t foo + = make_location (linemap_position_for_column (line_table, 7), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + dc.caret_chars[0] = 'A'; - const line_map_ordinary *ord_map - = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, - tmp.get_filename (), 0)); + location_t bar + = make_location (linemap_position_for_column (line_table, 16), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + dc.caret_chars[1] = 'B'; - linemap_line_start (line_table, 1, 100); + location_t field + = make_location (linemap_position_for_column (line_table, 26), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + dc.caret_chars[2] = 'C'; + rich_location richloc (line_table, foo); + richloc.add_range (bar, SHOW_RANGE_WITH_CARET); + richloc.add_range (field, SHOW_RANGE_WITH_CARET); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~A~ ~~~B~ ~~~~~C~~~\n", + pp_formatted_text (dc.printer)); +} - const location_t final_line_end - = linemap_position_for_line_and_column (line_table, ord_map, 6, 36); +/* Insertion fix-it hint: adding an "&" to the front of "P_bar.field". */ + +static void +test_one_liner_fixit_insert_before_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 12); + rich_location richloc (line_table, caret); + richloc.add_fixit_insert_before ("&"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " &\n", + pp_formatted_text (dc.printer)); +} + +/* Insertion fix-it hint: adding a "[0]" after "SS_foo". */ + +static void +test_one_liner_fixit_insert_after_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 1); + location_t finish = linemap_position_for_column (line_table, 8); + location_t foo = make_location (start, start, finish); + rich_location richloc (line_table, foo); + richloc.add_fixit_insert_after ("[0]"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~\n" + " [0]\n", + pp_formatted_text (dc.printer)); +} + +/* Removal fix-it hint: removal of the ".SS_fieldP". */ + +static void +test_one_liner_fixit_remove_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 18); + location_t finish = linemap_position_for_column (line_table, 30); + location_t dot = make_location (start, start, finish); + rich_location richloc (line_table, dot); + richloc.add_fixit_remove (); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~\n" + " ----------\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP". */ + +static void +test_one_liner_fixit_replace_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + location_t field = make_location (start, start, finish); + rich_location richloc (line_table, field); + richloc.add_fixit_replace ("m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + but where the caret was elsewhere. */ + +static void +test_one_liner_fixit_replace_non_equal_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + source_range range; + range.m_start = start; + range.m_finish = finish; + richloc.add_fixit_replace (range, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is not indicated in the annotation line, so + it should be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " ---------\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + where the caret was elsewhere, but where a secondary range + exactly covers "field". */ + +static void +test_one_liner_fixit_replace_equal_secondary_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + location_t field = make_location (start, start, finish); + richloc.add_range (field); + richloc.add_fixit_replace (field, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is indicated in the annotation line, + so it shouldn't be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^ ~~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Verify that we can use ad-hoc locations when adding fixits to a + rich_location. */ + +static void +test_one_liner_fixit_validation_adhoc_locations_utf8 () +{ + /* Generate a range that's too long to be packed, so must + be stored as an ad-hoc location (given the defaults + of 5 bits or 0 bits of packed range); 41 columns > 2**5. */ + const location_t c12 = linemap_position_for_column (line_table, 12); + const location_t c52 = linemap_position_for_column (line_table, 52); + const location_t loc = make_location (c12, c12, c52); + + if (c52 > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_TRUE (IS_ADHOC_LOC (loc)); + + /* Insert. */ + { + rich_location richloc (line_table, loc); + richloc.add_fixit_insert_before (loc, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } + + /* Remove. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_remove (range); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " -------------------------------------\n", + pp_formatted_text (dc.printer)); + } + + /* Replace. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_replace (range, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } +} + +/* Test of consolidating insertions at the same location. */ + +static void +test_one_liner_many_fixits_1_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + for (int i = 0; i < 19; i++) + richloc.add_fixit_insert_before (i & 1 ? "@" : "\xcf\x80"); + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@" + "\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Ensure that we can add an arbitrary number of fix-it hints to a + rich_location, even if they are not consolidated. */ + +static void +test_one_liner_many_fixits_2_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + const int nlocs = 19; + int locs[nlocs] = {1, 5, 7, 9, 11, 14, 16, 18, 23, 25, 27, 29, 32, + 34, 36, 38, 40, 42, 44}; + for (int i = 0; i != nlocs; ++i) + { + location_t loc = linemap_position_for_column (line_table, locs[i]); + richloc.add_fixit_insert_before (loc, i & 1 ? "@" : "\xcf\x80"); + } + + ASSERT_EQ (nlocs, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Test of labeling the ranges within a rich_location. */ + +static void +test_one_liner_labels_utf8 () +{ + location_t foo + = make_location (linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + location_t bar + = make_location (linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + location_t field + = make_location (linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + + /* Example where all the labels fit on one line. */ + { + /* These three labels contain multibyte characters such that their byte + lengths are respectively (12, 10, 18), but their display widths are only + (6, 5, 9). All three fit on the line when considering the display + widths, but not when considering the byte widths, so verify that we do + indeed put them all on one line. */ + text_range_label label0 + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); + text_range_label label1 + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label2 + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + "\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + { + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " \xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80" + " \xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + " \xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82" + "\xf0\x9f\x98\x82\xcf\x80\xcf\x80\n", + pp_formatted_text (dc.printer)); + } + + } + + /* Example where the labels need extra lines. */ + { + text_range_label label0 ("label 0\xf0\x9f\x98\x82"); + text_range_label label1 ("label 1\xcf\x80"); + text_range_label label2 ("label 2\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | label 2\xcf\x80\n" + " | label 1\xcf\x80\n" + " label 0\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } + + /* Example of boundary conditions: label 0 and 1 have just enough clearance, + but label 1 just touches label 2. */ + { + text_range_label label0 ("aaaaa\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label1 ("bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82"); + text_range_label label2 ("c"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | c\n" + " aaaaa\xf0\x9f\x98\x82\xcf\x80" + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } +} + +/* Run the various one-liner tests. */ + +static void +test_diagnostic_show_locus_one_liner_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + const char *content + /* Display columns. + 0000000000000000000000011111111111111111111111111111112222222222222 + 1111111122222222345678900000000123456666666677777777890123444444445 */ + = "\xf0\x9f\x98\x82_foo = \xcf\x80_bar.\xf0\x9f\x98\x82_field\xcf\x80;\n"; + /* 0000000000000000000001111111111111111111222222222222222222222233333 + 1111222233334444567890122223333456789999000011112222345678999900001 + Byte columns. */ + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1); + + location_t line_end = linemap_position_for_column (line_table, 31); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end)); + ASSERT_EQ (1, LOCATION_LINE (line_end)); + ASSERT_EQ (31, LOCATION_COLUMN (line_end)); + + char_span lspan = location_get_source_line (tmp.get_filename (), 1); + ASSERT_EQ (25, cpp_display_width (lspan.get_buffer (), lspan.length ())); + ASSERT_EQ (25, location_compute_display_column (expand_location (line_end))); + + test_one_liner_simple_caret_utf8 (); + test_one_liner_caret_and_range_utf8 (); + test_one_liner_multiple_carets_and_ranges_utf8 (); + test_one_liner_fixit_insert_before_utf8 (); + test_one_liner_fixit_insert_after_utf8 (); + test_one_liner_fixit_remove_utf8 (); + test_one_liner_fixit_replace_utf8 (); + test_one_liner_fixit_replace_non_equal_range_utf8 (); + test_one_liner_fixit_replace_equal_secondary_range_utf8 (); + test_one_liner_fixit_validation_adhoc_locations_utf8 (); + test_one_liner_many_fixits_1_utf8 (); + test_one_liner_many_fixits_2_utf8 (); + test_one_liner_labels_utf8 (); +} + +/* Verify that gcc_rich_location::add_location_if_nearby works. */ + +static void +test_add_location_if_nearby (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. + ...000000000111111111122222222223333333333. + ...123456789012345678901234567890123456789. */ + const char *content + = ("struct same_line { double x; double y; ;\n" /* line 1. */ + "struct different_line\n" /* line 2. */ + "{\n" /* line 3. */ + " double x;\n" /* line 4. */ + " double y;\n" /* line 5. */ + ";\n"); /* line 6. */ + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + const line_map_ordinary *ord_map + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, + tmp.get_filename (), 0)); + + linemap_line_start (line_table, 1, 100); + + const location_t final_line_end + = linemap_position_for_line_and_column (line_table, ord_map, 6, 7); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + /* Test of add_location_if_nearby on the same line as the + primary location. */ + { + const location_t missing_close_brace_1_39 + = linemap_position_for_line_and_column (line_table, ord_map, 1, 39); + const location_t matching_open_brace_1_18 + = linemap_position_for_line_and_column (line_table, ord_map, 1, 18); + gcc_rich_location richloc (missing_close_brace_1_39); + bool added = richloc.add_location_if_nearby (matching_open_brace_1_18); + ASSERT_TRUE (added); + ASSERT_EQ (2, richloc.get_num_locations ()); + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " struct same_line { double x; double y; ;\n" + " ~ ^\n", + pp_formatted_text (dc.printer)); + } + + /* Test of add_location_if_nearby on a different line to the + primary location. */ + { + const location_t missing_close_brace_6_1 + = linemap_position_for_line_and_column (line_table, ord_map, 6, 1); + const location_t matching_open_brace_3_1 + = linemap_position_for_line_and_column (line_table, ord_map, 3, 1); + gcc_rich_location richloc (missing_close_brace_6_1); + bool added = richloc.add_location_if_nearby (matching_open_brace_3_1); + ASSERT_FALSE (added); + ASSERT_EQ (1, richloc.get_num_locations ()); + } +} + +/* Verify that we print fixits even if they only affect lines + outside those covered by the ranges in the rich_location. */ + +static void +test_diagnostic_show_locus_fixit_lines (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. + ...000000000111111111122222222223333333333. + ...123456789012345678901234567890123456789. */ + const char *content + = ("struct point { double x; double y; };\n" /* line 1. */ + "struct point origin = {x: 0.0,\n" /* line 2. */ + " y\n" /* line 3. */ + "\n" /* line 4. */ + "\n" /* line 5. */ + " : 0.0};\n"); /* line 6. */ + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + const line_map_ordinary *ord_map + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, + tmp.get_filename (), 0)); + + linemap_line_start (line_table, 1, 100); + + const location_t final_line_end + = linemap_position_for_line_and_column (line_table, ord_map, 6, 36); /* Don't attempt to run the tests if column data might be unavailable. */ if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) @@ -3340,13 +4288,19 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* Unit-test the line_corrections machinery. */ ASSERT_EQ (3, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (12, 12), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, CU_BYTES)); + ASSERT_EQ (column_range (12, 12), + get_affected_range (hint_0, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (18, 18), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, CU_BYTES)); + ASSERT_EQ (column_range (18, 18), + get_affected_range (hint_1, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); const fixit_hint *hint_2 = richloc.get_fixit_hint (2); - ASSERT_EQ (column_range (29, 28), get_affected_columns (hint_2)); + ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, CU_BYTES)); + ASSERT_EQ (column_range (29, 28), + get_affected_range (hint_2, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (29, 29), get_printed_columns (hint_2)); /* Add each hint in turn to a line_corrections instance, @@ -3357,6 +4311,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* The first replace hint by itself. */ lc.add_hint (hint_0); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); @@ -3366,6 +4321,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) lc.add_hint (hint_1); ASSERT_EQ (1, lc.m_corrections.length ()); ASSERT_STREQ ("const_cast<foo *> (", lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); @@ -3375,6 +4331,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) ASSERT_STREQ ("const_cast<foo *> (ptr->field)", lc.m_corrections[0]->m_text); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 41), lc.m_corrections[0]->m_printed_columns); } @@ -3477,6 +4434,246 @@ test_overlapped_fixit_printing (const line_table_case &case_) } } +/* Multibyte-aware version of preceding tests. See comments above + test_one_liner_simple_caret_utf8() too, we use the same two multibyte + characters here. */ + +static void +test_overlapped_fixit_printing_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + + const char *content + /* Display columns. + 00000000000000000000000111111111111111111111111222222222222222223 + 12344444444555555556789012344444444555555556789012345678999999990 */ + = " f\xf0\x9f\x98\x82 *f = (f\xf0\x9f\x98\x82 *)ptr->field\xcf\x80;\n"; + /* 00000000000000000000011111111111111111111112222222222333333333333 + 12344445555666677778901234566667777888899990123456789012333344445 + Byte columns. */ + + temp_source_file tmp (SELFTEST_LOCATION, ".C", content); + line_table_test ltt (case_); + + const line_map_ordinary *ord_map + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, + tmp.get_filename (), 0)); + + linemap_line_start (line_table, 1, 100); + + const location_t final_line_end + = linemap_position_for_line_and_column (line_table, ord_map, 6, 50); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + /* A test for converting a C-style cast to a C++-style cast. */ + const location_t open_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 14); + const location_t close_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 22); + const location_t expr_start + = linemap_position_for_line_and_column (line_table, ord_map, 1, 23); + const location_t expr_finish + = linemap_position_for_line_and_column (line_table, ord_map, 1, 34); + const location_t expr = make_location (expr_start, expr_start, expr_finish); + + /* Various examples of fix-it hints that aren't themselves consolidated, + but for which the *printing* may need consolidation. */ + + /* Example where 3 fix-it hints are printed as one. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "const_cast<"); + richloc.add_fixit_replace (close_paren, "> ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " const_cast<f\xf0\x9f\x98\x82" + " *> (ptr->field\xcf\x80" + ")\n", + pp_formatted_text (dc.printer)); + + /* Unit-test the line_corrections machinery. */ + ASSERT_EQ (3, richloc.get_num_fixit_hints ()); + const fixit_hint *hint_0 = richloc.get_fixit_hint (0); + ASSERT_EQ (column_range (14, 14), get_affected_range (hint_0, CU_BYTES)); + ASSERT_EQ (column_range (12, 12), + get_affected_range (hint_0, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); + const fixit_hint *hint_1 = richloc.get_fixit_hint (1); + ASSERT_EQ (column_range (22, 22), get_affected_range (hint_1, CU_BYTES)); + ASSERT_EQ (column_range (18, 18), + get_affected_range (hint_1, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); + const fixit_hint *hint_2 = richloc.get_fixit_hint (2); + ASSERT_EQ (column_range (35, 34), get_affected_range (hint_2, CU_BYTES)); + ASSERT_EQ (column_range (30, 29), + get_affected_range (hint_2, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (30, 30), get_printed_columns (hint_2)); + + /* Add each hint in turn to a line_corrections instance, + and verify that they are consolidated into one correction instance + as expected. */ + line_corrections lc (tmp.get_filename (), 1); + + /* The first replace hint by itself. */ + lc.add_hint (hint_0); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 14), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); + ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); + + /* After the second replacement hint, they are printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_1); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (", + lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (14, 22), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); + + /* After the final insertion hint, they are all printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_2); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (ptr->field\xcf\x80)", + lc.m_corrections[0]->m_text); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 34), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 29), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 42), lc.m_corrections[0]->m_printed_columns); + } + + /* Example where two are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CAST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CAST (-\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example where none are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CST ( -\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(bar\xf0\x9f\x98\x82 *)"); + source_range victim = {open_paren, close_paren}; + richloc.add_fixit_remove (victim); + + /* This case is actually handled by fixit-consolidation, + rather than by line_corrections. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " (bar\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(long\xf0\x9f\x98\x82 *)"); + source_range victim = {expr_start, expr_finish}; + richloc.add_fixit_remove (victim); + + /* These fixits are not consolidated. */ + ASSERT_EQ (2, richloc.get_num_fixit_hints ()); + + /* But the corrections are. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " (long\xf0\x9f\x98\x82" + " *)(f\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of insertion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before + (open_paren, "L\xf0\x9f\x98\x82NGER THAN THE CAST"); + richloc.add_fixit_insert_after (close_paren, "TEST"); + + /* The first insertion is long enough that if printed naively, + it would overlap with the second. + Verify that they are printed as a single replacement. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " L\xf0\x9f\x98\x82" + "NGER THAN THE CAST(f\xf0\x9f\x98\x82" + " *)TEST\n", + pp_formatted_text (dc.printer)); + } +} + /* Verify that the line_corrections machinery correctly prints overlapping fixit-hints that have been added in the wrong order. @@ -3526,10 +4723,10 @@ test_overlapped_fixit_printing_2 (const line_table_case &case_) /* These fixits should be accepted; they can't be consolidated. */ ASSERT_EQ (2, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (23, 22), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (23, 22), get_affected_range (hint_0, CU_BYTES)); ASSERT_EQ (column_range (23, 23), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (21, 20), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (21, 20), get_affected_range (hint_1, CU_BYTES)); ASSERT_EQ (column_range (21, 21), get_printed_columns (hint_1)); /* Verify that they're printed correctly. */ @@ -3851,15 +5048,19 @@ diagnostic_show_locus_c_tests () test_layout_range_for_single_line (); test_layout_range_for_multiple_lines (); - test_get_line_width_without_trailing_whitespace (); + for_each_line_table_case (test_layout_x_offset_display_utf8); + + test_get_line_bytes_without_trailing_whitespace (); test_diagnostic_show_locus_unknown_location (); for_each_line_table_case (test_diagnostic_show_locus_one_liner); + for_each_line_table_case (test_diagnostic_show_locus_one_liner_utf8); for_each_line_table_case (test_add_location_if_nearby); for_each_line_table_case (test_diagnostic_show_locus_fixit_lines); for_each_line_table_case (test_fixit_consolidation); for_each_line_table_case (test_overlapped_fixit_printing); + for_each_line_table_case (test_overlapped_fixit_printing_utf8); for_each_line_table_case (test_overlapped_fixit_printing_2); for_each_line_table_case (test_fixit_insert_containing_newline); for_each_line_table_case (test_fixit_insert_containing_newline_2); diff --git a/gcc/input.c b/gcc/input.c index 00301ef68dd..1dc6b339afe 100644 --- a/gcc/input.c +++ b/gcc/input.c @@ -908,6 +908,22 @@ make_location (location_t caret, source_range src_range) return COMBINE_LOCATION_DATA (line_table, pure_loc, src_range, NULL); } +/* An expanded_location stores the column in byte units. This function + converts that column to display units. That requires reading the associated + source line in order to calculate the display width. If that cannot be done + for any reason, then returns the byte column as a fallback. */ +int +location_compute_display_column (expanded_location exploc) +{ + if (!(exploc.file && *exploc.file && exploc.line && exploc.column)) + return exploc.column; + char_span line = location_get_source_line (exploc.file, exploc.line); + /* If line is NULL, this function returns exploc.column which is the + desired fallback. */ + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), + exploc.column); +} + /* Dump statistics to stderr about the memory usage of the line_table set of line maps. This also displays some statistics about macro expansion. */ @@ -3590,6 +3606,93 @@ test_line_offset_overflow () ASSERT_NE (ordmap_a, ordmap_b); } +void test_cpp_utf8 () +{ + /* Verify that wcwidth of invalid UTF-8 or control bytes is 1. */ + { + int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8); + ASSERT_EQ (8, w_bad); + int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6); + ASSERT_EQ (6, w_ctrl); + } + + /* Verify that wcwidth of valid UTF-8 is as expected. */ + { + const int w_pi = cpp_display_width ("\xcf\x80", 2); + ASSERT_EQ (1, w_pi); + const int w_emoji = cpp_display_width ("\xf0\x9f\x98\x82", 4); + ASSERT_EQ (2, w_emoji); + const int w_umlaut_precomposed = cpp_display_width ("\xc3\xbf", 2); + ASSERT_EQ (1, w_umlaut_precomposed); + const int w_umlaut_combining = cpp_display_width ("y\xcc\x88", 3); + ASSERT_EQ (1, w_umlaut_combining); + const int w_han = cpp_display_width ("\xe4\xb8\xba", 3); + ASSERT_EQ (2, w_han); + const int w_ascii = cpp_display_width ("GCC", 3); + ASSERT_EQ (3, w_ascii); + const int w_mixed = cpp_display_width ("\xcf\x80 = 3.14 \xf0\x9f\x98\x82" + "\x9f! \xe4\xb8\xba y\xcc\x88", 24); + ASSERT_EQ (18, w_mixed); + } + + /* Verify that cpp_byte_column_to_display_column can go past the end, + and similar edge cases. */ + { + const char *str + /* Display columns. + 111111112345 */ + = "\xcf\x80 abc"; + /* 111122223456 + Byte columns. */ + + ASSERT_EQ (5, cpp_display_width (str, 6)); + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); + } + + /* Verify that cpp_display_column_to_byte_column can go past the end, + and similar edge cases, and check invertibility. */ + { + const char *str + /* Display columns. + 000000000000000000000000000000000000011 + 111111112222222234444444455555555678901 */ + = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; + /* 000000000000000000000000000000000111111 + 111122223333444456666777788889999012345 + Byte columns. */ + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); + + /* Verify that we do not interrupt a UTF-8 sequence. */ + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 1)); + + for (int byte_col = 1; byte_col <= 15; ++byte_col) + { + const int disp_col = cpp_byte_column_to_display_column (str, 15, + byte_col); + const int byte_col2 = cpp_display_column_to_byte_column (str, 15, + disp_col); + + /* If we ask for the display column in the middle of a UTF-8 + sequence, it will return the length of the partial sequence, + matching the behavior of GCC before display column support. + Otherwise check the round trip was successful. */ + if (byte_col < 4) + ASSERT_EQ (byte_col, disp_col); + else if (byte_col >= 6 && byte_col < 9) + ASSERT_EQ (3 + (byte_col - 5), disp_col); + else + ASSERT_EQ (byte_col2, byte_col); + } + } + +} + /* Run all of the selftests within this file. */ void @@ -3631,6 +3734,8 @@ input_c_tests () test_reading_source_line (); test_line_offset_overflow (); + + test_cpp_utf8 (); } } // namespace selftest diff --git a/gcc/input.h b/gcc/input.h index c459bf28553..35e02bd91d5 100644 --- a/gcc/input.h +++ b/gcc/input.h @@ -38,6 +38,7 @@ STATIC_ASSERT (BUILTINS_LOCATION < RESERVED_LOCATION_COUNT); extern bool is_location_from_builtin_token (location_t); extern expanded_location expand_location (location_t); +extern int location_compute_display_column (expanded_location); /* A class capturing the bounds of a buffer, to allow for run-time bounds-checking in a checked build. */ diff --git a/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c b/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c index 3f62edd408e..153bdb2fd89 100644 --- a/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c +++ b/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c @@ -174,7 +174,7 @@ test_show_locus (function *fun) /* Hardcode the "terminal width", to verify the behavior of very wide lines. */ - global_dc->caret_max_width = 70; + global_dc->caret_max_width = 71; if (0 == strcmp (fnname, "test_simple")) { diff --git a/libcpp/charset.c b/libcpp/charset.c index d4574415ac1..956d2dad5c8 100644 --- a/libcpp/charset.c +++ b/libcpp/charset.c @@ -2265,3 +2265,106 @@ cpp_string_location_reader::get_next () m_loc += m_offset_per_column; return result; } + +/* Helper for cpp_byte_column_to_display_column and its inverse. Given a + pointer to a UTF-8-encoded character, compute its display width. *INBUFP + points on entry to the start of the UTF-8 encoding of the character, and + is updated to point just after the last byte of the encoding. *INBYTESLEFTP + contains on entry the remaining size of the buffer into which *INBUFP + points, and this is also updated accordingly. If *INBUFP does not + point to a valid UTF-8-encoded sequence, then it will be treated as a single + byte with display width 1. */ + +static inline int +compute_next_display_width (const uchar **inbufp, size_t *inbytesleftp) +{ + cppchar_t c; + if (one_utf8_to_cppchar (inbufp, inbytesleftp, &c) != 0) + { + /* Input is not convertible to UTF-8. This could be fine, e.g. in a + string literal, so don't complain. Just treat it as if it has a width + of one. */ + ++*inbufp; + --*inbytesleftp; + return 1; + } + + /* one_utf8_to_cppchar() has updated inbufp and inbytesleftp for us. */ + return cpp_wcwidth (c); +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + how many display columns are occupied by the first COLUMN bytes. COLUMN + may exceed DATA_LENGTH, in which case the phantom bytes at the end are + treated as if they have display width 1. */ + +int +cpp_byte_column_to_display_column (const char *data, int data_length, + int column) +{ + int display_col = 0; + const uchar *udata = (const uchar *) data; + const int offset = MAX (0, column - data_length); + size_t inbytesleft = column - offset; + while (inbytesleft) + display_col += compute_next_display_width (&udata, &inbytesleft); + return display_col + offset; +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + the least number of bytes that will result in at least DISPLAY_COL display + columns. The return value may exceed DATA_LENGTH if the entire string does + not occupy enough display columns. */ + +int +cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col) +{ + int column = 0; + const uchar *udata = (const uchar *) data; + size_t inbytesleft = data_length; + while (column < display_col && inbytesleft) + column += compute_next_display_width (&udata, &inbytesleft); + return data_length - inbytesleft + MAX (0, display_col - column); +} + +/* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc, + because that will inspect the user's locale, and in particular in an ASCII + locale, it will not return anything useful for extended characters. But GCC + in other respects (see e.g. _cpp_default_encoding()) behaves as if + everything is UTF-8. We also make some tweaks that are useful for the way + GCC needs to use this data, e.g. tabs and other control characters should be + treated as having width 1. The lookup tables are generated from + contrib/unicode/gen_wcwidth.py and were made by simply calling glibc + wcwidth() on all codepoints, then applying the small tweaks. These tables + are not highly optimized, but for the present purpose of outputting + diagnostics, they are sufficient. */ + +#include "generated_cpp_wcwidth.h" +int cpp_wcwidth (cppchar_t c) +{ + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) + return wcwidth_widths[0]; + + /* Binary search the tables. */ + int begin = 1; + static const int end + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); + int len = end - begin; + do + { + int half = len/2; + int middle = begin + half; + if (c > wcwidth_range_ends[middle]) + { + begin = middle + 1; + len -= half + 1; + } + else + len = half; + } while (len); + + if (__builtin_expect (begin != end, true)) + return wcwidth_widths[begin]; + return 1; +} diff --git a/libcpp/generated_cpp_wcwidth.h b/libcpp/generated_cpp_wcwidth.h new file mode 100644 index 00000000000..ec8b73d3d01 --- /dev/null +++ b/libcpp/generated_cpp_wcwidth.h @@ -0,0 +1,156 @@ +/* Generated by contrib/unicode/gen_wcwidth.py, with the help of glibc's + utf8_gen.py, using version 12.1.0 of the Unicode standard. */ + +static const cppchar_t wcwidth_range_ends[] = { + 0x2ff, 0x36f, 0x482, 0x489, 0x590, 0x5bd, 0x5be, 0x5bf, + 0x5c0, 0x5c2, 0x5c3, 0x5c5, 0x5c6, 0x5c7, 0x60f, 0x61a, + 0x61b, 0x61c, 0x64a, 0x65f, 0x66f, 0x670, 0x6d5, 0x6dc, + 0x6de, 0x6e4, 0x6e6, 0x6e8, 0x6e9, 0x6ed, 0x710, 0x711, + 0x72f, 0x74a, 0x7a5, 0x7b0, 0x7ea, 0x7f3, 0x7fc, 0x7fd, + 0x815, 0x819, 0x81a, 0x823, 0x824, 0x827, 0x828, 0x82d, + 0x858, 0x85b, 0x8d2, 0x8e1, 0x8e2, 0x902, 0x939, 0x93a, + 0x93b, 0x93c, 0x940, 0x948, 0x94c, 0x94d, 0x950, 0x957, + 0x961, 0x963, 0x980, 0x981, 0x9bb, 0x9bc, 0x9c0, 0x9c4, + 0x9cc, 0x9cd, 0x9e1, 0x9e3, 0x9fd, 0x9fe, 0xa00, 0xa02, + 0xa3b, 0xa3c, 0xa40, 0xa42, 0xa46, 0xa48, 0xa4a, 0xa4d, + 0xa50, 0xa51, 0xa6f, 0xa71, 0xa74, 0xa75, 0xa80, 0xa82, + 0xabb, 0xabc, 0xac0, 0xac5, 0xac6, 0xac8, 0xacc, 0xacd, + 0xae1, 0xae3, 0xaf9, 0xaff, 0xb00, 0xb01, 0xb3b, 0xb3c, + 0xb3e, 0xb3f, 0xb40, 0xb44, 0xb4c, 0xb4d, 0xb55, 0xb56, + 0xb61, 0xb63, 0xb81, 0xb82, 0xbbf, 0xbc0, 0xbcc, 0xbcd, + 0xbff, 0xc00, 0xc03, 0xc04, 0xc3d, 0xc40, 0xc45, 0xc48, + 0xc49, 0xc4d, 0xc54, 0xc56, 0xc61, 0xc63, 0xc80, 0xc81, + 0xcbb, 0xcbc, 0xcbe, 0xcbf, 0xcc5, 0xcc6, 0xccb, 0xccd, + 0xce1, 0xce3, 0xcff, 0xd01, 0xd3a, 0xd3c, 0xd40, 0xd44, + 0xd4c, 0xd4d, 0xd61, 0xd63, 0xdc9, 0xdca, 0xdd1, 0xdd4, + 0xdd5, 0xdd6, 0xe30, 0xe31, 0xe33, 0xe3a, 0xe46, 0xe4e, + 0xeb0, 0xeb1, 0xeb3, 0xebc, 0xec7, 0xecd, 0xf17, 0xf19, + 0xf34, 0xf35, 0xf36, 0xf37, 0xf38, 0xf39, 0xf70, 0xf7e, + 0xf7f, 0xf84, 0xf85, 0xf87, 0xf8c, 0xf97, 0xf98, 0xfbc, + 0xfc5, 0xfc6, 0x102c, 0x1030, 0x1031, 0x1037, 0x1038, 0x103a, + 0x103c, 0x103e, 0x1057, 0x1059, 0x105d, 0x1060, 0x1070, 0x1074, + 0x1081, 0x1082, 0x1084, 0x1086, 0x108c, 0x108d, 0x109c, 0x109d, + 0x10ff, 0x115f, 0x11ff, 0x135c, 0x135f, 0x1711, 0x1714, 0x1731, + 0x1734, 0x1751, 0x1753, 0x1771, 0x1773, 0x17b3, 0x17b5, 0x17b6, + 0x17bd, 0x17c5, 0x17c6, 0x17c8, 0x17d3, 0x17dc, 0x17dd, 0x180a, + 0x180e, 0x1884, 0x1886, 0x18a8, 0x18a9, 0x191f, 0x1922, 0x1926, + 0x1928, 0x1931, 0x1932, 0x1938, 0x193b, 0x1a16, 0x1a18, 0x1a1a, + 0x1a1b, 0x1a55, 0x1a56, 0x1a57, 0x1a5e, 0x1a5f, 0x1a60, 0x1a61, + 0x1a62, 0x1a64, 0x1a6c, 0x1a72, 0x1a7c, 0x1a7e, 0x1a7f, 0x1aaf, + 0x1abe, 0x1aff, 0x1b03, 0x1b33, 0x1b34, 0x1b35, 0x1b3a, 0x1b3b, + 0x1b3c, 0x1b41, 0x1b42, 0x1b6a, 0x1b73, 0x1b7f, 0x1b81, 0x1ba1, + 0x1ba5, 0x1ba7, 0x1ba9, 0x1baa, 0x1bad, 0x1be5, 0x1be6, 0x1be7, + 0x1be9, 0x1bec, 0x1bed, 0x1bee, 0x1bf1, 0x1c2b, 0x1c33, 0x1c35, + 0x1c37, 0x1ccf, 0x1cd2, 0x1cd3, 0x1ce0, 0x1ce1, 0x1ce8, 0x1cec, + 0x1ced, 0x1cf3, 0x1cf4, 0x1cf7, 0x1cf9, 0x1dbf, 0x1df9, 0x1dfa, + 0x1dff, 0x200a, 0x200f, 0x2029, 0x202e, 0x205f, 0x2064, 0x2065, + 0x206f, 0x20cf, 0x20f0, 0x2319, 0x231b, 0x2328, 0x232a, 0x23e8, + 0x23ec, 0x23ef, 0x23f0, 0x23f2, 0x23f3, 0x25fc, 0x25fe, 0x2613, + 0x2615, 0x2647, 0x2653, 0x267e, 0x267f, 0x2692, 0x2693, 0x26a0, + 0x26a1, 0x26a9, 0x26ab, 0x26bc, 0x26be, 0x26c3, 0x26c5, 0x26cd, + 0x26ce, 0x26d3, 0x26d4, 0x26e9, 0x26ea, 0x26f1, 0x26f3, 0x26f4, + 0x26f5, 0x26f9, 0x26fa, 0x26fc, 0x26fd, 0x2704, 0x2705, 0x2709, + 0x270b, 0x2727, 0x2728, 0x274b, 0x274c, 0x274d, 0x274e, 0x2752, + 0x2755, 0x2756, 0x2757, 0x2794, 0x2797, 0x27af, 0x27b0, 0x27be, + 0x27bf, 0x2b1a, 0x2b1c, 0x2b4f, 0x2b50, 0x2b54, 0x2b55, 0x2cee, + 0x2cf1, 0x2d7e, 0x2d7f, 0x2ddf, 0x2dff, 0x2e7f, 0x2e99, 0x2e9a, + 0x2ef3, 0x2eff, 0x2fd5, 0x2fef, 0x2ffb, 0x2fff, 0x3029, 0x302d, + 0x303e, 0x3040, 0x3096, 0x3098, 0x309a, 0x30ff, 0x3104, 0x312f, + 0x3130, 0x318e, 0x318f, 0x31ba, 0x31bf, 0x31e3, 0x31ef, 0x321e, + 0x321f, 0x4db5, 0x4dbf, 0x9fef, 0x9fff, 0xa48c, 0xa48f, 0xa4c6, + 0xa66e, 0xa672, 0xa673, 0xa67d, 0xa69d, 0xa69f, 0xa6ef, 0xa6f1, + 0xa801, 0xa802, 0xa805, 0xa806, 0xa80a, 0xa80b, 0xa824, 0xa826, + 0xa8c3, 0xa8c5, 0xa8df, 0xa8f1, 0xa8fe, 0xa8ff, 0xa925, 0xa92d, + 0xa946, 0xa951, 0xa95f, 0xa97c, 0xa97f, 0xa982, 0xa9b2, 0xa9b3, + 0xa9b5, 0xa9b9, 0xa9bb, 0xa9bd, 0xa9e4, 0xa9e5, 0xaa28, 0xaa2e, + 0xaa30, 0xaa32, 0xaa34, 0xaa36, 0xaa42, 0xaa43, 0xaa4b, 0xaa4c, + 0xaa7b, 0xaa7c, 0xaaaf, 0xaab0, 0xaab1, 0xaab4, 0xaab6, 0xaab8, + 0xaabd, 0xaabf, 0xaac0, 0xaac1, 0xaaeb, 0xaaed, 0xaaf5, 0xaaf6, + 0xabe4, 0xabe5, 0xabe7, 0xabe8, 0xabec, 0xabed, 0xabff, 0xd7a3, + 0xf8ff, 0xfa6d, 0xfa6f, 0xfad9, 0xfb1d, 0xfb1e, 0xfdff, 0xfe0f, + 0xfe19, 0xfe1f, 0xfe2f, 0xfe52, 0xfe53, 0xfe66, 0xfe67, 0xfe6b, + 0xfefe, 0xfeff, 0xff00, 0xff60, 0xffdf, 0xffe6, 0xfff8, 0xfffb, + 0x101fc, 0x101fd, 0x102df, 0x102e0, 0x10375, 0x1037a, 0x10a00, 0x10a03, + 0x10a04, 0x10a06, 0x10a0b, 0x10a0f, 0x10a37, 0x10a3a, 0x10a3e, 0x10a3f, + 0x10ae4, 0x10ae6, 0x10d23, 0x10d27, 0x10f45, 0x10f50, 0x11000, 0x11001, + 0x11037, 0x11046, 0x1107e, 0x11081, 0x110b2, 0x110b6, 0x110b8, 0x110ba, + 0x110ff, 0x11102, 0x11126, 0x1112b, 0x1112c, 0x11134, 0x11172, 0x11173, + 0x1117f, 0x11181, 0x111b5, 0x111be, 0x111c8, 0x111cc, 0x1122e, 0x11231, + 0x11233, 0x11234, 0x11235, 0x11237, 0x1123d, 0x1123e, 0x112de, 0x112df, + 0x112e2, 0x112ea, 0x112ff, 0x11301, 0x1133a, 0x1133c, 0x1133f, 0x11340, + 0x11365, 0x1136c, 0x1136f, 0x11374, 0x11437, 0x1143f, 0x11441, 0x11444, + 0x11445, 0x11446, 0x1145d, 0x1145e, 0x114b2, 0x114b8, 0x114b9, 0x114ba, + 0x114be, 0x114c0, 0x114c1, 0x114c3, 0x115b1, 0x115b5, 0x115bb, 0x115bd, + 0x115be, 0x115c0, 0x115db, 0x115dd, 0x11632, 0x1163a, 0x1163c, 0x1163d, + 0x1163e, 0x11640, 0x116aa, 0x116ab, 0x116ac, 0x116ad, 0x116af, 0x116b5, + 0x116b6, 0x116b7, 0x1171c, 0x1171f, 0x11721, 0x11725, 0x11726, 0x1172b, + 0x1182e, 0x11837, 0x11838, 0x1183a, 0x119d3, 0x119d7, 0x119d9, 0x119db, + 0x119df, 0x119e0, 0x11a00, 0x11a0a, 0x11a32, 0x11a38, 0x11a3a, 0x11a3e, + 0x11a46, 0x11a47, 0x11a50, 0x11a56, 0x11a58, 0x11a5b, 0x11a89, 0x11a96, + 0x11a97, 0x11a99, 0x11c2f, 0x11c36, 0x11c37, 0x11c3d, 0x11c3e, 0x11c3f, + 0x11c91, 0x11ca7, 0x11ca9, 0x11cb0, 0x11cb1, 0x11cb3, 0x11cb4, 0x11cb6, + 0x11d30, 0x11d36, 0x11d39, 0x11d3a, 0x11d3b, 0x11d3d, 0x11d3e, 0x11d45, + 0x11d46, 0x11d47, 0x11d8f, 0x11d91, 0x11d94, 0x11d95, 0x11d96, 0x11d97, + 0x11ef2, 0x11ef4, 0x1342f, 0x13438, 0x16aef, 0x16af4, 0x16b2f, 0x16b36, + 0x16f4e, 0x16f4f, 0x16f8e, 0x16f92, 0x16fdf, 0x16fe3, 0x16fff, 0x187f7, + 0x187ff, 0x18af2, 0x1afff, 0x1b11e, 0x1b14f, 0x1b152, 0x1b163, 0x1b167, + 0x1b16f, 0x1b2fb, 0x1bc9c, 0x1bc9e, 0x1bc9f, 0x1bca3, 0x1d166, 0x1d169, + 0x1d172, 0x1d182, 0x1d184, 0x1d18b, 0x1d1a9, 0x1d1ad, 0x1d241, 0x1d244, + 0x1d9ff, 0x1da36, 0x1da3a, 0x1da6c, 0x1da74, 0x1da75, 0x1da83, 0x1da84, + 0x1da9a, 0x1da9f, 0x1daa0, 0x1daaf, 0x1dfff, 0x1e006, 0x1e007, 0x1e018, + 0x1e01a, 0x1e021, 0x1e022, 0x1e024, 0x1e025, 0x1e02a, 0x1e12f, 0x1e136, + 0x1e2eb, 0x1e2ef, 0x1e8cf, 0x1e8d6, 0x1e943, 0x1e94a, 0x1f003, 0x1f004, + 0x1f0ce, 0x1f0cf, 0x1f18d, 0x1f18e, 0x1f190, 0x1f19a, 0x1f1ff, 0x1f202, + 0x1f20f, 0x1f23b, 0x1f23f, 0x1f248, 0x1f24f, 0x1f251, 0x1f25f, 0x1f265, + 0x1f2ff, 0x1f320, 0x1f32c, 0x1f335, 0x1f336, 0x1f37c, 0x1f37d, 0x1f393, + 0x1f39f, 0x1f3ca, 0x1f3ce, 0x1f3d3, 0x1f3df, 0x1f3f0, 0x1f3f3, 0x1f3f4, + 0x1f3f7, 0x1f43e, 0x1f43f, 0x1f440, 0x1f441, 0x1f4fc, 0x1f4fe, 0x1f53d, + 0x1f54a, 0x1f54e, 0x1f54f, 0x1f567, 0x1f579, 0x1f57a, 0x1f594, 0x1f596, + 0x1f5a3, 0x1f5a4, 0x1f5fa, 0x1f64f, 0x1f67f, 0x1f6c5, 0x1f6cb, 0x1f6cc, + 0x1f6cf, 0x1f6d2, 0x1f6d4, 0x1f6d5, 0x1f6ea, 0x1f6ec, 0x1f6f3, 0x1f6fa, + 0x1f7df, 0x1f7eb, 0x1f90c, 0x1f971, 0x1f972, 0x1f976, 0x1f979, 0x1f9a2, + 0x1f9a4, 0x1f9aa, 0x1f9ad, 0x1f9ca, 0x1f9cc, 0x1f9ff, 0x1fa6f, 0x1fa73, + 0x1fa77, 0x1fa7a, 0x1fa7f, 0x1fa82, 0x1fa8f, 0x1fa95, 0x1ffff, 0x2a6d6, + 0x2a6ff, 0x2b734, 0x2b73f, 0x2b81d, 0x2b81f, 0x2cea1, 0x2ceaf, 0x2ebe0, + 0x2f7ff, 0x2fa1d, 0xe0000, 0xe0001, 0xe001f, 0xe007f, 0xe00ff, 0xe01ef, +}; + +static const unsigned char wcwidth_widths[] = { + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 0, 2, 1, 2, 1, 0, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, + 2, 1, 0, 2, 1, 2, 1, 2, 1, 0, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, +}; diff --git a/libcpp/include/cpplib.h b/libcpp/include/cpplib.h index ed108f17bfa..e199aecfa48 100644 --- a/libcpp/include/cpplib.h +++ b/libcpp/include/cpplib.h @@ -1320,4 +1320,15 @@ extern bool cpp_userdef_char_p extern const char * cpp_get_userdef_suffix (const cpp_token *); +/* In charset.c */ +int cpp_byte_column_to_display_column (const char *data, int data_length, + int column); +inline int cpp_display_width (const char *data, int data_length) +{ + return cpp_byte_column_to_display_column (data, data_length, data_length); +} +int cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col); +int cpp_wcwidth (cppchar_t c); + #endif /* ! LIBCPP_CPPLIB_H */ ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-11-26 17:12 ` Lewis Hyatt @ 2019-12-06 15:54 ` David Malcolm 2019-12-06 20:31 ` Lewis Hyatt 0 siblings, 1 reply; 17+ messages in thread From: David Malcolm @ 2019-12-06 15:54 UTC (permalink / raw) To: Lewis Hyatt; +Cc: gcc-patches, joseph On Tue, 2019-11-26 at 11:28 -0500, Lewis Hyatt wrote: > New version 4 patch attached, and responses below too. > Thanks for the various updates; sorry about the delay in responding. [...] > > As noted above, m_x_offset should be renamed to clarify its units > > ("m_x_offset_display"?) > > > > Can you move this calculation of the offset to a subroutine please. > > (I wonder if it can be unit-tested, but don't feel obliged to). > > > > Done. I also split the calculation of m_linenum_width into a > subroutine for consistency, and added new selftests that cover both. > > One thing that came up when setting up the selftests. The existing > code > offsets the caret position by (m_linenum_width + 2) when comparing it > to the > physical end of the display. I think this should be (m_linenum_width > + 3), > because the line number is followed by the three-character string " | > " > prior to the start of the source line. I went ahead and made that > change. This was one part of the patch I wasn't sure about, but I've been re-reading it and have come round. We emit a space after the '|' for m_x_offset's column, which is column 0 for the "no offset" case. There are a few places where move_to_column is used to reset things after a possible newline. I think I've had in my mind the idea that there's an initial space after the '|' that terminates the left margin, and then the source begins, but for some reason I thought that if we were offsetting, then the offset source could potentially begin right up against the '|' character. On re-reading trunk's implementation, I think that that isn't the current behavior, and that we simply have a " | " margin as your patch describes, with the offset source text being printed after it. Indeed, I think we ought to always have at least some indent of the source lines, so that they stand out from the diagnostic lines. > It did require a corresponding change to resolve some new testsuites > failure > afterwards, in this file: > > gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c > > The expected output just needs to shift left by one column, which I > did in > this version of the patch as well. It seems to make sense to me, but > I > wanted to mention in case I am missing something subtle here. I made > a > similar adjustment in case line numbers are not being output; here we > still > output a space before every line so it feels like that should be > taken into > account. > This calculation still does not attempt to take into account whether > pp_print_prefix () will do anything, not sure if that is desired or > not, but > it was the existing behavior. > > I am glad you brought this up, as the logic is a little tricky and > another > issue was fixed when I separated it out and worked through the tests: > some > source lines cannot be offset by exactly as many display columns as > dictated > by m_x_offset_display. For instance, if the offset is 1 column, and > the > portion of the line to be deleted ends with a character of wcwidth 2, > then > it ends up offsetting too much. I added code to pad with a space in > this > case to make it line up again. This is in the selftests as well. Excellent; thanks for doing this. [...] > BTW, bootstrap and reg-test were performed in linux x86-64. Test > results are > the same before and after: > > FAIL 104 104 > PASS 454289 454289 > UNSUPPORTED 10722 10722 > UNTESTED 205 205 > XFAIL 1652 1652 > XPASS 35 35 > > Also I wanted to remind that the three Unicode data files: > > contrib/unicode/EastAsianWidth.txt > contrib/unicode/PropList.txt > contrib/unicode/UnicodeData.txt > > are to be committed along with this this patch but I did not include > them in > the email since they are so large. > > Thanks again for your time, assuming you have the patience to look at > this > again :). > > -Lewis [...] > gcc/testsuite/ChangeLog: > > 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> > > * gcc.dg/plugin/diagnostic_plugin_test_show_locus.c > (test_show_locus): Adjust expected output based on new behavior. To be pedantic, this ChangeLog text seems wrong: I think you're actually tweaking the config to preserve the old expected output given the new x-offset implementation, right? The change in question is: > diff --git a/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c b/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c > index 3f62edd408e..153bdb2fd89 100644 > --- a/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c > +++ b/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c > @@ -174,7 +174,7 @@ test_show_locus (function *fun) > > /* Hardcode the "terminal width", to verify the behavior of > very wide lines. */ > - global_dc->caret_max_width = 70; > + global_dc->caret_max_width = 71; > > if (0 == strcmp (fnname, "test_simple")) > { [...] > diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c > index cb920f6b9d0..472cb604c8b 100644 > --- a/gcc/diagnostic-show-locus.c > +++ b/gcc/diagnostic-show-locus.c [...] > +/* Test that layout::calculate_x_offset_display() works. */ > +static void > +test_layout_x_offset_display_utf8 (const line_table_case &case_) > +{ Thanks for adding selftests for this. > + const char *content > + = "This line is very long, so that we can use it to test the logic for " > + "clipping long lines. Also this: \xf0\x9f\x98\x82\xf0\x9f\x98\x82 is a " > + "pair of emojis that occupies 8 bytes and 4 display columns, starting at " > + "column #102.\n"; > + > + const int line_bytes = strlen (content) - 1; > + const int line_display_cols = line_bytes - 2*2; Please add comments explaining where the "-1" and the "- 2*2" come from in the above; presumably it's for the newline, and for the difference between encoding length and display cols for the 2 emoji chars? [...] > + /* Test that the source line is offset as expected when printed. */ > + { > + test_diagnostic_context dc; > + dc.caret_max_width = small_width - 6; > + dc.min_margin_width = test_left_margin - test_linenum_sep + 1; > + dc.show_line_numbers_p = true; > + rich_location richloc (line_table, > + linemap_position_for_column (line_table, > + emoji_col)); > + layout test_layout (&dc, &richloc, DK_ERROR); > + test_layout.print_line (1); > + ASSERT_STREQ (" 1 | \xf0\x9f\x98\x82\xf0\x9f\x98\x82 is a pair of emojis " > + "that occupies 8 bytes and 4 display columns, starting at " > + "column #102.\n" > + " | ^\n\n", > + pp_formatted_text (dc.printer)); > + } > + > + /* Similar to the previous example, but now the offset called for would split > + the first emoji in the middle of the UTF-8 sequence. Check that we replace > + it with a padding space in this case. */ > + { > + test_diagnostic_context dc; > + dc.caret_max_width = small_width - 5; > + dc.min_margin_width = test_left_margin - test_linenum_sep + 1; > + dc.show_line_numbers_p = true; > + rich_location richloc (line_table, > + linemap_position_for_column (line_table, > + emoji_col + 2)); > + layout test_layout (&dc, &richloc, DK_ERROR); > + test_layout.print_line (1); > + ASSERT_STREQ (" 1 | \xf0\x9f\x98\x82 is a pair of emojis " > + "that occupies 8 bytes and 4 display columns, starting at " > + "column #102.\n" > + " | ^\n\n", > + pp_formatted_text (dc.printer)); > + } Might be nice to turn on the ruler in the dc for these tests (I find it helpful anytime I'm debugging x-offsets) - but it's not essential; up to you. [...] The patch is OK for trunk with the nits above fixed. Do you have commit access? (I've got my own patch [1] that touches diagnostic- show-locus.c which I'll need to refresh once yours goes in); need to remember to include those data files when committing. Thanks very much for fixing this, and sorry again for the delay in reviewing it. Dave [1] https://gcc.gnu.org/ml/gcc-patches/2019-11/msg01515.html ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-12-06 15:54 ` David Malcolm @ 2019-12-06 20:31 ` Lewis Hyatt 2019-12-09 20:12 ` David Malcolm 0 siblings, 1 reply; 17+ messages in thread From: Lewis Hyatt @ 2019-12-06 20:31 UTC (permalink / raw) To: David Malcolm; +Cc: gcc-patches, joseph [-- Attachment #1: Type: text/plain, Size: 4580 bytes --] On Fri, Dec 06, 2019 at 10:54:30AM -0500, David Malcolm wrote: > > Thanks for the various updates; sorry about the delay in responding. > Thanks for taking a look at it again. I didn't think there was a delay... Hopefully final version of the patch is attached. Bootstrap and testsuite were run on linux x86-64. Test results were the same before/after: FAIL 102 102 PASS 455581 455581 UNSUPPORTED 10924 10924 UNTESTED 205 205 XFAIL 1645 1645 XPASS 35 35 A couple comments below too. > > gcc/testsuite/ChangeLog: > > > > 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> > > > > * gcc.dg/plugin/diagnostic_plugin_test_show_locus.c > > (test_show_locus): Adjust expected output based on new behavior. > > To be pedantic, this ChangeLog text seems wrong: I think you're > actually tweaking the config to preserve the old expected output given > the new x-offset implementation, right? The change in question is: I can't get away with anything around here :). Fixed that. BTW, previous patch v4 omitted one other test (gcc.dg/cpp/pr66415-1.c) with a similar problem. This version fixes it with a one-line change similarly. > > + const char *content > > + = "This line is very long, so that we can use it to test the logic for " > > + "clipping long lines. Also this: \xf0\x9f\x98\x82\xf0\x9f\x98\x82 is a " > > + "pair of emojis that occupies 8 bytes and 4 display columns, starting at " > > + "column #102.\n"; > > + > > + const int line_bytes = strlen (content) - 1; > > + const int line_display_cols = line_bytes - 2*2; > > Please add comments explaining where the "-1" and the "- 2*2" come from > in the above; presumably it's for the newline, and for the difference between > encoding length and display cols for the 2 emoji chars? > Correct, added that. > [...] > > > + /* Test that the source line is offset as expected when printed. */ > > + { > > + test_diagnostic_context dc; > > + dc.caret_max_width = small_width - 6; > > + dc.min_margin_width = test_left_margin - test_linenum_sep + 1; > > + dc.show_line_numbers_p = true; > > + rich_location richloc (line_table, > > + linemap_position_for_column (line_table, > > + emoji_col)); > > + layout test_layout (&dc, &richloc, DK_ERROR); > > + test_layout.print_line (1); > > + ASSERT_STREQ (" 1 | \xf0\x9f\x98\x82\xf0\x9f\x98\x82 is a pair of emojis " > > + "that occupies 8 bytes and 4 display columns, starting at " > > + "column #102.\n" > > + " | ^\n\n", > > + pp_formatted_text (dc.printer)); > > + } > > + > > + /* Similar to the previous example, but now the offset called for would split > > + the first emoji in the middle of the UTF-8 sequence. Check that we replace > > + it with a padding space in this case. */ > > + { > > + test_diagnostic_context dc; > > + dc.caret_max_width = small_width - 5; > > + dc.min_margin_width = test_left_margin - test_linenum_sep + 1; > > + dc.show_line_numbers_p = true; > > + rich_location richloc (line_table, > > + linemap_position_for_column (line_table, > > + emoji_col + 2)); > > + layout test_layout (&dc, &richloc, DK_ERROR); > > + test_layout.print_line (1); > > + ASSERT_STREQ (" 1 | \xf0\x9f\x98\x82 is a pair of emojis " > > + "that occupies 8 bytes and 4 display columns, starting at " > > + "column #102.\n" > > + " | ^\n\n", > > + pp_formatted_text (dc.printer)); > > + } > > Might be nice to turn on the ruler in the dc for these tests (I find it > helpful anytime I'm debugging x-offsets) - but it's not essential; up > to you. > Done. > [...] > > The patch is OK for trunk with the nits above fixed. Do you have > commit access? (I've got my own patch [1] that touches diagnostic- > show-locus.c which I'll need to refresh once yours goes in); need to > remember to include those data files when committing. > > Thanks very much for fixing this, and sorry again for the delay in > reviewing it. That's wonderful, thanks very much. Happy to contribute something. I do not have commit access so if you could please apply it, that would be great. Might I also trouble you to please have a look at this one: https://gcc.gnu.org/ml/gcc-patches/2019-10/msg00766.html ? It is very much shorter than this one and fixes just a couple glitches in pretty-print.c -- UTF-8 gets mangled when printed via %q, and line-wrapping shouldn't wrap in the middle of a UTF-8 sequence. That's the only other issue I am aware of as far as diagnostics with multibyte characters go. Thanks again! -Lewis [-- Attachment #2: ChangeLog.txt --] [-- Type: text/plain, Size: 5299 bytes --] /ChangeLog 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * contrib/unicode/from_glibc/unicode_utils.py: Support script from glibc (commit 464cd3) to extract character widths from Unicode data files. * contrib/unicode/from_glibc/utf8_gen.py: Likewise. * contrib/unicode/UnicodeData.txt: Unicode v. 12.1.0 data file. * contrib/unicode/EastAsianWidth.txt: Likewise. * contrib/unicode/PropList.txt: Likewise. * contrib/unicode/gen_wcwidth.py: New utility to generate libcpp/generated_cpp_wcwidth.h with help from the glibc support scripts and the Unicode data files. * contrib/unicode/README: New explanatory file. libcpp/ChangeLog 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * generated_cpp_wcwidth.h: New file generated by ../contrib/unicode/gen_wcwidth.py, supports new cpp_wcwidth function. * charset.c (compute_next_display_width): New function to help implement display columns. (cpp_byte_column_to_display_column): Likewise. (cpp_display_column_to_byte_column): Likewise. (cpp_wcwidth): Likewise. * include/cpplib.h (cpp_byte_column_to_display_column): Declare. (cpp_display_column_to_byte_column): Declare. (cpp_wcwidth): Declare. (cpp_display_width): New function. gcc/ChangeLog 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> PR preprocessor/49973 * input.c (location_compute_display_column): New function to help with multibyte awareness in diagnostics. (test_cpp_utf8): New self-test. (input_c_tests): Call the new test. * input.h (location_compute_display_column): Declare. * diagnostic-show-locus.c: Pervasive changes to add multibyte awareness to all classes and functions. (enum column_unit): New enum. (class exploc_with_display_col): New class. (class layout_point): Convert m_column member to array m_columns[2]. (layout_range::contains_point): Add col_unit argument. (test_layout_range_for_single_point): Pass new argument. (test_layout_range_for_single_line): Likewise. (test_layout_range_for_multiple_lines): Likewise. (line_bounds::convert_to_display_cols): New function. (layout::get_state_at_point): Add col_unit argument. (make_range): Use empty filename rather than dummy filename. (get_line_width_without_trailing_whitespace): Rename to... (get_line_bytes_without_trailing_whitespace): ...this. (test_get_line_width_without_trailing_whitespace): Rename to... (test_get_line_bytes_without_trailing_whitespace): ...this. (class layout): m_exploc changed to exploc_with_display_col from plain expanded_location. (layout::get_linenum_width): New accessor member function. (layout::get_x_offset_display): Likewise. (layout::calculate_linenum_width): New subroutine for the constuctor. (layout::calculate_x_offset_display): Likewise. (layout::layout): Use the new subroutines. Add multibyte awareness. (layout::print_source_line): Add multibyte awareness. (layout::print_line): Likewise. (layout::print_annotation_line): Likewise. (line_label::line_label): Likewise. (layout::print_any_labels): Likewise. (layout::annotation_line_showed_range_p): Likewise. (get_printed_columns): Likewise. (class line_label): Rename m_length to m_display_width. (get_affected_columns): Rename to... (get_affected_range): ...this; add col_unit argument and multibyte awareness. (class correction): Add m_affected_bytes and m_display_cols members. Rename m_len to m_byte_length for clarity. Add multibyte awareness throughout. (correction::insertion_p): Add multibyte awareness. (correction::compute_display_cols): New function. (correction::ensure_terminated): Use new member name m_byte_length. (line_corrections::add_hint): Add multibyte awareness. (layout::print_trailing_fixits): Likewise. (layout::get_x_bound_for_row): Likewise. (test_one_liner_simple_caret_utf8): New self-test analogous to the one with _utf8 suffix removed, testing multibyte awareness. (test_one_liner_caret_and_range_utf8): Likewise. (test_one_liner_multiple_carets_and_ranges_utf8): Likewise. (test_one_liner_fixit_insert_before_utf8): Likewise. (test_one_liner_fixit_insert_after_utf8): Likewise. (test_one_liner_fixit_remove_utf8): Likewise. (test_one_liner_fixit_replace_utf8): Likewise. (test_one_liner_fixit_replace_non_equal_range_utf8): Likewise. (test_one_liner_fixit_replace_equal_secondary_range_utf8): Likewise. (test_one_liner_fixit_validation_adhoc_locations_utf8): Likewise. (test_one_liner_many_fixits_1_utf8): Likewise. (test_one_liner_many_fixits_2_utf8): Likewise. (test_one_liner_labels_utf8): Likewise. (test_diagnostic_show_locus_one_liner_utf8): Likewise. (test_overlapped_fixit_printing_utf8): Likewise. (test_overlapped_fixit_printing): Adapt for changes to get_affected_columns, get_printed_columns and class corrections. (test_overlapped_fixit_printing_2): Likewise. (test_linenum_sep): New constant. (test_left_margin): Likewise. (test_offset_impl): Helper function for new test. (test_layout_x_offset_display_utf8): New test. (diagnostic_show_locus_c_tests): Call new tests. gcc/testsuite/ChangeLog: 2019-11-26 Lewis Hyatt <lhyatt@gmail.com> * gcc.dg/plugin/diagnostic_plugin_test_show_locus.c (test_show_locus): Tweak so that expected output is the same as before the diagnostic-show-locus.c changes. * gcc.dg/cpp/pr66415-1.c: Likewise. [-- Attachment #3: display_cols_v5.patch --] [-- Type: text/x-patch, Size: 162240 bytes --] diff --git a/contrib/unicode/README b/contrib/unicode/README new file mode 100644 index 00000000000..3456a383224 --- /dev/null +++ b/contrib/unicode/README @@ -0,0 +1,44 @@ +This directory contains a mechanism for GCC to have its own internal +implementation of wcwidth functionality. (cpp_wcwidth () in libcpp/charset.c). + +The idea is to produce the necessary lookup table +(../../libcpp/generated_cpp_wcwidth.h) in a reproducible way, starting from the +following files that are distributed by the Unicode Consortium: + +ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt +ftp://ftp.unicode.org/Public/UNIDATA/EastAsianWidth.txt +ftp://ftp.unicode.org/Public/UNIDATA/PropList.txt + +These three files have been added to source control in this directory; +please see unicode-license.txt for the relevant copyright information. + +In order to keep in sync with glibc's wcwidth as much as possible, it is +desirable for the logic that processes the Unicode data to be the same as +glibc's. To that end, we also put in this directory, in the from_glibc/ +directory, the glibc python code that implements their logic. This code was +copied verbatim from glibc, and it can be updated at any time from the glibc +source code repository. The files copied from that respository are: + +localedata/unicode-gen/unicode_utils.py +localedata/unicode-gen/utf8_gen.py + +And the most recent versions added to GCC are from glibc git commit: +2a764c6ee848dfe92cb2921ed3b14085f15d9e79 + +Finally, the script gen_wcwidth.py found here contains the GCC-specific code to +map glibc's output to the lookup tables we require. This script should not need +to change, unless there are structural changes to the Unicode data files or to +the glibc code. + +The procedure to update GCC's wcwidth tables is the following: + +1. Update the three Unicode data files from the above URLs. + +2. Update the two glibc files in from_glibc/ from glibc's git. Update + the commit number above in this README. + +3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_wcwidth.h + (where X.Y is the version of the Unicode standard corresponding to the + Unicode data files being used, most recently, 12.1). + +After that, GCC's wcwidth will match the most recent glibc. diff --git a/contrib/unicode/from_glibc/unicode_utils.py b/contrib/unicode/from_glibc/unicode_utils.py new file mode 100644 index 00000000000..a9e94cce418 --- /dev/null +++ b/contrib/unicode/from_glibc/unicode_utils.py @@ -0,0 +1,527 @@ +# Utilities to generate Unicode data for glibc from upstream Unicode data. +# +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +''' +This module contains utilities used by the scripts to generate +Unicode data for glibc from upstream Unicode data files. +''' + +import sys +import re + + +# Common locale header. +COMMENT_HEADER = """ +% This file is part of the GNU C Library and contains locale data. +% The Free Software Foundation does not claim any copyright interest +% in the locale data contained in this file. The foregoing does not +% affect the license of the GNU C Library as a whole. It does not +% exempt you from the conditions of the license if your use would +% otherwise be governed by that license. +""" + +# Dictionary holding the entire contents of the UnicodeData.txt file +# +# Contents of this dictionary look like this: +# +# {0: {'category': 'Cc', +# 'title': None, +# 'digit': '', +# 'name': '<control>', +# 'bidi': 'BN', +# 'combining': '0', +# 'comment': '', +# 'oldname': 'NULL', +# 'decomposition': '', +# 'upper': None, +# 'mirrored': 'N', +# 'lower': None, +# 'decdigit': '', +# 'numeric': ''}, +# … +# } +UNICODE_ATTRIBUTES = {} + +# Dictionary holding the entire contents of the DerivedCoreProperties.txt file +# +# Contents of this dictionary look like this: +# +# {917504: ['Default_Ignorable_Code_Point'], +# 917505: ['Case_Ignorable', 'Default_Ignorable_Code_Point'], +# … +# } +DERIVED_CORE_PROPERTIES = {} + +# Dictionary holding the entire contents of the EastAsianWidths.txt file +# +# Contents of this dictionary look like this: +# +# {0: 'N', … , 45430: 'W', …} +EAST_ASIAN_WIDTHS = {} + +def fill_attribute(code_point, fields): + '''Stores in UNICODE_ATTRIBUTES[code_point] the values from the fields. + + One entry in the UNICODE_ATTRIBUTES dictionary represents one line + in the UnicodeData.txt file. + + ''' + UNICODE_ATTRIBUTES[code_point] = { + 'name': fields[1], # Character name + 'category': fields[2], # General category + 'combining': fields[3], # Canonical combining classes + 'bidi': fields[4], # Bidirectional category + 'decomposition': fields[5], # Character decomposition mapping + 'decdigit': fields[6], # Decimal digit value + 'digit': fields[7], # Digit value + 'numeric': fields[8], # Numeric value + 'mirrored': fields[9], # mirrored + 'oldname': fields[10], # Old Unicode 1.0 name + 'comment': fields[11], # comment + # Uppercase mapping + 'upper': int(fields[12], 16) if fields[12] else None, + # Lowercase mapping + 'lower': int(fields[13], 16) if fields[13] else None, + # Titlecase mapping + 'title': int(fields[14], 16) if fields[14] else None, + } + +def fill_attributes(filename): + '''Stores the entire contents of the UnicodeData.txt file + in the UNICODE_ATTRIBUTES dictionary. + + A typical line for a single code point in UnicodeData.txt looks + like this: + + 0041;LATIN CAPITAL LETTER A;Lu;0;L;;;;;N;;;;0061; + + Code point ranges are indicated by pairs of lines like this: + + 4E00;<CJK Ideograph, First>;Lo;0;L;;;;;N;;;;; + 9FCC;<CJK Ideograph, Last>;Lo;0;L;;;;;N;;;;; + ''' + with open(filename, mode='r') as unicode_data_file: + fields_start = [] + for line in unicode_data_file: + fields = line.strip().split(';') + if len(fields) != 15: + sys.stderr.write( + 'short line in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + if fields[2] == 'Cs': + # Surrogates are UTF-16 artefacts, + # not real characters. Ignore them. + fields_start = [] + continue + if fields[1].endswith(', First>'): + fields_start = fields + fields_start[1] = fields_start[1].split(',')[0][1:] + continue + if fields[1].endswith(', Last>'): + fields[1] = fields[1].split(',')[0][1:] + if fields[1:] != fields_start[1:]: + sys.stderr.write( + 'broken code point range in file "%(f)s": %(l)s\n' %{ + 'f': filename, 'l': line}) + exit(1) + for code_point in range( + int(fields_start[0], 16), + int(fields[0], 16)+1): + fill_attribute(code_point, fields) + fields_start = [] + continue + fill_attribute(int(fields[0], 16), fields) + fields_start = [] + +def fill_derived_core_properties(filename): + '''Stores the entire contents of the DerivedCoreProperties.txt file + in the DERIVED_CORE_PROPERTIES dictionary. + + Lines in DerivedCoreProperties.txt are either a code point range like + this: + + 0061..007A ; Lowercase # L& [26] LATIN SMALL LETTER A..LATIN SMALL LETTER Z + + or a single code point like this: + + 00AA ; Lowercase # Lo FEMININE ORDINAL INDICATOR + + ''' + with open(filename, mode='r') as derived_core_properties_file: + for line in derived_core_properties_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + + r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + + r'\s*;\s*(?P<property>[a-zA-Z_]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + prop = match.group('property') + if code_point in DERIVED_CORE_PROPERTIES: + DERIVED_CORE_PROPERTIES[code_point].append(prop) + else: + DERIVED_CORE_PROPERTIES[code_point] = [prop] + +def fill_east_asian_widths(filename): + '''Stores the entire contents of the EastAsianWidths.txt file + in the EAST_ASIAN_WIDTHS dictionary. + + Lines in EastAsianWidths.txt are either a code point range like + this: + + 9FCD..9FFF;W # Cn [51] <reserved-9FCD>..<reserved-9FFF> + + or a single code point like this: + + A015;W # Lm YI SYLLABLE WU + ''' + with open(filename, mode='r') as east_asian_widths_file: + for line in east_asian_widths_file: + match = re.match( + r'^(?P<codepoint1>[0-9A-F]{4,6})' + +r'(?:\.\.(?P<codepoint2>[0-9A-F]{4,6}))?' + +r'\s*;\s*(?P<property>[a-zA-Z]+)', + line) + if not match: + continue + start = match.group('codepoint1') + end = match.group('codepoint2') + if not end: + end = start + for code_point in range(int(start, 16), int(end, 16)+1): + EAST_ASIAN_WIDTHS[code_point] = match.group('property') + +def to_upper(code_point): + '''Returns the code point of the uppercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['upper']): + return UNICODE_ATTRIBUTES[code_point]['upper'] + else: + return code_point + +def to_lower(code_point): + '''Returns the code point of the lowercase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['lower']): + return UNICODE_ATTRIBUTES[code_point]['lower'] + else: + return code_point + +def to_upper_turkish(code_point): + '''Returns the code point of the Turkish uppercase version + of the given code point''' + if code_point == 0x0069: + return 0x0130 + return to_upper(code_point) + +def to_lower_turkish(code_point): + '''Returns the code point of the Turkish lowercase version + of the given code point''' + if code_point == 0x0049: + return 0x0131 + return to_lower(code_point) + +def to_title(code_point): + '''Returns the code point of the titlecase version + of the given code point''' + if (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['title']): + return UNICODE_ATTRIBUTES[code_point]['title'] + else: + return code_point + +def is_upper(code_point): + '''Checks whether the character with this code point is uppercase''' + return (to_lower(code_point) != code_point + or (code_point in DERIVED_CORE_PROPERTIES + and 'Uppercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_lower(code_point): + '''Checks whether the character with this code point is lowercase''' + # Some characters are defined as “Lowercase†in + # DerivedCoreProperties.txt but do not have a mapping to upper + # case. For example, ꜰ U+A72F “LATIN LETTER SMALL CAPITAL F†is + # one of these. + return (to_upper(code_point) != code_point + # <U00DF> is lowercase, but without simple to_upper mapping. + or code_point == 0x00DF + or (code_point in DERIVED_CORE_PROPERTIES + and 'Lowercase' in DERIVED_CORE_PROPERTIES[code_point])) + +def is_alpha(code_point): + '''Checks whether the character with this code point is alphabetic''' + return ((code_point in DERIVED_CORE_PROPERTIES + and + 'Alphabetic' in DERIVED_CORE_PROPERTIES[code_point]) + or + # Consider all the non-ASCII digits as alphabetic. + # ISO C 99 forbids us to have them in category “digitâ€, + # but we want iswalnum to return true on them. + (UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd' + and not (code_point >= 0x0030 and code_point <= 0x0039))) + +def is_digit(code_point): + '''Checks whether the character with this code point is a digit''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Nd') + # Note: U+0BE7..U+0BEF and U+1369..U+1371 are digit systems without + # a zero. Must add <0> in front of them by hand. + else: + # SUSV2 gives us some freedom for the "digit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.5: + # The iswdigit function tests for any wide character that + # corresponds to a decimal-digit character (as defined in 5.2.1). + # 5.2.1: + # the 10 decimal digits 0 1 2 3 4 5 6 7 8 9 + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_outdigit(code_point): + '''Checks whether the character with this code point is outdigit''' + return (code_point >= 0x0030 and code_point <= 0x0039) + +def is_blank(code_point): + '''Checks whether the character with this code point is blank''' + return (code_point == 0x0009 # '\t' + # Category Zs without mention of '<noBreak>' + or (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'] == 'Zs' + and '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])) + +def is_space(code_point): + '''Checks whether the character with this code point is a space''' + # Don’t make U+00A0 a space. Non-breaking space means that all programs + # should treat it like a punctuation character, not like a space. + return (code_point == 0x0020 # ' ' + or code_point == 0x000C # '\f' + or code_point == 0x000A # '\n' + or code_point == 0x000D # '\r' + or code_point == 0x0009 # '\t' + or code_point == 0x000B # '\v' + # Categories Zl, Zp, and Zs without mention of "<noBreak>" + or (UNICODE_ATTRIBUTES[code_point]['name'] + and + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'] + or + (UNICODE_ATTRIBUTES[code_point]['category'] in ['Zs'] + and + '<noBreak>' not in + UNICODE_ATTRIBUTES[code_point]['decomposition'])))) + +def is_cntrl(code_point): + '''Checks whether the character with this code point is + a control character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and (UNICODE_ATTRIBUTES[code_point]['name'] == '<control>' + or + UNICODE_ATTRIBUTES[code_point]['category'] in ['Zl', 'Zp'])) + +def is_xdigit(code_point): + '''Checks whether the character with this code point is + a hexadecimal digit''' + if False: + return (is_digit(code_point) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + else: + # SUSV2 gives us some freedom for the "xdigit" category, but ISO C 99 + # takes it away: + # 7.25.2.1.12: + # The iswxdigit function tests for any wide character that + # corresponds to a hexadecimal-digit character (as defined + # in 6.4.4.1). + # 6.4.4.1: + # hexadecimal-digit: one of + # 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F + return ((code_point >= 0x0030 and code_point <= 0x0039) + or (code_point >= 0x0041 and code_point <= 0x0046) + or (code_point >= 0x0061 and code_point <= 0x0066)) + +def is_graph(code_point): + '''Checks whether the character with this code point is + a graphical character''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and not is_space(code_point)) + +def is_print(code_point): + '''Checks whether the character with this code point is printable''' + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['name'] != '<control>' + and UNICODE_ATTRIBUTES[code_point]['category'] not in ['Zl', 'Zp']) + +def is_punct(code_point): + '''Checks whether the character with this code point is punctuation''' + if False: + return (UNICODE_ATTRIBUTES[code_point]['name'] + and UNICODE_ATTRIBUTES[code_point]['category'].startswith('P')) + else: + # The traditional POSIX definition of punctuation is every graphic, + # non-alphanumeric character. + return (is_graph(code_point) + and not is_alpha(code_point) + and not is_digit(code_point)) + +def is_combining(code_point): + '''Checks whether the character with this code point is + a combining character''' + # Up to Unicode 3.0.1 we took the Combining property from the PropList.txt + # file. In 3.0.1 it was identical to the union of the general categories + # "Mn", "Mc", "Me". In Unicode 3.1 this property has been dropped from the + # PropList.txt file, so we take the latter definition. + return (UNICODE_ATTRIBUTES[code_point]['name'] + and + UNICODE_ATTRIBUTES[code_point]['category'] in ['Mn', 'Mc', 'Me']) + +def is_combining_level3(code_point): + '''Checks whether the character with this code point is + a combining level3 character''' + return (is_combining(code_point) + and + int(UNICODE_ATTRIBUTES[code_point]['combining']) in range(0, 200)) + +def ucs_symbol(code_point): + '''Return the UCS symbol string for a Unicode character.''' + if code_point < 0x10000: + return '<U{:04X}>'.format(code_point) + else: + return '<U{:08X}>'.format(code_point) + +def ucs_symbol_range(code_point_low, code_point_high): + '''Returns a string UCS symbol string for a code point range. + + Example: + + <U0041>..<U005A> + ''' + return ucs_symbol(code_point_low) + '..' + ucs_symbol(code_point_high) + +def verifications(): + '''Tests whether the is_* functions observe the known restrictions''' + for code_point in sorted(UNICODE_ATTRIBUTES): + # toupper restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_upper(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but toupper(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_upper(code_point)}) + # tolower restriction: "Only characters specified for the keywords + # lower and upper shall be specified. + if (to_lower(code_point) != code_point + and not (is_lower(code_point) or is_upper(code_point))): + sys.stderr.write( + ('%(sym)s is not upper|lower ' + + 'but tolower(0x%(c)04X) = 0x%(uc)04X\n') %{ + 'sym': ucs_symbol(code_point), + 'c': code_point, + 'uc': to_lower(code_point)}) + # alpha restriction: "Characters classified as either upper or lower + # shall automatically belong to this class. + if ((is_lower(code_point) or is_upper(code_point)) + and not is_alpha(code_point)): + sys.stderr.write('%(sym)s is upper|lower but not alpha\n' %{ + 'sym': ucs_symbol(code_point)}) + # alpha restriction: “No character specified for the keywords cntrl, + # digit, punct or space shall be specified.†+ if (is_alpha(code_point) and is_cntrl(code_point)): + sys.stderr.write('%(sym)s is alpha and cntrl\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is alpha and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is alpha and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_alpha(code_point) and is_space(code_point)): + sys.stderr.write('%(sym)s is alpha and space\n' %{ + 'sym': ucs_symbol(code_point)}) + # space restriction: “No character specified for the keywords upper, + # lower, alpha, digit, graph or xdigit shall be specified.†+ # upper, lower, alpha already checked above. + if (is_space(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is space and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is space and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_space(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is space and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # cntrl restriction: “No character specified for the keywords upper, + # lower, alpha, digit, punct, graph, print or xdigit shall be + # specified.†upper, lower, alpha already checked above. + if (is_cntrl(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is cntrl and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_punct(code_point)): + sys.stderr.write('%(sym)s is cntrl and punct\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_graph(code_point)): + sys.stderr.write('%(sym)s is cntrl and graph\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_print(code_point)): + sys.stderr.write('%(sym)s is cntrl and print\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_cntrl(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is cntrl and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + # punct restriction: “No character specified for the keywords upper, + # lower, alpha, digit, cntrl, xdigit or as the <space> character shall + # be specified.†upper, lower, alpha, cntrl already checked above. + if (is_punct(code_point) and is_digit(code_point)): + sys.stderr.write('%(sym)s is punct and digit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and is_xdigit(code_point)): + sys.stderr.write('%(sym)s is punct and xdigit\n' %{ + 'sym': ucs_symbol(code_point)}) + if (is_punct(code_point) and code_point == 0x0020): + sys.stderr.write('%(sym)s is punct\n' %{ + 'sym': ucs_symbol(code_point)}) + # graph restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # print restriction: “No character specified for the keyword cntrl + # shall be specified.†Already checked above. + + # graph - print relation: differ only in the <space> character. + # How is this possible if there are more than one space character?! + # I think susv2/xbd/locale.html should speak of “space charactersâ€, + # not “space characterâ€. + if (is_print(code_point) + and not (is_graph(code_point) or is_space(code_point))): + sys.stderr.write('%(sym)s is print but not graph|<space>\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) + if (not is_print(code_point) + and (is_graph(code_point) or code_point == 0x0020)): + sys.stderr.write('%(sym)s is graph|<space> but not print\n' %{ + 'sym': unicode_utils.ucs_symbol(code_point)}) diff --git a/contrib/unicode/from_glibc/utf8_gen.py b/contrib/unicode/from_glibc/utf8_gen.py new file mode 100755 index 00000000000..0e5583cd259 --- /dev/null +++ b/contrib/unicode/from_glibc/utf8_gen.py @@ -0,0 +1,364 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- +# Copyright (C) 2014-2019 Free Software Foundation, Inc. +# This file is part of the GNU C Library. +# +# The GNU C 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 2.1 of the License, or (at your option) any later version. +# +# The GNU C 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with the GNU C Library; if not, see +# <https://www.gnu.org/licenses/>. + +'''glibc/localedata/charmaps/UTF-8 file generator script + +This script generates a glibc/localedata/charmaps/UTF-8 file +from Unicode data. + +Usage: python3 utf8_gen.py UnicodeData.txt EastAsianWidth.txt + +It will output UTF-8 file +''' + +import argparse +import sys +import re +import unicode_utils + +# Auxiliary tables for Hangul syllable names, see the Unicode 3.0 book, +# sections 3.11 and 4.4. + +JAMO_INITIAL_SHORT_NAME = ( + 'G', 'GG', 'N', 'D', 'DD', 'R', 'M', 'B', 'BB', 'S', 'SS', '', 'J', 'JJ', + 'C', 'K', 'T', 'P', 'H' +) + +JAMO_MEDIAL_SHORT_NAME = ( + 'A', 'AE', 'YA', 'YAE', 'EO', 'E', 'YEO', 'YE', 'O', 'WA', 'WAE', 'OE', + 'YO', 'U', 'WEO', 'WE', 'WI', 'YU', 'EU', 'YI', 'I' +) + +JAMO_FINAL_SHORT_NAME = ( + '', 'G', 'GG', 'GS', 'N', 'NI', 'NH', 'D', 'L', 'LG', 'LM', 'LB', 'LS', + 'LT', 'LP', 'LH', 'M', 'B', 'BS', 'S', 'SS', 'NG', 'J', 'C', 'K', 'T', + 'P', 'H' +) + +def process_range(start, end, outfile, name): + '''Writes a range of code points into the CHARMAP section of the + output file + + ''' + if 'Hangul Syllable' in name: + # from glibc/localedata/ChangeLog: + # + # 2000-09-24 Bruno Haible <haible@clisp.cons.org> + # * charmaps/UTF-8: Expand <Hangul Syllable> and <Private Use> ranges, + # so they become printable and carry a width. Comment out surrogate + # ranges. Add a WIDTH table + # + # So we expand the Hangul Syllables here: + for i in range(int(start, 16), int(end, 16)+1 ): + index2, index3 = divmod(i - 0xaC00, 28) + index1, index2 = divmod(index2, 21) + hangul_syllable_name = 'HANGUL SYLLABLE ' \ + + JAMO_INITIAL_SHORT_NAME[index1] \ + + JAMO_MEDIAL_SHORT_NAME[index2] \ + + JAMO_FINAL_SHORT_NAME[index3] + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), convert_to_hex(i), + hangul_syllable_name)) + return + # UnicodeData.txt file has contains code point ranges like this: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + # + # The glibc UTF-8 file splits ranges like these into shorter + # ranges of 64 code points each: + # + # <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + # … + # <U4D80>..<U4DB5> /xe4/xb6/x80 <CJK Ideograph Extension A> + for i in range(int(start, 16), int(end, 16), 64 ): + if i > (int(end, 16)-64): + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(int(end,16)), + convert_to_hex(i), + name)) + break + outfile.write('{:s}..{:s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(i), + unicode_utils.ucs_symbol(i+63), + convert_to_hex(i), + name)) + +def process_charmap(flines, outfile): + '''This function takes an array which contains *all* lines of + of UnicodeData.txt and write lines to outfile as used in the + + CHARMAP + … + END CHARMAP + + section of the UTF-8 file in glibc/localedata/charmaps/UTF-8. + + Samples for input lines: + + 0010;<control>;Cc;0;BN;;;;;N;DATA LINK ESCAPE;;;; + 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + D800;<Non Private Use High Surrogate, First>;Cs;0;L;;;;;N;;;;; + DB7F;<Non Private Use High Surrogate, Last>;Cs;0;L;;;;;N;;;;; + 100000;<Plane 16 Private Use, First>;Co;0;L;;;;;N;;;;; + 10FFFD;<Plane 16 Private Use, Last>;Co;0;L;;;;;N;;;;; + + Samples for output lines (Unicode-Value UTF-8-HEX Unicode-Char-Name): + + <U0010> /x10 DATA LINK ESCAPE + <U3400>..<U343F> /xe3/x90/x80 <CJK Ideograph Extension A> + %<UD800> /xed/xa0/x80 <Non Private Use High Surrogate, First> + %<UDB7F> /xed/xad/xbf <Non Private Use High Surrogate, Last> + <U0010FFC0>..<U0010FFFD> /xf4/x8f/xbf/x80 <Plane 16 Private Use> + + ''' + fields_start = [] + for line in flines: + fields = line.split(";") + # Some characters have “<control>†as their name. We try to + # use the “Unicode 1.0 Name†(10th field in + # UnicodeData.txt) for them. + # + # The Characters U+0080, U+0081, U+0084 and U+0099 have + # “<control>†as their name but do not even have aa + # â€Unicode 1.0 Nameâ€. We could write code to take their + # alternate names from NameAliases.txt. + if fields[1] == "<control>" and fields[10]: + fields[1] = fields[10] + # Handling code point ranges like: + # + # 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;; + # 4DB5;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;; + if fields[1].endswith(', First>') and not 'Surrogate,' in fields[1]: + fields_start = fields + continue + if fields[1].endswith(', Last>') and not 'Surrogate,' in fields[1]: + process_range(fields_start[0], fields[0], + outfile, fields[1][:-7]+'>') + fields_start = [] + continue + fields_start = [] + if 'Surrogate,' in fields[1]: + # Comment out the surrogates in the UTF-8 file. + # One could of course skip them completely but + # the original UTF-8 file in glibc had them as + # comments, so we keep these comment lines. + outfile.write('%') + outfile.write('{:<11s} {:<12s} {:s}\n'.format( + unicode_utils.ucs_symbol(int(fields[0], 16)), + convert_to_hex(int(fields[0], 16)), + fields[1])) + +def convert_to_hex(code_point): + '''Converts a code point to a hexadecimal UTF-8 representation + like /x**/x**/x**.''' + # Getting UTF8 of Unicode characters. + # In Python3, .encode('UTF-8') does not work for + # surrogates. Therefore, we use this conversion table + surrogates = { + 0xD800: '/xed/xa0/x80', + 0xDB7F: '/xed/xad/xbf', + 0xDB80: '/xed/xae/x80', + 0xDBFF: '/xed/xaf/xbf', + 0xDC00: '/xed/xb0/x80', + 0xDFFF: '/xed/xbf/xbf', + } + if code_point in surrogates: + return surrogates[code_point] + return ''.join([ + '/x{:02x}'.format(c) for c in chr(code_point).encode('UTF-8') + ]) + +def write_header_charmap(outfile): + '''Write the header on top of the CHARMAP section to the output file''' + outfile.write("<code_set_name> UTF-8\n") + outfile.write("<comment_char> %\n") + outfile.write("<escape_char> /\n") + outfile.write("<mb_cur_min> 1\n") + outfile.write("<mb_cur_max> 6\n\n") + outfile.write("% CHARMAP generated using utf8_gen.py\n") + outfile.write("% alias ISO-10646/UTF-8\n") + outfile.write("CHARMAP\n") + +def write_header_width(outfile, unicode_version): + '''Writes the header on top of the WIDTH section to the output file''' + outfile.write('% Character width according to Unicode ' + + '{:s}.\n'.format(unicode_version)) + outfile.write('% - Default width is 1.\n') + outfile.write('% - Double-width characters have width 2; generated from\n') + outfile.write('% "grep \'^[^;]*;[WF]\' EastAsianWidth.txt"\n') + outfile.write('% - Non-spacing characters have width 0; ' + + 'generated from PropList.txt or\n') + outfile.write('% "grep \'^[^;]*;[^;]*;[^;]*;[^;]*;NSM;\' ' + + 'UnicodeData.txt"\n') + outfile.write('% - Format control characters have width 0; ' + + 'generated from\n') + outfile.write("% \"grep '^[^;]*;[^;]*;Cf;' UnicodeData.txt\"\n") +# Not needed covered by Cf +# outfile.write("% - Zero width characters have width 0; generated from\n") +# outfile.write("% \"grep '^[^;]*;ZERO WIDTH ' UnicodeData.txt\"\n") + outfile.write("WIDTH\n") + +def process_width(outfile, ulines, elines, plines): + '''ulines are lines from UnicodeData.txt, elines are lines from + EastAsianWidth.txt containing characters with width “W†or “Fâ€, + plines are lines from PropList.txt which contain characters + with the property “Prepended_Concatenation_Markâ€. + + ''' + width_dict = {} + for line in elines: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + width_dict[key] = 2 + + for line in ulines: + fields = line.split(";") + if fields[4] == "NSM" or fields[2] in ("Cf", "Me", "Mn"): + width_dict[int(fields[0], 16)] = 0 + + for line in plines: + # Characters with the property “Prepended_Concatenation_Mark†+ # should have the width 1: + fields = line.split(";") + if not '..' in fields[0]: + code_points = (fields[0], fields[0]) + else: + code_points = fields[0].split("..") + for key in range(int(code_points[0], 16), + int(code_points[1], 16)+1): + del width_dict[key] # default width is 1 + + # handle special cases for compatibility + for key in list((0x00AD,)): + # https://www.cs.tut.fi/~jkorpela/shy.html + if key in width_dict: + del width_dict[key] # default width is 1 + for key in list(range(0x1160, 0x1200)): + width_dict[key] = 0 + for key in list(range(0x3248, 0x3250)): + # These are “A†which means we can decide whether to treat them + # as “W†or “N†based on context: + # http://www.unicode.org/mail-arch/unicode-ml/y2017-m08/0023.html + # For us, “W†seems better. + width_dict[key] = 2 + for key in list(range(0x4DC0, 0x4E00)): + width_dict[key] = 2 + + same_width_lists = [] + current_width_list = [] + for key in sorted(width_dict): + if not current_width_list: + current_width_list = [key] + elif (key == current_width_list[-1] + 1 + and width_dict[key] == width_dict[current_width_list[0]]): + current_width_list.append(key) + else: + same_width_lists.append(current_width_list) + current_width_list = [key] + if current_width_list: + same_width_lists.append(current_width_list) + + for same_width_list in same_width_lists: + if len(same_width_list) == 1: + outfile.write('{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + width_dict[same_width_list[0]])) + else: + outfile.write('{:s}...{:s}\t{:d}\n'.format( + unicode_utils.ucs_symbol(same_width_list[0]), + unicode_utils.ucs_symbol(same_width_list[-1]), + width_dict[same_width_list[0]])) + +if __name__ == "__main__": + PARSER = argparse.ArgumentParser( + description=''' + Generate a UTF-8 file from UnicodeData.txt, EastAsianWidth.txt, and PropList.txt. + ''') + PARSER.add_argument( + '-u', '--unicode_data_file', + nargs='?', + type=str, + default='UnicodeData.txt', + help=('The UnicodeData.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-e', '--east_asian_with_file', + nargs='?', + type=str, + default='EastAsianWidth.txt', + help=('The EastAsianWidth.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '-p', '--prop_list_file', + nargs='?', + type=str, + default='PropList.txt', + help=('The PropList.txt file to read, ' + + 'default: %(default)s')) + PARSER.add_argument( + '--unicode_version', + nargs='?', + required=True, + type=str, + help='The Unicode version of the input files used.') + ARGS = PARSER.parse_args() + + with open(ARGS.unicode_data_file, mode='r') as UNIDATA_FILE: + UNICODE_DATA_LINES = UNIDATA_FILE.readlines() + with open(ARGS.east_asian_with_file, mode='r') as EAST_ASIAN_WIDTH_FILE: + EAST_ASIAN_WIDTH_LINES = [] + for LINE in EAST_ASIAN_WIDTH_FILE: + # If characters from EastAasianWidth.txt which are from + # from reserved ranges (i.e. not yet assigned code points) + # are added to the WIDTH section of the UTF-8 file, then + # “make check†produces “Unknown Character†errors for + # these code points because such unassigned code points + # are not in the CHARMAP section of the UTF-8 file. + # + # Therefore, we skip all reserved code points when reading + # the EastAsianWidth.txt file. + if re.match(r'.*<reserved-.+>\.\.<reserved-.+>.*', LINE): + continue + if re.match(r'^[^;]*;[WF]', LINE): + EAST_ASIAN_WIDTH_LINES.append(LINE.strip()) + with open(ARGS.prop_list_file, mode='r') as PROP_LIST_FILE: + PROP_LIST_LINES = [] + for LINE in PROP_LIST_FILE: + if re.match(r'^[^;]*;[\s]*Prepended_Concatenation_Mark', LINE): + PROP_LIST_LINES.append(LINE.strip()) + with open('UTF-8', mode='w') as OUTFILE: + # Processing UnicodeData.txt and write CHARMAP to UTF-8 file + write_header_charmap(OUTFILE) + process_charmap(UNICODE_DATA_LINES, OUTFILE) + OUTFILE.write("END CHARMAP\n\n") + # Processing EastAsianWidth.txt and write WIDTH to UTF-8 file + write_header_width(OUTFILE, ARGS.unicode_version) + process_width(OUTFILE, + UNICODE_DATA_LINES, + EAST_ASIAN_WIDTH_LINES, + PROP_LIST_LINES) + OUTFILE.write("END WIDTH\n") diff --git a/contrib/unicode/gen_wcwidth.py b/contrib/unicode/gen_wcwidth.py new file mode 100755 index 00000000000..02b28bcedcf --- /dev/null +++ b/contrib/unicode/gen_wcwidth.py @@ -0,0 +1,106 @@ +#!/usr/bin/env python3 +# +# Script to generate tables for cpp_wcwidth, leveraging glibc's utf8_gen.py. +# +# This file is part of GCC. +# +# GCC is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation; either version 3, or (at your option) any later +# version. +# +# GCC 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 Public License +# for more details. +# +# You should have received a copy of the GNU General Public License +# along with GCC; see the file COPYING3. If not see +# <http://www.gnu.org/licenses/>. */ + +import sys +import os + +if len(sys.argv) != 2: + print("usage: %s <unicode version>", file=sys.stderr) + sys.exit(1) +unicode_version = sys.argv[1] + +# Parse a codepoint in the format output by glibc tools. +def parse_ucn(s): + if not (s.startswith("<U") and s.endswith(">")): + raise ValueError + return int(s[2:-1], base=16) + +# Process a line of width output from utf_gen.py and update global array. +widths = [1] * (1 + 0x10FFFF) +def process_width(line): + # Example lines: + # <UA8FF> 0 + # <UA926>...<UA92D> 0 + + s = line.split() + width = int(s[1]) + r = s[0].split("...") + if len(r) == 1: + begin = parse_ucn(r[0]) + end = begin + 1 + elif len(r) == 2: + begin = parse_ucn(r[0]) + end = parse_ucn(r[1]) + 1 + else: + raise ValueError + widths[begin:end] = [width] * (end - begin) + +# To keep things simple, we use glibc utf8_gen.py as-is. It only outputs to a +# file named UTF-8, which is not configurable. Then we parse this into the form +# we want it. +os.system("from_glibc/utf8_gen.py --unicode_version %s" % unicode_version) +processing = False +for line in open("UTF-8", "r"): + if processing: + if line == "END WIDTH\n": + processing = False + else: + try: + process_width(line) + except (ValueError, IndexError): + print(e, "warning: ignored unexpected line: %s" % line, + file=sys.stderr, end="") + elif line == "WIDTH\n": + processing = True + +# All bytes < 256 we treat as width 1. +widths[0:255] = [1] * 255 + +# Condense the list to contiguous ranges. +cur_range = [-1, 1] +all_ranges = [] +for i, width in enumerate(widths): + if width == cur_range[1]: + cur_range[0] = i + else: + all_ranges.append(cur_range) + cur_range = [i, width] + +# Output the arrays for generated_cpp_wcwidth.h +print("/* Generated by contrib/unicode/gen_wcwidth.py,", + "with the help of glibc's") +print(" utf8_gen.py, using version %s" % unicode_version, + "of the Unicode standard. */") +print("\nstatic const cppchar_t wcwidth_range_ends[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 8: + print(" ", end="") + else: + print("\n ", end="") + print("0x%x," % (r[0]), end="") +print("\n};\n") +print("static const unsigned char wcwidth_widths[] = {", end="") +for i, r in enumerate(all_ranges): + if i % 24: + print(" ", end="") + else: + print("\n ", end="") + print("%d," % r[1], end="") +print("\n};") diff --git a/contrib/unicode/unicode-license.txt b/contrib/unicode/unicode-license.txt new file mode 100644 index 00000000000..bdbb0a5c32d --- /dev/null +++ b/contrib/unicode/unicode-license.txt @@ -0,0 +1,50 @@ +UNICODE, INC. LICENSE AGREEMENT - DATA FILES AND SOFTWARE + + Unicode Data Files include all data files under the directories +http://www.unicode.org/Public/, http://www.unicode.org/reports/, and +http://www.unicode.org/cldr/data/. Unicode Data Files do not include PDF +online code charts under the directory http://www.unicode.org/Public/. +Software includes any source code published in the Unicode Standard or under +the directories http://www.unicode.org/Public/, +http://www.unicode.org/reports/, and http://www.unicode.org/cldr/data/. + + NOTICE TO USER: Carefully read the following legal agreement. BY +DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING UNICODE INC.'S DATA FILES +("DATA FILES"), AND/OR SOFTWARE ("SOFTWARE"), YOU UNEQUIVOCALLY ACCEPT, AND +AGREE TO BE BOUND BY, ALL OF THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF +YOU DO NOT AGREE, DO NOT DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE THE DATA +FILES OR SOFTWARE. + + COPYRIGHT AND PERMISSION NOTICE + + Copyright © 1991-2013 Unicode, Inc. All rights reserved. Distributed under +the Terms of Use in http://www.unicode.org/copyright.html. + + Permission is hereby granted, free of charge, to any person obtaining a +copy of the Unicode data files and any associated documentation (the "Data +Files") or Unicode software and any associated documentation (the "Software") +to deal in the Data Files or Software without restriction, including without +limitation the rights to use, copy, modify, merge, publish, distribute, and/or +sell copies of the Data Files or Software, and to permit persons to whom the +Data Files or Software are furnished to do so, provided that (a) the above +copyright notice(s) and this permission notice appear with all copies of the +Data Files or Software, (b) both the above copyright notice(s) and this +permission notice appear in associated documentation, and (c) there is clear +notice in each modified Data File or in the Software as well as in the +documentation associated with the Data File(s) or Software that the data or +software has been modified. + + THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD +PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN +THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL +DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR +PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS +ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE +DATA FILES OR SOFTWARE. + + Except as contained in this notice, the name of a copyright holder shall +not be used in advertising or otherwise to promote the sale, use or other +dealings in these Data Files or Software without prior written authorization +of the copyright holder. diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c index cb920f6b9d0..9cd16952ce0 100644 --- a/gcc/diagnostic-show-locus.c +++ b/gcc/diagnostic-show-locus.c @@ -30,6 +30,7 @@ along with GCC; see the file COPYING3. If not see #include "gcc-rich-location.h" #include "selftest.h" #include "selftest-diagnostic.h" +#include "cpplib.h" #ifdef HAVE_TERMIOS_H # include <termios.h> @@ -112,18 +113,81 @@ class colorizer const char *m_stop_color; }; -/* A point within a layout_range; similar to an expanded_location, +/* In order to handle multibyte sources properly, all of this logic needs to be + aware of the distinction between the number of bytes and the number of + display columns occupied by a character, which are not the same for non-ASCII + characters. For example, the Unicode pi symbol, U+03C0, is encoded in UTF-8 + as "\xcf\x80", and thus occupies 2 bytes of space while only occupying 1 + display column when it is output. A typical emoji, such as U+1F602 (in + UTF-8, "\xf0\x9f\x98\x82"), requires 4 bytes and has a display width of 2. + + The below example line, which is also used for selftests below, shows how the + display column and byte column are related: + + 0000000001111111111222222 display + 1234567890123456789012345 columns + SS_foo = P_bar.SS_fieldP; + 0000000111111111222222223 byte + 1356789012456789134567891 columns + + Here SS represents the two display columns for the U+1F602 emoji, and P + represents the one display column for the U+03C0 pi symbol. As an example, a + diagnostic pointing to the final P on this line is at byte column 29 and + display column 24. This reflects the fact that the three extended characters + before the final P occupy cumulatively 5 more bytes than they do display + columns (a difference of 2 for each of the two SSs, and one for the other P). + + One or the other of the two column units is more useful depending on the + context. For instance, in order to output the caret at the correct location, + we need to count display columns; in order to colorize a source line, we need + to count the bytes. All locations are provided to us as byte counts, which + we augment with the display column on demand so that it can be used when + needed. This is not the most efficient way to do things since it requires + looping over the whole line each time, but it should be fine for the purpose + of outputting diagnostics. + + In order to keep straight which units (byte or display) are in use at a + given time, the following enum lets us specify that explicitly. */ + +enum column_unit { + /* Measured in raw bytes. */ + CU_BYTES = 0, + + /* Measured in display units. */ + CU_DISPLAY_COLS, + + /* For arrays indexed by column_unit. */ + CU_NUM_UNITS +}; + +/* Utility class to augment an exploc with the corresponding display column. */ + +class exploc_with_display_col : public expanded_location +{ + public: + exploc_with_display_col (const expanded_location &exploc) + : expanded_location (exploc), + m_display_col (location_compute_display_column (exploc)) {} + + int m_display_col; +}; + + +/* A point within a layout_range; similar to an exploc_with_display_col, but after filtering on file. */ class layout_point { public: layout_point (const expanded_location &exploc) - : m_line (exploc.line), - m_column (exploc.column) {} + : m_line (exploc.line) + { + m_columns[CU_BYTES] = exploc.column; + m_columns[CU_DISPLAY_COLS] = location_compute_display_column (exploc); + } linenum_type m_line; - int m_column; + int m_columns[CU_NUM_UNITS]; }; /* A class for use by "class layout" below: a filtered location_range. */ @@ -138,7 +202,8 @@ class layout_range unsigned original_idx, const range_label *label); - bool contains_point (linenum_type row, int column) const; + bool contains_point (linenum_type row, int column, + enum column_unit col_unit) const; bool intersects_line_p (linenum_type row) const; layout_point m_start; @@ -157,6 +222,17 @@ struct line_bounds { int m_first_non_ws; int m_last_non_ws; + + void convert_to_display_cols (char_span line) + { + m_first_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_first_non_ws); + + m_last_non_ws = cpp_byte_column_to_display_column (line.get_buffer (), + line.length (), + m_last_non_ws); + } }; /* A range of contiguous source lines within a layout (e.g. "lines 5-10" @@ -252,6 +328,9 @@ class layout int get_num_line_spans () const { return m_line_spans.length (); } const line_span *get_line_span (int idx) const { return &m_line_spans[idx]; } + int get_linenum_width () const { return m_linenum_width; } + int get_x_offset_display () const { return m_x_offset_display; } + void print_gap_in_line_numbering (); bool print_heading_for_line_span_index_p (int line_span_idx) const; @@ -262,7 +341,7 @@ class layout private: bool will_show_line_p (linenum_type row) const; void print_leading_fixits (linenum_type row); - void print_source_line (linenum_type row, const char *line, int line_width, + void print_source_line (linenum_type row, const char *line, int line_bytes, line_bounds *lbounds_out); bool should_print_annotation_line_p (linenum_type row) const; void start_annotation_line (char margin_char = ' ') const; @@ -277,6 +356,8 @@ class layout bool validate_fixit_hint_p (const fixit_hint *hint); void calculate_line_spans (); + void calculate_linenum_width (); + void calculate_x_offset_display (); void print_newline (); @@ -284,6 +365,7 @@ class layout get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + enum column_unit col_unit, /* Outputs. */ point_state *out_state); @@ -298,7 +380,7 @@ class layout diagnostic_context *m_context; pretty_printer *m_pp; location_t m_primary_loc; - expanded_location m_exploc; + exploc_with_display_col m_exploc; colorizer m_colorizer; bool m_colorize_source_p; bool m_show_labels_p; @@ -307,7 +389,7 @@ class layout auto_vec <const fixit_hint *> m_fixit_hints; auto_vec <line_span> m_line_spans; int m_linenum_width; - int m_x_offset; + int m_x_offset_display; }; /* Implementation of "class colorizer". */ @@ -472,10 +554,15 @@ layout_range::layout_range (const expanded_location *start_exploc, - 'w' indicates a point within the range - 'F' indicates the finish of the range (which is within it). - - 'a' indicates a subsequent point *after* the range. */ + - 'a' indicates a subsequent point *after* the range. + + COL_UNIT controls whether we check the byte column or + the display column; one or the other is more convenient + depending on the context. */ bool -layout_range::contains_point (linenum_type row, int column) const +layout_range::contains_point (linenum_type row, int column, + enum column_unit col_unit) const { gcc_assert (m_start.m_line <= m_finish.m_line); /* ...but the equivalent isn't true for the columns; @@ -491,7 +578,7 @@ layout_range::contains_point (linenum_type row, int column) const /* On same line as start of range (corresponding to line 02 in example A and line 03 in example B). */ { - if (column < m_start.m_column) + if (column < m_start.m_columns[col_unit]) /* Points on the starting line of the range, but before the column in which it begins. */ return false; @@ -505,7 +592,7 @@ layout_range::contains_point (linenum_type row, int column) const { /* This is a single-line range. */ gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.m_columns[col_unit]; } } @@ -530,7 +617,7 @@ layout_range::contains_point (linenum_type row, int column) const gcc_assert (row == m_finish.m_line); - return column <= m_finish.m_column; + return column <= m_finish.m_columns[col_unit]; } /* Does this layout_range contain any part of line ROW? */ @@ -548,15 +635,22 @@ layout_range::intersects_line_p (linenum_type row) const #if CHECKING_P -/* A helper function for testing layout_range. */ +/* Create some expanded locations for testing layout_range. The filename + member of the explocs is set to the empty string. This member will only be + inspected by the calls to location_compute_display_column() made from the + layout_point constructors. That function will check for an empty filename + argument and not attempt to open it, rather treating the non-existent data + as if the display width were the same as the byte count. Tests exercising a + real difference between byte count and display width are performed later, + e.g. in test_diagnostic_show_locus_one_liner_utf8(). */ static layout_range make_range (int start_line, int start_col, int end_line, int end_col) { const expanded_location start_exploc - = {"test.c", start_line, start_col, NULL, false}; + = {"", start_line, start_col, NULL, false}; const expanded_location finish_exploc - = {"test.c", end_line, end_col, NULL, false}; + = {"", end_line, end_col, NULL, false}; return layout_range (&start_exploc, &finish_exploc, SHOW_RANGE_WITHOUT_CARET, &start_exploc, 0, NULL); } @@ -574,20 +668,25 @@ test_layout_range_for_single_point () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (point.contains_point (6, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before the line. */ + ASSERT_FALSE (point.contains_point (6, 1, col_unit)); - /* On the line, but before start. */ - ASSERT_FALSE (point.contains_point (7, 9)); + /* On the line, but before start. */ + ASSERT_FALSE (point.contains_point (7, 9, col_unit)); - /* At the point. */ - ASSERT_TRUE (point.contains_point (7, 10)); + /* At the point. */ + ASSERT_TRUE (point.contains_point (7, 10, col_unit)); - /* On the line, after the point. */ - ASSERT_FALSE (point.contains_point (7, 11)); + /* On the line, after the point. */ + ASSERT_FALSE (point.contains_point (7, 11, col_unit)); - /* After the line. */ - ASSERT_FALSE (point.contains_point (8, 1)); + /* After the line. */ + ASSERT_FALSE (point.contains_point (8, 1, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (point.intersects_line_p (6)); @@ -605,26 +704,31 @@ test_layout_range_for_single_line () /* Tests for layout_range::contains_point. */ - /* Before the line. */ - ASSERT_FALSE (example_a.contains_point (1, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before the line. */ + ASSERT_FALSE (example_a.contains_point (1, 1, col_unit)); - /* On the line, but before start. */ - ASSERT_FALSE (example_a.contains_point (2, 21)); + /* On the line, but before start. */ + ASSERT_FALSE (example_a.contains_point (2, 21, col_unit)); - /* On the line, at the start. */ - ASSERT_TRUE (example_a.contains_point (2, 22)); + /* On the line, at the start. */ + ASSERT_TRUE (example_a.contains_point (2, 22, col_unit)); - /* On the line, within the range. */ - ASSERT_TRUE (example_a.contains_point (2, 23)); + /* On the line, within the range. */ + ASSERT_TRUE (example_a.contains_point (2, 23, col_unit)); - /* On the line, at the end. */ - ASSERT_TRUE (example_a.contains_point (2, 38)); + /* On the line, at the end. */ + ASSERT_TRUE (example_a.contains_point (2, 38, col_unit)); - /* On the line, after the end. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* On the line, after the end. */ + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); - /* After the line. */ - ASSERT_FALSE (example_a.contains_point (2, 39)); + /* After the line. */ + ASSERT_FALSE (example_a.contains_point (2, 39, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_a.intersects_line_p (1)); @@ -642,40 +746,45 @@ test_layout_range_for_multiple_lines () /* Tests for layout_range::contains_point. */ - /* Before first line. */ - ASSERT_FALSE (example_b.contains_point (1, 1)); + for (int i = 0; i != CU_NUM_UNITS; ++i) + { + const enum column_unit col_unit = (enum column_unit) i; + + /* Before first line. */ + ASSERT_FALSE (example_b.contains_point (1, 1, col_unit)); - /* On the first line, but before start. */ - ASSERT_FALSE (example_b.contains_point (3, 13)); + /* On the first line, but before start. */ + ASSERT_FALSE (example_b.contains_point (3, 13, col_unit)); - /* At the start. */ - ASSERT_TRUE (example_b.contains_point (3, 14)); + /* At the start. */ + ASSERT_TRUE (example_b.contains_point (3, 14, col_unit)); - /* On the first line, within the range. */ - ASSERT_TRUE (example_b.contains_point (3, 15)); + /* On the first line, within the range. */ + ASSERT_TRUE (example_b.contains_point (3, 15, col_unit)); - /* On an interior line. - The column number should not matter; try various boundary - values. */ - ASSERT_TRUE (example_b.contains_point (4, 1)); - ASSERT_TRUE (example_b.contains_point (4, 7)); - ASSERT_TRUE (example_b.contains_point (4, 8)); - ASSERT_TRUE (example_b.contains_point (4, 9)); - ASSERT_TRUE (example_b.contains_point (4, 13)); - ASSERT_TRUE (example_b.contains_point (4, 14)); - ASSERT_TRUE (example_b.contains_point (4, 15)); + /* On an interior line. + The column number should not matter; try various boundary + values. */ + ASSERT_TRUE (example_b.contains_point (4, 1, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 7, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 8, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 9, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 13, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 14, col_unit)); + ASSERT_TRUE (example_b.contains_point (4, 15, col_unit)); - /* On the final line, before the end. */ - ASSERT_TRUE (example_b.contains_point (5, 7)); + /* On the final line, before the end. */ + ASSERT_TRUE (example_b.contains_point (5, 7, col_unit)); - /* On the final line, at the end. */ - ASSERT_TRUE (example_b.contains_point (5, 8)); + /* On the final line, at the end. */ + ASSERT_TRUE (example_b.contains_point (5, 8, col_unit)); - /* On the final line, after the end. */ - ASSERT_FALSE (example_b.contains_point (5, 9)); + /* On the final line, after the end. */ + ASSERT_FALSE (example_b.contains_point (5, 9, col_unit)); - /* After the line. */ - ASSERT_FALSE (example_b.contains_point (6, 1)); + /* After the line. */ + ASSERT_FALSE (example_b.contains_point (6, 1, col_unit)); + } /* Tests for layout_range::intersects_line_p. */ ASSERT_FALSE (example_b.intersects_line_p (2)); @@ -687,13 +796,13 @@ test_layout_range_for_multiple_lines () #endif /* #if CHECKING_P */ -/* Given a source line LINE of length LINE_WIDTH, determine the width - without any trailing whitespace. */ +/* Given a source line LINE of length LINE_BYTES bytes, determine the length + (still in bytes, not display cols) without any trailing whitespace. */ static int -get_line_width_without_trailing_whitespace (const char *line, int line_width) +get_line_bytes_without_trailing_whitespace (const char *line, int line_bytes) { - int result = line_width; + int result = line_bytes; while (result > 0) { char ch = line[result - 1]; @@ -703,7 +812,7 @@ get_line_width_without_trailing_whitespace (const char *line, int line_width) break; } gcc_assert (result >= 0); - gcc_assert (result <= line_width); + gcc_assert (result <= line_bytes); gcc_assert (result == 0 || (line[result - 1] != ' ' && line[result -1] != '\t' @@ -713,21 +822,21 @@ get_line_width_without_trailing_whitespace (const char *line, int line_width) #if CHECKING_P -/* A helper function for testing get_line_width_without_trailing_whitespace. */ +/* A helper function for testing get_line_bytes_without_trailing_whitespace. */ static void -assert_eq (const char *line, int expected_width) +assert_eq (const char *line, int expected_bytes) { int actual_value - = get_line_width_without_trailing_whitespace (line, strlen (line)); - ASSERT_EQ (actual_value, expected_width); + = get_line_bytes_without_trailing_whitespace (line, strlen (line)); + ASSERT_EQ (actual_value, expected_bytes); } -/* Verify that get_line_width_without_trailing_whitespace is sane for +/* Verify that get_line_bytes_without_trailing_whitespace is sane for various inputs. It is not required to handle newlines. */ static void -test_get_line_width_without_trailing_whitespace () +test_get_line_bytes_without_trailing_whitespace () { assert_eq ("", 0); assert_eq (" ", 0); @@ -835,7 +944,7 @@ fixit_cmp (const void *p_a, const void *p_b) sanely print, populating m_layout_ranges and m_fixit_hints. Determine the range of lines that we will print, splitting them up into an ordered list of disjoint spans of contiguous line numbers. - Determine m_x_offset, to ensure that the primary caret + Determine m_x_offset_display, to ensure that the primary caret will fit within the max_width provided by the diagnostic_context. */ layout::layout (diagnostic_context * context, @@ -853,7 +962,7 @@ layout::layout (diagnostic_context * context, m_fixit_hints (richloc->get_num_fixit_hints ()), m_line_spans (1 + richloc->get_num_locations ()), m_linenum_width (0), - m_x_offset (0) + m_x_offset_display (0) { for (unsigned int idx = 0; idx < richloc->get_num_locations (); idx++) { @@ -875,45 +984,16 @@ layout::layout (diagnostic_context * context, /* Sort m_fixit_hints. */ m_fixit_hints.qsort (fixit_cmp); - /* Populate m_line_spans. */ + /* Populate the indicated members. */ calculate_line_spans (); - - /* Determine m_linenum_width. */ - gcc_assert (m_line_spans.length () > 0); - const line_span *last_span = &m_line_spans[m_line_spans.length () - 1]; - int highest_line = last_span->m_last_line; - if (highest_line < 0) - highest_line = 0; - m_linenum_width = num_digits (highest_line); - /* If we're showing jumps in the line-numbering, allow at least 3 chars. */ - if (m_line_spans.length () > 1) - m_linenum_width = MAX (m_linenum_width, 3); - /* If there's a minimum margin width, apply it (subtracting 1 for the space - after the line number. */ - m_linenum_width = MAX (m_linenum_width, context->min_margin_width - 1); - - /* Adjust m_x_offset. - Center the primary caret to fit in max_width; all columns - will be adjusted accordingly. */ - size_t max_width = m_context->caret_max_width; - char_span line = location_get_source_line (m_exploc.file, m_exploc.line); - if (line && (size_t)m_exploc.column <= line.length ()) - { - size_t right_margin = CARET_LINE_MARGIN; - size_t column = m_exploc.column; - if (m_show_line_numbers_p) - column += m_linenum_width + 2; - right_margin = MIN (line.length () - column, right_margin); - right_margin = max_width - right_margin; - if (line.length () >= max_width && column > right_margin) - m_x_offset = column - right_margin; - gcc_assert (m_x_offset >= 0); - } + calculate_linenum_width (); + calculate_x_offset_display (); if (context->show_ruler_p) - show_ruler (m_x_offset + max_width); + show_ruler (m_x_offset_display + m_context->caret_max_width); } + /* Attempt to add LOC_RANGE to m_layout_ranges, filtering them to those that we can sanely print. @@ -1086,7 +1166,7 @@ layout::get_expanded_location (const line_span *line_span) const { expanded_location exploc = m_exploc; exploc.line = lr->m_start.m_line; - exploc.column = lr->m_start.m_column; + exploc.column = lr->m_start.m_columns[CU_BYTES]; return exploc; } } @@ -1251,25 +1331,122 @@ layout::calculate_line_spans () } } +/* Determine how many display columns need to be reserved for line numbers, + based on the largest line number that will be needed, and populate + m_linenum_width. */ + +void +layout::calculate_linenum_width () +{ + gcc_assert (m_line_spans.length () > 0); + const line_span *last_span = &m_line_spans[m_line_spans.length () - 1]; + int highest_line = last_span->m_last_line; + if (highest_line < 0) + highest_line = 0; + m_linenum_width = num_digits (highest_line); + /* If we're showing jumps in the line-numbering, allow at least 3 chars. */ + if (m_line_spans.length () > 1) + m_linenum_width = MAX (m_linenum_width, 3); + /* If there's a minimum margin width, apply it (subtracting 1 for the space + after the line number. */ + m_linenum_width = MAX (m_linenum_width, m_context->min_margin_width - 1); +} + +/* Calculate m_x_offset_display, which improves readability in case the source + line of interest is longer than the user's display. All lines output will be + shifted to the left (so that their beginning is no longer displayed) by + m_x_offset_display display columns, so that the caret is in a reasonable + location. */ + +void +layout::calculate_x_offset_display () +{ + m_x_offset_display = 0; + + const int max_width = m_context->caret_max_width; + if (!max_width) + { + /* Nothing to do, the width is not capped. */ + return; + } + + const char_span line = location_get_source_line (m_exploc.file, + m_exploc.line); + if (!line) + { + /* Nothing to do, we couldn't find the source line. */ + return; + } + int caret_display_column = m_exploc.m_display_col; + const int line_bytes + = get_line_bytes_without_trailing_whitespace (line.get_buffer (), + line.length ()); + int eol_display_column + = cpp_display_width (line.get_buffer (), line_bytes); + if (caret_display_column > eol_display_column + || !caret_display_column) + { + /* This does not make sense, so don't try to do anything in this case. */ + return; + } + + /* Adjust caret and eol positions to include the left margin. If we are + outputting line numbers, then the left margin is equal to m_linenum_width + plus three for the " | " which follows it. Otherwise the left margin width + is equal to 1, because layout::print_source_line() will prefix each line + with a space. */ + const int source_display_cols = eol_display_column; + int left_margin_size = 1; + if (m_show_line_numbers_p) + left_margin_size = m_linenum_width + 3; + caret_display_column += left_margin_size; + eol_display_column += left_margin_size; + + if (eol_display_column <= max_width) + { + /* Nothing to do, everything fits in the display. */ + return; + } + + /* The line is too long for the display. Calculate an offset such that the + caret is not too close to the right edge of the screen. It will be + CARET_LINE_MARGIN display columns from the right edge, unless it is closer + than that to the end of the source line anyway. */ + int right_margin_size = CARET_LINE_MARGIN; + right_margin_size = MIN (eol_display_column - caret_display_column, + right_margin_size); + if (right_margin_size + left_margin_size >= max_width) + { + /* The max_width is very small, so anything we try to do will not be very + effective; just punt in this case and output with no offset. */ + return; + } + const int max_caret_display_column = max_width - right_margin_size; + if (caret_display_column > max_caret_display_column) + { + m_x_offset_display = caret_display_column - max_caret_display_column; + /* Make sure we don't offset the line into oblivion. */ + static const int min_cols_visible = 2; + if (source_display_cols - m_x_offset_display < min_cols_visible) + m_x_offset_display = 0; + } +} + /* Print line ROW of source code, potentially colorized at any ranges, and populate *LBOUNDS_OUT. - LINE is the source line (not necessarily 0-terminated) and LINE_WIDTH - is its width. */ + LINE is the source line (not necessarily 0-terminated) and LINE_BYTES + is its length in bytes. + This function deals only with byte offsets, not display columns, so + m_x_offset_display must be converted from display to byte units. In + particular, LINE_BYTES and LBOUNDS_OUT are in bytes. */ void -layout::print_source_line (linenum_type row, const char *line, int line_width, +layout::print_source_line (linenum_type row, const char *line, int line_bytes, line_bounds *lbounds_out) { m_colorizer.set_normal_text (); - /* We will stop printing the source line at any trailing - whitespace. */ - line_width = get_line_width_without_trailing_whitespace (line, - line_width); - line += m_x_offset; - pp_emit_prefix (m_pp); - if (m_show_line_numbers_p) { int width = num_digits (row); @@ -1279,10 +1456,31 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, } else pp_space (m_pp); + + /* We will stop printing the source line at any trailing whitespace, and start + printing it as per m_x_offset_display. */ + line_bytes = get_line_bytes_without_trailing_whitespace (line, + line_bytes); + int x_offset_bytes = 0; + if (m_x_offset_display) + { + x_offset_bytes = cpp_display_column_to_byte_column (line, line_bytes, + m_x_offset_display); + /* In case the leading portion of the line that will be skipped over ends + with a character with wcwidth > 1, then it is possible we skipped too + much, so account for that by padding with spaces. */ + const int overage + = cpp_byte_column_to_display_column (line, line_bytes, x_offset_bytes) + - m_x_offset_display; + for (int column = 0; column < overage; ++column) + pp_space (m_pp); + line += x_offset_bytes; + } + + /* Print the line. */ int first_non_ws = INT_MAX; int last_non_ws = 0; - int column; - for (column = 1 + m_x_offset; column <= line_width; column++) + for (int col_byte = 1 + x_offset_bytes; col_byte <= line_bytes; col_byte++) { /* Assuming colorization is enabled for the caret and underline characters, we may also colorize the associated characters @@ -1300,8 +1498,9 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, { bool in_range_p; point_state state; - in_range_p = get_state_at_point (row, column, + in_range_p = get_state_at_point (row, col_byte, 0, INT_MAX, + CU_BYTES, &state); if (in_range_p) m_colorizer.set_range (state.range_idx); @@ -1313,9 +1512,9 @@ layout::print_source_line (linenum_type row, const char *line, int line_width, c = ' '; if (c != ' ') { - last_non_ws = column; + last_non_ws = col_byte; if (first_non_ws == INT_MAX) - first_non_ws = column; + first_non_ws = col_byte; } pp_character (m_pp, c); line++; @@ -1365,24 +1564,26 @@ layout::start_annotation_line (char margin_char) const } /* Print a line consisting of the caret/underlines for the given - source line. */ + source line. This function works with display columns, rather than byte + counts; in particular, LBOUNDS should be in display column units. */ void layout::print_annotation_line (linenum_type row, const line_bounds lbounds) { - int x_bound = get_x_bound_for_row (row, m_exploc.column, + int x_bound = get_x_bound_for_row (row, m_exploc.m_display_col, lbounds.m_last_non_ws); start_annotation_line (); pp_space (m_pp); - for (int column = 1 + m_x_offset; column < x_bound; column++) + for (int column = 1 + m_x_offset_display; column < x_bound; column++) { bool in_range_p; point_state state; in_range_p = get_state_at_point (row, column, lbounds.m_first_non_ws, lbounds.m_last_non_ws, + CU_DISPLAY_COLS, &state); if (in_range_p) { @@ -1420,9 +1621,11 @@ class line_label public: line_label (int state_idx, int column, label_text text) : m_state_idx (state_idx), m_column (column), - m_text (text), m_length (strlen (text.m_buffer)), - m_label_line (0), m_has_vbar (true) - {} + m_text (text), m_label_line (0), m_has_vbar (true) + { + const int bytes = strlen (text.m_buffer); + m_display_width = cpp_display_width (text.m_buffer, bytes); + } /* Sorting is primarily by column, then by state index. */ static int comparator (const void *p1, const void *p2) @@ -1441,7 +1644,7 @@ public: int m_state_idx; int m_column; label_text m_text; - size_t m_length; + size_t m_display_width; int m_label_line; bool m_has_vbar; }; @@ -1467,8 +1670,9 @@ layout::print_any_labels (linenum_type row) continue; /* Reject labels that aren't fully visible due to clipping - by m_x_offset. */ - if (range->m_caret.m_column <= m_x_offset) + by m_x_offset_display. */ + const int disp_col = range->m_caret.m_columns[CU_DISPLAY_COLS]; + if (disp_col <= m_x_offset_display) continue; label_text text; @@ -1480,7 +1684,7 @@ layout::print_any_labels (linenum_type row) if (text.m_buffer == NULL) continue; - labels.safe_push (line_label (i, range->m_caret.m_column, text)); + labels.safe_push (line_label (i, disp_col, text)); } } @@ -1530,7 +1734,7 @@ layout::print_any_labels (linenum_type row) FOR_EACH_VEC_ELT_REVERSE (labels, i, label) { /* Would this label "touch" or overlap the next label? */ - if (label->m_column + label->m_length >= (size_t)next_column) + if (label->m_column + label->m_display_width >= (size_t)next_column) { max_label_line++; @@ -1554,7 +1758,7 @@ layout::print_any_labels (linenum_type row) { start_annotation_line (); pp_space (m_pp); - int column = 1 + m_x_offset; + int column = 1 + m_x_offset_display; line_label *label; FOR_EACH_VEC_ELT (labels, i, label) { @@ -1569,7 +1773,7 @@ layout::print_any_labels (linenum_type row) m_colorizer.set_range (label->m_state_idx); pp_string (m_pp, label->m_text.m_buffer); m_colorizer.set_normal_text (); - column += label->m_length; + column += label->m_display_width; } else if (label->m_has_vbar) { @@ -1636,7 +1840,7 @@ layout::print_leading_fixits (linenum_type row) /* Subroutine of layout::print_trailing_fixits. Determine if the annotation line printed for LINE contained - the exact range from START_COLUMN to FINISH_COLUMN. */ + the exact range from START_COLUMN to FINISH_COLUMN (in display units). */ bool layout::annotation_line_showed_range_p (linenum_type line, int start_column, @@ -1646,9 +1850,9 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, int i; FOR_EACH_VEC_ELT (m_layout_ranges, i, range) if (range->m_start.m_line == line - && range->m_start.m_column == start_column + && range->m_start.m_columns[CU_DISPLAY_COLS] == start_column && range->m_finish.m_line == line - && range->m_finish.m_column == finish_column) + && range->m_finish.m_columns[CU_DISPLAY_COLS] == finish_column) return true; return false; } @@ -1735,7 +1939,7 @@ layout::annotation_line_showed_range_p (linenum_type line, int start_column, and is thus printed as desired. */ -/* A range of columns within a line. */ +/* A range of (byte or display) columns within a line. */ class column_range { @@ -1755,32 +1959,51 @@ public: int finish; }; -/* Get the range of columns that HINT would affect. */ - +/* Get the range of bytes or display columns that HINT would affect. */ static column_range -get_affected_columns (const fixit_hint *hint) +get_affected_range (const fixit_hint *hint, enum column_unit col_unit) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; + expanded_location exploc_start = expand_location (hint->get_start_loc ()); + expanded_location exploc_finish = expand_location (hint->get_next_loc ()); + --exploc_finish.column; + int start_column; + int finish_column; + if (col_unit == CU_DISPLAY_COLS) + { + start_column = location_compute_display_column (exploc_start); + if (hint->insertion_p ()) + finish_column = start_column - 1; + else + finish_column = location_compute_display_column (exploc_finish); + } + else + { + start_column = exploc_start.column; + finish_column = exploc_finish.column; + } return column_range (start_column, finish_column); } -/* Get the range of columns that would be printed for HINT. */ +/* Get the range of display columns that would be printed for HINT. */ static column_range get_printed_columns (const fixit_hint *hint) { - int start_column = LOCATION_COLUMN (hint->get_start_loc ()); - int final_hint_column = start_column + hint->get_length () - 1; + expanded_location exploc = expand_location (hint->get_start_loc ()); + int start_column = location_compute_display_column (exploc); + int hint_width = cpp_display_width (hint->get_string (), + hint->get_length ()); + int final_hint_column = start_column + hint_width - 1; if (hint->insertion_p ()) { return column_range (start_column, final_hint_column); } else { - int finish_column = LOCATION_COLUMN (hint->get_next_loc ()) - 1; - + exploc = expand_location (hint->get_next_loc ()); + --exploc.column; + int finish_column = location_compute_display_column (exploc); return column_range (start_column, MAX (finish_column, final_hint_column)); } @@ -1794,27 +2017,35 @@ get_printed_columns (const fixit_hint *hint) class correction { public: - correction (column_range affected_columns, + correction (column_range affected_bytes, + column_range affected_columns, column_range printed_columns, const char *new_text, size_t new_text_len) - : m_affected_columns (affected_columns), + : m_affected_bytes (affected_bytes), + m_affected_columns (affected_columns), m_printed_columns (printed_columns), m_text (xstrdup (new_text)), - m_len (new_text_len), + m_byte_length (new_text_len), m_alloc_sz (new_text_len + 1) { + compute_display_cols (); } ~correction () { free (m_text); } bool insertion_p () const { - return m_affected_columns.start == m_affected_columns.finish + 1; + return m_affected_bytes.start == m_affected_bytes.finish + 1; } void ensure_capacity (size_t len); void ensure_terminated (); + void compute_display_cols () + { + m_display_cols = cpp_display_width (m_text, m_byte_length); + } + void overwrite (int dst_offset, const char_span &src_span) { gcc_assert (dst_offset >= 0); @@ -1827,6 +2058,7 @@ public: is to be inserted, and finish is offset by the length of the replacement. If replace, then the range of columns affected. */ + column_range m_affected_bytes; column_range m_affected_columns; /* If insert, then start: the column before which the text @@ -1837,7 +2069,8 @@ public: /* The text to be inserted/used as replacement. */ char *m_text; - size_t m_len; + size_t m_byte_length; /* Not including null-terminator. */ + int m_display_cols; size_t m_alloc_sz; }; @@ -1862,8 +2095,8 @@ void correction::ensure_terminated () { /* 0-terminate the buffer. */ - gcc_assert (m_len < m_alloc_sz); - m_text[m_len] = '\0'; + gcc_assert (m_byte_length < m_alloc_sz); + m_text[m_byte_length] = '\0'; } /* A list of corrections affecting a particular line. @@ -1925,7 +2158,8 @@ source_line::source_line (const char *filename, int line) void line_corrections::add_hint (const fixit_hint *hint) { - column_range affected_columns = get_affected_columns (hint); + column_range affected_bytes = get_affected_range (hint, CU_BYTES); + column_range affected_columns = get_affected_range (hint, CU_DISPLAY_COLS); column_range printed_columns = get_printed_columns (hint); /* Potentially consolidate. */ @@ -1936,8 +2170,8 @@ line_corrections::add_hint (const fixit_hint *hint) /* The following consolidation code assumes that the fix-it hints have been sorted by start (done within layout's ctor). */ - gcc_assert (affected_columns.start - >= last_correction->m_affected_columns.start); + gcc_assert (affected_bytes.start + >= last_correction->m_affected_bytes.start); gcc_assert (printed_columns.start >= last_correction->m_printed_columns.start); @@ -1949,8 +2183,8 @@ line_corrections::add_hint (const fixit_hint *hint) Attempt to inject a "replace" correction from immediately after the end of the last hint to immediately before the start of the next hint. */ - column_range between (last_correction->m_affected_columns.finish + 1, - printed_columns.start - 1); + column_range between (last_correction->m_affected_bytes.finish + 1, + affected_bytes.start - 1); /* Try to read the source. */ source_line line (m_filename, m_row); @@ -1959,33 +2193,39 @@ line_corrections::add_hint (const fixit_hint *hint) /* Consolidate into the last correction: add a no-op "replace" of the "between" text, and add the text from the new hint. */ - int old_len = last_correction->m_len; - gcc_assert (old_len >= 0); - int between_len = between.finish + 1 - between.start; - gcc_assert (between_len >= 0); - int new_len = old_len + between_len + hint->get_length (); - gcc_assert (new_len >= 0); - last_correction->ensure_capacity (new_len); + int old_byte_len = last_correction->m_byte_length; + gcc_assert (old_byte_len >= 0); + int between_byte_len = between.finish + 1 - between.start; + gcc_assert (between_byte_len >= 0); + int new_byte_len + = old_byte_len + between_byte_len + hint->get_length (); + gcc_assert (new_byte_len >= 0); + last_correction->ensure_capacity (new_byte_len); last_correction->overwrite - (old_len, + (old_byte_len, line.as_span ().subspan (between.start - 1, between.finish + 1 - between.start)); - last_correction->overwrite (old_len + between_len, + last_correction->overwrite (old_byte_len + between_byte_len, char_span (hint->get_string (), hint->get_length ())); - last_correction->m_len = new_len; + last_correction->m_byte_length = new_byte_len; last_correction->ensure_terminated (); + last_correction->m_affected_bytes.finish + = affected_bytes.finish; last_correction->m_affected_columns.finish = affected_columns.finish; + int prev_display_cols = last_correction->m_display_cols; + last_correction->compute_display_cols (); last_correction->m_printed_columns.finish - += between_len + hint->get_length (); + += last_correction->m_display_cols - prev_display_cols; return; } } } /* If no consolidation happened, add a new correction instance. */ - m_corrections.safe_push (new correction (affected_columns, + m_corrections.safe_push (new correction (affected_bytes, + affected_columns, printed_columns, hint->get_string (), hint->get_length ())); @@ -2018,7 +2258,7 @@ layout::print_trailing_fixits (linenum_type row) /* Now print the corrections. */ unsigned i; correction *c; - int column = m_x_offset; + int column = m_x_offset_display; if (!corrections.m_corrections.is_empty ()) start_annotation_line (); @@ -2034,7 +2274,7 @@ layout::print_trailing_fixits (linenum_type row) m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } else { @@ -2046,7 +2286,7 @@ layout::print_trailing_fixits (linenum_type row) int finish_column = c->m_affected_columns.finish; if (!annotation_line_showed_range_p (row, start_column, finish_column) - || c->m_len == 0) + || c->m_byte_length == 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_delete (); @@ -2057,13 +2297,13 @@ layout::print_trailing_fixits (linenum_type row) /* Print the replacement text. REPLACE also covers removals, so only do this extra work (potentially starting a new line) if we have actual replacement text. */ - if (c->m_len > 0) + if (c->m_byte_length > 0) { move_to_column (&column, start_column, true); m_colorizer.set_fixit_insert (); pp_string (m_pp, c->m_text); m_colorizer.set_normal_text (); - column += c->m_len; + column += c->m_display_cols; } } } @@ -2084,12 +2324,14 @@ layout::print_newline () /* Return true if (ROW/COLUMN) is within a range of the layout. If it returns true, OUT_STATE is written to, with the range index, and whether we should draw the caret at - (ROW/COLUMN) (as opposed to an underline). */ + (ROW/COLUMN) (as opposed to an underline). COL_UNIT controls + whether all inputs and outputs are in bytes or display column units. */ bool layout::get_state_at_point (/* Inputs. */ linenum_type row, int column, int first_non_ws, int last_non_ws, + enum column_unit col_unit, /* Outputs. */ point_state *out_state) { @@ -2102,7 +2344,7 @@ layout::get_state_at_point (/* Inputs. */ source colorization. */ continue; - if (range->contains_point (row, column)) + if (range->contains_point (row, column, col_unit)) { out_state->range_idx = i; @@ -2110,7 +2352,7 @@ layout::get_state_at_point (/* Inputs. */ out_state->draw_caret_p = false; if (range->m_range_display_kind == SHOW_RANGE_WITH_CARET && row == range->m_caret.m_line - && column == range->m_caret.m_column) + && column == range->m_caret.m_columns[col_unit]) out_state->draw_caret_p = true; /* Within a multiline range, don't display any underline @@ -2130,11 +2372,11 @@ layout::get_state_at_point (/* Inputs. */ /* Helper function for use by layout::print_line when printing the annotation line under the source line. - Get the column beyond the rightmost one that could contain a caret or - range marker, given that we stop rendering at trailing whitespace. + Get the display column beyond the rightmost one that could contain a caret + or range marker, given that we stop rendering at trailing whitespace. ROW is the source line within the given file. - CARET_COLUMN is the column of range 0's caret. - LAST_NON_WS_COLUMN is the last column containing a non-whitespace + CARET_COLUMN is the display column of range 0's caret. + LAST_NON_WS_COLUMN is the last display column containing a non-whitespace character of source (as determined when printing the source line). */ int @@ -2153,8 +2395,9 @@ layout::get_x_bound_for_row (linenum_type row, int caret_column, { /* On the final line within a range; ensure that we render up to the end of the range. */ - if (result <= range->m_finish.m_column) - result = range->m_finish.m_column + 1; + const int disp_col = range->m_finish.m_columns[CU_DISPLAY_COLS]; + if (result <= disp_col) + result = disp_col + 1; } else if (row < range->m_finish.m_line) { @@ -2183,7 +2426,7 @@ layout::move_to_column (int *column, int dest_column, bool add_left_margin) print_newline (); if (add_left_margin) start_annotation_line (); - *column = m_x_offset; + *column = m_x_offset_display; } while (*column < dest_column) @@ -2204,7 +2447,7 @@ layout::show_ruler (int max_column) const { start_annotation_line (); pp_space (m_pp); - for (int column = 1 + m_x_offset; column <= max_column; column++) + for (int column = 1 + m_x_offset_display; column <= max_column; column++) if (column % 10 == 0) pp_character (m_pp, '0' + (column / 100) % 10); else @@ -2215,7 +2458,7 @@ layout::show_ruler (int max_column) const /* Tens. */ start_annotation_line (); pp_space (m_pp); - for (int column = 1 + m_x_offset; column <= max_column; column++) + for (int column = 1 + m_x_offset_display; column <= max_column; column++) if (column % 10 == 0) pp_character (m_pp, '0' + (column / 10) % 10); else @@ -2225,7 +2468,7 @@ layout::show_ruler (int max_column) const /* Units. */ start_annotation_line (); pp_space (m_pp); - for (int column = 1 + m_x_offset; column <= max_column; column++) + for (int column = 1 + m_x_offset_display; column <= max_column; column++) pp_character (m_pp, '0' + (column % 10)); pp_newline (m_pp); } @@ -2245,7 +2488,11 @@ layout::print_line (linenum_type row) print_leading_fixits (row); print_source_line (row, line.get_buffer (), line.length (), &lbounds); if (should_print_annotation_line_p (row)) - print_annotation_line (row, lbounds); + { + if (lbounds.m_first_non_ws != INT_MAX) + lbounds.convert_to_display_cols (line); + print_annotation_line (row, lbounds); + } if (m_show_labels_p) print_any_labels (row); print_trailing_fixits (row); @@ -2339,6 +2586,178 @@ namespace selftest { /* Selftests for diagnostic_show_locus. */ +/* For precise tests of the layout, make clear where the source line will + start. test_left_margin sets the total byte count from the left side of the + screen to the start of source lines, after the line number and the separator, + which consists of the three characters " | ". */ +static const int test_linenum_sep = 3; +static const int test_left_margin = 7; + +/* Helper function for test_layout_x_offset_display_utf8(). */ +static void +test_offset_impl (int caret_byte_col, int max_width, + int expected_x_offset_display, + int left_margin = test_left_margin) +{ + test_diagnostic_context dc; + dc.caret_max_width = max_width; + /* diagnostic_context::min_margin_width sets the minimum space reserved for + the line number plus one space after. */ + dc.min_margin_width = left_margin - test_linenum_sep + 1; + dc.show_line_numbers_p = true; + rich_location richloc (line_table, + linemap_position_for_column (line_table, + caret_byte_col)); + layout test_layout (&dc, &richloc, DK_ERROR); + ASSERT_EQ (left_margin - test_linenum_sep, + test_layout.get_linenum_width ()); + ASSERT_EQ (expected_x_offset_display, + test_layout.get_x_offset_display ()); +} + +/* Test that layout::calculate_x_offset_display() works. */ +static void +test_layout_x_offset_display_utf8 (const line_table_case &case_) +{ + + const char *content + = "This line is very long, so that we can use it to test the logic for " + "clipping long lines. Also this: \xf0\x9f\x98\x82\xf0\x9f\x98\x82 is a " + "pair of emojis that occupies 8 bytes and 4 display columns, starting at " + "column #102.\n"; + + /* Number of bytes in the line, subtracting one to remove the newline. */ + const int line_bytes = strlen (content) - 1; + + /* Number of display columns occupied by the line; each of the 2 emojis + takes up 2 fewer display columns than it does bytes. */ + const int line_display_cols = line_bytes - 2*2; + + /* The column of the first emoji. Byte or display is the same as there are + no multibyte characters earlier on the line. */ + const int emoji_col = 102; + + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1); + + location_t line_end = linemap_position_for_column (line_table, line_bytes); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end)); + ASSERT_EQ (1, LOCATION_LINE (line_end)); + ASSERT_EQ (line_bytes, LOCATION_COLUMN (line_end)); + + char_span lspan = location_get_source_line (tmp.get_filename (), 1); + ASSERT_EQ (line_display_cols, + cpp_display_width (lspan.get_buffer (), lspan.length ())); + ASSERT_EQ (line_display_cols, + location_compute_display_column (expand_location (line_end))); + ASSERT_EQ (0, memcmp (lspan.get_buffer () + (emoji_col - 1), + "\xf0\x9f\x98\x82\xf0\x9f\x98\x82", 8)); + + /* (caret_byte, max_width, expected_x_offset_display, [left_margin]) */ + + /* No constraint on the width -> no offset. */ + test_offset_impl (emoji_col, 0, 0); + + /* Caret is before the beginning -> no offset. */ + test_offset_impl (0, 100, 0); + + /* Caret is past the end of the line -> no offset. */ + test_offset_impl (line_bytes+1, 100, 0); + + /* Line fits in the display -> no offset. */ + test_offset_impl (line_bytes, line_display_cols + test_left_margin, 0); + test_offset_impl (emoji_col, line_display_cols + test_left_margin, 0); + + /* Line is too long for the display but caret location is OK + anyway -> no offset. */ + static const int small_width = 24; + test_offset_impl (1, small_width, 0); + + /* Width constraint is very small -> no offset. */ + test_offset_impl (emoji_col, CARET_LINE_MARGIN, 0); + + /* Line would be offset, but due to large line numbers, offsetting + would remove the whole line -> no offset. */ + static const int huge_left_margin = 100; + test_offset_impl (emoji_col, huge_left_margin, 0, huge_left_margin); + + /* Line is the same length as the display, but the line number makes it too + long, so offset is required. Caret is at the end so padding on the right + is not in effect. */ + for (int excess = 1; excess <= 3; ++excess) + test_offset_impl (line_bytes, line_display_cols + test_left_margin - excess, + excess); + + /* Line is much too long for the display, caret is near the end -> + offset should be such that the line fits in the display and caret + remains the same distance from the end that it was. */ + for (int caret_offset = 0, max_offset = MIN (CARET_LINE_MARGIN, 10); + caret_offset <= max_offset; ++caret_offset) + test_offset_impl (line_bytes - caret_offset, small_width, + line_display_cols + test_left_margin - small_width); + + /* As previous case but caret is closer to the middle; now we want it to end + up CARET_LINE_MARGIN bytes from the end. */ + ASSERT_GT (line_display_cols - emoji_col, CARET_LINE_MARGIN); + test_offset_impl (emoji_col, small_width, + emoji_col + test_left_margin + - (small_width - CARET_LINE_MARGIN)); + + /* Test that the source line is offset as expected when printed. */ + { + test_diagnostic_context dc; + dc.caret_max_width = small_width - 6; + dc.min_margin_width = test_left_margin - test_linenum_sep + 1; + dc.show_line_numbers_p = true; + dc.show_ruler_p = true; + rich_location richloc (line_table, + linemap_position_for_column (line_table, + emoji_col)); + layout test_layout (&dc, &richloc, DK_ERROR); + test_layout.print_line (1); + ASSERT_STREQ (" | 1 \n" + " | 1 \n" + " | 234567890123456789\n" + " 1 | \xf0\x9f\x98\x82\xf0\x9f\x98\x82 is a pair of emojis " + "that occupies 8 bytes and 4 display columns, starting at " + "column #102.\n" + " | ^\n\n", + pp_formatted_text (dc.printer)); + } + + /* Similar to the previous example, but now the offset called for would split + the first emoji in the middle of the UTF-8 sequence. Check that we replace + it with a padding space in this case. */ + { + test_diagnostic_context dc; + dc.caret_max_width = small_width - 5; + dc.min_margin_width = test_left_margin - test_linenum_sep + 1; + dc.show_line_numbers_p = true; + dc.show_ruler_p = true; + rich_location richloc (line_table, + linemap_position_for_column (line_table, + emoji_col + 2)); + layout test_layout (&dc, &richloc, DK_ERROR); + test_layout.print_line (1); + ASSERT_STREQ (" | 1 1 \n" + " | 1 2 \n" + " | 3456789012345678901\n" + " 1 | \xf0\x9f\x98\x82 is a pair of emojis " + "that occupies 8 bytes and 4 display columns, starting at " + "column #102.\n" + " | ^\n\n", + pp_formatted_text (dc.printer)); + } + +} + /* Verify that diagnostic_show_locus works sanely on UNKNOWN_LOCATION. */ static void @@ -2965,77 +3384,622 @@ test_diagnostic_show_locus_one_liner (const line_table_case &case_) test_one_liner_labels (); } -/* Verify that gcc_rich_location::add_location_if_nearby works. */ +/* Version of all one-liner tests exercising multibyte awareness. For + simplicity we stick to using two multibyte characters in the test, U+1F602 + == "\xf0\x9f\x98\x82", which uses 4 bytes and 2 display columns, and U+03C0 + == "\xcf\x80", which uses 2 bytes and 1 display column. Note: all of the + below asserts would be easier to read if we used UTF-8 directly in the + string constants, but it seems better not to demand the host compiler + support this, when it isn't otherwise necessary. Instead, whenever an + extended character appears in a string, we put a line break after it so that + all succeeding characters can appear visually at the correct display column. + + All of these work on the following 1-line source file: + + .0000000001111111111222222 display + .1234567890123456789012345 columns + "SS_foo = P_bar.SS_fieldP;\n" + .0000000111111111222222223 byte + .1356789012456789134567891 columns + + which is set up by test_diagnostic_show_locus_one_liner and calls + them. Here SS represents the two display columns for the U+1F602 emoji and + P represents the one display column for the U+03C0 pi symbol. */ + +/* Just a caret. */ static void -test_add_location_if_nearby (const line_table_case &case_) +test_one_liner_simple_caret_utf8 () { - /* Create a tempfile and write some text to it. - ...000000000111111111122222222223333333333. - ...123456789012345678901234567890123456789. */ - const char *content - = ("struct same_line { double x; double y; ;\n" /* line 1. */ - "struct different_line\n" /* line 2. */ - "{\n" /* line 3. */ - " double x;\n" /* line 4. */ - " double y;\n" /* line 5. */ - ";\n"); /* line 6. */ - temp_source_file tmp (SELFTEST_LOCATION, ".c", content); - line_table_test ltt (case_); + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + rich_location richloc (line_table, caret); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n", + pp_formatted_text (dc.printer)); +} - const line_map_ordinary *ord_map - = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, - tmp.get_filename (), 0)); +/* Caret and range. */ +static void +test_one_liner_caret_and_range_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 18); + location_t start = linemap_position_for_column (line_table, 12); + location_t finish = linemap_position_for_column (line_table, 30); + location_t loc = make_location (caret, start, finish); + rich_location richloc (line_table, loc); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~~^~~~~~~~~~\n", + pp_formatted_text (dc.printer)); +} - linemap_line_start (line_table, 1, 100); +/* Multiple ranges and carets. */ - const location_t final_line_end - = linemap_position_for_line_and_column (line_table, ord_map, 6, 7); +static void +test_one_liner_multiple_carets_and_ranges_utf8 () +{ + test_diagnostic_context dc; + location_t foo + = make_location (linemap_position_for_column (line_table, 7), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + dc.caret_chars[0] = 'A'; - /* Don't attempt to run the tests if column data might be unavailable. */ - if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) - return; + location_t bar + = make_location (linemap_position_for_column (line_table, 16), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + dc.caret_chars[1] = 'B'; - /* Test of add_location_if_nearby on the same line as the - primary location. */ - { - const location_t missing_close_brace_1_39 - = linemap_position_for_line_and_column (line_table, ord_map, 1, 39); - const location_t matching_open_brace_1_18 - = linemap_position_for_line_and_column (line_table, ord_map, 1, 18); - gcc_rich_location richloc (missing_close_brace_1_39); - bool added = richloc.add_location_if_nearby (matching_open_brace_1_18); - ASSERT_TRUE (added); - ASSERT_EQ (2, richloc.get_num_locations ()); - test_diagnostic_context dc; - diagnostic_show_locus (&dc, &richloc, DK_ERROR); - ASSERT_STREQ ("\n" - " struct same_line { double x; double y; ;\n" - " ~ ^\n", - pp_formatted_text (dc.printer)); - } + location_t field + = make_location (linemap_position_for_column (line_table, 26), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + dc.caret_chars[2] = 'C'; + rich_location richloc (line_table, foo); + richloc.add_range (bar, SHOW_RANGE_WITH_CARET); + richloc.add_range (field, SHOW_RANGE_WITH_CARET); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ~~~~A~ ~~~B~ ~~~~~C~~~\n", + pp_formatted_text (dc.printer)); +} - /* Test of add_location_if_nearby on a different line to the - primary location. */ - { - const location_t missing_close_brace_6_1 - = linemap_position_for_line_and_column (line_table, ord_map, 6, 1); - const location_t matching_open_brace_3_1 - = linemap_position_for_line_and_column (line_table, ord_map, 3, 1); - gcc_rich_location richloc (missing_close_brace_6_1); - bool added = richloc.add_location_if_nearby (matching_open_brace_3_1); - ASSERT_FALSE (added); - ASSERT_EQ (1, richloc.get_num_locations ()); - } +/* Insertion fix-it hint: adding an "&" to the front of "P_bar.field". */ + +static void +test_one_liner_fixit_insert_before_utf8 () +{ + test_diagnostic_context dc; + location_t caret = linemap_position_for_column (line_table, 12); + rich_location richloc (line_table, caret); + richloc.add_fixit_insert_before ("&"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " &\n", + pp_formatted_text (dc.printer)); } -/* Verify that we print fixits even if they only affect lines - outside those covered by the ranges in the rich_location. */ +/* Insertion fix-it hint: adding a "[0]" after "SS_foo". */ static void -test_diagnostic_show_locus_fixit_lines (const line_table_case &case_) +test_one_liner_fixit_insert_after_utf8 () { - /* Create a tempfile and write some text to it. + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 1); + location_t finish = linemap_position_for_column (line_table, 8); + location_t foo = make_location (start, start, finish); + rich_location richloc (line_table, foo); + richloc.add_fixit_insert_after ("[0]"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~\n" + " [0]\n", + pp_formatted_text (dc.printer)); +} + +/* Removal fix-it hint: removal of the ".SS_fieldP". */ + +static void +test_one_liner_fixit_remove_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 18); + location_t finish = linemap_position_for_column (line_table, 30); + location_t dot = make_location (start, start, finish); + rich_location richloc (line_table, dot); + richloc.add_fixit_remove (); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~\n" + " ----------\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP". */ + +static void +test_one_liner_fixit_replace_utf8 () +{ + test_diagnostic_context dc; + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + location_t field = make_location (start, start, finish); + rich_location richloc (line_table, field); + richloc.add_fixit_replace ("m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + but where the caret was elsewhere. */ + +static void +test_one_liner_fixit_replace_non_equal_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + source_range range; + range.m_start = start; + range.m_finish = finish; + richloc.add_fixit_replace (range, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is not indicated in the annotation line, so + it should be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " ---------\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Replace fix-it hint: replacing "SS_fieldP" with "m_SSfieldP", + where the caret was elsewhere, but where a secondary range + exactly covers "field". */ + +static void +test_one_liner_fixit_replace_equal_secondary_range_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + location_t start = linemap_position_for_column (line_table, 19); + location_t finish = linemap_position_for_column (line_table, 30); + rich_location richloc (line_table, equals); + location_t field = make_location (start, start, finish); + richloc.add_range (field); + richloc.add_fixit_replace (field, "m_\xf0\x9f\x98\x82_field\xcf\x80"); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + /* The replacement range is indicated in the annotation line, + so it shouldn't be indicated via an additional underline. */ + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^ ~~~~~~~~~\n" + " m_\xf0\x9f\x98\x82" + "_field\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Verify that we can use ad-hoc locations when adding fixits to a + rich_location. */ + +static void +test_one_liner_fixit_validation_adhoc_locations_utf8 () +{ + /* Generate a range that's too long to be packed, so must + be stored as an ad-hoc location (given the defaults + of 5 bits or 0 bits of packed range); 41 columns > 2**5. */ + const location_t c12 = linemap_position_for_column (line_table, 12); + const location_t c52 = linemap_position_for_column (line_table, 52); + const location_t loc = make_location (c12, c12, c52); + + if (c52 > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_TRUE (IS_ADHOC_LOC (loc)); + + /* Insert. */ + { + rich_location richloc (line_table, loc); + richloc.add_fixit_insert_before (loc, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } + + /* Remove. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_remove (range); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " -------------------------------------\n", + pp_formatted_text (dc.printer)); + } + + /* Replace. */ + { + rich_location richloc (line_table, loc); + source_range range = source_range::from_locations (loc, c52); + richloc.add_fixit_replace (range, "test"); + /* It should not have been discarded by the validator. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~~~~~~~~~~~ \n" + " test\n", + pp_formatted_text (dc.printer)); + } +} + +/* Test of consolidating insertions at the same location. */ + +static void +test_one_liner_many_fixits_1_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + for (int i = 0; i < 19; i++) + richloc.add_fixit_insert_before (i & 1 ? "@" : "\xcf\x80"); + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@" + "\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80@\xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Ensure that we can add an arbitrary number of fix-it hints to a + rich_location, even if they are not consolidated. */ + +static void +test_one_liner_many_fixits_2_utf8 () +{ + test_diagnostic_context dc; + location_t equals = linemap_position_for_column (line_table, 10); + rich_location richloc (line_table, equals); + const int nlocs = 19; + int locs[nlocs] = {1, 5, 7, 9, 11, 14, 16, 18, 23, 25, 27, 29, 32, + 34, 36, 38, 40, 42, 44}; + for (int i = 0; i != nlocs; ++i) + { + location_t loc = linemap_position_for_column (line_table, locs[i]); + richloc.add_fixit_insert_before (loc, i & 1 ? "@" : "\xcf\x80"); + } + + ASSERT_EQ (nlocs, richloc.get_num_fixit_hints ()); + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^\n" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @" + " \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80 @ \xcf\x80\n", + pp_formatted_text (dc.printer)); +} + +/* Test of labeling the ranges within a rich_location. */ + +static void +test_one_liner_labels_utf8 () +{ + location_t foo + = make_location (linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 1), + linemap_position_for_column (line_table, 8)); + location_t bar + = make_location (linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 12), + linemap_position_for_column (line_table, 17)); + location_t field + = make_location (linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 19), + linemap_position_for_column (line_table, 30)); + + /* Example where all the labels fit on one line. */ + { + /* These three labels contain multibyte characters such that their byte + lengths are respectively (12, 10, 18), but their display widths are only + (6, 5, 9). All three fit on the line when considering the display + widths, but not when considering the byte widths, so verify that we do + indeed put them all on one line. */ + text_range_label label0 + ("\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80"); + text_range_label label1 + ("\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label2 + ("\xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + "\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + { + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " \xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80\xcf\x80" + " \xf0\x9f\x98\x82\xf0\x9f\x98\x82\xcf\x80" + " \xf0\x9f\x98\x82\xcf\x80\xf0\x9f\x98\x82" + "\xf0\x9f\x98\x82\xcf\x80\xcf\x80\n", + pp_formatted_text (dc.printer)); + } + + } + + /* Example where the labels need extra lines. */ + { + text_range_label label0 ("label 0\xf0\x9f\x98\x82"); + text_range_label label1 ("label 1\xcf\x80"); + text_range_label label2 ("label 2\xcf\x80"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | label 2\xcf\x80\n" + " | label 1\xcf\x80\n" + " label 0\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } + + /* Example of boundary conditions: label 0 and 1 have just enough clearance, + but label 1 just touches label 2. */ + { + text_range_label label0 ("aaaaa\xf0\x9f\x98\x82\xcf\x80"); + text_range_label label1 ("bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82"); + text_range_label label2 ("c"); + gcc_rich_location richloc (foo, &label0); + richloc.add_range (bar, SHOW_RANGE_WITHOUT_CARET, &label1); + richloc.add_range (field, SHOW_RANGE_WITHOUT_CARET, &label2); + + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " \xf0\x9f\x98\x82" + "_foo = \xcf\x80" + "_bar.\xf0\x9f\x98\x82" + "_field\xcf\x80" + ";\n" + " ^~~~~~ ~~~~~ ~~~~~~~~~\n" + " | | |\n" + " | | c\n" + " aaaaa\xf0\x9f\x98\x82\xcf\x80" + " bb\xf0\x9f\x98\x82\xf0\x9f\x98\x82\n", + pp_formatted_text (dc.printer)); + } +} + +/* Run the various one-liner tests. */ + +static void +test_diagnostic_show_locus_one_liner_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + const char *content + /* Display columns. + 0000000000000000000000011111111111111111111111111111112222222222222 + 1111111122222222345678900000000123456666666677777777890123444444445 */ + = "\xf0\x9f\x98\x82_foo = \xcf\x80_bar.\xf0\x9f\x98\x82_field\xcf\x80;\n"; + /* 0000000000000000000001111111111111111111222222222222222222222233333 + 1111222233334444567890122223333456789999000011112222345678999900001 + Byte columns. */ + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + linemap_add (line_table, LC_ENTER, false, tmp.get_filename (), 1); + + location_t line_end = linemap_position_for_column (line_table, 31); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + ASSERT_STREQ (tmp.get_filename (), LOCATION_FILE (line_end)); + ASSERT_EQ (1, LOCATION_LINE (line_end)); + ASSERT_EQ (31, LOCATION_COLUMN (line_end)); + + char_span lspan = location_get_source_line (tmp.get_filename (), 1); + ASSERT_EQ (25, cpp_display_width (lspan.get_buffer (), lspan.length ())); + ASSERT_EQ (25, location_compute_display_column (expand_location (line_end))); + + test_one_liner_simple_caret_utf8 (); + test_one_liner_caret_and_range_utf8 (); + test_one_liner_multiple_carets_and_ranges_utf8 (); + test_one_liner_fixit_insert_before_utf8 (); + test_one_liner_fixit_insert_after_utf8 (); + test_one_liner_fixit_remove_utf8 (); + test_one_liner_fixit_replace_utf8 (); + test_one_liner_fixit_replace_non_equal_range_utf8 (); + test_one_liner_fixit_replace_equal_secondary_range_utf8 (); + test_one_liner_fixit_validation_adhoc_locations_utf8 (); + test_one_liner_many_fixits_1_utf8 (); + test_one_liner_many_fixits_2_utf8 (); + test_one_liner_labels_utf8 (); +} + +/* Verify that gcc_rich_location::add_location_if_nearby works. */ + +static void +test_add_location_if_nearby (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. + ...000000000111111111122222222223333333333. + ...123456789012345678901234567890123456789. */ + const char *content + = ("struct same_line { double x; double y; ;\n" /* line 1. */ + "struct different_line\n" /* line 2. */ + "{\n" /* line 3. */ + " double x;\n" /* line 4. */ + " double y;\n" /* line 5. */ + ";\n"); /* line 6. */ + temp_source_file tmp (SELFTEST_LOCATION, ".c", content); + line_table_test ltt (case_); + + const line_map_ordinary *ord_map + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, + tmp.get_filename (), 0)); + + linemap_line_start (line_table, 1, 100); + + const location_t final_line_end + = linemap_position_for_line_and_column (line_table, ord_map, 6, 7); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + /* Test of add_location_if_nearby on the same line as the + primary location. */ + { + const location_t missing_close_brace_1_39 + = linemap_position_for_line_and_column (line_table, ord_map, 1, 39); + const location_t matching_open_brace_1_18 + = linemap_position_for_line_and_column (line_table, ord_map, 1, 18); + gcc_rich_location richloc (missing_close_brace_1_39); + bool added = richloc.add_location_if_nearby (matching_open_brace_1_18); + ASSERT_TRUE (added); + ASSERT_EQ (2, richloc.get_num_locations ()); + test_diagnostic_context dc; + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " struct same_line { double x; double y; ;\n" + " ~ ^\n", + pp_formatted_text (dc.printer)); + } + + /* Test of add_location_if_nearby on a different line to the + primary location. */ + { + const location_t missing_close_brace_6_1 + = linemap_position_for_line_and_column (line_table, ord_map, 6, 1); + const location_t matching_open_brace_3_1 + = linemap_position_for_line_and_column (line_table, ord_map, 3, 1); + gcc_rich_location richloc (missing_close_brace_6_1); + bool added = richloc.add_location_if_nearby (matching_open_brace_3_1); + ASSERT_FALSE (added); + ASSERT_EQ (1, richloc.get_num_locations ()); + } +} + +/* Verify that we print fixits even if they only affect lines + outside those covered by the ranges in the rich_location. */ + +static void +test_diagnostic_show_locus_fixit_lines (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. ...000000000111111111122222222223333333333. ...123456789012345678901234567890123456789. */ const char *content @@ -3340,13 +4304,19 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* Unit-test the line_corrections machinery. */ ASSERT_EQ (3, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (12, 12), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (12, 12), get_affected_range (hint_0, CU_BYTES)); + ASSERT_EQ (column_range (12, 12), + get_affected_range (hint_0, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (18, 18), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (18, 18), get_affected_range (hint_1, CU_BYTES)); + ASSERT_EQ (column_range (18, 18), + get_affected_range (hint_1, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); const fixit_hint *hint_2 = richloc.get_fixit_hint (2); - ASSERT_EQ (column_range (29, 28), get_affected_columns (hint_2)); + ASSERT_EQ (column_range (29, 28), get_affected_range (hint_2, CU_BYTES)); + ASSERT_EQ (column_range (29, 28), + get_affected_range (hint_2, CU_DISPLAY_COLS)); ASSERT_EQ (column_range (29, 29), get_printed_columns (hint_2)); /* Add each hint in turn to a line_corrections instance, @@ -3357,6 +4327,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) /* The first replace hint by itself. */ lc.add_hint (hint_0); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); @@ -3366,6 +4337,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) lc.add_hint (hint_1); ASSERT_EQ (1, lc.m_corrections.length ()); ASSERT_STREQ ("const_cast<foo *> (", lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); @@ -3375,6 +4347,7 @@ test_overlapped_fixit_printing (const line_table_case &case_) ASSERT_STREQ ("const_cast<foo *> (ptr->field)", lc.m_corrections[0]->m_text); ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_bytes); ASSERT_EQ (column_range (12, 28), lc.m_corrections[0]->m_affected_columns); ASSERT_EQ (column_range (12, 41), lc.m_corrections[0]->m_printed_columns); } @@ -3477,6 +4450,246 @@ test_overlapped_fixit_printing (const line_table_case &case_) } } +/* Multibyte-aware version of preceding tests. See comments above + test_one_liner_simple_caret_utf8() too, we use the same two multibyte + characters here. */ + +static void +test_overlapped_fixit_printing_utf8 (const line_table_case &case_) +{ + /* Create a tempfile and write some text to it. */ + + const char *content + /* Display columns. + 00000000000000000000000111111111111111111111111222222222222222223 + 12344444444555555556789012344444444555555556789012345678999999990 */ + = " f\xf0\x9f\x98\x82 *f = (f\xf0\x9f\x98\x82 *)ptr->field\xcf\x80;\n"; + /* 00000000000000000000011111111111111111111112222222222333333333333 + 12344445555666677778901234566667777888899990123456789012333344445 + Byte columns. */ + + temp_source_file tmp (SELFTEST_LOCATION, ".C", content); + line_table_test ltt (case_); + + const line_map_ordinary *ord_map + = linemap_check_ordinary (linemap_add (line_table, LC_ENTER, false, + tmp.get_filename (), 0)); + + linemap_line_start (line_table, 1, 100); + + const location_t final_line_end + = linemap_position_for_line_and_column (line_table, ord_map, 6, 50); + + /* Don't attempt to run the tests if column data might be unavailable. */ + if (final_line_end > LINE_MAP_MAX_LOCATION_WITH_COLS) + return; + + /* A test for converting a C-style cast to a C++-style cast. */ + const location_t open_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 14); + const location_t close_paren + = linemap_position_for_line_and_column (line_table, ord_map, 1, 22); + const location_t expr_start + = linemap_position_for_line_and_column (line_table, ord_map, 1, 23); + const location_t expr_finish + = linemap_position_for_line_and_column (line_table, ord_map, 1, 34); + const location_t expr = make_location (expr_start, expr_start, expr_finish); + + /* Various examples of fix-it hints that aren't themselves consolidated, + but for which the *printing* may need consolidation. */ + + /* Example where 3 fix-it hints are printed as one. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "const_cast<"); + richloc.add_fixit_replace (close_paren, "> ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " const_cast<f\xf0\x9f\x98\x82" + " *> (ptr->field\xcf\x80" + ")\n", + pp_formatted_text (dc.printer)); + + /* Unit-test the line_corrections machinery. */ + ASSERT_EQ (3, richloc.get_num_fixit_hints ()); + const fixit_hint *hint_0 = richloc.get_fixit_hint (0); + ASSERT_EQ (column_range (14, 14), get_affected_range (hint_0, CU_BYTES)); + ASSERT_EQ (column_range (12, 12), + get_affected_range (hint_0, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (12, 22), get_printed_columns (hint_0)); + const fixit_hint *hint_1 = richloc.get_fixit_hint (1); + ASSERT_EQ (column_range (22, 22), get_affected_range (hint_1, CU_BYTES)); + ASSERT_EQ (column_range (18, 18), + get_affected_range (hint_1, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (18, 20), get_printed_columns (hint_1)); + const fixit_hint *hint_2 = richloc.get_fixit_hint (2); + ASSERT_EQ (column_range (35, 34), get_affected_range (hint_2, CU_BYTES)); + ASSERT_EQ (column_range (30, 29), + get_affected_range (hint_2, CU_DISPLAY_COLS)); + ASSERT_EQ (column_range (30, 30), get_printed_columns (hint_2)); + + /* Add each hint in turn to a line_corrections instance, + and verify that they are consolidated into one correction instance + as expected. */ + line_corrections lc (tmp.get_filename (), 1); + + /* The first replace hint by itself. */ + lc.add_hint (hint_0); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 14), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 12), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 22), lc.m_corrections[0]->m_printed_columns); + ASSERT_STREQ ("const_cast<", lc.m_corrections[0]->m_text); + + /* After the second replacement hint, they are printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_1); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (", + lc.m_corrections[0]->m_text); + ASSERT_EQ (column_range (14, 22), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 18), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 30), lc.m_corrections[0]->m_printed_columns); + + /* After the final insertion hint, they are all printed together + as a replacement (along with the text between them). */ + lc.add_hint (hint_2); + ASSERT_STREQ ("const_cast<f\xf0\x9f\x98\x82 *> (ptr->field\xcf\x80)", + lc.m_corrections[0]->m_text); + ASSERT_EQ (1, lc.m_corrections.length ()); + ASSERT_EQ (column_range (14, 34), lc.m_corrections[0]->m_affected_bytes); + ASSERT_EQ (column_range (12, 29), lc.m_corrections[0]->m_affected_columns); + ASSERT_EQ (column_range (12, 42), lc.m_corrections[0]->m_printed_columns); + } + + /* Example where two are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CAST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CAST (-\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example where none are consolidated during printing. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_replace (open_paren, "CST ("); + richloc.add_fixit_replace (close_paren, ") ("); + richloc.add_fixit_insert_after (")"); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -\n" + " CST ( -\n" + " ) ( )\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(bar\xf0\x9f\x98\x82 *)"); + source_range victim = {open_paren, close_paren}; + richloc.add_fixit_remove (victim); + + /* This case is actually handled by fixit-consolidation, + rather than by line_corrections. */ + ASSERT_EQ (1, richloc.get_num_fixit_hints ()); + + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " (bar\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of deletion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before (open_paren, "(long\xf0\x9f\x98\x82 *)"); + source_range victim = {expr_start, expr_finish}; + richloc.add_fixit_remove (victim); + + /* These fixits are not consolidated. */ + ASSERT_EQ (2, richloc.get_num_fixit_hints ()); + + /* But the corrections are. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " ------------------\n" + " (long\xf0\x9f\x98\x82" + " *)(f\xf0\x9f\x98\x82" + " *)\n", + pp_formatted_text (dc.printer)); + } + + /* Example of insertion fix-it hints that would overlap. */ + { + test_diagnostic_context dc; + rich_location richloc (line_table, expr); + richloc.add_fixit_insert_before + (open_paren, "L\xf0\x9f\x98\x82NGER THAN THE CAST"); + richloc.add_fixit_insert_after (close_paren, "TEST"); + + /* The first insertion is long enough that if printed naively, + it would overlap with the second. + Verify that they are printed as a single replacement. */ + diagnostic_show_locus (&dc, &richloc, DK_ERROR); + ASSERT_STREQ ("\n" + " f\xf0\x9f\x98\x82" + " *f = (f\xf0\x9f\x98\x82" + " *)ptr->field\xcf\x80" + ";\n" + " ^~~~~~~~~~~\n" + " -------\n" + " L\xf0\x9f\x98\x82" + "NGER THAN THE CAST(f\xf0\x9f\x98\x82" + " *)TEST\n", + pp_formatted_text (dc.printer)); + } +} + /* Verify that the line_corrections machinery correctly prints overlapping fixit-hints that have been added in the wrong order. @@ -3526,10 +4739,10 @@ test_overlapped_fixit_printing_2 (const line_table_case &case_) /* These fixits should be accepted; they can't be consolidated. */ ASSERT_EQ (2, richloc.get_num_fixit_hints ()); const fixit_hint *hint_0 = richloc.get_fixit_hint (0); - ASSERT_EQ (column_range (23, 22), get_affected_columns (hint_0)); + ASSERT_EQ (column_range (23, 22), get_affected_range (hint_0, CU_BYTES)); ASSERT_EQ (column_range (23, 23), get_printed_columns (hint_0)); const fixit_hint *hint_1 = richloc.get_fixit_hint (1); - ASSERT_EQ (column_range (21, 20), get_affected_columns (hint_1)); + ASSERT_EQ (column_range (21, 20), get_affected_range (hint_1, CU_BYTES)); ASSERT_EQ (column_range (21, 21), get_printed_columns (hint_1)); /* Verify that they're printed correctly. */ @@ -3851,15 +5064,19 @@ diagnostic_show_locus_c_tests () test_layout_range_for_single_line (); test_layout_range_for_multiple_lines (); - test_get_line_width_without_trailing_whitespace (); + for_each_line_table_case (test_layout_x_offset_display_utf8); + + test_get_line_bytes_without_trailing_whitespace (); test_diagnostic_show_locus_unknown_location (); for_each_line_table_case (test_diagnostic_show_locus_one_liner); + for_each_line_table_case (test_diagnostic_show_locus_one_liner_utf8); for_each_line_table_case (test_add_location_if_nearby); for_each_line_table_case (test_diagnostic_show_locus_fixit_lines); for_each_line_table_case (test_fixit_consolidation); for_each_line_table_case (test_overlapped_fixit_printing); + for_each_line_table_case (test_overlapped_fixit_printing_utf8); for_each_line_table_case (test_overlapped_fixit_printing_2); for_each_line_table_case (test_fixit_insert_containing_newline); for_each_line_table_case (test_fixit_insert_containing_newline_2); diff --git a/gcc/input.c b/gcc/input.c index 00301ef68dd..1dc6b339afe 100644 --- a/gcc/input.c +++ b/gcc/input.c @@ -908,6 +908,22 @@ make_location (location_t caret, source_range src_range) return COMBINE_LOCATION_DATA (line_table, pure_loc, src_range, NULL); } +/* An expanded_location stores the column in byte units. This function + converts that column to display units. That requires reading the associated + source line in order to calculate the display width. If that cannot be done + for any reason, then returns the byte column as a fallback. */ +int +location_compute_display_column (expanded_location exploc) +{ + if (!(exploc.file && *exploc.file && exploc.line && exploc.column)) + return exploc.column; + char_span line = location_get_source_line (exploc.file, exploc.line); + /* If line is NULL, this function returns exploc.column which is the + desired fallback. */ + return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), + exploc.column); +} + /* Dump statistics to stderr about the memory usage of the line_table set of line maps. This also displays some statistics about macro expansion. */ @@ -3590,6 +3606,93 @@ test_line_offset_overflow () ASSERT_NE (ordmap_a, ordmap_b); } +void test_cpp_utf8 () +{ + /* Verify that wcwidth of invalid UTF-8 or control bytes is 1. */ + { + int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8); + ASSERT_EQ (8, w_bad); + int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6); + ASSERT_EQ (6, w_ctrl); + } + + /* Verify that wcwidth of valid UTF-8 is as expected. */ + { + const int w_pi = cpp_display_width ("\xcf\x80", 2); + ASSERT_EQ (1, w_pi); + const int w_emoji = cpp_display_width ("\xf0\x9f\x98\x82", 4); + ASSERT_EQ (2, w_emoji); + const int w_umlaut_precomposed = cpp_display_width ("\xc3\xbf", 2); + ASSERT_EQ (1, w_umlaut_precomposed); + const int w_umlaut_combining = cpp_display_width ("y\xcc\x88", 3); + ASSERT_EQ (1, w_umlaut_combining); + const int w_han = cpp_display_width ("\xe4\xb8\xba", 3); + ASSERT_EQ (2, w_han); + const int w_ascii = cpp_display_width ("GCC", 3); + ASSERT_EQ (3, w_ascii); + const int w_mixed = cpp_display_width ("\xcf\x80 = 3.14 \xf0\x9f\x98\x82" + "\x9f! \xe4\xb8\xba y\xcc\x88", 24); + ASSERT_EQ (18, w_mixed); + } + + /* Verify that cpp_byte_column_to_display_column can go past the end, + and similar edge cases. */ + { + const char *str + /* Display columns. + 111111112345 */ + = "\xcf\x80 abc"; + /* 111122223456 + Byte columns. */ + + ASSERT_EQ (5, cpp_display_width (str, 6)); + ASSERT_EQ (105, cpp_byte_column_to_display_column (str, 6, 106)); + ASSERT_EQ (10000, cpp_byte_column_to_display_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_byte_column_to_display_column (NULL, 10000, 0)); + } + + /* Verify that cpp_display_column_to_byte_column can go past the end, + and similar edge cases, and check invertibility. */ + { + const char *str + /* Display columns. + 000000000000000000000000000000000000011 + 111111112222222234444444455555555678901 */ + = "\xf0\x9f\x98\x82 \xf0\x9f\x98\x82 hello"; + /* 000000000000000000000000000000000111111 + 111122223333444456666777788889999012345 + Byte columns. */ + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 2)); + ASSERT_EQ (15, cpp_display_column_to_byte_column (str, 15, 11)); + ASSERT_EQ (115, cpp_display_column_to_byte_column (str, 15, 111)); + ASSERT_EQ (10000, cpp_display_column_to_byte_column (NULL, 0, 10000)); + ASSERT_EQ (0, cpp_display_column_to_byte_column (NULL, 10000, 0)); + + /* Verify that we do not interrupt a UTF-8 sequence. */ + ASSERT_EQ (4, cpp_display_column_to_byte_column (str, 15, 1)); + + for (int byte_col = 1; byte_col <= 15; ++byte_col) + { + const int disp_col = cpp_byte_column_to_display_column (str, 15, + byte_col); + const int byte_col2 = cpp_display_column_to_byte_column (str, 15, + disp_col); + + /* If we ask for the display column in the middle of a UTF-8 + sequence, it will return the length of the partial sequence, + matching the behavior of GCC before display column support. + Otherwise check the round trip was successful. */ + if (byte_col < 4) + ASSERT_EQ (byte_col, disp_col); + else if (byte_col >= 6 && byte_col < 9) + ASSERT_EQ (3 + (byte_col - 5), disp_col); + else + ASSERT_EQ (byte_col2, byte_col); + } + } + +} + /* Run all of the selftests within this file. */ void @@ -3631,6 +3734,8 @@ input_c_tests () test_reading_source_line (); test_line_offset_overflow (); + + test_cpp_utf8 (); } } // namespace selftest diff --git a/gcc/input.h b/gcc/input.h index c459bf28553..35e02bd91d5 100644 --- a/gcc/input.h +++ b/gcc/input.h @@ -38,6 +38,7 @@ STATIC_ASSERT (BUILTINS_LOCATION < RESERVED_LOCATION_COUNT); extern bool is_location_from_builtin_token (location_t); extern expanded_location expand_location (location_t); +extern int location_compute_display_column (expanded_location); /* A class capturing the bounds of a buffer, to allow for run-time bounds-checking in a checked build. */ diff --git a/gcc/testsuite/gcc.dg/cpp/pr66415-1.c b/gcc/testsuite/gcc.dg/cpp/pr66415-1.c index cc4e41724a2..4a0ef551840 100644 --- a/gcc/testsuite/gcc.dg/cpp/pr66415-1.c +++ b/gcc/testsuite/gcc.dg/cpp/pr66415-1.c @@ -1,7 +1,7 @@ /* PR c/66415 */ /* { dg-do compile } */ /* { dg-options "-Wformat -fdiagnostics-show-caret" } */ -/* { dg-set-compiler-env-var COLUMNS "82" } */ +/* { dg-set-compiler-env-var COLUMNS "83" } */ void fn1 (void) diff --git a/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c b/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c index 3f62edd408e..153bdb2fd89 100644 --- a/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c +++ b/gcc/testsuite/gcc.dg/plugin/diagnostic_plugin_test_show_locus.c @@ -174,7 +174,7 @@ test_show_locus (function *fun) /* Hardcode the "terminal width", to verify the behavior of very wide lines. */ - global_dc->caret_max_width = 70; + global_dc->caret_max_width = 71; if (0 == strcmp (fnname, "test_simple")) { diff --git a/libcpp/charset.c b/libcpp/charset.c index d4574415ac1..956d2dad5c8 100644 --- a/libcpp/charset.c +++ b/libcpp/charset.c @@ -2265,3 +2265,106 @@ cpp_string_location_reader::get_next () m_loc += m_offset_per_column; return result; } + +/* Helper for cpp_byte_column_to_display_column and its inverse. Given a + pointer to a UTF-8-encoded character, compute its display width. *INBUFP + points on entry to the start of the UTF-8 encoding of the character, and + is updated to point just after the last byte of the encoding. *INBYTESLEFTP + contains on entry the remaining size of the buffer into which *INBUFP + points, and this is also updated accordingly. If *INBUFP does not + point to a valid UTF-8-encoded sequence, then it will be treated as a single + byte with display width 1. */ + +static inline int +compute_next_display_width (const uchar **inbufp, size_t *inbytesleftp) +{ + cppchar_t c; + if (one_utf8_to_cppchar (inbufp, inbytesleftp, &c) != 0) + { + /* Input is not convertible to UTF-8. This could be fine, e.g. in a + string literal, so don't complain. Just treat it as if it has a width + of one. */ + ++*inbufp; + --*inbytesleftp; + return 1; + } + + /* one_utf8_to_cppchar() has updated inbufp and inbytesleftp for us. */ + return cpp_wcwidth (c); +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + how many display columns are occupied by the first COLUMN bytes. COLUMN + may exceed DATA_LENGTH, in which case the phantom bytes at the end are + treated as if they have display width 1. */ + +int +cpp_byte_column_to_display_column (const char *data, int data_length, + int column) +{ + int display_col = 0; + const uchar *udata = (const uchar *) data; + const int offset = MAX (0, column - data_length); + size_t inbytesleft = column - offset; + while (inbytesleft) + display_col += compute_next_display_width (&udata, &inbytesleft); + return display_col + offset; +} + +/* For the string of length DATA_LENGTH bytes that begins at DATA, compute + the least number of bytes that will result in at least DISPLAY_COL display + columns. The return value may exceed DATA_LENGTH if the entire string does + not occupy enough display columns. */ + +int +cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col) +{ + int column = 0; + const uchar *udata = (const uchar *) data; + size_t inbytesleft = data_length; + while (column < display_col && inbytesleft) + column += compute_next_display_width (&udata, &inbytesleft); + return data_length - inbytesleft + MAX (0, display_col - column); +} + +/* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc, + because that will inspect the user's locale, and in particular in an ASCII + locale, it will not return anything useful for extended characters. But GCC + in other respects (see e.g. _cpp_default_encoding()) behaves as if + everything is UTF-8. We also make some tweaks that are useful for the way + GCC needs to use this data, e.g. tabs and other control characters should be + treated as having width 1. The lookup tables are generated from + contrib/unicode/gen_wcwidth.py and were made by simply calling glibc + wcwidth() on all codepoints, then applying the small tweaks. These tables + are not highly optimized, but for the present purpose of outputting + diagnostics, they are sufficient. */ + +#include "generated_cpp_wcwidth.h" +int cpp_wcwidth (cppchar_t c) +{ + if (__builtin_expect (c <= wcwidth_range_ends[0], true)) + return wcwidth_widths[0]; + + /* Binary search the tables. */ + int begin = 1; + static const int end + = sizeof wcwidth_range_ends / sizeof (*wcwidth_range_ends); + int len = end - begin; + do + { + int half = len/2; + int middle = begin + half; + if (c > wcwidth_range_ends[middle]) + { + begin = middle + 1; + len -= half + 1; + } + else + len = half; + } while (len); + + if (__builtin_expect (begin != end, true)) + return wcwidth_widths[begin]; + return 1; +} diff --git a/libcpp/generated_cpp_wcwidth.h b/libcpp/generated_cpp_wcwidth.h new file mode 100644 index 00000000000..ec8b73d3d01 --- /dev/null +++ b/libcpp/generated_cpp_wcwidth.h @@ -0,0 +1,156 @@ +/* Generated by contrib/unicode/gen_wcwidth.py, with the help of glibc's + utf8_gen.py, using version 12.1.0 of the Unicode standard. */ + +static const cppchar_t wcwidth_range_ends[] = { + 0x2ff, 0x36f, 0x482, 0x489, 0x590, 0x5bd, 0x5be, 0x5bf, + 0x5c0, 0x5c2, 0x5c3, 0x5c5, 0x5c6, 0x5c7, 0x60f, 0x61a, + 0x61b, 0x61c, 0x64a, 0x65f, 0x66f, 0x670, 0x6d5, 0x6dc, + 0x6de, 0x6e4, 0x6e6, 0x6e8, 0x6e9, 0x6ed, 0x710, 0x711, + 0x72f, 0x74a, 0x7a5, 0x7b0, 0x7ea, 0x7f3, 0x7fc, 0x7fd, + 0x815, 0x819, 0x81a, 0x823, 0x824, 0x827, 0x828, 0x82d, + 0x858, 0x85b, 0x8d2, 0x8e1, 0x8e2, 0x902, 0x939, 0x93a, + 0x93b, 0x93c, 0x940, 0x948, 0x94c, 0x94d, 0x950, 0x957, + 0x961, 0x963, 0x980, 0x981, 0x9bb, 0x9bc, 0x9c0, 0x9c4, + 0x9cc, 0x9cd, 0x9e1, 0x9e3, 0x9fd, 0x9fe, 0xa00, 0xa02, + 0xa3b, 0xa3c, 0xa40, 0xa42, 0xa46, 0xa48, 0xa4a, 0xa4d, + 0xa50, 0xa51, 0xa6f, 0xa71, 0xa74, 0xa75, 0xa80, 0xa82, + 0xabb, 0xabc, 0xac0, 0xac5, 0xac6, 0xac8, 0xacc, 0xacd, + 0xae1, 0xae3, 0xaf9, 0xaff, 0xb00, 0xb01, 0xb3b, 0xb3c, + 0xb3e, 0xb3f, 0xb40, 0xb44, 0xb4c, 0xb4d, 0xb55, 0xb56, + 0xb61, 0xb63, 0xb81, 0xb82, 0xbbf, 0xbc0, 0xbcc, 0xbcd, + 0xbff, 0xc00, 0xc03, 0xc04, 0xc3d, 0xc40, 0xc45, 0xc48, + 0xc49, 0xc4d, 0xc54, 0xc56, 0xc61, 0xc63, 0xc80, 0xc81, + 0xcbb, 0xcbc, 0xcbe, 0xcbf, 0xcc5, 0xcc6, 0xccb, 0xccd, + 0xce1, 0xce3, 0xcff, 0xd01, 0xd3a, 0xd3c, 0xd40, 0xd44, + 0xd4c, 0xd4d, 0xd61, 0xd63, 0xdc9, 0xdca, 0xdd1, 0xdd4, + 0xdd5, 0xdd6, 0xe30, 0xe31, 0xe33, 0xe3a, 0xe46, 0xe4e, + 0xeb0, 0xeb1, 0xeb3, 0xebc, 0xec7, 0xecd, 0xf17, 0xf19, + 0xf34, 0xf35, 0xf36, 0xf37, 0xf38, 0xf39, 0xf70, 0xf7e, + 0xf7f, 0xf84, 0xf85, 0xf87, 0xf8c, 0xf97, 0xf98, 0xfbc, + 0xfc5, 0xfc6, 0x102c, 0x1030, 0x1031, 0x1037, 0x1038, 0x103a, + 0x103c, 0x103e, 0x1057, 0x1059, 0x105d, 0x1060, 0x1070, 0x1074, + 0x1081, 0x1082, 0x1084, 0x1086, 0x108c, 0x108d, 0x109c, 0x109d, + 0x10ff, 0x115f, 0x11ff, 0x135c, 0x135f, 0x1711, 0x1714, 0x1731, + 0x1734, 0x1751, 0x1753, 0x1771, 0x1773, 0x17b3, 0x17b5, 0x17b6, + 0x17bd, 0x17c5, 0x17c6, 0x17c8, 0x17d3, 0x17dc, 0x17dd, 0x180a, + 0x180e, 0x1884, 0x1886, 0x18a8, 0x18a9, 0x191f, 0x1922, 0x1926, + 0x1928, 0x1931, 0x1932, 0x1938, 0x193b, 0x1a16, 0x1a18, 0x1a1a, + 0x1a1b, 0x1a55, 0x1a56, 0x1a57, 0x1a5e, 0x1a5f, 0x1a60, 0x1a61, + 0x1a62, 0x1a64, 0x1a6c, 0x1a72, 0x1a7c, 0x1a7e, 0x1a7f, 0x1aaf, + 0x1abe, 0x1aff, 0x1b03, 0x1b33, 0x1b34, 0x1b35, 0x1b3a, 0x1b3b, + 0x1b3c, 0x1b41, 0x1b42, 0x1b6a, 0x1b73, 0x1b7f, 0x1b81, 0x1ba1, + 0x1ba5, 0x1ba7, 0x1ba9, 0x1baa, 0x1bad, 0x1be5, 0x1be6, 0x1be7, + 0x1be9, 0x1bec, 0x1bed, 0x1bee, 0x1bf1, 0x1c2b, 0x1c33, 0x1c35, + 0x1c37, 0x1ccf, 0x1cd2, 0x1cd3, 0x1ce0, 0x1ce1, 0x1ce8, 0x1cec, + 0x1ced, 0x1cf3, 0x1cf4, 0x1cf7, 0x1cf9, 0x1dbf, 0x1df9, 0x1dfa, + 0x1dff, 0x200a, 0x200f, 0x2029, 0x202e, 0x205f, 0x2064, 0x2065, + 0x206f, 0x20cf, 0x20f0, 0x2319, 0x231b, 0x2328, 0x232a, 0x23e8, + 0x23ec, 0x23ef, 0x23f0, 0x23f2, 0x23f3, 0x25fc, 0x25fe, 0x2613, + 0x2615, 0x2647, 0x2653, 0x267e, 0x267f, 0x2692, 0x2693, 0x26a0, + 0x26a1, 0x26a9, 0x26ab, 0x26bc, 0x26be, 0x26c3, 0x26c5, 0x26cd, + 0x26ce, 0x26d3, 0x26d4, 0x26e9, 0x26ea, 0x26f1, 0x26f3, 0x26f4, + 0x26f5, 0x26f9, 0x26fa, 0x26fc, 0x26fd, 0x2704, 0x2705, 0x2709, + 0x270b, 0x2727, 0x2728, 0x274b, 0x274c, 0x274d, 0x274e, 0x2752, + 0x2755, 0x2756, 0x2757, 0x2794, 0x2797, 0x27af, 0x27b0, 0x27be, + 0x27bf, 0x2b1a, 0x2b1c, 0x2b4f, 0x2b50, 0x2b54, 0x2b55, 0x2cee, + 0x2cf1, 0x2d7e, 0x2d7f, 0x2ddf, 0x2dff, 0x2e7f, 0x2e99, 0x2e9a, + 0x2ef3, 0x2eff, 0x2fd5, 0x2fef, 0x2ffb, 0x2fff, 0x3029, 0x302d, + 0x303e, 0x3040, 0x3096, 0x3098, 0x309a, 0x30ff, 0x3104, 0x312f, + 0x3130, 0x318e, 0x318f, 0x31ba, 0x31bf, 0x31e3, 0x31ef, 0x321e, + 0x321f, 0x4db5, 0x4dbf, 0x9fef, 0x9fff, 0xa48c, 0xa48f, 0xa4c6, + 0xa66e, 0xa672, 0xa673, 0xa67d, 0xa69d, 0xa69f, 0xa6ef, 0xa6f1, + 0xa801, 0xa802, 0xa805, 0xa806, 0xa80a, 0xa80b, 0xa824, 0xa826, + 0xa8c3, 0xa8c5, 0xa8df, 0xa8f1, 0xa8fe, 0xa8ff, 0xa925, 0xa92d, + 0xa946, 0xa951, 0xa95f, 0xa97c, 0xa97f, 0xa982, 0xa9b2, 0xa9b3, + 0xa9b5, 0xa9b9, 0xa9bb, 0xa9bd, 0xa9e4, 0xa9e5, 0xaa28, 0xaa2e, + 0xaa30, 0xaa32, 0xaa34, 0xaa36, 0xaa42, 0xaa43, 0xaa4b, 0xaa4c, + 0xaa7b, 0xaa7c, 0xaaaf, 0xaab0, 0xaab1, 0xaab4, 0xaab6, 0xaab8, + 0xaabd, 0xaabf, 0xaac0, 0xaac1, 0xaaeb, 0xaaed, 0xaaf5, 0xaaf6, + 0xabe4, 0xabe5, 0xabe7, 0xabe8, 0xabec, 0xabed, 0xabff, 0xd7a3, + 0xf8ff, 0xfa6d, 0xfa6f, 0xfad9, 0xfb1d, 0xfb1e, 0xfdff, 0xfe0f, + 0xfe19, 0xfe1f, 0xfe2f, 0xfe52, 0xfe53, 0xfe66, 0xfe67, 0xfe6b, + 0xfefe, 0xfeff, 0xff00, 0xff60, 0xffdf, 0xffe6, 0xfff8, 0xfffb, + 0x101fc, 0x101fd, 0x102df, 0x102e0, 0x10375, 0x1037a, 0x10a00, 0x10a03, + 0x10a04, 0x10a06, 0x10a0b, 0x10a0f, 0x10a37, 0x10a3a, 0x10a3e, 0x10a3f, + 0x10ae4, 0x10ae6, 0x10d23, 0x10d27, 0x10f45, 0x10f50, 0x11000, 0x11001, + 0x11037, 0x11046, 0x1107e, 0x11081, 0x110b2, 0x110b6, 0x110b8, 0x110ba, + 0x110ff, 0x11102, 0x11126, 0x1112b, 0x1112c, 0x11134, 0x11172, 0x11173, + 0x1117f, 0x11181, 0x111b5, 0x111be, 0x111c8, 0x111cc, 0x1122e, 0x11231, + 0x11233, 0x11234, 0x11235, 0x11237, 0x1123d, 0x1123e, 0x112de, 0x112df, + 0x112e2, 0x112ea, 0x112ff, 0x11301, 0x1133a, 0x1133c, 0x1133f, 0x11340, + 0x11365, 0x1136c, 0x1136f, 0x11374, 0x11437, 0x1143f, 0x11441, 0x11444, + 0x11445, 0x11446, 0x1145d, 0x1145e, 0x114b2, 0x114b8, 0x114b9, 0x114ba, + 0x114be, 0x114c0, 0x114c1, 0x114c3, 0x115b1, 0x115b5, 0x115bb, 0x115bd, + 0x115be, 0x115c0, 0x115db, 0x115dd, 0x11632, 0x1163a, 0x1163c, 0x1163d, + 0x1163e, 0x11640, 0x116aa, 0x116ab, 0x116ac, 0x116ad, 0x116af, 0x116b5, + 0x116b6, 0x116b7, 0x1171c, 0x1171f, 0x11721, 0x11725, 0x11726, 0x1172b, + 0x1182e, 0x11837, 0x11838, 0x1183a, 0x119d3, 0x119d7, 0x119d9, 0x119db, + 0x119df, 0x119e0, 0x11a00, 0x11a0a, 0x11a32, 0x11a38, 0x11a3a, 0x11a3e, + 0x11a46, 0x11a47, 0x11a50, 0x11a56, 0x11a58, 0x11a5b, 0x11a89, 0x11a96, + 0x11a97, 0x11a99, 0x11c2f, 0x11c36, 0x11c37, 0x11c3d, 0x11c3e, 0x11c3f, + 0x11c91, 0x11ca7, 0x11ca9, 0x11cb0, 0x11cb1, 0x11cb3, 0x11cb4, 0x11cb6, + 0x11d30, 0x11d36, 0x11d39, 0x11d3a, 0x11d3b, 0x11d3d, 0x11d3e, 0x11d45, + 0x11d46, 0x11d47, 0x11d8f, 0x11d91, 0x11d94, 0x11d95, 0x11d96, 0x11d97, + 0x11ef2, 0x11ef4, 0x1342f, 0x13438, 0x16aef, 0x16af4, 0x16b2f, 0x16b36, + 0x16f4e, 0x16f4f, 0x16f8e, 0x16f92, 0x16fdf, 0x16fe3, 0x16fff, 0x187f7, + 0x187ff, 0x18af2, 0x1afff, 0x1b11e, 0x1b14f, 0x1b152, 0x1b163, 0x1b167, + 0x1b16f, 0x1b2fb, 0x1bc9c, 0x1bc9e, 0x1bc9f, 0x1bca3, 0x1d166, 0x1d169, + 0x1d172, 0x1d182, 0x1d184, 0x1d18b, 0x1d1a9, 0x1d1ad, 0x1d241, 0x1d244, + 0x1d9ff, 0x1da36, 0x1da3a, 0x1da6c, 0x1da74, 0x1da75, 0x1da83, 0x1da84, + 0x1da9a, 0x1da9f, 0x1daa0, 0x1daaf, 0x1dfff, 0x1e006, 0x1e007, 0x1e018, + 0x1e01a, 0x1e021, 0x1e022, 0x1e024, 0x1e025, 0x1e02a, 0x1e12f, 0x1e136, + 0x1e2eb, 0x1e2ef, 0x1e8cf, 0x1e8d6, 0x1e943, 0x1e94a, 0x1f003, 0x1f004, + 0x1f0ce, 0x1f0cf, 0x1f18d, 0x1f18e, 0x1f190, 0x1f19a, 0x1f1ff, 0x1f202, + 0x1f20f, 0x1f23b, 0x1f23f, 0x1f248, 0x1f24f, 0x1f251, 0x1f25f, 0x1f265, + 0x1f2ff, 0x1f320, 0x1f32c, 0x1f335, 0x1f336, 0x1f37c, 0x1f37d, 0x1f393, + 0x1f39f, 0x1f3ca, 0x1f3ce, 0x1f3d3, 0x1f3df, 0x1f3f0, 0x1f3f3, 0x1f3f4, + 0x1f3f7, 0x1f43e, 0x1f43f, 0x1f440, 0x1f441, 0x1f4fc, 0x1f4fe, 0x1f53d, + 0x1f54a, 0x1f54e, 0x1f54f, 0x1f567, 0x1f579, 0x1f57a, 0x1f594, 0x1f596, + 0x1f5a3, 0x1f5a4, 0x1f5fa, 0x1f64f, 0x1f67f, 0x1f6c5, 0x1f6cb, 0x1f6cc, + 0x1f6cf, 0x1f6d2, 0x1f6d4, 0x1f6d5, 0x1f6ea, 0x1f6ec, 0x1f6f3, 0x1f6fa, + 0x1f7df, 0x1f7eb, 0x1f90c, 0x1f971, 0x1f972, 0x1f976, 0x1f979, 0x1f9a2, + 0x1f9a4, 0x1f9aa, 0x1f9ad, 0x1f9ca, 0x1f9cc, 0x1f9ff, 0x1fa6f, 0x1fa73, + 0x1fa77, 0x1fa7a, 0x1fa7f, 0x1fa82, 0x1fa8f, 0x1fa95, 0x1ffff, 0x2a6d6, + 0x2a6ff, 0x2b734, 0x2b73f, 0x2b81d, 0x2b81f, 0x2cea1, 0x2ceaf, 0x2ebe0, + 0x2f7ff, 0x2fa1d, 0xe0000, 0xe0001, 0xe001f, 0xe007f, 0xe00ff, 0xe01ef, +}; + +static const unsigned char wcwidth_widths[] = { + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, + 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, + 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 0, 2, 1, 2, 1, 0, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, + 2, 1, 0, 2, 1, 2, 1, 2, 1, 0, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, + 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, + 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 0, 1, 0, 1, 0, +}; diff --git a/libcpp/include/cpplib.h b/libcpp/include/cpplib.h index ed108f17bfa..e199aecfa48 100644 --- a/libcpp/include/cpplib.h +++ b/libcpp/include/cpplib.h @@ -1320,4 +1320,15 @@ extern bool cpp_userdef_char_p extern const char * cpp_get_userdef_suffix (const cpp_token *); +/* In charset.c */ +int cpp_byte_column_to_display_column (const char *data, int data_length, + int column); +inline int cpp_display_width (const char *data, int data_length) +{ + return cpp_byte_column_to_display_column (data, data_length, data_length); +} +int cpp_display_column_to_byte_column (const char *data, int data_length, + int display_col); +int cpp_wcwidth (cppchar_t c); + #endif /* ! LIBCPP_CPPLIB_H */ ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-12-06 20:31 ` Lewis Hyatt @ 2019-12-09 20:12 ` David Malcolm 2019-12-09 23:00 ` Lewis Hyatt 0 siblings, 1 reply; 17+ messages in thread From: David Malcolm @ 2019-12-09 20:12 UTC (permalink / raw) To: Lewis Hyatt; +Cc: gcc-patches, joseph On Fri, 2019-12-06 at 15:31 -0500, Lewis Hyatt wrote: > On Fri, Dec 06, 2019 at 10:54:30AM -0500, David Malcolm wrote: [...] > > The patch is OK for trunk with the nits above fixed. Do you have > > commit access? (I've got my own patch [1] that touches diagnostic- > > show-locus.c which I'll need to refresh once yours goes in); need > > to > > remember to include those data files when committing. > > > > Thanks very much for fixing this, and sorry again for the delay in > > reviewing it. > > That's wonderful, thanks very much. Happy to contribute something. I > do not > have commit access so if you could please apply it, that would be > great. Thanks; I've committed it on your behalf to trunk as r279137 (including the data files). FWIW I made a few minor fixes: * I added a ChangeLog entry for contrib/unicode/unicode-license.txt, and added the PR reference to the gcc/testsuite/ChangeLog. * I also moved the top-level ChangeLog to contrib/ChangeLog, updating the paths. * I updated the instructions to reflect the path of the generated file: -3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_wcwidth.h +3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_cpp_wcwidth.h (I tested regenerating the file and got the same result as you, on supplying "12.1.0") and did another bootstrap®ression test (on x86_64-pc-linux-gnu) for good measure. > Might I also trouble you to please have a look at this one: > https://gcc.gnu.org/ml/gcc-patches/2019-10/msg00766.html ? Looking now. > It is very much shorter than this one and fixes just a couple > glitches in > pretty-print.c -- UTF-8 gets mangled when printed via %q, and line- > wrapping > shouldn't wrap in the middle of a UTF-8 sequence. That's the only > other > issue I am aware of as far as diagnostics with multibyte characters > go. If you feel like tackling a related issue, maybe have a look at how we print tab characters in diagnostic_show_locus; we should probably resolve them into spaces (respecting -ftab-stop [1]), since when we print them as tabs after a left-margin for line-numbers the "tabification" is mangled. I don't know if there's a bug for this in bugzilla, but it seems tightly related to this column-handling work. > Thanks again! Thanks for all your work putting the patch together. Dave [1] see also c-indentation.c; gah ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH] Multibyte awareness for diagnostics (PR 49973) 2019-12-09 20:12 ` David Malcolm @ 2019-12-09 23:00 ` Lewis Hyatt 0 siblings, 0 replies; 17+ messages in thread From: Lewis Hyatt @ 2019-12-09 23:00 UTC (permalink / raw) To: David Malcolm; +Cc: gcc-patches, joseph On Mon, Dec 09, 2019 at 03:12:31PM -0500, David Malcolm wrote: > On Fri, 2019-12-06 at 15:31 -0500, Lewis Hyatt wrote: > > On Fri, Dec 06, 2019 at 10:54:30AM -0500, David Malcolm wrote: > > [...] > > > > The patch is OK for trunk with the nits above fixed. Do you have > > > commit access? (I've got my own patch [1] that touches diagnostic- > > > show-locus.c which I'll need to refresh once yours goes in); need > > > to > > > remember to include those data files when committing. > > > > > > Thanks very much for fixing this, and sorry again for the delay in > > > reviewing it. > > > > That's wonderful, thanks very much. Happy to contribute something. I > > do not > > have commit access so if you could please apply it, that would be > > great. > > Thanks; I've committed it on your behalf to trunk as r279137 (including > the data files). > > FWIW I made a few minor fixes: > * I added a ChangeLog entry for contrib/unicode/unicode-license.txt, > and added the PR reference to the gcc/testsuite/ChangeLog. > * I also moved the top-level ChangeLog to contrib/ChangeLog, updating > the paths. > * I updated the instructions to reflect the path of the generated file: > -3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_wcwidth.h > +3. Run ./gen_wcwidth.py X.Y > ../../libcpp/generated_cpp_wcwidth.h > (I tested regenerating the file and got the same result as you, on > supplying "12.1.0") > > and did another bootstrap®ression test (on x86_64-pc-linux-gnu) for > good measure. > > > > Might I also trouble you to please have a look at this one: > > https://gcc.gnu.org/ml/gcc-patches/2019-10/msg00766.html ? > > Looking now. > > > It is very much shorter than this one and fixes just a couple > > glitches in > > pretty-print.c -- UTF-8 gets mangled when printed via %q, and line- > > wrapping > > shouldn't wrap in the middle of a UTF-8 sequence. That's the only > > other > > issue I am aware of as far as diagnostics with multibyte characters > > go. > > If you feel like tackling a related issue, maybe have a look at how we > print tab characters in diagnostic_show_locus; we should probably > resolve them into spaces (respecting -ftab-stop [1]), since when we > print them as tabs after a left-margin for line-numbers the > "tabification" is mangled. I don't know if there's a bug for this in > bugzilla, but it seems tightly related to this column-handling work. > > > Thanks again! > > Thanks for all your work putting the patch together. > > Dave > > [1] see also c-indentation.c; gah > That's great, thanks very much. I'm happy to look at the tab situation. My understanding is that -ftabstop is only used to implement the logic in c-indentation.c and does not propagate to diagnostics otherwise. Currently, cpp_wcwidth() returns 1 for all control characters, including tabs. The tab is also counted as 1 byte for purpose of the column number calculation. Then in diagnostic-show-locus, we convert all tabs to a single space on output. So that much is at least consistent and doesn't lead to any spacing issues AFAIK, as far as internal consistency of diagnostic-show-locus's generated output goes. But it does make the source which is output look weird for mixed-tabs-and-spaces styles. Below patch would fix it including respecting -ftabstop. This patch causes cpp_wcwidth() to return the actual tab width for '\t', and also changes diagnostic-show-locus to convert the tab to the same number of spaces. My main concern with this approach is I am not quite sure what's the "right" way to expose the option value everywhere it needs to be. It lives inside a cpp_options struct, but I think this is only accessible from a cpp_file object, which I don't have in all relevant contexts. For this illustration I used a global variable but I wonder whether there's a more preferred way to do it. Other issue would be that the -ftabstop option is only processed in c-family but presumably it's applicable to other languages too. Anyway if that much seems OK, I could prepare this properly including comments + tests. There would of course be the question of what the column number should show in this case. It would be trivial to change it to show the display width of all characters (multibyte and tabs). Changing it to show the byte count of multibyte characters as it does now, but the actual width of tabs newly, would require adding some new concepts that don't exist yet. -Lewis diff --git a/gcc/c-family/c-opts.c b/gcc/c-family/c-opts.c index c913291c07c..ff85344d63f 100644 --- a/gcc/c-family/c-opts.c +++ b/gcc/c-family/c-opts.c @@ -506,7 +506,7 @@ c_common_handle_option (size_t scode, const char *arg, HOST_WIDE_INT value, case OPT_ftabstop_: /* It is documented that we silently ignore silly values. */ if (value >= 1 && value <= 100) - cpp_opts->tabstop = value; + cpp_opts->tabstop = cpp_tab_width = value; break; case OPT_fexec_charset_: diff --git a/gcc/diagnostic-show-locus.c b/gcc/diagnostic-show-locus.c index 9cd16952ce0..4f9a1800030 100644 --- a/gcc/diagnostic-show-locus.c +++ b/gcc/diagnostic-show-locus.c @@ -1508,15 +1508,23 @@ layout::print_source_line (linenum_type row, const char *line, int line_bytes, m_colorizer.set_normal_text (); } char c = *line; - if (c == '\0' || c == '\t' || c == '\r') - c = ' '; - if (c != ' ') + if (c == '\t') { - last_non_ws = col_byte; - if (first_non_ws == INT_MAX) - first_non_ws = col_byte; + for (int i = 0; i < cpp_tab_width; ++i) + pp_space (m_pp); + } + else + { + if (c == '\0' || c == '\r') + c = ' '; + else if (c != ' ') + { + last_non_ws = col_byte; + if (first_non_ws == INT_MAX) + first_non_ws = col_byte; + } + pp_character (m_pp, c); } - pp_character (m_pp, c); line++; } print_newline (); diff --git a/gcc/input.c b/gcc/input.c index 1dc6b339afe..811627d88c8 100644 --- a/gcc/input.c +++ b/gcc/input.c @@ -3612,8 +3612,10 @@ void test_cpp_utf8 () { int w_bad = cpp_display_width ("\xf0!\x9f!\x98!\x82!", 8); ASSERT_EQ (8, w_bad); - int w_ctrl = cpp_display_width ("\r\t\n\v\0\1", 6); - ASSERT_EQ (6, w_ctrl); + int w_ctrl = cpp_display_width ("\r\n\v\0\1", 5); + ASSERT_EQ (5, w_ctrl); + int w_tab = cpp_display_width ("a\tb\tc", 5); + ASSERT_EQ (3 + 2*cpp_tab_width, w_tab); } /* Verify that wcwidth of valid UTF-8 is as expected. */ diff --git a/libcpp/charset.c b/libcpp/charset.c index 956d2dad5c8..b700856a5cc 100644 --- a/libcpp/charset.c +++ b/libcpp/charset.c @@ -2328,6 +2328,8 @@ cpp_display_column_to_byte_column (const char *data, int data_length, return data_length - inbytesleft + MAX (0, display_col - column); } +int cpp_tab_width = 8; + /* Our own version of wcwidth(). We don't use the actual wcwidth() in glibc, because that will inspect the user's locale, and in particular in an ASCII locale, it will not return anything useful for extended characters. But GCC @@ -2344,7 +2346,7 @@ cpp_display_column_to_byte_column (const char *data, int data_length, int cpp_wcwidth (cppchar_t c) { if (__builtin_expect (c <= wcwidth_range_ends[0], true)) - return wcwidth_widths[0]; + return c == '\t' ? cpp_tab_width : wcwidth_widths[0]; /* Binary search the tables. */ int begin = 1; diff --git a/libcpp/include/cpplib.h b/libcpp/include/cpplib.h index e199aecfa48..214f2b868d3 100644 --- a/libcpp/include/cpplib.h +++ b/libcpp/include/cpplib.h @@ -1321,6 +1321,7 @@ extern const char * cpp_get_userdef_suffix (const cpp_token *); /* In charset.c */ +extern int cpp_tab_width; int cpp_byte_column_to_display_column (const char *data, int data_length, int column); inline int cpp_display_width (const char *data, int data_length) ^ permalink raw reply [flat|nested] 17+ messages in thread
end of thread, other threads:[~2019-12-09 23:00 UTC | newest] Thread overview: 17+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2019-09-26 20:16 [PATCH] Multibyte awareness for diagnostics (PR 49973) Lewis Hyatt 2019-09-26 20:47 ` Joseph Myers 2019-09-26 20:51 ` Lewis Hyatt 2019-09-27 20:42 ` Lewis Hyatt 2019-10-18 13:59 ` Lewis Hyatt 2019-11-19 17:38 ` David Malcolm 2019-11-19 18:40 ` Joseph Myers 2019-11-19 22:33 ` Joseph Myers 2019-11-20 16:31 ` Lewis Hyatt 2019-11-20 16:39 ` Lewis Hyatt 2019-11-22 3:24 ` David Malcolm 2019-11-22 11:06 ` David Malcolm 2019-11-26 17:12 ` Lewis Hyatt 2019-12-06 15:54 ` David Malcolm 2019-12-06 20:31 ` Lewis Hyatt 2019-12-09 20:12 ` David Malcolm 2019-12-09 23:00 ` Lewis Hyatt
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).