diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /compilerplugins/clang/checkconfigmacros.cxx | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'compilerplugins/clang/checkconfigmacros.cxx')
-rw-r--r-- | compilerplugins/clang/checkconfigmacros.cxx | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/compilerplugins/clang/checkconfigmacros.cxx b/compilerplugins/clang/checkconfigmacros.cxx new file mode 100644 index 000000000..aea60ed56 --- /dev/null +++ b/compilerplugins/clang/checkconfigmacros.cxx @@ -0,0 +1,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: */ |