Merge pull request #45250 from Qrox/translator-comments-check

Properly implement translator comments check for the _() macro
CleverRaven · Nov 5, 2020 · 146d314 · 146d314
2 parents f390470 + 69c8333
commit 146d314
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git a/src/translations.h b/src/translations.h
@@ -130,21 +130,14 @@ static inline local_translation_cache<std::string> get_local_translation_cache(
     return local_translation_cache<std::string>();
 }
 
-// this function is used as a marker for clang-tidy check (see TranslatorCommentsCheck.cpp)
-template <typename T>
-static inline auto translation_macro_marker_func( T &&arg )
-{
-    return std::forward<T>( arg );
-}
-
 } // namespace detail
 
 // Note: in case of std::string argument, the result is copied, this is intended (for safety)
 #define _( msg ) \
     ( ( []( const auto & arg ) { \
         static auto cache = detail::get_local_translation_cache( arg ); \
         return cache( arg ); \
-    } )( detail::translation_macro_marker_func( msg ) ) )
+    } )( msg ) )
 
 // ngettext overload taking an unsigned long long so that people don't need
 // to cast at call sites.  This is particularly relevant on 64-bit Windows where

diff --git a/tools/clang-tidy-plugin/TranslatorCommentsCheck.cpp b/tools/clang-tidy-plugin/TranslatorCommentsCheck.cpp
@@ -150,10 +150,16 @@ class TranslatorCommentsCheck::TranslationMacroCallback : public PPCallbacks
 
             StringRef MacroName = MacroNameTok.getIdentifierInfo()->getName();
 
+            bool is_marker;
             unsigned int RawStringInd;
-            if( MacroName == "translate_marker" ) {
+            if( MacroName == "_" ) {
+                is_marker = false;
+                RawStringInd = 0;
+            } else if( MacroName == "translate_marker" ) {
+                is_marker = true;
                 RawStringInd = 0;
             } else if( MacroName == "translate_marker_context" ) {
+                is_marker = true;
                 RawStringInd = 1;
             } else {
                 return;
@@ -173,7 +179,9 @@ class TranslatorCommentsCheck::TranslationMacroCallback : public PPCallbacks
                 }
                 for( ; Tok->isNot( tok::eof ); ++Tok ) {
                     if( !tok::isStringLiteral( Tok->getKind() ) ) {
-                        Check.diag( Tok->getLocation(), "Translation marker macros only accepts string literal arguments" );
+                        if( is_marker ) {
+                            Check.diag( Tok->getLocation(), "Translation marker macros only accepts string literal arguments" );
+                        }
                         return;
                     }
                 }
@@ -220,7 +228,7 @@ void TranslatorCommentsCheck::registerMatchers( MatchFinder *Finder )
         );
     Finder->addMatcher(
         callExpr(
-            callee( functionDecl( hasAnyName( "_", "gettext", "translation_macro_marker_func" ) ) ),
+            callee( functionDecl( hasAnyName( "_", "gettext" ) ) ),
             hasImmediateArgument( 0, stringLiteralArgumentBound )
         ),
         this

diff --git a/tools/clang-tidy-plugin/test/translator-comments.cpp b/tools/clang-tidy-plugin/test/translator-comments.cpp
@@ -18,8 +18,12 @@ using string = basic_string<char>;
 // check_clang_tidy uses -nostdinc++, so we add dummy translation interface here instead of including translations.h
 #define translate_marker( s ) ( s )
 #define translate_marker_context( c, s ) ( s )
+// mimic how it's declared in translation.h
+#define _( msg ) \
+    ( ( []( const auto & arg ) { \
+        return arg; \
+    } )( msg ) )
 
-const char *_( const char * );
 const char *gettext( const char * );
 const char *pgettext( const char *, const char * );
 const char *ngettext( const char *, const char *, int );