cluaupp 0.2.3 → 1.3.0

package/templates/game/libs/FormatNumber/_internal/class.lua

@@ -0,0 +1,204 @@
+local class = { }
+local type_parents = { }
+local proxy_meta = setmetatable({ }, { __mode = "k" })
+
+local function proxy_tostring(self)
+	return proxy_meta[self].type_name .. ": " .. proxy_meta[self].as_string
+end
+
+local ImmutabilityType = table.freeze({
+	DEFAULT = 0,
+	NUMBER_FORMATTER = 1,
+	SYMBOLS = 2,
+})
+class.ImmutabilityType = ImmutabilityType
+
+function class.create_init_function(
+	type_name: string, parent_type_name: string?,
+	methods, parent_methods,
+	immutable: number
+)
+	local result_methods
+
+	if parent_methods then
+		result_methods = setmetatable(table.clone(parent_methods), { __index = methods })
+	else
+		result_methods = methods
+	end
+
+	type_parents[type_name] = parent_type_name or "FormatNumberObject"
+
+	return function(data, as_string)
+		local result_object = newproxy(true)
+		local result_object_meta = getmetatable(result_object)
+
+		if immutable ~= ImmutabilityType.SYMBOLS and type(data) == "table" then
+			table.freeze(data)
+		end
+
+		result_object_meta.data = data
+		result_object_meta.resolved_data = nil
+		result_object_meta.type_name = type_name
+		result_object_meta.as_string = as_string
+			or string.sub(tostring(result_object), 11)
+		result_object_meta.__index = result_methods
+		result_object_meta.__tostring = proxy_tostring
+		result_object_meta.__metatable = "The metatable is locked"
+
+		if immutable ~= ImmutabilityType.NUMBER_FORMATTER then
+			table.freeze(result_object_meta)
+		end
+
+		proxy_meta[result_object] = result_object_meta
+
+		return result_object
+	end
+end
+
+function class.is_a(object, type_name)
+	local selected_meta = proxy_meta[object]
+	local compared_type_name = selected_meta and selected_meta.type_name
+	local target_type_name = type_name
+	local result = false
+
+	if compared_type_name == target_type_name then
+		result = true
+	elseif compared_type_name then
+		repeat
+			compared_type_name = type_parents[compared_type_name]
+			result = compared_type_name == target_type_name
+		until not compared_type_name or result
+	end
+
+	return result
+end
+
+function class.get_data(object)
+	return proxy_meta[object].data
+end
+
+function class.get_resolved_data(object, call_if_not_resolved)
+	local proxy_meta_object = proxy_meta[object]
+	local resolved_data = proxy_meta_object.resolved_data
+
+	if not resolved_data then
+		resolved_data = call_if_not_resolved(proxy_meta_object.data)
+		proxy_meta_object.resolved_data = resolved_data
+		if resolved_data then
+			table.freeze(proxy_meta_object)
+		end
+	end
+
+	return resolved_data
+end
+
+function class.try_coerce(argument_no, value, type_name, default)
+	local success = false
+	local coerced_value = nil
+
+	if value == nil and default ~= nil then
+		coerced_value = default
+		success = true
+	elseif type_name == "string" then
+		if type(value) == "string" then
+			coerced_value = value
+			success = true
+		elseif type(value) == "number" then
+			coerced_value = tostring(value)
+			success = true
+		else
+			success = false
+		end
+	elseif type_name == "number" then
+		coerced_value = tonumber(value)
+		if coerced_value then
+			success = true
+		else
+			success = false
+			type_name ..= " object"
+		end
+	elseif string.sub(type_name, 1, 1) == "{" then
+		local t = string.sub(type_name, 2, -2)
+		if type(value) == "table" then
+			-- only copy the array part
+			-- no metamethods are respected
+			coerced_value = table.move(value, 1, rawlen(value), 1, table.create(rawlen(value)))
+			for i, v in coerced_value do
+				if type(v) ~= t then
+					error(string.format("Values inside the table argument must be a %s, index %d got %s", t, i, type(v)), 3)
+				end
+			end
+			success = true
+		else
+			type_name = "table"
+		end
+	elseif class.is_a(value, type_name) then
+		coerced_value = proxy_meta[value].data
+		success = true
+	end
+
+	if not success then
+		error(string.format("Argument #%d provided must be a %s", argument_no, type_name), 3)
+	end
+
+	return coerced_value
+end
+
+function class.try_coerce_range(argument_no, value, min, max, default)
+	local coerced_value
+
+	if value == nil then
+		coerced_value = default
+	else
+		local converted_integer = tonumber(value)
+		if converted_integer then
+			converted_integer = class.double_to_int32(converted_integer)
+
+			if converted_integer >= min and converted_integer <= max then
+				coerced_value = converted_integer
+			end
+		end
+	end
+
+	return coerced_value or error(string.format(
+		"Argument #%d provided must be an integer that is in the range of %d to (and including) %d",
+		argument_no, min, max
+	), 3)
+end
+
+function class.try_coerce_enum(argument_no, value, enum_tbl, default)
+	local coerced_value
+
+	if value == nil then
+		coerced_value = default
+	else
+		local enum_value_to_try = tonumber(value)
+		if enum_value_to_try then
+			enum_value_to_try = class.double_to_int32(value)
+			for k, v in enum_tbl do
+				if enum_value_to_try == v then
+					coerced_value = v
+					break
+				end
+			end
+		end
+	end
+
+	return coerced_value or error(string.format("Argument #%d provided is out of range", argument_no), 3)
+end
+
+function class.double_to_int32(value: number): number
+	if not (value > -0x80000001 and value < 0x80000000) then
+		-- Double to int32 conversion
+		-- cvttsd2si on x86
+		-- fcvtzs on aarch64
+		return UDim.new(nil, value).Offset
+	elseif value <= -1 then
+		return math.ceil(value)
+	elseif value >= 1 then
+		return math.floor(value)
+	end
+	return 0
+end
+
+return table.freeze(class)

