cmBreakCommand.h 1.12 KB
Newer Older
1 2
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file Copyright.txt or https://cmake.org/licensing for details.  */
3 4 5
#ifndef cmBreakCommand_h
#define cmBreakCommand_h

6
#include <cmConfigure.h>
7

8 9 10
#include <string>
#include <vector>

11 12
#include "cmCommand.h"

13 14
class cmExecutionStatus;

15 16 17 18 19 20 21 22 23 24 25
/** \class cmBreakCommand
 * \brief Break from an enclosing foreach or while loop
 *
 * cmBreakCommand returns from an enclosing foreach or while loop
 */
class cmBreakCommand : public cmCommand
{
public:
  /**
   * This is a virtual constructor for the command.
   */
26
  cmCommand* Clone() CM_OVERRIDE { return new cmBreakCommand; }
27 28 29 30 31

  /**
   * This is called when the command is first encountered in
   * the CMakeLists.txt file.
   */
32 33
  bool InitialPass(std::vector<std::string> const& args,
                   cmExecutionStatus& status) CM_OVERRIDE;
34 35 36 37

  /**
   * This determines if the command is invoked when in script mode.
   */
38
  bool IsScriptable() const CM_OVERRIDE { return true; }
39 40 41 42

  /**
   * The name of the command as specified in CMakeList.txt.
   */
43
  std::string GetName() const CM_OVERRIDE { return "break"; }
44 45 46
};

#endif