blob: 36d1a50d0a6f55d1068aa3b151812b8fcd630511 [file] [log] [blame]
mjs5cf37c82002-08-18 07:21:26 +00001// -*- 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) 2002 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., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
22 *
23 */
24
25#ifndef _KJS_COMPLETION_H_
26#define _KJS_COMPLETION_H_
27
darin880105d2002-11-19 22:02:26 +000028#include "identifier.h"
mjs5cf37c82002-08-18 07:21:26 +000029#include "value.h"
30
31namespace KJS {
32
33 /**
34 * Completion types.
35 */
36 enum ComplType { Normal, Break, Continue, ReturnValue, Throw };
37
38 /**
39 * Completion objects are used to convey the return status and value
40 * from functions.
41 *
42 * See @ref FunctionImp::execute()
43 *
44 * @see FunctionImp
45 *
46 * @short Handle for a Completion type.
47 */
48 class Completion : private Value {
49 public:
50 Completion(ComplType c = Normal, const Value& v = Value(),
darin880105d2002-11-19 22:02:26 +000051 const Identifier &t = Identifier::null);
mjs5cf37c82002-08-18 07:21:26 +000052
mjsd0bd48c2002-08-19 21:14:02 +000053 ComplType complType() const { return comp; }
54 Value value() const { return val; }
darin880105d2002-11-19 22:02:26 +000055 Identifier target() const { return tar; }
mjsd0bd48c2002-08-19 21:14:02 +000056 bool isValueCompletion() const { return !val.isNull(); }
mjs5cf37c82002-08-18 07:21:26 +000057 private:
58 ComplType comp;
59 Value val;
darin880105d2002-11-19 22:02:26 +000060 Identifier tar;
mjs5cf37c82002-08-18 07:21:26 +000061 };
62
63}
64
65#endif