Jak3 Build Environment (#3098)

This sets out the bones of a Jak 3 build, many things are stubbed out,
guessed, or copied from Jak 2 but it should at least be good enough to:
run `task set-game-jak3`
launch the repl
run builds from the repl

build outputs themselves are untested but the build itself runs without
errors

---------

Co-authored-by: Tyler Wilding <[email protected]>

Author: jabermony

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "endOfLine": "auto",
+  "overrides": [
+    {
+      "files": ["**/*.jsonc"],
+      "options": {
+        "parser": "json"
+      }
+    }
+  ]
+}

.prettierrc.json

@@ -74,24 +74,23 @@ tasks:
         msg: "Couldn't locate compiler executable in '{{.GOALC_BIN_RELEASE_DIR}}/goalc'"
     cmds:
       - "{{.GOALC_BIN_RELEASE_DIR}}/goalc --user-auto --game {{.GAME}}"
-  format:
+  format-json:
     desc: "Format code"
     cmds:
-      - cmd: python ./scripts/cpp/format-includes.py
-      - cmd: python ./third-party/run-clang-format/run-clang-format.py -r common decompiler game goalc test tools lsp -i
       # npm install -g prettier
       - cmd: npx prettier --write ./decompiler/config/jak1/**/*.jsonc
         ignore_error: true
       - cmd: npx prettier --write ./decompiler/config/jak2/**/*.jsonc
         ignore_error: true
-  format-json:
+      - cmd: npx prettier --write ./decompiler/config/jak3/**/*.jsonc
+        ignore_error: true
+  format:
     desc: "Format code"
     cmds:
-      # npm install -g prettier
-      - cmd: npx prettier --write ./decompiler/config/jak1/**/*.jsonc
-        ignore_error: true
-      - cmd: npx prettier --write ./decompiler/config/jak2/**/*.jsonc
-        ignore_error: true
+      - cmd: python ./scripts/cpp/format-includes.py
+      - cmd: python ./third-party/run-clang-format/run-clang-format.py -r common decompiler game goalc test tools lsp -i
+      - task: format-json
+  
   # DECOMPILING
   decomp:
     cmds:

Taskfile.yml