package/templates/game/libs/FormatNumber/_internal/decimal_conversion.lua

@@ -0,0 +1,30 @@
+local decimal_conversion = { }
+local NUMBER_BYTE_CONVERSION = table.freeze({
+	["0"] = "\x00", ["1"] = "\x01", ["2"] = "\x02", ["3"] = "\x03",
+	["4"] = "\x04", ["5"] = "\x05", ["6"] = "\x06", ["7"] = "\x07",
+	["8"] = "\x08", ["9"] = "\x09",
+})
+
+function decimal_conversion.from_double(double: number): ({ number }, number, number)
+	local result_fmt
+	local result_n
+	local result_scale
+
+	local sigt_int, sigt_frac, expt = string.match(
+		tostring(double), "^(%d+)%.?(%d*)e?([+-]?%d*)$"
+	)
+	local sigt, sigt_incr = string.match(
+		sigt_int .. sigt_frac, "^0*(%d-)(0*)$"
+	)
+
+	result_fmt = {string.byte(
+		string.gsub(sigt, ".", NUMBER_BYTE_CONVERSION),
+		1, -1
+	)}
+	result_n = #result_fmt
+	result_scale = (tonumber(expt) or 0) - #sigt_frac + #sigt_incr
+
+	return result_fmt, result_n, result_scale
+end
+
+return table.freeze(decimal_conversion)

package/templates/game/libs/FormatNumber/_internal/enums.lua

