1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
|
/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim: set ts=8 sw=4 et tw=78: */
// SPDX-License-Identifier: MPL-1.1 OR GPL-2.0-or-later OR LGPL-2.1-or-later
// SPDX-FileCopyrightText: 1998 Netscape Communications Corporation
#include <config.h> // for HAVE_READLINE_READLINE_H
#ifdef HAVE_SIGNAL_H
# include <setjmp.h>
# include <signal.h>
# ifdef _WIN32
# define sigjmp_buf jmp_buf
# define siglongjmp(e, v) longjmp (e, v)
# define sigsetjmp(v, m) setjmp (v)
# endif
#endif
#ifdef HAVE_READLINE_READLINE_H
# include <stdio.h> // include before readline/readline.h
# include <readline/history.h>
# include <readline/readline.h>
#endif
#include <string>
#include <glib.h>
#include <glib/gprintf.h> // for g_fprintf
#include <js/CallAndConstruct.h>
#include <js/CallArgs.h>
#include <js/CharacterEncoding.h> // for JS_EncodeStringToUTF8
#include <js/CompilationAndEvaluation.h>
#include <js/CompileOptions.h>
#include <js/ErrorReport.h>
#include <js/Exception.h>
#include <js/PropertyAndElement.h>
#include <js/RootingAPI.h>
#include <js/SourceText.h>
#include <js/TypeDecls.h>
#include <js/Utility.h> // for UniqueChars
#include <js/Value.h>
#include <js/ValueArray.h>
#include <js/Warnings.h>
#include <jsapi.h> // for JS_NewPlainObject
#include "gjs/atoms.h"
#include "gjs/context-private.h"
#include "gjs/global.h"
#include "gjs/jsapi-util.h"
#include "gjs/macros.h"
#include "modules/console.h"
namespace mozilla {
union Utf8Unit;
}
static void gjs_console_warning_reporter(JSContext*, JSErrorReport* report) {
JS::PrintError(stderr, report, /* reportWarnings = */ true);
}
/* Based on js::shell::AutoReportException from SpiderMonkey. */
class AutoReportException {
JSContext *m_cx;
public:
explicit AutoReportException(JSContext *cx) : m_cx(cx) {}
~AutoReportException() {
if (!JS_IsExceptionPending(m_cx))
return;
/* Get exception object before printing and clearing exception. */
JS::ExceptionStack exnStack(m_cx);
JS::ErrorReportBuilder report(m_cx);
if (!JS::StealPendingExceptionStack(m_cx, &exnStack) ||
!report.init(m_cx, exnStack,
JS::ErrorReportBuilder::NoSideEffects)) {
g_printerr("(Unable to print exception)\n");
JS_ClearPendingException(m_cx);
return;
}
g_assert(!report.report()->isWarning());
JS::PrintError(stderr, report, /* reportWarnings = */ false);
if (exnStack.stack()) {
GjsAutoChar stack_str =
gjs_format_stack_trace(m_cx, exnStack.stack());
if (!stack_str)
g_printerr("(Unable to print stack trace)\n");
else
g_printerr("%s", stack_str.get());
}
JS_ClearPendingException(m_cx);
}
};
// Adapted from https://stackoverflow.com/a/17035073/172999
class AutoCatchCtrlC {
#ifdef HAVE_SIGNAL_H
void (*m_prev_handler)(int);
static void handler(int signal) {
if (signal == SIGINT)
siglongjmp(jump_buffer, 1);
}
public:
static sigjmp_buf jump_buffer;
AutoCatchCtrlC() {
m_prev_handler = signal(SIGINT, &AutoCatchCtrlC::handler);
}
~AutoCatchCtrlC() {
if (m_prev_handler != SIG_ERR)
signal(SIGINT, m_prev_handler);
}
void raise_default() {
if (m_prev_handler != SIG_ERR)
signal(SIGINT, m_prev_handler);
raise(SIGINT);
}
#endif // HAVE_SIGNAL_H
};
#ifdef HAVE_SIGNAL_H
sigjmp_buf AutoCatchCtrlC::jump_buffer;
#endif // HAVE_SIGNAL_H
[[nodiscard]] static bool gjs_console_readline(char** bufp,
const char* prompt) {
#ifdef HAVE_READLINE_READLINE_H
char *line;
line = readline(prompt);
if (!line)
return false;
if (line[0] != '\0')
add_history(line);
*bufp = line;
#else // !HAVE_READLINE_READLINE_H
char line[256];
fprintf(stdout, "%s", prompt);
fflush(stdout);
if (!fgets(line, sizeof line, stdin))
return false;
*bufp = g_strdup(line);
#endif // !HAVE_READLINE_READLINE_H
return true;
}
std::string print_string_value(JSContext* cx, JS::HandleValue v_string) {
if (!v_string.isString())
return "[unexpected result from printing value]";
JS::RootedString printed_string(cx, v_string.toString());
JS::AutoSaveExceptionState exc_state(cx);
JS::UniqueChars chars(JS_EncodeStringToUTF8(cx, printed_string));
exc_state.restore();
if (!chars)
return "[error printing value]";
return chars.get();
}
/* Return value of false indicates an uncatchable exception, rather than any
* exception. (This is because the exception should be auto-printed around the
* invocation of this function.)
*/
[[nodiscard]] static bool gjs_console_eval_and_print(JSContext* cx,
JS::HandleObject global,
const std::string& bytes,
int lineno) {
JS::SourceText<mozilla::Utf8Unit> source;
if (!source.init(cx, bytes.c_str(), bytes.size(),
JS::SourceOwnership::Borrowed))
return false;
JS::CompileOptions options(cx);
options.setFileAndLine("typein", lineno);
JS::RootedValue result(cx);
if (!JS::Evaluate(cx, options, source, &result)) {
if (!JS_IsExceptionPending(cx))
return false;
}
GjsContextPrivate* gjs = GjsContextPrivate::from_cx(cx);
gjs->schedule_gc_if_needed();
if (result.isUndefined())
return true;
JS::AutoSaveExceptionState exc_state(cx);
JS::RootedValue v_printed_string(cx);
JS::RootedValue v_pretty_print(
cx, gjs_get_global_slot(global, GjsGlobalSlot::PRETTY_PRINT_FUNC));
bool ok = JS::Call(cx, global, v_pretty_print, JS::HandleValueArray(result),
&v_printed_string);
if (!ok)
gjs_log_exception(cx);
exc_state.restore();
if (ok) {
g_fprintf(stdout, "%s\n",
print_string_value(cx, v_printed_string).c_str());
} else {
g_fprintf(stdout, "[error printing value]\n");
}
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool
gjs_console_interact(JSContext *context,
unsigned argc,
JS::Value *vp)
{
JS::CallArgs argv = JS::CallArgsFromVp(argc, vp);
bool eof, exit_warning;
JS::RootedObject global(context, gjs_get_import_global(context));
char* temp_buf;
int lineno;
int startline;
#ifndef HAVE_READLINE_READLINE_H
int rl_end = 0; // nonzero if using readline and any text is typed in
#endif
JS::SetWarningReporter(context, gjs_console_warning_reporter);
AutoCatchCtrlC ctrl_c;
// Separate initialization from declaration because of possible overwriting
// when siglongjmp() jumps into this function
eof = exit_warning = false;
temp_buf = nullptr;
lineno = 1;
do {
/*
* Accumulate lines until we get a 'compilable unit' - one that either
* generates an error (before running out of source) or that compiles
* cleanly. This should be whenever we get a complete statement that
* coincides with the end of a line.
*/
startline = lineno;
std::string buffer;
do {
#ifdef HAVE_SIGNAL_H
// sigsetjmp() returns 0 if control flow encounters it normally, and
// nonzero if it's been jumped to. In the latter case, use a while
// loop so that we call sigsetjmp() a second time to reinit the jump
// buffer.
while (sigsetjmp(AutoCatchCtrlC::jump_buffer, 1) != 0) {
g_fprintf(stdout, "\n");
if (buffer.empty() && rl_end == 0) {
if (!exit_warning) {
g_fprintf(stdout,
"(To exit, press Ctrl+C again or Ctrl+D)\n");
exit_warning = true;
} else {
ctrl_c.raise_default();
}
} else {
exit_warning = false;
}
buffer.clear();
startline = lineno = 1;
}
#endif // HAVE_SIGNAL_H
if (!gjs_console_readline(
&temp_buf, startline == lineno ? "gjs> " : ".... ")) {
eof = true;
break;
}
buffer += temp_buf;
buffer += "\n";
g_free(temp_buf);
lineno++;
} while (!JS_Utf8BufferIsCompilableUnit(context, global, buffer.c_str(),
buffer.size()));
bool ok;
{
AutoReportException are(context);
ok = gjs_console_eval_and_print(context, global, buffer, startline);
}
exit_warning = false;
GjsContextPrivate* gjs = GjsContextPrivate::from_cx(context);
ok = gjs->run_jobs_fallible() && ok;
if (!ok) {
/* If this was an uncatchable exception, throw another uncatchable
* exception on up to the surrounding JS::Evaluate() in main(). This
* happens when you run gjs-console and type imports.system.exit(0);
* at the prompt. If we don't throw another uncatchable exception
* here, then it's swallowed and main() won't exit. */
return false;
}
} while (!eof);
g_fprintf(stdout, "\n");
argv.rval().setUndefined();
return true;
}
bool
gjs_define_console_stuff(JSContext *context,
JS::MutableHandleObject module)
{
module.set(JS_NewPlainObject(context));
const GjsAtoms& atoms = GjsContextPrivate::atoms(context);
return JS_DefineFunctionById(context, module, atoms.interact(),
gjs_console_interact, 1,
GJS_MODULE_PROP_FLAGS);
}
|