@@ -11,13 +11,15 @@ GameVersion game_name_to_version(const std::string& name) {
     return GameVersion::Jak1;
   } else if (name == "jak2") {
     return GameVersion::Jak2;
+  } else if (name == "jak3") {
+    return GameVersion::Jak3;
   } else {
     ASSERT_MSG(false, fmt::format("invalid game name: {}", name));
   }
 }
 
 bool valid_game_version(const std::string& name) {
-  return name == "jak1" || name == "jak2";
+  return name == "jak1" || name == "jak2" || name == "jak3";
 }
 
 std::string version_to_game_name(GameVersion v) {
@@ -26,6 +28,8 @@ std::string version_to_game_name(GameVersion v) {
       return "jak1";
     case GameVersion::Jak2:
       return "jak2";
+    case GameVersion::Jak3:
+      return "jak3";
     default:
       ASSERT_MSG(false, fmt::format("no game_name for version: {} found", fmt::underlying(v)));
   }
@@ -37,13 +41,16 @@ std::string version_to_game_name_external(GameVersion v) {
       return "Jak 1";
     case GameVersion::Jak2:
       return "Jak 2";
+    case GameVersion::Jak3:
+      return "Jak 3";
     default:
       ASSERT_MSG(false, fmt::format("no game_name for version: {} found", fmt::underlying(v)));
   }
 }
 
 std::vector<std::string> valid_game_version_names() {
-  return {game_version_names[GameVersion::Jak1], game_version_names[GameVersion::Jak2]};
+  return {game_version_names[GameVersion::Jak1], game_version_names[GameVersion::Jak2],
+          game_version_names[GameVersion::Jak3]};
 }
 
 std::string build_revision() {

common/versions/versions.cpp

@@ -191,7 +191,7 @@ TP_Type SimpleExpression::get_type(const TypeState& input,
         return TP_Type::make_from_ts("float");
       }
       // new for jak 2:
-      if (env.version == GameVersion::Jak2 && in_type.is_integer_constant() &&
+      if (env.version >= GameVersion::Jak2 && in_type.is_integer_constant() &&
           (s64)((s32)in_type.get_integer_constant()) == (s64)in_type.get_integer_constant()) {
         return TP_Type::make_from_ts("float");
       }
@@ -406,7 +406,7 @@ TP_Type SimpleExpression::get_type_int2(const TypeState& input,
       }
 
       if (m_kind == Kind::RIGHT_SHIFT_ARITH) {
-        if (env.version == GameVersion::Jak2 && arg0_type.typespec().base_type() == "float") {
+        if (env.version >= GameVersion::Jak2 && arg0_type.typespec().base_type() == "float") {
           return TP_Type::make_from_ts(TypeSpec("float"));
         }
         return TP_Type::make_from_ts(TypeSpec("int"));

decompiler/IR2/AtomicOpTypeAnalysis.cpp

@@ -170,7 +170,7 @@ FormElement* handle_get_property_struct(const std::vector<Form*>& forms,
                                         const Env& env) {
   return handle_get_property_data_or_structure(
       forms, pool, env, ResLumpMacroElement::Kind::STRUCT,
-      env.version == GameVersion::Jak2 ? "(the-as structure #f)" : "#f", TypeSpec("structure"));
+      env.version >= GameVersion::Jak2 ? "(the-as structure #f)" : "#f", TypeSpec("structure"));
 }
 
 FormElement* handle_get_property_value(const std::vector<Form*>& forms,

decompiler/IR2/ExpressionHelpers.cpp

@@ -3255,7 +3255,7 @@ goos::Object DefpartgroupElement::to_form_internal(const Env& env) const {
 
     if (offset) {
       // jak2 has switched this field to a signed 16 bit number
-      if (env.version == GameVersion::Jak2) {
+      if (env.version >= GameVersion::Jak2) {
         result += fmt::format(" :offset {}", (s16)offset);
       } else {
         result += fmt::format(" :offset {}", offset);

decompiler/IR2/Form.cpp

@@ -122,7 +122,7 @@ Form* try_cast_simplify(Form* in,
     return in;
   }
 
-  if (env.version == GameVersion::Jak2) {
+  if (env.version >= GameVersion::Jak2) {
     if (new_type == TypeSpec("float")) {
       auto ic = get_goal_integer_constant(in, env);
       if (ic) {
@@ -138,7 +138,7 @@ Form* try_cast_simplify(Form* in,
   if (new_type == TypeSpec("meters")) {
     auto fc = get_goal_float_constant(in);
 
-    if (!fc && env.version == GameVersion::Jak2) {
+    if (!fc && env.version >= GameVersion::Jak2) {
       auto ic = get_goal_integer_constant(in, env);
       if (ic) {
         ASSERT((s64)*ic == (s64)(s32)*ic);
@@ -2853,7 +2853,7 @@ bool try_to_rewrite_vector_inline_ctor(const Env& env,
       token_matchers = {DerefTokenMatcher::string("quad")};
     }
 
-    if (env.version == GameVersion::Jak2) {
+    if (env.version >= GameVersion::Jak2) {
       token_matchers = {DerefTokenMatcher::string("quad")};
     }
 
@@ -3376,7 +3376,7 @@ void FunctionCallElement::update_from_stack(const Env& env,
                     argset = argset.substr(1);
                     auto argsym = arg_forms.at(1)->to_string(env);
                     // convert the float param
-                    if (env.version == GameVersion::Jak2) {
+                    if (env.version >= GameVersion::Jak2) {
                       static const std::unordered_set<std::string> use_degrees_settings = {
                           "matrix-blend-max-angle",
                           "fov",
@@ -4081,7 +4081,7 @@ void DerefElement::update_from_stack(const Env& env,
   }
 
   auto as_simple_expr = m_base->try_as_element<SimpleExpressionElement>();
-  if (env.version == GameVersion::Jak2 && as_simple_expr && as_simple_expr->expr().is_identity() &&
+  if (env.version >= GameVersion::Jak2 && as_simple_expr && as_simple_expr->expr().is_identity() &&
       as_simple_expr->expr().get_arg(0).is_sym_val() &&
       as_simple_expr->expr().get_arg(0).get_str() == "*game-info*" && m_tokens.size() >= 2 &&
       m_tokens.at(0).is_field_name("sub-task-list") && m_tokens.at(1).is_int()) {

decompiler/IR2/FormExpressionAnalysis.cpp

@@ -263,7 +263,7 @@ static void link_v2_or_v4(LinkedObjectFile& f,
   const uint8_t* code_end =
       &data.at(code_offset + code_size - 1) + 1;  // get the pointer to one past the end.
 
-  if (version == GameVersion::Jak2) {
+  if (version >= GameVersion::Jak2) {
     while (((code_end - code_start) % 4)) {
       code_end++;
     }
@@ -689,7 +689,7 @@ static void link_v3(LinkedObjectFile& f,
       segment_size++;
     }
 
-    if (game_version == GameVersion::Jak2) {
+    if (game_version >= GameVersion::Jak2) {
       while (segment_size % 4) {
         segment_size++;
       }

decompiler/ObjectFile/LinkedObjectFileCreation.cpp

@@ -647,8 +647,8 @@ void ObjectFileDB::ir2_type_analysis_pass(int seg, const Config& config, ObjectF
         }
 
         constexpr bool kForceNewTypes = false;
-        if (config.game_version == GameVersion::Jak2 || kForceNewTypes) {
-          // use new types for jak 2 always
+        if (config.game_version != GameVersion::Jak1 || kForceNewTypes) {
+          // use new types for jak 2/3 always
           types2::Input in;
           types2::Output out;
           in.func = &func;