e746360b9a
Using the fact that there are 2^52-2 NaN representations we can "NaN-box" all the Values possible. This means that Value no longer has an explicit "Type" but that information is now stored in the bits of a double. This is done by "tagging" the top two bytes of the double. For a full explanation see the large comment with asserts at the top of Value. We can also use the exact representation of the tags to make checking properties like nullish, or is_cell quicker. But the largest gains are in the fact that the size of a Value is now halved. The SunSpider and other benchmarks have been ran to confirm that there are no regressions in performance compared to the previous implementation. The tests never performed worse and in some cases performed better. But the biggest differences can be seen in memory usage when large arrays are allocated. A simple test which allocates a 1000 arrays of size 100000 has roughly half the memory usage. There is also space in the representations for future expansions such as tuples and records. To ensure that Values on the stack and registers are not lost during garbage collection we also have to add a check to the Heap to check for any of the cell tags and extracting the canonical form of the pointer if it matches.
417 lines
16 KiB
C++
417 lines
16 KiB
C++
/*
|
|
* Copyright (c) 2020-2022, the SerenityOS developers.
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#include "JSIntegration.h"
|
|
#include "Spreadsheet.h"
|
|
#include "Workbook.h"
|
|
#include <LibJS/Lexer.h>
|
|
#include <LibJS/Runtime/Error.h>
|
|
#include <LibJS/Runtime/GlobalObject.h>
|
|
#include <LibJS/Runtime/Object.h>
|
|
#include <LibJS/Runtime/Value.h>
|
|
|
|
namespace Spreadsheet {
|
|
|
|
Optional<FunctionAndArgumentIndex> get_function_and_argument_index(StringView source)
|
|
{
|
|
JS::Lexer lexer { source };
|
|
// Track <identifier> <OpenParen>'s, and how many complete expressions are inside the parenthesized expression.
|
|
Vector<size_t> state;
|
|
StringView last_name;
|
|
Vector<StringView> names;
|
|
size_t open_parens_since_last_commit = 0;
|
|
size_t open_curlies_and_brackets_since_last_commit = 0;
|
|
bool previous_was_identifier = false;
|
|
auto token = lexer.next();
|
|
while (token.type() != JS::TokenType::Eof) {
|
|
switch (token.type()) {
|
|
case JS::TokenType::Identifier:
|
|
previous_was_identifier = true;
|
|
last_name = token.value();
|
|
break;
|
|
case JS::TokenType::ParenOpen:
|
|
if (!previous_was_identifier) {
|
|
open_parens_since_last_commit++;
|
|
break;
|
|
}
|
|
previous_was_identifier = false;
|
|
state.append(0);
|
|
names.append(last_name);
|
|
break;
|
|
case JS::TokenType::ParenClose:
|
|
previous_was_identifier = false;
|
|
if (open_parens_since_last_commit == 0) {
|
|
if (state.is_empty() || names.is_empty()) {
|
|
// JS Syntax error.
|
|
break;
|
|
}
|
|
state.take_last();
|
|
names.take_last();
|
|
break;
|
|
}
|
|
--open_parens_since_last_commit;
|
|
break;
|
|
case JS::TokenType::Comma:
|
|
previous_was_identifier = false;
|
|
if (open_parens_since_last_commit == 0 && open_curlies_and_brackets_since_last_commit == 0) {
|
|
if (!state.is_empty())
|
|
state.last()++;
|
|
break;
|
|
}
|
|
break;
|
|
case JS::TokenType::BracketOpen:
|
|
previous_was_identifier = false;
|
|
open_curlies_and_brackets_since_last_commit++;
|
|
break;
|
|
case JS::TokenType::BracketClose:
|
|
previous_was_identifier = false;
|
|
if (open_curlies_and_brackets_since_last_commit > 0)
|
|
open_curlies_and_brackets_since_last_commit--;
|
|
break;
|
|
case JS::TokenType::CurlyOpen:
|
|
previous_was_identifier = false;
|
|
open_curlies_and_brackets_since_last_commit++;
|
|
break;
|
|
case JS::TokenType::CurlyClose:
|
|
previous_was_identifier = false;
|
|
if (open_curlies_and_brackets_since_last_commit > 0)
|
|
open_curlies_and_brackets_since_last_commit--;
|
|
break;
|
|
default:
|
|
previous_was_identifier = false;
|
|
break;
|
|
}
|
|
|
|
token = lexer.next();
|
|
}
|
|
if (!names.is_empty() && !state.is_empty())
|
|
return FunctionAndArgumentIndex { names.last(), state.last() };
|
|
return {};
|
|
}
|
|
|
|
SheetGlobalObject::SheetGlobalObject(JS::Realm& realm, Sheet& sheet)
|
|
: JS::GlobalObject(realm)
|
|
, m_sheet(sheet)
|
|
{
|
|
}
|
|
|
|
JS::ThrowCompletionOr<bool> SheetGlobalObject::internal_has_property(JS::PropertyKey const& name) const
|
|
{
|
|
if (name.is_string()) {
|
|
if (name.as_string() == "value")
|
|
return true;
|
|
if (m_sheet.parse_cell_name(name.as_string()).has_value())
|
|
return true;
|
|
}
|
|
return Object::internal_has_property(name);
|
|
}
|
|
|
|
JS::ThrowCompletionOr<JS::Value> SheetGlobalObject::internal_get(const JS::PropertyKey& property_name, JS::Value receiver) const
|
|
{
|
|
if (property_name.is_string()) {
|
|
if (property_name.as_string() == "value") {
|
|
if (auto cell = m_sheet.current_evaluated_cell())
|
|
return cell->js_data();
|
|
|
|
return JS::js_undefined();
|
|
}
|
|
if (auto pos = m_sheet.parse_cell_name(property_name.as_string()); pos.has_value()) {
|
|
auto& cell = m_sheet.ensure(pos.value());
|
|
cell.reference_from(m_sheet.current_evaluated_cell());
|
|
return cell.typed_js_data();
|
|
}
|
|
}
|
|
|
|
return Base::internal_get(property_name, receiver);
|
|
}
|
|
|
|
JS::ThrowCompletionOr<bool> SheetGlobalObject::internal_set(const JS::PropertyKey& property_name, JS::Value value, JS::Value receiver)
|
|
{
|
|
if (property_name.is_string()) {
|
|
if (auto pos = m_sheet.parse_cell_name(property_name.as_string()); pos.has_value()) {
|
|
auto& cell = m_sheet.ensure(pos.value());
|
|
if (auto current = m_sheet.current_evaluated_cell())
|
|
current->reference_from(&cell);
|
|
|
|
cell.set_data(value); // FIXME: This produces un-savable state!
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return Base::internal_set(property_name, value, receiver);
|
|
}
|
|
|
|
void SheetGlobalObject::initialize_global_object()
|
|
{
|
|
Base::initialize_global_object();
|
|
u8 attr = JS::Attribute::Configurable | JS::Attribute::Writable | JS::Attribute::Enumerable;
|
|
define_native_function("get_real_cell_contents", get_real_cell_contents, 1, attr);
|
|
define_native_function("set_real_cell_contents", set_real_cell_contents, 2, attr);
|
|
define_native_function("parse_cell_name", parse_cell_name, 1, attr);
|
|
define_native_function("current_cell_position", current_cell_position, 0, attr);
|
|
define_native_function("column_arithmetic", column_arithmetic, 2, attr);
|
|
define_native_function("column_index", column_index, 1, attr);
|
|
define_native_function("get_column_bound", get_column_bound, 1, attr);
|
|
define_native_accessor("name", get_name, nullptr, attr);
|
|
}
|
|
|
|
void SheetGlobalObject::visit_edges(Visitor& visitor)
|
|
{
|
|
Base::visit_edges(visitor);
|
|
for (auto& it : m_sheet.cells()) {
|
|
if (auto opt_thrown_value = it.value->thrown_value(); opt_thrown_value.has_value())
|
|
visitor.visit(*opt_thrown_value);
|
|
|
|
visitor.visit(it.value->evaluated_data());
|
|
}
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(SheetGlobalObject::get_name)
|
|
{
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<SheetGlobalObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "SheetGlobalObject");
|
|
|
|
auto sheet_object = static_cast<SheetGlobalObject*>(this_object);
|
|
return JS::js_string(global_object.heap(), sheet_object->m_sheet.name());
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(SheetGlobalObject::get_real_cell_contents)
|
|
{
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<SheetGlobalObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "SheetGlobalObject");
|
|
|
|
auto sheet_object = static_cast<SheetGlobalObject*>(this_object);
|
|
|
|
if (vm.argument_count() != 1)
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected exactly one argument to get_real_cell_contents()");
|
|
|
|
auto name_value = vm.argument(0);
|
|
if (!name_value.is_string())
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected a String argument to get_real_cell_contents()");
|
|
auto position = sheet_object->m_sheet.parse_cell_name(name_value.as_string().string());
|
|
if (!position.has_value())
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Invalid cell name");
|
|
|
|
auto const* cell = sheet_object->m_sheet.at(position.value());
|
|
if (!cell)
|
|
return JS::js_undefined();
|
|
|
|
if (cell->kind() == Spreadsheet::Cell::Kind::Formula)
|
|
return JS::js_string(vm, String::formatted("={}", cell->data()));
|
|
|
|
return JS::js_string(vm, cell->data());
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(SheetGlobalObject::set_real_cell_contents)
|
|
{
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<SheetGlobalObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "SheetGlobalObject");
|
|
|
|
auto sheet_object = static_cast<SheetGlobalObject*>(this_object);
|
|
|
|
if (vm.argument_count() != 2)
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected exactly two arguments to set_real_cell_contents()");
|
|
|
|
auto name_value = vm.argument(0);
|
|
if (!name_value.is_string())
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected the first argument of set_real_cell_contents() to be a String");
|
|
auto position = sheet_object->m_sheet.parse_cell_name(name_value.as_string().string());
|
|
if (!position.has_value())
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Invalid cell name");
|
|
|
|
auto new_contents_value = vm.argument(1);
|
|
if (!new_contents_value.is_string())
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected the second argument of set_real_cell_contents() to be a String");
|
|
|
|
auto& cell = sheet_object->m_sheet.ensure(position.value());
|
|
auto& new_contents = new_contents_value.as_string().string();
|
|
cell.set_data(new_contents);
|
|
return JS::js_null();
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(SheetGlobalObject::parse_cell_name)
|
|
{
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<SheetGlobalObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "SheetGlobalObject");
|
|
|
|
auto sheet_object = static_cast<SheetGlobalObject*>(this_object);
|
|
|
|
if (vm.argument_count() != 1)
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected exactly one argument to parse_cell_name()");
|
|
auto name_value = vm.argument(0);
|
|
if (!name_value.is_string())
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected a String argument to parse_cell_name()");
|
|
auto position = sheet_object->m_sheet.parse_cell_name(name_value.as_string().string());
|
|
if (!position.has_value())
|
|
return JS::js_undefined();
|
|
|
|
auto object = JS::Object::create(global_object, global_object.object_prototype());
|
|
object->define_direct_property("column", JS::js_string(vm, sheet_object->m_sheet.column(position.value().column)), JS::default_attributes);
|
|
object->define_direct_property("row", JS::Value((unsigned)position.value().row), JS::default_attributes);
|
|
|
|
return object;
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(SheetGlobalObject::current_cell_position)
|
|
{
|
|
if (vm.argument_count() != 0)
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected no arguments to current_cell_position()");
|
|
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<SheetGlobalObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "SheetGlobalObject");
|
|
|
|
auto sheet_object = static_cast<SheetGlobalObject*>(this_object);
|
|
auto* current_cell = sheet_object->m_sheet.current_evaluated_cell();
|
|
if (!current_cell)
|
|
return JS::js_null();
|
|
|
|
auto position = current_cell->position();
|
|
|
|
auto object = JS::Object::create(global_object, global_object.object_prototype());
|
|
object->define_direct_property("column", JS::js_string(vm, sheet_object->m_sheet.column(position.column)), JS::default_attributes);
|
|
object->define_direct_property("row", JS::Value((unsigned)position.row), JS::default_attributes);
|
|
|
|
return object;
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(SheetGlobalObject::column_index)
|
|
{
|
|
if (vm.argument_count() != 1)
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected exactly one argument to column_index()");
|
|
|
|
auto column_name = vm.argument(0);
|
|
if (!column_name.is_string())
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "String");
|
|
|
|
auto& column_name_str = column_name.as_string().string();
|
|
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<SheetGlobalObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "SheetGlobalObject");
|
|
|
|
auto sheet_object = static_cast<SheetGlobalObject*>(this_object);
|
|
auto& sheet = sheet_object->m_sheet;
|
|
auto column_index = sheet.column_index(column_name_str);
|
|
if (!column_index.has_value())
|
|
return vm.throw_completion<JS::TypeError>(global_object, String::formatted("'{}' is not a valid column", column_name_str));
|
|
|
|
return JS::Value((i32)column_index.value());
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(SheetGlobalObject::column_arithmetic)
|
|
{
|
|
if (vm.argument_count() != 2)
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected exactly two arguments to column_arithmetic()");
|
|
|
|
auto column_name = vm.argument(0);
|
|
if (!column_name.is_string())
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "String");
|
|
|
|
auto& column_name_str = column_name.as_string().string();
|
|
|
|
auto offset = TRY(vm.argument(1).to_number(global_object));
|
|
auto offset_number = static_cast<i32>(offset.as_double());
|
|
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<SheetGlobalObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "SheetGlobalObject");
|
|
|
|
auto sheet_object = static_cast<SheetGlobalObject*>(this_object);
|
|
auto& sheet = sheet_object->m_sheet;
|
|
auto new_column = sheet.column_arithmetic(column_name_str, offset_number);
|
|
if (!new_column.has_value())
|
|
return vm.throw_completion<JS::TypeError>(global_object, String::formatted("'{}' is not a valid column", column_name_str));
|
|
|
|
return JS::js_string(vm, new_column.release_value());
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(SheetGlobalObject::get_column_bound)
|
|
{
|
|
if (vm.argument_count() != 1)
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected exactly one argument to get_column_bound()");
|
|
|
|
auto column_name = vm.argument(0);
|
|
if (!column_name.is_string())
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "String");
|
|
|
|
auto& column_name_str = column_name.as_string().string();
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<SheetGlobalObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "SheetGlobalObject");
|
|
|
|
auto sheet_object = static_cast<SheetGlobalObject*>(this_object);
|
|
auto& sheet = sheet_object->m_sheet;
|
|
auto maybe_column_index = sheet.column_index(column_name_str);
|
|
if (!maybe_column_index.has_value())
|
|
return vm.throw_completion<JS::TypeError>(global_object, String::formatted("'{}' is not a valid column", column_name_str));
|
|
|
|
auto bounds = sheet.written_data_bounds(*maybe_column_index);
|
|
return JS::Value(bounds.row);
|
|
}
|
|
|
|
WorkbookObject::WorkbookObject(Workbook& workbook, JS::GlobalObject& global_object)
|
|
: JS::Object(*JS::Object::create(global_object, global_object.object_prototype()))
|
|
, m_workbook(workbook)
|
|
{
|
|
}
|
|
|
|
void WorkbookObject::initialize(JS::GlobalObject& global_object)
|
|
{
|
|
Object::initialize(global_object);
|
|
define_native_function("sheet", sheet, 1, JS::default_attributes);
|
|
}
|
|
|
|
void WorkbookObject::visit_edges(Visitor& visitor)
|
|
{
|
|
Base::visit_edges(visitor);
|
|
for (auto& sheet : m_workbook.sheets())
|
|
visitor.visit(&sheet.global_object());
|
|
}
|
|
|
|
JS_DEFINE_NATIVE_FUNCTION(WorkbookObject::sheet)
|
|
{
|
|
if (vm.argument_count() != 1)
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected exactly one argument to sheet()");
|
|
auto name_value = vm.argument(0);
|
|
if (!name_value.is_string() && !name_value.is_number())
|
|
return vm.throw_completion<JS::TypeError>(global_object, "Expected a String or Number argument to sheet()");
|
|
|
|
auto* this_object = TRY(vm.this_value(global_object).to_object(global_object));
|
|
|
|
if (!is<WorkbookObject>(this_object))
|
|
return vm.throw_completion<JS::TypeError>(global_object, JS::ErrorType::NotAnObjectOfType, "WorkbookObject");
|
|
|
|
auto& workbook = static_cast<WorkbookObject*>(this_object)->m_workbook;
|
|
|
|
if (name_value.is_string()) {
|
|
auto& name = name_value.as_string().string();
|
|
for (auto& sheet : workbook.sheets()) {
|
|
if (sheet.name() == name)
|
|
return JS::Value(&sheet.global_object());
|
|
}
|
|
} else {
|
|
auto index = TRY(name_value.to_length(global_object));
|
|
if (index < workbook.sheets().size())
|
|
return JS::Value(&workbook.sheets()[index].global_object());
|
|
}
|
|
|
|
return JS::js_undefined();
|
|
}
|
|
|
|
}
|