/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: set ts=8 sts=2 et sw=2 tw=80:
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef builtin_RegExp_h
#define builtin_RegExp_h
#include <stddef.h>
#include <stdint.h>
#include "NamespaceImports.h"
#include "js/PropertySpec.h"
#include "js/RootingAPI.h"
#include "js/TypeDecls.h"
#include "vm/RegExpShared.h"
class JSLinearString;
namespace JS {
class Value;
}
/*
* The following builtin natives are extern'd for pointer comparison in
* other parts of the engine.
*/
namespace js {
class ArrayObject;
class MatchPairs;
class RegExpObject;
class RegExpStatics;
JSObject* InitRegExpClass(JSContext* cx, HandleObject obj);
/*
* Legacy behavior of ExecuteRegExp(), which is baked into the JSAPI.
*
* |res| may be nullptr if the RegExpStatics are not to be updated.
* |input| may be nullptr if there is no JSString corresponding to
* |chars| and |length|.
*/
[[nodiscard]]
bool ExecuteRegExpLegacy(JSContext* cx, RegExpStatics* res,
Handle<RegExpObject*> reobj,
Handle<JSLinearString*> input,
size_t* lastIndex,
bool test,
MutableHandleValue rval);
// Translation from MatchPairs to a JS array in regexp_exec()'s output format.
[[nodiscard]]
bool CreateRegExpMatchResult(JSContext* cx, HandleRegExpShared re,
HandleString input,
const MatchPairs& matches,
MutableHandleValue rval);
[[nodiscard]]
extern bool RegExpMatcher(JSContext* cx,
unsigned argc,
Value* vp);
[[nodiscard]]
extern bool RegExpMatcherRaw(JSContext* cx, HandleObject regexp,
HandleString input,
int32_t lastIndex,
MatchPairs* maybeMatches,
MutableHandleValue output);
[[nodiscard]]
extern bool RegExpSearcher(JSContext* cx,
unsigned argc,
Value* vp);
[[nodiscard]]
extern bool RegExpSearcherRaw(JSContext* cx, HandleObject regexp,
HandleString input,
int32_t lastIndex,
MatchPairs* maybeMatches,
int32_t* result);
[[nodiscard]]
extern bool RegExpSearcherLastLimit(JSContext* cx,
unsigned argc,
Value* vp);
[[nodiscard]]
extern bool RegExpBuiltinExecMatchFromJit(
JSContext* cx, Handle<RegExpObject*> regexp, HandleString input,
MatchPairs* maybeMatches, MutableHandleValue output);
[[nodiscard]]
extern bool RegExpBuiltinExecTestFromJit(
JSContext* cx, Handle<RegExpObject*> regexp, HandleString input,
bool* result);
[[nodiscard]]
extern bool intrinsic_GetElemBaseForLambda(JSContext* cx,
unsigned argc,
Value* vp);
[[nodiscard]]
extern bool intrinsic_GetStringDataProperty(JSContext* cx,
unsigned argc,
Value* vp);
/*
* The following functions are for use by self-hosted code.
*/
/*
* Behaves like RegExp(source, flags).
* |source| must be a valid regular expression pattern, |flags| is a raw
* integer value representing the regular expression flags.
* Must be called without |new|.
*
* Dedicated function for RegExp.prototype[@@replace] and
* RegExp.prototype[@@split] optimized paths.
*/
[[nodiscard]]
extern bool regexp_construct_raw_flags(JSContext* cx,
unsigned argc, Value* vp);
[[nodiscard]]
extern bool IsRegExp(JSContext* cx, HandleValue value,
bool* result);
[[nodiscard]]
extern bool RegExpCreate(JSContext* cx, HandleValue pattern,
HandleValue flags,
MutableHandleValue rval);
[[nodiscard]]
extern bool RegExpPrototypeOptimizable(JSContext* cx,
unsigned argc, Value* vp);
[[nodiscard]]
extern bool RegExpPrototypeOptimizableRaw(JSContext* cx,
JSObject* proto);
[[nodiscard]]
extern bool RegExpInstanceOptimizable(JSContext* cx,
unsigned argc, Value* vp);
[[nodiscard]]
extern bool RegExpInstanceOptimizableRaw(JSContext* cx,
JSObject* obj,
JSObject* proto);
[[nodiscard]]
extern bool RegExpBuiltinExec(JSContext* cx,
Handle<RegExpObject*> regexp,
Handle<JSString*> string,
bool forTest,
MutableHandle<Value> rval);
[[nodiscard]]
extern bool RegExpExec(JSContext* cx, Handle<JSObject*> regexp,
Handle<JSString*> string,
bool forTest,
MutableHandle<Value> rval);
[[nodiscard]]
extern bool RegExpGetSubstitution(
JSContext* cx, Handle<ArrayObject*> matchResult,
Handle<JSLinearString*> string, size_t position,
Handle<JSLinearString*> replacement, size_t firstDollarIndex,
HandleValue namedCaptures, MutableHandleValue rval);
[[nodiscard]]
extern bool RegExpHasCaptureGroups(JSContext* cx,
Handle<RegExpObject*> obj,
Handle<JSString*> input,
bool* result);
[[nodiscard]]
extern bool GetFirstDollarIndex(JSContext* cx,
unsigned argc,
Value* vp);
[[nodiscard]]
extern bool GetFirstDollarIndexRaw(JSContext* cx, JSString* str,
int32_t* index);
extern int32_t GetFirstDollarIndexRawFlat(
const JSLinearString* text);
// RegExp ClassSpec members used in RegExpObject.cpp.
[[nodiscard]]
extern bool regexp_construct(JSContext* cx,
unsigned argc,
Value* vp);
extern const JSPropertySpec regexp_static_props[];
extern const JSFunctionSpec regexp_static_methods[];
extern const JSPropertySpec regexp_properties[];
extern const JSFunctionSpec regexp_methods[];
// Used in RegExpObject::isOriginalFlagGetter.
[[nodiscard]]
extern bool regexp_hasIndices(JSContext* cx,
unsigned argc,
JS::Value* vp);
[[nodiscard]]
extern bool regexp_global(JSContext* cx,
unsigned argc,
JS::Value* vp);
[[nodiscard]]
extern bool regexp_ignoreCase(JSContext* cx,
unsigned argc,
JS::Value* vp);
[[nodiscard]]
extern bool regexp_multiline(JSContext* cx,
unsigned argc,
JS::Value* vp);
[[nodiscard]]
extern bool regexp_dotAll(JSContext* cx,
unsigned argc,
JS::Value* vp);
[[nodiscard]]
extern bool regexp_sticky(JSContext* cx,
unsigned argc,
JS::Value* vp);
[[nodiscard]]
extern bool regexp_unicode(JSContext* cx,
unsigned argc,
JS::Value* vp);
[[nodiscard]]
extern bool regexp_unicodeSets(JSContext* cx,
unsigned argc,
JS::Value* vp);
#ifdef DEBUG
// Sentinel value for cx->regExpSearcherLastLimit.
constexpr uint32_t RegExpSearcherLastLimitSentinel = UINT32_MAX;
#endif
}
/* namespace js */
#endif /* builtin_RegExp_h */