@@ -0,0 +1,55 @@
+return table.freeze({
+	RoundingMode = table.freeze({
+		CEILING = 0,
+		FLOOR = 1,
+		DOWN = 2,
+		UP = 3,
+		HALF_EVEN = 4,
+		HALF_DOWN = 5,
+		HALF_UP = 6,
+	}),
+	GroupingStrategy = table.freeze({
+		OFF = 0,
+		MIN2 = 1,
+		ON_ALIGNED = 3,
+	}),
+	ENumberFormatSymbols = table.freeze({
+		kDecimalSeparatorSymbol = 0,
+		kGroupingSeparatorSymbol = 1,
+		kMinusSignSymbol = 6,
+		kPlusSignSymbol = 7,
+		kExponentialSymbol = 11,
+		kInfinitySymbol = 14,
+		kNaNSymbol = 15,
+	}),
+	SignDisplay = table.freeze({
+		AUTO = 0,
+		ALWAYS = 1,
+		NEVER = 2,
+		EXCEPT_ZERO = 5,
+		NEGATIVE = 7,
+	}),
+	DecimalSeparatorDisplay = table.freeze({
+		AUTO = 0,
+		ALWAYS = 1,
+	}),
+	RoundingPriority = table.freeze({
+		RELAXED = 0,
+		STRICT = 1,
+	}),
+
+	_Internal = table.freeze({
+		NotationType = table.freeze({
+			SIMPLE = 0,
+			SCIENTIFIC = 1,
+			COMPACT = 2,
+		}),
+
+		PrecisionType = table.freeze({
+			FRACTION = 0,
+			SIGNFICANT = 1,
+			FRACTION_SIGNIFICANT = 2,
+			UNLIMITED = 3,
+		}),
+	}),
+})

package/templates/game/libs/FormatNumber/_internal/format.lua

