dtolnay/cxx

Smarter handling of illegal names

Open

#110 opened on Apr 12, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (4,472 stars) (253 forks)batch import
help wanted

Description

We should sanitize where possible (function argument names) and produce diagnostics otherwise (function names, type names, field names).

mod ffi {
    extern "C" {
        // sanitize the variable name somehow instead of emitting invalid C++
        fn f(operator: usize);
    }

    extern "Rust" {
        // reject; ask the user to reimport the Rust fn under a different name
        fn operator();
    }
}

Currently the above all emit invalid C++ code, which is not nice.

Contributor guide

Tech stack
rustcpp
Domain
tooling
Issue type
bug
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Rustfamiliarity with cxx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate how cxx generates C++ bindings, particularly the handling of function argument names. Look at the code generation logic to see where illegal names are emitted and add sanitization or diagnostics. The issue does not mention any linked PRs or comments.