boostorg / boostorg/preprocessor

BOOST_PP_REMOVE_PARENS() is dangerously broken -- it strips initial group of parentheses instead of surrounding

Đang mở
#65 5 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
C++
Star
118
Fork
76
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

https://godbolt.org/z/38jbTP7qn

```
#include

int main(int argc, char *argv[]) {
#if MACRO
return BOOST_PP_REMOVE_PARENS((*argv)[1]); // Crash
#else
return (*argv)[1] ; // OK
#endif
}
```

Note the documentation piles extra confusion on top of this. It says:

> The `BOOST_PP_REMOVE_PARENS` macro removes the beginning parenthesis, if it exists, from the input data and expands to the result

"Parenthes**i**s" is singular (plural is parenthes**es**), so the documentation is claiming that only a beginning `(` is being removed. It makes no mention of removing any closing `)`, regardless of its expected location, even though the function apparently does that regardless of its location.

This is a massive pitfall. The name `BOOST_PP_REMOVE_PARENS` itself (and the intended usage) are misleading for most users and very unlikely to be what they actually want.

I would suggest, at the very least, renaming the macro to something like `BOOST_PP_REMOVE_BEGINNING_PARENS` and updating the documentation to clarify it is not doing what users would expect from a `REMOVE_PARENS` macro.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Start with the Godbolt reproducer and boost/preprocessor/punctuation/remove_parens.hpp to verify how BOOST_PP_REMOVE_PARENS handles the input. Review the documented contract and determine the intended API change, including compatibility and naming implications. Done means the behavior and documentation agree with an explicitly decided contract, with the reproducer no longer exposing the reported pitfall.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
cpp
Lĩnh vực
compilers
Loại issue
Lỗi
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.