1 /*
   2  * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.nashorn.internal.ir;
  27 
  28 import jdk.nashorn.internal.codegen.Label;
  29 
  30 /**
  31  * This class represents a node from which control flow can execute
  32  * a {@code break} statement
  33  */
  34 public interface BreakableNode extends LexicalContextNode, JoinPredecessor, Labels {
  35     /**
  36      * Ensure that any labels in this breakable node are unique so
  37      * that new jumps won't go to old parts of the tree. Used for
  38      * example for cloning finally blocks
  39      *
  40      * @param lc the lexical context
  41      * @return node after labels have been made unique
  42      */
  43     public abstract Node ensureUniqueLabels(final LexicalContext lc);
  44 
  45     /**
  46      * Check whether this can be broken out from without using a label,
  47      * e.g. everything but Blocks, basically
  48      * @return true if breakable without label
  49      */
  50     public boolean isBreakableWithoutLabel();
  51 
  52     /**
  53      * Return the break label, i.e. the location to go to on break.
  54      * @return the break label
  55      */
  56     public Label getBreakLabel();
  57 
  58 }