LoopUtils.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 CLAZY_LOOP_UTILS_H
#define CLAZY_LOOP_UTILS_H

#include "clazy_stl.h"

#include <clang/AST/StmtCXX.h>

namespace clang {
class Stmt;
class CompilerInstance;
class SourceLocation;
class Expr;
class ParentMap;
}

namespace LoopUtils {
    /**
     * Returns the body of a for, range-foor, while or do-while loop
     */
    clang::Stmt *bodyFromLoop(clang::Stmt *);

    /**
     * Recursively goes through stmt's children and returns true if it finds a "break", "continue" or a "return" stmt
     * All child statements that are on a source code line <
     * If onlyBeforThisLoc is valid, then this function will only return true if the break/return/continue happens before
     */
    bool loopCanBeInterrupted(clang::Stmt *loop, const clang::CompilerInstance &ci,
                              clang::SourceLocation onlyBeforeThisLoc);

    /**
     * Returns true if stmt is a for, while or do-while loop
     */
    inline bool isLoop(clang::Stmt *stmt)
    {
        return llvm::isa<clang::DoStmt>(stmt)  || llvm::isa<clang::WhileStmt>(stmt) ||
               llvm::isa<clang::ForStmt>(stmt) || llvm::isa<clang::CXXForRangeStmt>(stmt);
    }

    /**
     * Returns the container expression for a range-loop or Q_FOREACH
     *
     * Q_FOREACH (auto f, expression) or for (auto i : expression)
     */
    clang::Expr* containerExprForLoop(clang::Stmt *loop);

    /**
     * Returns true of stmt is inside a for, while or do-while loop.
     * If yes, returns the loop statement, otherwise nullptr.
     */
    clang::Stmt* isInLoop(clang::ParentMap *pmap, clang::Stmt *stmt);
}

#endif