mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-09 17:52:08 -10:00
544 lines
16 KiB
C++
544 lines
16 KiB
C++
/*
|
|
* Created by Hassan "Karajorma" Kazmi and Josh "jg18" Glatt for The FreeSpace 2 Source Code Project.
|
|
* You may not sell or otherwise commercially exploit the source or things you
|
|
* create based on the source.
|
|
*/
|
|
|
|
#include <algorithm>
|
|
#include <array>
|
|
#include <iterator>
|
|
|
|
#include "gamesequence/gamesequence.h"
|
|
#include "globalincs/pstypes.h"
|
|
#include "globalincs/toolchain.h"
|
|
#include "mission/missiongoals.h"
|
|
#include "parse/generic_log.h"
|
|
#include "parse/parselo.h"
|
|
#include "parse/sexp_container.h"
|
|
#include "utils/Random.h"
|
|
|
|
static SCP_vector<sexp_container> Sexp_containers;
|
|
static SCP_unordered_map<SCP_string, sexp_container*, SCP_string_lcase_hash, SCP_string_lcase_equal_to>
|
|
Containers_by_name_map;
|
|
|
|
|
|
const SCP_vector<sexp_container> &get_all_sexp_containers()
|
|
{
|
|
return Sexp_containers;
|
|
}
|
|
|
|
static const SCP_vector<list_modifier> List_modifiers = {
|
|
{ "Get_First", ListModifier::GET_FIRST },
|
|
{ "Get_Last", ListModifier::GET_LAST },
|
|
{ "Remove_First", ListModifier::REMOVE_FIRST },
|
|
{ "Remove_Last", ListModifier::REMOVE_LAST },
|
|
{ "Get_Random", ListModifier::GET_RANDOM },
|
|
{ "Remove_Random", ListModifier::REMOVE_RANDOM },
|
|
{ "At", ListModifier::AT_INDEX }
|
|
};
|
|
|
|
const SCP_vector<list_modifier>& get_all_list_modifiers()
|
|
{
|
|
return List_modifiers;
|
|
}
|
|
|
|
// CTEXT()-related data
|
|
namespace {
|
|
const char *Empty_str = "";
|
|
} // namespace
|
|
|
|
// sexp_container data and functions
|
|
const SCP_string sexp_container::DELIM_STR(1, sexp_container::DELIM);
|
|
|
|
|
|
bool sexp_container::operator==(const sexp_container &sc) const
|
|
{
|
|
return container_name == sc.container_name && type == sc.type && opf_type == sc.opf_type &&
|
|
list_data == sc.list_data && map_data == sc.map_data;
|
|
}
|
|
|
|
bool sexp_container::name_matches(const sexp_container &container) const
|
|
{
|
|
return !stricmp(container.container_name.c_str(), container_name.c_str());
|
|
}
|
|
|
|
bool sexp_container::empty() const
|
|
{
|
|
return size() == 0;
|
|
}
|
|
|
|
int sexp_container::size() const
|
|
{
|
|
if (is_list()) {
|
|
return (int)list_data.size();
|
|
} else if (is_map()) {
|
|
return (int)map_data.size();
|
|
} else {
|
|
UNREACHABLE("Unknown container type %d", (int)type);
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
static constexpr ContainerType CONTAINER_PERSISTENCE_FLAGS =
|
|
ContainerType::SAVE_ON_MISSION_CLOSE | ContainerType::SAVE_ON_MISSION_PROGRESS | ContainerType::NETWORK |
|
|
ContainerType::SAVE_TO_PLAYER_FILE;
|
|
|
|
ContainerType sexp_container::get_non_persistent_type() const
|
|
{
|
|
return type & ~CONTAINER_PERSISTENCE_FLAGS;
|
|
}
|
|
|
|
bool sexp_container::type_matches(const sexp_container &container) const
|
|
{
|
|
return get_non_persistent_type() == container.get_non_persistent_type();
|
|
}
|
|
|
|
// list_modifier functions
|
|
|
|
list_modifier::Modifier list_modifier::get_modifier(const char *modifier_name)
|
|
{
|
|
Assert(modifier_name != nullptr);
|
|
|
|
for (const auto &modifier_obj : List_modifiers) {
|
|
if (modifier_obj.match_name(modifier_name)) {
|
|
return modifier_obj.modifier;
|
|
}
|
|
}
|
|
|
|
// not found
|
|
return ListModifier::INVALID;;
|
|
}
|
|
|
|
bool list_modifier::match_name(const char *other_name) const
|
|
{
|
|
if (modifier == ListModifier::AT_INDEX) {
|
|
// check if modifier is a prefix
|
|
return !strnicmp(name, other_name, strlen(name));
|
|
} else {
|
|
return !stricmp(name, other_name);
|
|
}
|
|
}
|
|
|
|
// sexp_container.h functions
|
|
|
|
/**
|
|
* Clear the SEXP Containers and related data
|
|
*/
|
|
void init_sexp_containers()
|
|
{
|
|
Sexp_containers.clear();
|
|
Containers_by_name_map.clear();
|
|
}
|
|
|
|
void update_sexp_containers(SCP_vector<sexp_container> &containers,
|
|
const SCP_unordered_map<SCP_string, SCP_string, SCP_string_lcase_hash, SCP_string_lcase_equal_to>
|
|
&renamed_containers)
|
|
{
|
|
Sexp_containers = std::move(containers);
|
|
|
|
Containers_by_name_map.clear();
|
|
for (auto &container : Sexp_containers) {
|
|
Containers_by_name_map.emplace(container.container_name, &container);
|
|
}
|
|
|
|
if (!renamed_containers.empty()) {
|
|
for (int i = 0; i < Num_sexp_nodes; i++) {
|
|
auto &node = Sexp_nodes[i];
|
|
if (node.type == SEXP_ATOM && node.subtype == SEXP_ATOM_CONTAINER) {
|
|
const auto new_name_it = renamed_containers.find(node.text);
|
|
if (new_name_it != renamed_containers.cend()) {
|
|
strcpy_s(node.text, new_name_it->second.c_str());
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
bool stuff_one_generic_sexp_container(SCP_string &name, ContainerType &type, int &opf_type, SCP_vector<SCP_string> &data)
|
|
{
|
|
bool valid = true; // try to skip past bad containers by not returning until end of function
|
|
SCP_string temp_type_string;
|
|
|
|
data.clear();
|
|
|
|
required_string("$Name:");
|
|
stuff_string(name, F_NAME);
|
|
|
|
if (name.empty()) {
|
|
Warning(LOCATION, "SEXP Container with empty name found");
|
|
log_printf(LOGFILE_EVENT_LOG, "SEXP Container with empty name found");
|
|
valid = false;
|
|
} else if (name.length() > sexp_container::NAME_MAX_LENGTH) {
|
|
Warning(LOCATION,
|
|
"SEXP Container name %s is longer than limit %d",
|
|
name.c_str(),
|
|
sexp_container::NAME_MAX_LENGTH);
|
|
log_printf(LOGFILE_EVENT_LOG,
|
|
"SEXP Container name %s is longer than limit %d",
|
|
name.c_str(),
|
|
sexp_container::NAME_MAX_LENGTH);
|
|
valid = false;
|
|
} else if (get_sexp_container(name.c_str()) != nullptr) {
|
|
Warning(LOCATION, "A SEXP Container named %s already exists", name.c_str());
|
|
log_printf(LOGFILE_EVENT_LOG, "A SEXP Container named %s already exists", name.c_str());
|
|
valid = false;
|
|
}
|
|
|
|
required_string("$Data Type:");
|
|
stuff_string(temp_type_string, F_NAME);
|
|
if (!stricmp(temp_type_string.c_str(), "Number")) {
|
|
type |= ContainerType::NUMBER_DATA;
|
|
opf_type = OPF_NUMBER;
|
|
} else if (!stricmp(temp_type_string.c_str(), "String")) {
|
|
type |= ContainerType::STRING_DATA;
|
|
opf_type = OPF_ANYTHING;
|
|
} else {
|
|
Warning(LOCATION, "Unknown SEXP Container type %s found", temp_type_string.c_str());
|
|
log_printf(LOGFILE_EVENT_LOG, "Unknown SEXP Container type %s found", temp_type_string.c_str());
|
|
valid = false;
|
|
}
|
|
|
|
if (optional_string("$Key Type:")) {
|
|
Assertion(any(type & ContainerType::MAP), "$Key Type: found for container which doesn't use keys!");
|
|
|
|
stuff_string(temp_type_string, F_NAME);
|
|
if (!stricmp(temp_type_string.c_str(), "Number")) {
|
|
type |= ContainerType::NUMBER_KEYS;
|
|
} else if (!stricmp(temp_type_string.c_str(), "String")) {
|
|
type |= ContainerType::STRING_KEYS;
|
|
} else {
|
|
Warning(LOCATION, "Unknown SEXP Container type %s found", temp_type_string.c_str());
|
|
log_printf(LOGFILE_EVENT_LOG, "Unknown SEXP Container type %s found", temp_type_string.c_str());
|
|
valid = false;
|
|
}
|
|
}
|
|
|
|
if (optional_string("+Strictly Typed Keys")) {
|
|
Assertion(any(type & ContainerType::MAP), "+Strictly Typed Keys found for container which doesn't use keys!");
|
|
Warning(LOCATION, "Container %s is marked for strictly typed keys, which are not yet supported.", name.c_str());
|
|
type |= ContainerType::STRICTLY_TYPED_KEYS;
|
|
}
|
|
|
|
if (optional_string("+Strictly Typed Data")) {
|
|
Warning(LOCATION, "Container %s is marked for strictly typed data, which are not yet supported.", name.c_str());
|
|
type |= ContainerType::STRICTLY_TYPED_DATA;
|
|
}
|
|
|
|
required_string("$Data:");
|
|
stuff_string_list(data);
|
|
|
|
if (optional_string("+Network Container")) {
|
|
Warning(LOCATION, "Container %s is marked as a network container, which is not yet supported.", name.c_str());
|
|
type |= ContainerType::NETWORK;
|
|
}
|
|
|
|
if (optional_string("+Eternal")) {
|
|
type |= ContainerType::SAVE_TO_PLAYER_FILE;
|
|
}
|
|
|
|
// campaign-persistent
|
|
if (optional_string("+Save On Mission Progress")) {
|
|
type |= ContainerType::SAVE_ON_MISSION_PROGRESS;
|
|
}
|
|
|
|
// player-persistent
|
|
if (optional_string("+Save On Mission Close")) {
|
|
Assert(none(type & ContainerType::SAVE_ON_MISSION_PROGRESS));
|
|
type |= ContainerType::SAVE_ON_MISSION_CLOSE;
|
|
}
|
|
|
|
Assert(none(type & ContainerType::SAVE_TO_PLAYER_FILE) ||
|
|
(any(type & ContainerType::SAVE_ON_MISSION_PROGRESS) ^ any(type & ContainerType::SAVE_ON_MISSION_CLOSE)));
|
|
|
|
return valid;
|
|
}
|
|
|
|
void stuff_sexp_list_containers()
|
|
{
|
|
SCP_vector<SCP_string> parsed_data;
|
|
|
|
while (required_string_either("$End Lists", "$Name:")) {
|
|
Sexp_containers.emplace_back();
|
|
auto &new_list = Sexp_containers.back();
|
|
|
|
new_list.type = ContainerType::LIST;
|
|
if (stuff_one_generic_sexp_container(new_list.container_name, new_list.type, new_list.opf_type, parsed_data)) {
|
|
std::copy(parsed_data.begin(), parsed_data.end(), back_inserter(new_list.list_data));
|
|
Containers_by_name_map.emplace(new_list.container_name, &new_list);
|
|
} else {
|
|
Sexp_containers.pop_back();
|
|
}
|
|
}
|
|
}
|
|
|
|
void stuff_sexp_map_containers()
|
|
{
|
|
SCP_vector<SCP_string> parsed_data;
|
|
|
|
while (required_string_either("$End Maps", "$Name:")) {
|
|
Sexp_containers.emplace_back();
|
|
auto& new_map = Sexp_containers.back();
|
|
|
|
new_map.type = ContainerType::MAP;
|
|
if (stuff_one_generic_sexp_container(new_map.container_name, new_map.type, new_map.opf_type, parsed_data)) {
|
|
if (parsed_data.size() % 2 != 0) {
|
|
Warning(LOCATION,
|
|
"Data in the SEXP Map container is corrupt. Must be an even number of entries. Instead have %d",
|
|
(int)parsed_data.size());
|
|
log_printf(LOGFILE_EVENT_LOG,
|
|
"Data in the SEXP Map container is corrupt. Must be an even number of entries. Instead have %d",
|
|
(int)parsed_data.size());
|
|
Sexp_containers.pop_back();
|
|
} else {
|
|
for (int i = 0; i < (int)parsed_data.size(); i += 2) {
|
|
new_map.map_data.emplace(parsed_data[i], parsed_data[i + 1]);
|
|
}
|
|
Containers_by_name_map.emplace(new_map.container_name, &new_map);
|
|
}
|
|
} else {
|
|
Sexp_containers.pop_back();
|
|
}
|
|
}
|
|
}
|
|
|
|
sexp_container *get_sexp_container(const char* name) {
|
|
auto container_it = Containers_by_name_map.find(name);
|
|
if (container_it != Containers_by_name_map.end()) {
|
|
return container_it->second;
|
|
} else {
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tests whether this position in a character array is the start of a container name
|
|
* Returns a pointer to the container or nullptr if not found
|
|
**/
|
|
sexp_container *get_sexp_container_special(const SCP_string& text, size_t start_pos)
|
|
{
|
|
Assert(!text.empty());
|
|
Assert(start_pos < text.length());
|
|
|
|
for (auto &container : Sexp_containers) {
|
|
if (!strnicmp(container.container_name.c_str(), text.c_str(), container.container_name.length())) {
|
|
return &container;
|
|
}
|
|
}
|
|
|
|
// not found
|
|
return nullptr;
|
|
}
|
|
|
|
// Containers should not be modified if the game is simply checking the syntax.
|
|
bool are_containers_modifiable()
|
|
{
|
|
// can always modify containers during the mission itself
|
|
if (Game_mode & GM_IN_MISSION) {
|
|
return true;
|
|
}
|
|
|
|
// can also modify if we are calling the sexp from a script or if we are briefing / debriefing, etc.
|
|
switch (gameseq_get_state()) {
|
|
case GS_STATE_BRIEFING:
|
|
case GS_STATE_DEBRIEF:
|
|
case GS_STATE_CMD_BRIEF:
|
|
case GS_STATE_FICTION_VIEWER:
|
|
case GS_STATE_SCRIPTING:
|
|
return true;
|
|
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// TODO: see if this code can be combined with similar code for text replacement
|
|
bool sexp_container_CTEXT_helper(int &node, sexp_container &container, SCP_string &result)
|
|
{
|
|
if (container.is_map()) {
|
|
if (container.map_data.empty()) {
|
|
Warning(LOCATION, "Attempt to retrieve data from empty map container %s", container.container_name.c_str());
|
|
return false;
|
|
}
|
|
|
|
const char *key = CTEXT(node);
|
|
const auto value_it = container.map_data.find(SCP_string(key));
|
|
|
|
if (value_it != container.map_data.end()) {
|
|
result = value_it->second;
|
|
return true;
|
|
} else {
|
|
if (Log_event) {
|
|
SCP_string log_string = container.container_name;
|
|
log_string.append(" map container returned nothing when searched for key ");
|
|
log_string.append(key);
|
|
Current_event_log_container_buffer->emplace_back(log_string);
|
|
}
|
|
return false;
|
|
}
|
|
} else if (container.is_list()) {
|
|
if (container.list_data.empty()) {
|
|
Warning(LOCATION, "Attempt to retrieve data from empty list container %s", container.container_name.c_str());
|
|
return false;
|
|
}
|
|
|
|
const char *modifier_name = CTEXT(node);
|
|
const auto modifier = list_modifier::get_modifier(modifier_name);
|
|
|
|
|
|
if (modifier == ListModifier::INVALID) {
|
|
const SCP_string &container_name = container.container_name;
|
|
Warning(LOCATION,
|
|
"Illegal operation attempted on %s container. There is no modifier called %s.",
|
|
container_name.c_str(),
|
|
modifier_name);
|
|
log_printf(LOGFILE_EVENT_LOG,
|
|
"Illegal operation attempted on %s container. There is no modifier called %s.",
|
|
container_name.c_str(),
|
|
modifier_name);
|
|
return false;
|
|
}
|
|
|
|
int data_index = -1;
|
|
auto &list_data = container.list_data;
|
|
auto list_it = list_data.begin();
|
|
|
|
switch (modifier) {
|
|
case ListModifier::GET_FIRST:
|
|
case ListModifier::REMOVE_FIRST:
|
|
result = list_data.front();
|
|
if (modifier == ListModifier::REMOVE_FIRST && are_containers_modifiable()) {
|
|
list_data.pop_front();
|
|
}
|
|
return true;
|
|
|
|
case ListModifier::GET_LAST:
|
|
case ListModifier::REMOVE_LAST:
|
|
result = list_data.back();
|
|
if (modifier == ListModifier::REMOVE_LAST && are_containers_modifiable()) {
|
|
list_data.pop_back();
|
|
}
|
|
return true;
|
|
|
|
case ListModifier::GET_RANDOM:
|
|
case ListModifier::REMOVE_RANDOM:
|
|
data_index = util::Random::next((int)list_data.size());
|
|
std::advance(list_it, data_index);
|
|
result = *list_it;
|
|
if (modifier == ListModifier::REMOVE_RANDOM && are_containers_modifiable()) {
|
|
list_data.erase(list_it);
|
|
}
|
|
return true;
|
|
|
|
case ListModifier::AT_INDEX:
|
|
node = CDR(node);
|
|
if (node == -1) {
|
|
return false;
|
|
}
|
|
bool is_nan, is_nan_forever;
|
|
data_index = eval_num(node, is_nan, is_nan_forever);
|
|
if (is_nan || is_nan_forever) {
|
|
return false;
|
|
}
|
|
if (data_index < 0 || data_index >= (int)list_data.size()) {
|
|
return false;
|
|
}
|
|
result = *std::next(list_it, data_index);
|
|
return true;
|
|
|
|
default:
|
|
UNREACHABLE("Unhandled list modifier %d found for container %s",
|
|
(int)modifier,
|
|
container.container_name.c_str());
|
|
break;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
// inspired by sexp_campaign_file_variable_count()
|
|
bool sexp_container_has_persistent_non_eternal_containers()
|
|
{
|
|
for (const auto &container : Sexp_containers) {
|
|
if (container.is_persistent() && !container.is_eternal()) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
const char *sexp_container_CTEXT(int node)
|
|
{
|
|
auto *p_container = get_sexp_container(Sexp_nodes[node].text);
|
|
|
|
if (!p_container) {
|
|
Warning(LOCATION, "sexp_container_CTEXT() called for %s, a container which does not exist!", Sexp_nodes[node].text);
|
|
log_printf(LOGFILE_EVENT_LOG, "sexp_container_CTEXT() called for %s, a container which does not exist!", Sexp_nodes[node].text);
|
|
return Empty_str;
|
|
}
|
|
|
|
node = CAR(node);
|
|
Assert(node != -1);
|
|
|
|
SCP_string result;
|
|
|
|
for (int sanity = 0; sanity < 20; ++sanity) {
|
|
auto &container = *p_container;
|
|
bool success = sexp_container_CTEXT_helper(node, container, result);
|
|
|
|
if (Log_event) {
|
|
SCP_string log_string = container.container_name;
|
|
if (success) {
|
|
log_string += " container returned ";
|
|
log_string += result;
|
|
} else {
|
|
log_string += " container lookup failed";
|
|
}
|
|
Current_event_log_container_buffer->emplace_back(log_string);
|
|
}
|
|
|
|
if (!success || result.empty()) {
|
|
return Empty_str;
|
|
}
|
|
|
|
if (result.front() != sexp_container::DELIM) {
|
|
if (!Sexp_nodes[node].cache) {
|
|
Sexp_nodes[node].cache = new sexp_cached_data(OPF_CONTAINER_NAME, result);
|
|
} else {
|
|
Sexp_nodes[node].cache->update_container_CTEXT_result(result);
|
|
}
|
|
return Sexp_nodes[node].cache->container_CTEXT_result;
|
|
} else {
|
|
// we're dealing with a multidimentional container
|
|
node = CDR(node);
|
|
|
|
if (node == -1) {
|
|
Warning(LOCATION,
|
|
"Multidimensional container argument missing for '%s' from container %s!",
|
|
result.c_str(),
|
|
container.container_name.c_str());
|
|
log_printf(LOGFILE_EVENT_LOG,
|
|
"Multidimensional container argument missing for '%s' from container %s!",
|
|
result.c_str(),
|
|
container.container_name.c_str());
|
|
return Empty_str;
|
|
}
|
|
|
|
// "- 2" because we're skipping the first and last chars, which are/should both be &
|
|
auto *p_next_container = get_sexp_container(result.substr(1, (result.length() - 2)).c_str());
|
|
|
|
if (p_next_container != nullptr) {
|
|
p_container = p_next_container;
|
|
result.clear();
|
|
} else {
|
|
Warning(LOCATION, "There is no container called %s in this mission.", result.c_str());
|
|
return Empty_str;
|
|
}
|
|
}
|
|
}
|
|
|
|
// we've hit sanity limit; give up
|
|
return Empty_str;
|
|
}
|