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 "CommonIdentifiers.h"
29
30namespace KJS {
31
32 typedef unsigned Addr; // ### should there be some separare types h?
33
34 class Node;
35 class JSValue;
36
37 /**
38 * Completion types.
39 */
40 enum ComplType { Normal, Break, Continue, ReturnValue, Throw, Interrupted };
41
42 /**
43 * Completion objects are used to convey the return status and value
44 * from functions.
45 *
46 * See FunctionImp::execute()
47 *
48 * @see FunctionImp
49 *
50 * @short Handle for a Completion type.
51 */
52 class KJS_EXPORT Completion {
53 public:
54 explicit Completion(ComplType c = Normal, JSValue *v = NULL, Addr t = 0 )
55 : comp(c), val(v), tar(t) { }
56
57 /**
58 * Returns the type of this completion.
59 */
60 ComplType complType() const { return comp; }
61
62 /**
63 * Returns the value of this completion if it is of type
64 * value-completion, 0 otherwise.
65 */
66 JSValue *value() const { return val; }
67
68 /**
69 * Returns the address a break or a continue statement targets
70 */
71 Addr target() const { return tar; }
72
73 /**
74 * Returns true if this is a value completion, false otherwise.
75 */
76 bool isValueCompletion() const { return !!val; }
77 private:
78 ComplType comp;
79 JSValue *val;
80 Addr tar;
81 };
82
83}
84
85#endif
86