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