checkmanager.h

/*
   This file is part of the clazy static checker.

  Copyright (C) 2015 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
  Author: Sérgio Martins <sergio.martins@kdab.com>

  Copyright (C) 2015 Sergio Martins <smartins@kde.org>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/

#ifndef CLANG_LAZY_CHECK_MANAGER_H
#define CLANG_LAZY_CHECK_MANAGER_H

#include "checkbase.h"

#include <string>
#include <functional>
#include <vector>
#include <unordered_map>

struct RegisteredFixIt {
    typedef std::vector<RegisteredFixIt> List;
    RegisteredFixIt() : id(-1) {}
    RegisteredFixIt(int id, const std::string &name) : id(id), name(name) {}
    int id = -1;
    std::string name;
    bool operator==(const RegisteredFixIt &other) const { return id == other.id; }
};

using FactoryFunction = std::function<CheckBase*(const clang::CompilerInstance &ci)>;

struct RegisteredCheck {
    typedef std::vector<RegisteredCheck> List;
    std::string name;
    CheckLevel level;
    FactoryFunction factory;
    bool operator==(const RegisteredCheck &other) const { return name == other.name; }
};

class CheckManager
{
public:
    static CheckManager *instance();

    int registerCheck(const std::string &name, CheckLevel level, FactoryFunction);
    int registerFixIt(int id, const std::string &fititName, const std::string &checkName);

    RegisteredCheck::List availableChecks(CheckLevel maxLevel) const;
    RegisteredCheck::List requestedChecksThroughEnv() const;

    RegisteredCheck::List::const_iterator checkForName(const RegisteredCheck::List &checks, const std::string &name) const;
    RegisteredCheck::List checksForCommaSeparatedString(const std::string &str) const;
    RegisteredFixIt::List availableFixIts(const std::string &checkName) const;

    /**
     * Returns all checks with level <= requested level.
     */
    RegisteredCheck::List checksFromRequestedLevel() const;

    CheckBase::List createChecks(RegisteredCheck::List requestedChecks, const clang::CompilerInstance &ci);

    bool fixitsEnabled() const;
    void enableAllFixIts();

    bool allFixitsEnabled() const;
    bool isOptionSet(const std::string &optionName) const;

    /**
     * Enables all checks with level <= @p level.
     * A high level will enable checks known to have false positives, while a low level is more
     * conservative and emits less warnings.
     */
    void setRequestedLevel(CheckLevel level);
    CheckLevel requestedLevel() const;

private:
    CheckManager();

    RegisteredCheck::List checksForLevel(int level) const;
    bool isReservedCheckName(const std::string &name) const;
    std::unique_ptr<CheckBase> createCheck(const std::string &name, const clang::CompilerInstance &ci);
    std::string checkNameForFixIt(const std::string &) const;
    RegisteredCheck::List m_registeredChecks;
    std::unordered_map<std::string, std::vector<RegisteredFixIt> > m_fixitsByCheckName;
    std::unordered_map<std::string, RegisteredFixIt > m_fixitByName;
    std::string m_requestedFixitName;
    bool m_enableAllFixits;
    CheckLevel m_requestedLevel;
    const std::vector<std::string> m_extraOptions;
};

#define REGISTER_CHECK_WITH_FLAGS(CHECK_NAME, CLASS_NAME, LEVEL) \
    static int dummy = CheckManager::instance()->registerCheck(CHECK_NAME, LEVEL, [](const clang::CompilerInstance &ci){ return new CLASS_NAME(CHECK_NAME, ci); }); \
    inline void silence_warning() { (void)dummy; }

#define REGISTER_FIXIT(FIXIT_ID, FIXIT_NAME, CHECK_NAME) \
    static int dummy_##FIXIT_ID = CheckManager::instance()->registerFixIt(FIXIT_ID, FIXIT_NAME, CHECK_NAME); \
    inline void silence_warning_dummy_##FIXIT_ID() { (void)dummy_##FIXIT_ID; }

#endif