1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <tuple>
#include <vector>
// When a C++ MACRO references a variable that isn't passed as an argument to
// that MACRO for example. It is sometimes not possible to spanify correctly.
// This documents a case where the spanification is aborted.
#include "base/containers/span.h"
#define ASSIGN(num) assign(x, num);
void assign(int* x, int num) {
*x = num;
}
void test_with_macro() {
std::vector<int> buffer(10, 0);
// A local variable could be rewritten to a span if there wasn't a MACRO.
{
int* x = buffer.data();
x[0] = 0;
ASSIGN(0);
}
// A local variable that doesn't need to be rewritten to a span.
{
int* x = buffer.data();
ASSIGN(0); // Sets the integer pointed to by x to 0;
}
}
// No function body so that the argument type won't get spanified.
void take_ptr1(int* arg);
// Macros that expect a pointer as the argument.
//
// TODO: Since these macros are defined and used inside this translation unit
// only, we may want to rewrite the macro definitions rather than adding
// ".data()" call on the call sites.
#define TAKE_PTR1(arg) (take_ptr1(arg))
#define TAKE_PTR2(arg) (arg + 1)
#define TAKE_PTR3_REINTERPRET_CAST(arg) (reinterpret_cast<unsigned char*>(arg))
#define TAKE_PTR3_STATIC_CAST(arg) (static_cast<const int*>(arg))
#define TAKE_PTR3_C_STYLE_CAST(arg) ((double*)(arg))
void test_take_ptr_macro() {
int array[] = {1, 2, 3};
// Expected rewrite:
// base::span<int> buf = array;
base::span<int> buf = array;
buf[0] = 0;
// Expected rewrite:
// TAKE_PTR1(buf.data());
TAKE_PTR1(buf.data());
// Expected rewrite:
// UNSAFE_TODO(TAKE_PTR2(buf.data()));
UNSAFE_TODO(TAKE_PTR2(buf.data()));
// Expected rewrite:
// unsigned char* p1 = TAKE_PTR3_REINTERPRET_CAST(buf.data());
unsigned char* p1 = TAKE_PTR3_REINTERPRET_CAST(buf.data());
// Expected rewrite:
// const int* p2 = TAKE_PTR3_STATIC_CAST(buf.data());
const int* p2 = TAKE_PTR3_STATIC_CAST(buf.data());
// Expected rewrite:
// double* p3 = TAKE_PTR3_C_STYLE_CAST(buf.data());
double* p3 = TAKE_PTR3_C_STYLE_CAST(buf.data());
// The following rewrites are not compilable. Just demonstrating the current
// behavior.
//
// Unexpected rewrite:
// base::span<unsigned char> s1 = TAKE_PTR3_REINTERPRET_CAST(buf);
base::span<unsigned char> s1 = TAKE_PTR3_REINTERPRET_CAST(buf);
std::ignore = s1[0];
// Unexpected rewrite:
// base::span<const int> s2 = TAKE_PTR3_STATIC_CAST(buf);
base::span<const int> s2 = TAKE_PTR3_STATIC_CAST(buf);
std::ignore = s2[0];
// Unexpected rewrite:
// base::span<double> s3 = TAKE_PTR3_C_STYLE_CAST(buf);
base::span<double> s3 = TAKE_PTR3_C_STYLE_CAST(buf);
std::ignore = s3[0];
// Just casting doesn't trigger rewriting.
TAKE_PTR3_REINTERPRET_CAST(buf);
TAKE_PTR3_STATIC_CAST(buf);
TAKE_PTR3_C_STYLE_CAST(buf);
}
|