@@ -0,0 +1,342 @@
+local enums = require(script.Parent.enums)
+local formatter_settings = require(script.Parent.formatter_settings)
+local format = { }
+
+local function internal_get_digits(fmt: { number }, fmt_n: number, i: number, j: number): string
+	local leftz, strd, rightz, rightzn
+
+	if i <= 0 then
+		leftz = string.rep("0", -i + 1)
+		i = 1
+	else
+		leftz = ""
+	end
+
+	rightzn = j - math.max(fmt_n, i - 1)
+	if rightzn <= 0 then
+		rightz = ""
+	else
+		j = fmt_n
+		rightz = string.rep("0", rightzn)
+	end
+
+	if i > fmt_n then
+		strd = ""
+	else
+		strd = string.char(table.unpack(fmt, i, j))
+	end
+
+	return leftz .. strd .. rightz
+end
+
+function format.strip_trailing_zero(fmt: { number }, fmt_n: number): (number)
+	if fmt_n < 0 then
+		fmt_n = 0
+	else
+		while fmt[fmt_n] == 0 do
+			fmt_n -= 1
+		end
+	end
+	return fmt_n
+end
+
+function format.round_sig(
+	fmt: { number }, fmt_n: number, sig: number,
+	sign: boolean, rounding_mode: number
+): (number, boolean)
+	local incr_e = 0
+
+	if fmt_n > sig then
+		local midpoint
+		-- 1 = down
+		-- 0 = half down
+		-- -1 = half up
+		-- -2 = up
+		local resolved_rounding_midpoint
+
+		if sig < 0 then
+			midpoint = -1
+		elseif fmt[sig + 1] > 5 then
+			midpoint = 1
+		elseif fmt[sig + 1] == 5 then
+			midpoint = if fmt_n > sig + 1 then 1 else 0
+		else
+			midpoint = -1
+		end
+
+
+		if rounding_mode == enums.RoundingMode.CEILING then
+			resolved_rounding_midpoint = if sign then 1 else -2
+		elseif rounding_mode == enums.RoundingMode.FLOOR then
+			resolved_rounding_midpoint = if sign then -2 else 1
+		elseif rounding_mode == enums.RoundingMode.UP then
+			resolved_rounding_midpoint = -2
+		elseif rounding_mode == enums.RoundingMode.DOWN then
+			resolved_rounding_midpoint = 1
+		elseif rounding_mode == enums.RoundingMode.HALF_EVEN then
+			resolved_rounding_midpoint = if sig <= 0
+				then 0
+				else fmt[sig] % -2
+		elseif rounding_mode == enums.RoundingMode.HALF_DOWN then
+			resolved_rounding_midpoint = 0
+		elseif rounding_mode == enums.RoundingMode.HALF_UP then
+			resolved_rounding_midpoint = -1
+		end
+
+		fmt_n = sig
+
+		if midpoint > resolved_rounding_midpoint then
+			while fmt[fmt_n] == 9 and fmt_n > 0 do
+				fmt_n -= 1
+			end
+
+			if fmt_n <= 0 then
+				fmt[1] = 1
+				incr_e = 1 - fmt_n
+				fmt_n = 1
+			else
+				fmt[fmt_n] += 1
+			end
+		end
+
+		fmt_n = format.strip_trailing_zero(fmt, fmt_n)
+	end
+
+	return fmt_n, incr_e
+end
+
+function format.resolve_int_frac(
+	fmt: { number }, fmt_n: number, marker: number,
+	i: number, j: number, min_grouping: number?, grouping_symbol: string
+): string
+	local intg, frac, expt
+
+	for i = 1, fmt_n do
+		fmt[i] += 0x30
+	end
+
+	-- interesting edge case
+	if marker < i and j < marker + 1 then
+		intg = "0"
+		frac = ""
+	else
+		intg = internal_get_digits(fmt, fmt_n, i, marker)
+		frac = internal_get_digits(fmt, fmt_n, marker + 1, j)
+	end
+
+	if min_grouping and marker - i + 1 >= min_grouping then
+		local grouping_repl
+
+		if grouping_symbol == "%" then
+			grouping_repl = "%0%%"
+		elseif #grouping_symbol > 1 then
+			grouping_repl = "%0" .. string.reverse(grouping_symbol)
+		else
+			grouping_repl = "%0" .. grouping_symbol
+		end
+		intg = string.reverse((string.gsub(string.reverse(intg),
+			"...", grouping_repl, (marker - i) / 3
+		)))
+	end
+
+	return intg, frac
+end
+
+function format.format_expt(expt, symbols, min_int_digits, disp_sign_at)
+	local disp_sign = ""
+	local exp_str
+	if expt < 0 then
+		exp_str = tostring(-expt)
+		if disp_sign_at.negative then
+			disp_sign = symbols[enums.ENumberFormatSymbols.kMinusSignSymbol]
+		end
+	elseif expt == 0 then
+		exp_str = "0"
+		if disp_sign_at.positiveZero then
+			disp_sign = symbols[enums.ENumberFormatSymbols.kPlusSignSymbol]
+		end
+	else
+		exp_str = tostring(expt)
+		if disp_sign_at.positive then
+			disp_sign = symbols[enums.ENumberFormatSymbols.kPlusSignSymbol]
+		end
+	end
+
+	exp_str = string.rep("0", min_int_digits - #exp_str) .. exp_str
+
+	return symbols[enums.ENumberFormatSymbols.kExponentialSymbol]
+		.. disp_sign .. exp_str
+end
+
+function format.resolve_with_notation(fmt, fmt_n, scale, notation, symbols)
+	local fmtd_expt = nil
+	local next_expt_threshold = nil
+	local next_fmtd_expt = nil
+	local decimal_marker = scale
+
+	if fmt_n <= 0 then
+		if notation.type == enums._Internal.NotationType.SCIENTIFIC then
+			fmtd_expt = format.format_expt(
+				0, symbols,
+				notation.minExponentDigits,
+				notation.displayExponentSignAt
+			)
+		end
+	else
+		if notation.type == enums._Internal.NotationType.SIMPLE then
+			decimal_marker += fmt_n
+		else
+			local d_pow10 = notation.power10Scale
+			local value_pow10 = decimal_marker + fmt_n - 1
+			local p_quotient = math.floor(value_pow10 / d_pow10)
+			local p_remainder = value_pow10 - p_quotient * d_pow10
+
+			decimal_marker = p_remainder + 1
+			if notation.type == enums._Internal.NotationType.COMPACT then
+				local suffix_n = notation.suffixesLength
+				if p_quotient > suffix_n then
+					decimal_marker += (p_quotient - suffix_n) * d_pow10
+					fmtd_expt = notation.suffixes[suffix_n]
+				elseif p_quotient < 0 then
+					decimal_marker += p_quotient * d_pow10
+				elseif p_quotient ~= 0 then
+					fmtd_expt = notation.suffixes[p_quotient]
+				end
+
+				if p_quotient >= 0 and p_quotient < suffix_n then
+					next_expt_threshold = d_pow10
+					next_fmtd_expt = notation.suffixes[p_quotient + 1]
+				end
+			else
+				fmtd_expt = format.format_expt(
+					p_quotient * d_pow10,
+					symbols,
+					notation.minExponentDigits,
+					notation.displayExponentSignAt
+				)
+				next_fmtd_expt = format.format_expt(
+					(p_quotient + 1) * d_pow10,
+					symbols,
+					notation.minExponentDigits,
+					notation.displayExponentSignAt
+				)
+
+				next_expt_threshold = d_pow10
+			end
+		end
+	end
+
+	return decimal_marker, fmtd_expt, next_expt_threshold, next_fmtd_expt
+end
+
+function format.format_unsigned_finite(
+	fmt, fmt_n, scale, is_negt,
+	internal_settings
+): string
+	local result, rounded_to_zero
+
+	local fmtd_frac
+	local int_width
+	local min_int = internal_settings.integerWidth.min
+	local max_int = internal_settings.integerWidth.max
+	local re_min_sig, re_max_sig
+	local incr_marker
+
+	local notation = internal_settings.notation
+	local symbols = internal_settings.symbols
+
+	local decimal_marker, fmtd_expt, next_expt_threshold, next_fmtd_expt =
+		format.resolve_with_notation(fmt, fmt_n, scale, notation, symbols)
+
+	re_min_sig, re_max_sig =
+		formatter_settings.resolve_min_max_sig(
+			internal_settings.precision,
+			decimal_marker
+		)
+
+	fmt_n, incr_marker = format.round_sig(
+		fmt, fmt_n, re_max_sig, is_negt,
+		internal_settings.roundingMode
+	)
+
+	rounded_to_zero = fmt_n == 0
+
+	if incr_marker > 0 then
+		if decimal_marker == next_expt_threshold then
+			-- assume incr_maker is 1
+			assert(incr_marker == 1)
+			fmtd_expt = next_fmtd_expt
+			decimal_marker = 1
+		else
+			decimal_marker += incr_marker
+		end
+
+		re_min_sig, re_max_sig =
+			formatter_settings.resolve_min_max_sig(
+				internal_settings.precision, decimal_marker
+			)
+	elseif rounded_to_zero then
+		-- for convenince
+		re_min_sig, re_max_sig =
+			formatter_settings.resolve_min_max_sig(
+				internal_settings.precision, 1
+			)
+		decimal_marker = 1
+	end
+
+	if decimal_marker < min_int then
+		int_width = min_int
+	elseif max_int ~= -1 and decimal_marker > max_int then
+		int_width = max_int
+	else
+		int_width = decimal_marker
+	end
+
+	result, fmtd_frac = format.resolve_int_frac(
+		fmt, fmt_n, decimal_marker,
+		math.max(decimal_marker, 0) - int_width + 1,
+		math.max(fmt_n, re_min_sig),
+		internal_settings.minGrouping,
+		symbols[enums.ENumberFormatSymbols.kGroupingSeparatorSymbol]
+	)
+
+	if internal_settings.alwaysDisplayDecimal
+		or fmtd_frac ~= "" then
+		result ..= symbols[enums.ENumberFormatSymbols.kDecimalSeparatorSymbol]
+			.. fmtd_frac
+	end
+
+	if fmtd_expt then
+		result ..= fmtd_expt
+	end
+
+	return result, rounded_to_zero
+end
+
+function format.display_sign(str, is_negt, is_zero, disp_sign_at, symbols)
+	local sign_symbol
+	local display
+
+	if is_negt then
+		sign_symbol = symbols[enums.ENumberFormatSymbols.kMinusSignSymbol]
+		if is_zero then
+			display = disp_sign_at.negativeZero
+		else
+			display = disp_sign_at.negative
+		end
+	else
+		sign_symbol = symbols[enums.ENumberFormatSymbols.kPlusSignSymbol]
+		if is_zero then
+			display = disp_sign_at.positiveZero
+		else
+			display = disp_sign_at.positive
+		end
+	end
+
+	if display then
+		return sign_symbol .. str
+	end
+	return str
+end
+
+return table.freeze(format)