llvm/llvm-project

clang-tidy check readability-container-data-pointer fix isn't configurable to use std::string::c_str() instead of data()

Open

#55,026 opened on Apr 21, 2022

View on GitHub
 (12 comments) (0 reactions) (0 assignees)C++ (10,782 forks)batch import
clang-tidyenhancementgood first issue

Repository metrics

Stars
 (26,378 stars)
PR merge metrics
 (Avg merge 1d 2h) (1,000 merged PRs in 30d)

Description

This is an "enhancement" request. I used clang-tidy 14.0.0.

Use C++ code

#include <string>

int main()
{
    std::string st1;
    char *cp1 = &st1[0];
    return 0;
}

The clang-tidy fix creates st1.data() -- ideally the fix would create std.c_str() instead or have a fix configuration option for that.

However, usage of c_str() would only work if the "const char* data()" overload were used instead of "char * data()".

Contributor guide

Research direction
Examine the clang tidy readability container data pointer check implementation in the LLVM source. Add a configuration option (e.g., 'UseCStr') that when enabled, replaces data() with c str() for std::string, but only when the const overload is available. Update tests and documentation.
Tech stack
cpp
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++LLVM/clang tidy internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50