kjs/completion.h

   1 // -*- c-basic-offset: 2 -*-
   2 /*
   3  *  This file is part of the KDE libraries
   4  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
   5  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
   6  *  Copyright (C) 2003 Apple Computer, Inc
   7  *
   8  *  This library is free software; you can redistribute it and/or
   9  *  modify it under the terms of the GNU Library General Public
  10  *  License as published by the Free Software Foundation; either
  11  *  version 2 of the License, or (at your option) any later version.
  12  *
  13  *  This library is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *  Library General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU Library General Public License
  19  *  along with this library; see the file COPYING.LIB.  If not, write to
  20  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  *  Boston, MA 02110-1301, USA.
  22  *
  23  */
  24
  25 #ifndef _KJS_COMPLETION_H_
  26 #define _KJS_COMPLETION_H_
  27
  28 #include "identifier.h"
  29 #include "value.h"
  30
  31 namespace KJS {
  32
  33   /**
  34    * Completion types.
  35    */
  36   enum ComplType { Normal, Break, Continue, ReturnValue, Throw, Interrupted };
  37
  38   /**
  39    * Completion objects are used to convey the return status and value
  40    * from functions.
  41    *
  42    * See FunctionImp::execute()
  43    *
  44    * @see FunctionImp
  45    *
  46    * @short Handle for a Completion type.
  47    */
  48   class KJS_EXPORT Completion {
  49   public:
  50     Completion(ComplType c = Normal, JSValue *v = NULL, const Identifier &t = Identifier::null())
  51         : comp(c), val(v), tar(t) { }
  52
  53     /**
  54      *
  55      * @return
  56      */
  57     ComplType complType() const { return comp; }
  58
  59     /**
  60      *
  61      * @param
  62      * @return
  63      */
  64     JSValue *value() const { return val; }
  65
  66     /**
  67      *
  68      * @param
  69      * @return
  70      */
  71     Identifier target() const { return tar; }
  72
  73     /**
  74      *
  75      * @param
  76      * @return
  77      */
  78     bool isValueCompletion() const { return (val != NULL); }
  79   private:
  80     ComplType comp;
  81     JSValue *val;
  82     Identifier tar;
  83   };
  84
  85 }
  86
  87 #endif