• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KJS-API

  • kjs
  • api
kjsinterpreter.h
Go to the documentation of this file.
1/*
2 * This file is part of the KDE libraries
3 * Copyright (C) 2008 Harri Porten (porten@kde.org)
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
14 *
15 * You should have received a copy of the GNU Library General Public License
16 * along with this library; see the file COPYING.LIB. If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
19 *
20 */
21
22#ifndef KJSINTERPRETER_H
23#define KJSINTERPRETER_H
24
25#include "kjsapi_export.h"
26#include "kjsobject.h"
27#include "kjscontext.h"
28
29class KJSPrototype;
30class KJSInterpreter;
31class KJSInterpreterHandle;
32class KJSResultHandle;
33
37class KJSAPI_EXPORT KJSResult
38{
39 friend class KJSInterpreter;
40public:
44 KJSResult();
48 KJSResult(const KJSResult&);
52 KJSResult& operator=(const KJSResult&);
56 ~KJSResult();
60 bool isException() const;
61
65 QString errorMessage() const;
66 /*
67 * If the evaluation was successful, i.e. isException() is false
68 * this function returns the value returned by the script. Can be
69 * an "undefined" (isUndefined()) value.
70 */
71 KJSObject value() const;
72
73private:
74 KJSResultHandle* hnd;
75};
76
82class KJSAPI_EXPORT KJSInterpreter
83{
84 friend class KJSResult;
85 friend class KJSPrototype;
86 friend class KJSContext;
87public:
91 KJSInterpreter();
95 KJSInterpreter(const KJSGlobalObject& global);
99 KJSInterpreter(const KJSInterpreter& other);
103 KJSInterpreter& operator=(const KJSInterpreter& other);
109 ~KJSInterpreter();
110
114 KJSContext* globalContext();
118 const KJSContext* globalContext() const;
123 KJSObject globalObject();
130 KJSResult evaluate(const QString& sourceURL, int startingLineNumber,
131 const QString& code,
132 KJSObject* thisValue = 0);
136 KJSResult evaluate(const QString& code,
137 KJSObject* thisValue = 0);
138
154 static bool normalizeCode(const QString& codeIn, QString* codeOut,
155 int* errLine = 0, QString* errMsg = 0);
156private:
157 KJSInterpreter(KJSInterpreterHandle* h);
158 KJSInterpreterHandle* hnd;
159 KJSContext globCtx;
160};
161
162#endif
KJSContext
A class representing a JavaScript execution context.
Definition: kjscontext.h:40
KJSGlobalObject
A class representing a global object of an execution environment.
Definition: kjsobject.h:281
KJSInterpreter
A class representing a JavaScript interpreter.
Definition: kjsinterpreter.h:83
KJSInterpreter::globalContext
const KJSContext * globalContext() const
This is an overloaded member function, provided for convenience. It differs from the above function o...
KJSObject
A class representing a JavaScript value.
Definition: kjsobject.h:49
KJSPrototype
A class representing a JavaScript prototype object.
Definition: kjsprototype.h:39
KJSResult
A class representing the result of a script evaluation.
Definition: kjsinterpreter.h:38
kjsapi_export.h
kjscontext.h
kjsobject.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KJS-API

Skip menu "KJS-API"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal