1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * Based on LLVM/Clang.
6 *
7 * This file is distributed under the University of Illinois Open Source
8 * License. See LICENSE.TXT for details.
9 *
10 */
11
12 #include <memory>
13 #include <set>
14
15 #include "plugin.hxx"
16
17 #include <clang/Lex/Preprocessor.h>
18
19 namespace loplugin
20 {
21
22 /*
23 This is a compile check.
24
25 Feature macros from config_XXX.h headers are always #defined (to 1 or 0 in case of yes/no
26 settings). It is a mistake to use #ifdef/#ifndef/defined to check them.
27
28 Using 1/0 instead of defined/undefined avoids undetected problems when e.g. the necessary
29 #include of the config_XXX.h file is missing.
30 */
31
32 class CheckConfigMacros
33 : public PPCallbacks
34 , public Plugin
35 {
36 public:
37 explicit CheckConfigMacros( const InstantiationData& data );
38 virtual void run() override;
39 virtual void MacroDefined( const Token& macroToken, const MacroDirective* info ) override;
40 virtual void MacroUndefined( const Token& macroToken, MacroDefinition const &, MacroDirective const * ) override;
41 virtual void Ifdef( SourceLocation location, const Token& macroToken, MacroDefinition const & ) override;
42 virtual void Ifndef( SourceLocation location, const Token& macroToken, MacroDefinition const & ) override;
43 virtual void Defined( const Token& macroToken, MacroDefinition const &, SourceRange Range ) override;
44 enum { isPPCallback = true };
45 private:
46 void checkMacro( const Token& macroToken, SourceLocation location );
47 std::set< std::string > configMacros;
48 };
49
CheckConfigMacros(const InstantiationData & data)50 CheckConfigMacros::CheckConfigMacros( const InstantiationData& data )
51 : Plugin( data )
52 {
53 compiler.getPreprocessor().addPPCallbacks(std::unique_ptr<PPCallbacks>(this));
54 }
55
run()56 void CheckConfigMacros::run()
57 {
58 // nothing, only check preprocessor usage
59 }
60
MacroDefined(const Token & macroToken,const MacroDirective * info)61 void CheckConfigMacros::MacroDefined( const Token& macroToken, const MacroDirective* info )
62 {
63 SourceLocation location = info->getLocation();
64 const char* filename = compiler.getSourceManager().getPresumedLoc( location ).getFilename();
65 if( filename != NULL
66 && ( hasPathnamePrefix(filename, BUILDDIR "/config_host/")
67 || hasPathnamePrefix(filename, BUILDDIR "/config_build/") ))
68 {
69 // fprintf(stderr,"DEF: %s %s\n", macroToken.getIdentifierInfo()->getName().data(), filename );
70 configMacros.insert( macroToken.getIdentifierInfo()->getName());
71 }
72 }
73
MacroUndefined(const Token & macroToken,MacroDefinition const &,MacroDirective const *)74 void CheckConfigMacros::MacroUndefined( const Token& macroToken, MacroDefinition const &, MacroDirective const * )
75 {
76 configMacros.erase( macroToken.getIdentifierInfo()->getName());
77 }
78
Ifdef(SourceLocation location,const Token & macroToken,MacroDefinition const &)79 void CheckConfigMacros::Ifdef( SourceLocation location, const Token& macroToken, MacroDefinition const & )
80 {
81 checkMacro( macroToken, location );
82 }
83
Ifndef(SourceLocation location,const Token & macroToken,MacroDefinition const &)84 void CheckConfigMacros::Ifndef( SourceLocation location, const Token& macroToken, MacroDefinition const & )
85 {
86 checkMacro( macroToken, location );
87 }
88
Defined(const Token & macroToken,MacroDefinition const &,SourceRange)89 void CheckConfigMacros::Defined( const Token& macroToken, MacroDefinition const &, SourceRange )
90 {
91 checkMacro( macroToken, macroToken.getLocation());
92 }
93
checkMacro(const Token & macroToken,SourceLocation location)94 void CheckConfigMacros::checkMacro( const Token& macroToken, SourceLocation location )
95 {
96 if( configMacros.find( macroToken.getIdentifierInfo()->getName()) != configMacros.end())
97 {
98 const char* filename = compiler.getSourceManager().getPresumedLoc( location ).getFilename();
99 if( filename == NULL
100 || !hasPathnamePrefix(filename, SRCDIR "/include/LibreOfficeKit/") )
101 {
102 report( DiagnosticsEngine::Error, "checking whether a config macro %0 is defined",
103 location ) << macroToken.getIdentifierInfo()->getName();
104 report( DiagnosticsEngine::Note, "use #if instead of #ifdef/#ifndef/defined", location );
105 }
106 }
107 }
108
109 static Plugin::Registration< CheckConfigMacros > X( "checkconfigmacros" );
110
111 } // namespace
112
113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
114