plugin.hxx 7.96 KB
Newer Older
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 3 4 5 6 7 8 9 10 11
/*
 * 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.
 *
 */

12 13
#ifndef PLUGIN_H
#define PLUGIN_H
14

15 16
#include <config_clang.h>

17
#include <clang/AST/ASTContext.h>
18
#include <clang/AST/RecursiveASTVisitor.h>
19 20
#include <clang/Basic/FileManager.h>
#include <clang/Basic/SourceManager.h>
21
#include <clang/Frontend/CompilerInstance.h>
22
#include <clang/Lex/Preprocessor.h>
23
#include <unordered_map>
Stephan Bergmann's avatar
Stephan Bergmann committed
24 25

#include <clang/Rewrite/Core/Rewriter.h>
26 27

using namespace clang;
28
using namespace llvm;
29 30 31 32

namespace loplugin
{

33 34
class PluginHandler;

35 36 37 38 39 40
/**
    Base class for plugins.

    If you want to create a non-rewriter action, inherit from this class. Remember to also
    use Plugin::Registration.
*/
41
class Plugin
42 43 44
{
public:
    struct InstantiationData
45
    {
46
        const char* name;
47 48 49
        PluginHandler& handler;
        CompilerInstance& compiler;
        Rewriter* rewriter;
50 51
    };

52 53 54 55 56 57 58
    explicit Plugin( const InstantiationData& data );
    virtual ~Plugin() {}
    virtual void run() = 0;
    template< typename T > class Registration;
    enum { isPPCallback = false };
    // Returns location right after the end of the token that starts at the given location.
    SourceLocation locationAfterToken( SourceLocation location );
59 60
protected:
    DiagnosticBuilder report( DiagnosticsEngine::Level level, StringRef message, SourceLocation loc = SourceLocation()) const;
61 62 63 64 65 66 67 68 69
    bool ignoreLocation( SourceLocation loc );
    bool ignoreLocation( const Decl* decl );
    bool ignoreLocation( const Stmt* stmt );
    CompilerInstance& compiler;
    PluginHandler& handler;
    /**
     Returns the parent of the given AST node. Clang's internal AST representation doesn't provide this information,
     it can only provide children, but getting the parent is often useful for inspecting a part of the AST.
    */
70 71 72
    const Stmt* getParentStmt( const Stmt* stmt );
    Stmt* getParentStmt( Stmt* stmt );
    const FunctionDecl* getParentFunctionDecl( const Stmt* stmt );
73 74 75 76 77 78 79 80 81 82
    /**
     Checks if the location is inside an UNO file, more specifically, if it forms part of the URE stable interface,
     which is not allowed to be changed.
    */
    bool isInUnoIncludeFile(SourceLocation spellingLocation) const;
    bool isInUnoIncludeFile(const FunctionDecl*) const;

    static void normalizeDotDotInFilePath(std::string&);

    static bool isUnitTestMode();
83 84 85

    bool containsPreprocessingConditionalInclusion(SourceRange range);

86 87 88 89 90 91 92
private:
    static void registerPlugin( Plugin* (*create)( const InstantiationData& ), const char* optionName, bool isPPCallback, bool byDefault );
    template< typename T > static Plugin* createHelper( const InstantiationData& data );
    enum { isRewriter = false };
    const char* name;
};

93 94 95 96 97
/**
    Base class for rewriter plugins.

    Remember to also use Plugin::Registration.
*/
98 99
class RewritePlugin
    : public Plugin
100 101 102 103 104
{
public:
    explicit RewritePlugin( const InstantiationData& data );
protected:
    enum RewriteOption
105
    {
106 107 108 109 110 111 112 113 114 115 116
        // This enum allows passing just 'RemoveLineIfEmpty' to functions below.
        // If the resulting line would be completely empty, it'll be removed.
        RemoveLineIfEmpty    = 1 << 0,
        // Use this to remove the declaration/statement as a whole, i.e. all whitespace before the statement
        // and the trailing semicolon (is not part of the AST element range itself).
        // The trailing semicolon must be present.
        RemoveWholeStatement = 1 << 1,
        // Removes also all whitespace preceding and following the expression (completely, so that
        // the preceding and following tokens would be right next to each other, follow with insertText( " " )
        // if this is not wanted). Despite the name, indentation whitespace is not removed.
        RemoveAllWhitespace  = 1 << 2
117
    };
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
    struct RewriteOptions
        : public Rewriter::RewriteOptions
    {
        RewriteOptions() : flags( 0 ) {}
        explicit RewriteOptions( RewriteOption option );
        const int flags;
    };
    // syntactic sugar to be able to write 'RemoveLineIfEmpty | RemoveWholeStatement'
    friend RewriteOption operator|( RewriteOption option1, RewriteOption option2 );
    // These following insert/remove/replaceText functions map to functions
    // in clang::Rewriter, with these differences:
    // - they (more intuitively) return false on failure rather than true
    // - they report a warning when the change cannot be done
    // - There are more options for easier removal of surroundings of a statement/expression.
    bool insertText( SourceLocation Loc, StringRef Str,
    bool InsertAfter = true, bool indentNewLines = false );
    bool insertTextAfter( SourceLocation Loc, StringRef Str );
    bool insertTextAfterToken( SourceLocation Loc, StringRef Str );
    bool insertTextBefore( SourceLocation Loc, StringRef Str );
    bool removeText( SourceLocation Start, unsigned Length, RewriteOptions opts = RewriteOptions());
    bool removeText( CharSourceRange range, RewriteOptions opts = RewriteOptions());
    bool removeText( SourceRange range, RewriteOptions opts = RewriteOptions());
    bool replaceText( SourceLocation Start, unsigned OrigLength, StringRef NewStr );
    bool replaceText( SourceRange range, StringRef NewStr );
    bool replaceText( SourceRange range, SourceRange replacementRange );
    Rewriter* rewriter;
private:
    template< typename T > friend class Plugin::Registration;
    enum { isRewriter = true };
    bool wouldRewriteWorkdir(SourceLocation loc);
    bool reportEditFailure( SourceLocation loc );
    bool adjustRangeForOptions( CharSourceRange* range, RewriteOptions options );
};
151

152 153 154 155 156 157 158 159 160 161 162 163 164
/**
    Plugin registration helper.

    If you create a new helper class, create also an instance of this class to automatically register it.
    The passed argument is name of the plugin, used for explicitly invoking rewriter plugins
    (it is ignored for non-rewriter plugins).

    @code
    static Plugin::Registration< NameOfClass > X( "nameofclass" );
    @endcode
*/
template< typename T >
class Plugin::Registration
165 166 167 168
{
public:
    Registration( const char* optionName, bool byDefault = !T::isRewriter );
};
169 170

class RegistrationCreate
171 172 173 174
{
public:
    template< typename T, bool > static T* create( const Plugin::InstantiationData& data );
};
175

176 177
inline
bool Plugin::ignoreLocation( const Decl* decl )
178
{
179
    return ignoreLocation( decl->getLocation());
180
}
181 182 183

inline
bool Plugin::ignoreLocation( const Stmt* stmt )
184
{
185 186 187
    // Invalid location can happen at least for ImplicitCastExpr of
    // ImplicitParam 'self' in Objective C method declarations:
    return stmt->getLocStart().isValid() && ignoreLocation( stmt->getLocStart());
188
}
189

190
template< typename T >
191
Plugin* Plugin::createHelper( const InstantiationData& data )
192
 {
193
    return new T( data );
194
}
195 196 197

template< typename T >
inline
198
Plugin::Registration< T >::Registration( const char* optionName, bool byDefault )
199
{
200
    registerPlugin( &T::template createHelper< T >, optionName, T::isPPCallback, byDefault );
201
}
202 203 204 205

inline
RewritePlugin::RewriteOptions::RewriteOptions( RewriteOption option )
    : flags( option )
206
{
207 208
    // Note that 'flags' stores also RemoveLineIfEmpty, it must be kept in sync with the base class.
    if( flags & RewritePlugin::RemoveLineIfEmpty )
209
        RemoveLineIfEmpty = true;
210
}
211 212 213

inline
RewritePlugin::RewriteOption operator|( RewritePlugin::RewriteOption option1, RewritePlugin::RewriteOption option2 )
214
{
215
    return static_cast< RewritePlugin::RewriteOption >( int( option1 ) | int( option2 ));
216
}
217

218 219 220 221 222 223 224 225
// Same as pathname.startswith(prefix), except on Windows, where pathname (but
// not prefix) may also contain backslashes:
bool hasPathnamePrefix(StringRef pathname, StringRef prefix);

// Same as pathname == other, except on Windows, where pathname (but not other)
// may also contain backslashes:
bool isSamePathname(StringRef pathname, StringRef other);

226 227
} // namespace

228
#endif // COMPILEPLUGIN_H
229 230

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */