Merge branch 'develop' of https://github.com/thelink2012/modloader into develop

Author: thelink2012

doc/config/modloader.ini.0

@@ -3,15 +3,17 @@
 ;
 [Folder.Config]
 Profile = Default                 ; Profile to be used to configure mods
+PriorityLimit = 100               ; Max allowed value in Profiles.*.Priority (minimum is 1)
 
 [Profiles.Default.Config]
 IgnoreAllMods  = false            ; Ignores all mods. This essentially disables mods loading.
 ExcludeAllMods = false            ; Excludes all mods from being loaded except the ones at IncludeMods list
 
 [Profiles.Default.Priority]
 ; Defines mods priority (which mods should go into effect if both replaces the same file)
-; The priority should be between 1 and 100, where 100 overrides 1, additionally priority 0 makes be ignored (just like IgnoreMods)
-; The default priority is 50!
+; The priority should be between 1 and PriorityLimit, where higher values override lower ones.
+; Additionally priority 0 makes the mod be ignored (just like IgnoreMods).
+; The default priority is 50.
 ;MyMod=50
 
 [Profiles.Default.IgnoreFiles]

src/core/config.cpp

@@ -242,7 +242,8 @@ void Loader::UpdateOldConfig_0115_021()
             for(auto& kv : newer["Priority"])
             {
                 auto pr = std::stoi(kv.second);
-                kv.second = std::to_string(pr > 0 && pr <= 100? 101 - pr : pr);
+                auto limit = this->mods.GetPriorityLimit();
+                kv.second = std::to_string(pr > 0 && pr <= limit? (limit + 1) - pr : pr);
             }
 
             newer.write_file(gamePath + "modloader/" +  folderConfigFilename);

src/core/extras/gta3/menu.cpp

@@ -610,7 +610,7 @@ void TheMenu::ModPageEvents()
     // Helper function to setup a integer priority entry in the menu
     auto SetupPriorityEntry = [this](const char* label, uint32_t& priority, std::function<void(MenuEntry&)> cb) -> std::function<bool(ActionInfo&)>
     {
-        static const uint32_t min = 0, max = 100, step = 1;
+        const uint32_t min = 0, max = loader.mods.GetPriorityLimit(), step = 1;
 
         auto PriorityLabel = [](const uint32_t& priority)
         {
@@ -624,10 +624,14 @@ void TheMenu::ModPageEvents()
             entry->SetHelper(HelpLabel(label));
             entry->OnStateChange(cb);
 
-            auto fInitStates = entry->SetupStatefulEntry(std::ref(priority), std::ref(PriorityLabel), [](const uint32_t& value, ActionInfo& info)
-            {
-                return std::min(std::max((value + step * info.wheel), min), max);
-            });
+            auto fInitStates = entry->SetupStatefulEntry(
+                std::ref(priority),
+                std::ref(PriorityLabel),
+                [min, max, step](const uint32_t& value, ActionInfo& info)
+                {
+                    return std::min(std::max((value + step * info.wheel), min), max);
+                }
+            );
 
             return fInitStates;
         }

src/core/folder.cpp

@@ -14,8 +14,8 @@ using namespace modloader;
 void Loader::FolderInformation::Clear()
 {
     mods.clear();
-    profiles.clear();
-    current_profile = nullptr;
+    RemoveProfiles();
+    priority_limit = default_priority_limit;
 }
 
 /*
@@ -127,8 +127,9 @@ void Loader::FolderInformation::RemoveReferencesToProfile(Loader::Profile& rm)
  */
 void Loader::FolderInformation::RemoveProfiles()
 {
-    for(auto it = this->profiles.begin(); it != this->profiles.end(); )
-        it = this->profiles.erase(it);  // Profile destructor automatically cleans this->current_profile
+    for(auto& prof : this->profiles)
+        RemoveReferencesToProfile(prof);
+    this->profiles.clear();
 }
 
 /*
@@ -374,7 +375,13 @@ void Loader::FolderInformation::LoadConfigFromINI()
 
     // First take the profiles from modloader.ini
     if(ini.load_file(loader.folderConfigFilename))
+    {
+        const auto default_limit = std::to_string(default_priority_limit);
+        const auto priority_limit = std::strtol(ini.get("Folder.Config", "PriorityLimit", default_limit).c_str(), 0, 0);
+        this->SetPriorityLimit(priority_limit);
+
         ReadProfilesFromINI(ini, "");
+    }
     else
         Log("Warning: Failed to load folder config file");
 
@@ -411,6 +418,7 @@ void Loader::FolderInformation::SaveConfigForINI()
 
     // Save current profile
     ini.set("Folder.Config", "Profile", this->Profile().GetName());
+    ini.set("Folder.Config", "PriorityLimit", std::to_string(this->GetPriorityLimit()));
 
     // Save all the profiles
     for(auto& profile : this->profiles)

src/core/loader.cpp

@@ -35,15 +35,70 @@ BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
     return TRUE;
 }
 
+void Loader::InitFromEntryPoint()
+{
+    typedef function_hooker<0x53ECBD, void(int)> ridle_hook;
+    typedef function_hooker<0x53ECCB, void(int)> rfidle_hook;   // Actually void() but... meh
+
+    // This may be called more than once due to the cinit/WinMain trick at Patch().
+    static bool has_patches = false;
+    if(has_patches) return;
+    has_patches = true;
+
+    auto& gvm = injector::address_manager::singleton();
+
+#ifndef NDEBUG
+    if(!gvm.IsSA())
+    {
+        static int& gGameState = *mem_ptr(0xC8D4C0).get<int>();
+
+        gGameState = 5; // skip intro
+        if(gvm.IsIII())
+            MakeNOP(raw_ptr(0x5811F8), 10);
+        else if(gvm.IsVC())
+            MakeNOP(raw_ptr(0x601B3B), 10);
+
+        if(gvm.IsIII())
+            MakeJMP(raw_ptr(0x405DB0), &Loader::Log);
+        else if(gvm.IsVC())
+            MakeJMP(raw_ptr(0x401000), &Loader::Log);
+
+        // Debugger does not attach properly in III/VC DxWnd, so we need to do it manually.
+        LaunchDebugger();
+    }
+#endif
+
+    // Install exception filter to log crashes
+    InstallExceptionCatcher([](const char* buffer)
+    {
+        Log("\n\n");
+        LogGameVersion();
+        Log(buffer);
+        loader.Shutdown();
+    });
+
+    // To be called each frame
+    auto CallTick = [this](ridle_hook::func_type Idle, int& i)
+    {
+        this->Tick();
+        return Idle(i);
+    };
+
+    // Do tick hook only if possible
+    if(try_address(ridle_hook::addr))  make_static_hook<ridle_hook>(CallTick);
+    if(try_address(rfidle_hook::addr)) make_static_hook<rfidle_hook>(CallTick);
+
+    this->Startup();
+}
+
 /*
  *  Loader::Patch
  *      Patches the game code to run the loader
  */
 bool Loader::Patch()
 {
     typedef function_hooker_stdcall<0x8246EC, int(HINSTANCE, HINSTANCE, LPSTR, int)> winmain_hook;
-    typedef function_hooker<0x53ECBD, void(int)> ridle_hook;
-    typedef function_hooker<0x53ECCB, void(int)> rfidle_hook;   // Actually void() but... meh
+    typedef function_hooker<0x8246AC, int()> cinit_hook;
 
     auto& gvm = injector::address_manager::singleton();
     gvm.set_name("Mod Loader");
@@ -54,74 +109,39 @@ bool Loader::Patch()
         if(injector::ReadMemory<int>(0xC920E8)) // RwInitialized -- should enter only when using the mss32 loader on III/VC
         {
             const char* buf = "You installed Mod Loader wrongly!\n\n"
-                              "You need Ultimate ASI Loader, and modloader.asi must be in the 'scripts/' directory.\n\n"
-                              "Please refer to the 'Readme.txt' or 'Leia-me.txt' for more information.";
+                "You need Ultimate ASI Loader, and modloader.asi must be in the 'scripts/' directory.\n\n"
+                "Please refer to the 'Readme.txt' or 'Leia-me.txt' for more information.";
             this->Error(buf);
             return false;
         }
 
         // Hook WinMain to run mod loader
         injector::make_static_hook<winmain_hook>([this](winmain_hook::func_type WinMain,
-                                                    HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
+            HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
         {
-            // Avoind circular looping forever
+            // Avoid circular looping forever
             static bool bRan = false;
             if(bRan) return WinMain(hInstance, hPrevInstance, lpCmdLine, nCmdShow);
             bRan = true;
 
-#ifndef NDEBUG
-            auto& gvm = injector::address_manager::singleton();
-            if(!gvm.IsSA())
-            {
-                static int& gGameState = *mem_ptr(0xC8D4C0).get<int>();
-
-                gGameState = 5; // skip intro
-                if(gvm.IsIII())
-                    MakeNOP(raw_ptr(0x5811F8), 10);
-                else if(gvm.IsVC())
-                    MakeNOP(raw_ptr(0x601B3B), 10);
-
-                if(gvm.IsIII())
-                    MakeJMP(raw_ptr(0x405DB0), &Loader::Log);
-                else if(gvm.IsVC())
-                    MakeJMP(raw_ptr(0x401000), &Loader::Log);
-
-                // Debugger does not attach properly in III/VC DxWnd, so we need to do it manually.
-                LaunchDebugger();
-            }
-#endif
-
-            // Install exception filter to log crashes
-            InstallExceptionCatcher([](const char* buffer)
-            {
-                Log("\n\n");
-                LogGameVersion();
-                Log(buffer);
-                loader.Shutdown();
-            });
-
-            // To be called each frame
-            auto CallTick = [this](ridle_hook::func_type Idle, int& i)
-            {
-                this->Tick();
-                return Idle(i);
-            };
-
-            // Do tick hook only if possible
-            if(try_address(ridle_hook::addr))  make_static_hook<ridle_hook>(CallTick);
-            if(try_address(rfidle_hook::addr)) make_static_hook<rfidle_hook>(CallTick);
-
-            // Startup the loader and call WinMain, Shutdown the loader after WinMain.
-            // If any mod hooked WinMain at Startup, no conflict will happen, we're takin' care of that
-            {
-            this->Startup();
-            auto WinMain = (winmain_hook::func_type_raw) ReadRelativeOffset(winmain_hook::addr + 1).get();
-            auto result = WinMain(hInstance, hPrevInstance, lpCmdLine, nCmdShow);
+            this->InitFromEntryPoint();
+            auto WinMainNext = (winmain_hook::func_type_raw)ReadRelativeOffset(winmain_hook::addr + 1).get();
+            auto result = WinMainNext(hInstance, hPrevInstance, lpCmdLine, nCmdShow);
             this->Shutdown();
             return result;
-            }
         });
 
+        // If possible, startup before WinMain.
+        // This is important for certain mods (e.g. FLA) that need to change offsets of
+        // functions that run pre-WinMain (e.g. global constructors).
+        if(try_address(cinit_hook::addr))
+        {
+            injector::make_static_hook<cinit_hook>([this](cinit_hook::func_type cinit) {
+                this->InitFromEntryPoint();
+                return cinit();
+            });
+        }
+
         return true;
     }
     else

src/core/loader.hpp

@@ -34,6 +34,8 @@ static const char* downurl = "https://github.com/thelink2012/modloader/releases"
 //
 static const char* default_profile_name = "Default";
 
+static const int default_priority_limit = 100;
+
 // Functor for sorting based on priority
 template<class T>
 struct SimplePriorityPred
@@ -272,7 +274,6 @@ class Loader : public modloader_t
                 {}
 
                 Profile(const Profile&) = default;
-                ~Profile();
 
                 //
                 FolderInformation& Parent() const  { return this->parent; }
@@ -413,6 +414,9 @@ class Loader : public modloader_t
 
                 // Gets the path to this modfolder (relative to gamedir, normalized)
                 const std::string& GetPath() { return path; }
+
+                int GetPriorityLimit() const { return this->priority_limit; }
+                void SetPriorityLimit(int value) { this->priority_limit = std::max(value, 1); }
 
                 // Clears all buffers from this structure
                 void Clear();
@@ -454,6 +458,7 @@ class Loader : public modloader_t
                 Loader::Profile*            current_profile;// Curretly selected profile from the 'profiles' list
                 std::unique_ptr<Loader::Profile> anon_profile;// Forced temporary profile (made by command line, conditionals, etc)
                                                                     // The .first boolean specifies whether we have a temporary profile
+                int priority_limit = default_priority_limit; // Max allowed priority for mods in this folder config
 
             protected:
                 void SetUnchanged() { if(status != Status::Removed) status = Status::Unchanged; }
@@ -553,6 +558,7 @@ class Loader : public modloader_t
         bool Patch();
 
         // Start or Shutdown the loader
+        void InitFromEntryPoint();
         void Startup();
         void Shutdown();
 

src/core/profiles.cpp

@@ -33,14 +33,6 @@ static bool MatchWildcards(const std::string& string, const Container& patterns)
 
 
 
-/*
- *  Profile::~Profile
- */
-Loader::Profile::~Profile()
-{
-    parent.RemoveReferencesToProfile(*this);
-}
-
 /*
  *  Profile::Clear
  *      Clears this object
@@ -256,7 +248,7 @@ void Loader::Profile::SetPriority(std::string name, int priority)
     if(priority == default_priority)
         mods_priority.erase(name);
     else
-        mods_priority[name] = std::max(std::min(priority, 100), 0); // clamp to 0-100
+        mods_priority[name] = std::max(std::min(priority, this->parent.GetPriorityLimit()), 0); // clamp to 0-priorityLimit
 }
 
 /*

src/plugins/gta3/std.asi/CsInfo.cpp

@@ -16,18 +16,14 @@ using namespace modloader;
  *  This stores information about cleo scripts 
  */
 ThePlugin::CsInfo::CsInfo(const modloader::file* file) : file(file)
-{
-    // Do basic initial setup
-    this->bIsMission = false;                   
-    this->iVersion = CLEO_VER_NONE;
-    
-    std::string path = file->filepath();
+{    
+    const std::string path = file->filepath();
 
     // Get path used to search files when a script tries to open a file (fopen etc)
     if(IsFileInsideFolder(file->filedir(), true, "CLEO"))  // If inside a CLEO folder, use the path before it
-        this->folder = path.substr(0, GetLastPathComponent(path, 2));
+        this->translationPath = plugin_ptr->loader->gamepath + path.substr(0, GetLastPathComponent(path, 2));
     else                                        // Use this path
-        this->folder = path.substr(0, GetLastPathComponent(path, 1));
+        this->translationPath = plugin_ptr->loader->gamepath + path.substr(0, GetLastPathComponent(path, 1));
 
     // Get script attributes
     if(file->is_ext("cm"))