Merge remote-tracking branch 'upstream/master'

CMakeLists.txt

@@ -50,10 +50,10 @@ endif()
 # set up versioning.
 set(DF_VERSION_MAJOR "0")
 set(DF_VERSION_MINOR "34")
-set(DF_VERSION_PATCH "05")
+set(DF_VERSION_PATCH "06")
 set(DF_VERSION "${DF_VERSION_MAJOR}.${DF_VERSION_MINOR}.${DF_VERSION_PATCH}")
 
-set(DFHACK_RELEASE "1f")
+set(DFHACK_RELEASE "1")
 
 set(DFHACK_VERSION "${DF_VERSION_MAJOR}.${DF_VERSION_MINOR}.${DF_VERSION_PATCH}-r${DFHACK_RELEASE}")
 add_definitions(-DDFHACK_VERSION="${DFHACK_VERSION}")

README.rst

@@ -110,9 +110,10 @@ tl;dr: You will end up with changing quite big areas in one go, especially if yo
 
 Options
 -------
-:all_biomes:        Change layer for all biomes on your map.
+:all_biomes:        Change selected layer for all biomes on your map.
                     Result may be undesirable since the same layer can AND WILL be on different z-levels for different biomes. Use the tool 'probe' to get an idea how layers and biomes are distributed on your map.
-:all-layers:        Change all layers on your map. Candy mountain, anyone? Will make your map quite boring, but tidy. 
+:all_layers:        Change all layers on your map (only for the selected biome unless 'all_biomes' is added). 
+                    Candy mountain, anyone? Will make your map quite boring, but tidy. 
 :force:             Allow changing stone to soil and vice versa. !!THIS CAN HAVE WEIRD EFFECTS, USE WITH CARE!!
                     Note that soil will not be magically replaced with stone. You will, however, get a stone floor after digging so it will allow the floor to be engraved.
                     Note that stone will not be magically replaced with soil. You will, however, get a soil floor after digging so it could be helpful for creating farm plots on maps with no soil.
@@ -121,23 +122,27 @@ Options
 
 Examples:
 ---------
-``changelayer GRANITE`` : Convert layer at cursor position into granite.
-``changelayer SILTY_CLAY force`` : Convert layer at cursor position into clay even if it's stone.
-``changelayer MARBLE all_biomes all_layers`` : Convert all layers of all biomes which are not soil into marble.
+``changelayer GRANITE``
+   Convert layer at cursor position into granite.
+``changelayer SILTY_CLAY force``
+   Convert layer at cursor position into clay even if it's stone.
+``changelayer MARBLE all_biomes all_layers``
+   Convert all layers of all biomes which are not soil into marble.
 
-.. note::
+.. Notes::
 
-    * If you use changelayer and nothing happens, try to pause/unpause the game for a while and try to move the cursor to another tile.
+    * If you use changelayer and nothing happens, try to pause/unpause the game for a while and try to move the cursor to another tile. Then try again. If that doesn't help try temporarily changing some other layer, undo your changes and try again for the layer you want to change. Saving and reloading your map might also help.
     * You should be fine if you only change single layers without the use of 'force'. Still it's advisable to save your game before messing with the map.
-    * When you force changelayer to convert soil to stone you might experience weird stuff (flashing tiles, tiles changed all over the map, ...). Try reverting the changes manually or even better use an older savegame. You did save your game, right?
+    * When you force changelayer to convert soil to stone you might experience weird stuff (flashing tiles, tiles changed all over place etc). Try reverting the changes manually or even better use an older savegame. You did save your game, right?
 
 changevein
 ==========
 Changes material of the vein under cursor to the specified inorganic RAW material.
 
 Example:
----------
-``changevein NATIVE_PLATINUM`` : Convert vein at cursor position into platinum ore.
+--------
+``changevein NATIVE_PLATINUM``
+   Convert vein at cursor position into platinum ore.
 
 cursecheck
 ==========
@@ -157,14 +162,10 @@ Options
 
 Examples:
 ---------
-Check one single map tile if one of the creatures on it is cursed (in-game cursor required):
-  * cursecheck
-Count all active cursed creatures who roam around on your map (no in-game cursor) without giving more details:
-  * cursecheck
-Give detailed info about all cursed creatures including deceased ones (no in-game cursor):
-  * cursecheck detail all
-Give a nickname all living/active cursed creatures on the map(no in-game cursor):
-  * cursecheck nick
+``cursecheck detail all``
+   Give detailed info about all cursed creatures including deceased ones (no in-game cursor).
+``cursecheck nick``
+  Give a nickname all living/active cursed creatures on the map(no in-game cursor).
 
 .. note::
 
@@ -434,7 +435,7 @@ When multiple commands are bound to the same key combination, DFHack selects the
 
 liquids
 =======
-Allows adding magma, water and obsidian to the game. It replaces the normal dfhack command line and can't be used from a hotkey. Settings will be remembered as long as dfhack runs. Intended for use in combination with the command liquidsgo-here (which can be bound to a hotkey).
+Allows adding magma, water and obsidian to the game. It replaces the normal dfhack command line and can't be used from a hotkey. Settings will be remembered as long as dfhack runs. Intended for use in combination with the command liquids-here (which can be bound to a hotkey).
 For more information, refer to the command's internal help. 
 
 .. note::
@@ -444,7 +445,7 @@ For more information, refer to the command's internal help.
 
 liquids-here
 ============
-Run the liquid spawner with the current/last settings made in liquidsgo (if no settings in liquidsgo were made it paints a point of 7/7 magma by default).
+Run the liquid spawner with the current/last settings made in liquids (if no settings in liquids were made it paints a point of 7/7 magma by default).
 Intended to be used as keybinding. Requires an active in-game cursor.
 	
 mode

library/Core.cpp

@@ -972,6 +972,7 @@ int Core::UnicodeAwareSym(const SDL::KeyboardEvent& ke)
 {
     // Assume keyboard layouts don't change the order of numbers:
     if( '0' <= ke.ksym.sym && ke.ksym.sym <= '9') return ke.ksym.sym;
+    if(SDL::K_F1 <= ke.ksym.sym && ke.ksym.sym <= SDL::K_F12) return ke.ksym.sym;
 
     int unicode = ke.ksym.unicode;
 

library/LuaTypes.cpp

@@ -65,8 +65,21 @@ void constructed_identity::lua_read(lua_State *state, int fname_idx, void *ptr)
     push_object_internal(state, this, ptr);
 }
 
+static void invoke_assign(lua_State *state, type_identity *id, void *ptr, int val_index)
+{
+    lua_getfield(state, LUA_REGISTRYINDEX, DFHACK_ASSIGN_NAME);
+    push_object_internal(state, id, ptr);
+    lua_pushvalue(state, val_index);
+    lua_call(state, 2, 0);
+}
+
 void constructed_identity::lua_write(lua_State *state, int fname_idx, void *ptr, int val_index)
 {
+    if (lua_istable(state, val_index))
+    {
+        invoke_assign(state, this, ptr, val_index);
+    }
+    else
         field_error(state, fname_idx, "complex object", "write");
 }
 
@@ -150,6 +163,58 @@ void df::pointer_identity::lua_read(lua_State *state, int fname_idx, void *ptr)
     lua_read(state, fname_idx, ptr, target);
 }
 
+static void autovivify_ptr(lua_State *state, int fname_idx, void **pptr,
+                          type_identity *target, int val_index)
+{
+    lua_getfield(state, val_index, "new");
+
+    // false or nil => bail out
+    if (!lua_toboolean(state, -1))
+        field_error(state, fname_idx, "null and autovivify not requested", "write");
+
+    // not 'true' => call df.new()
+    if (!lua_isboolean(state, -1))
+    {
+        int top = lua_gettop(state);
+
+        // Verify new points to a reasonable type of object
+        type_identity *suggested = get_object_identity(state, top, "autovivify", true, true);
+
+        if (!is_type_compatible(state, target, 0, suggested, top+1, false))
+            field_error(state, fname_idx, "incompatible suggested autovivify type", "write");
+
+        lua_pop(state, 1);
+
+        // Invoke df.new()
+        lua_getfield(state, LUA_REGISTRYINDEX, DFHACK_NEW_NAME);
+        lua_swap(state);
+        lua_call(state, 1, 1);
+
+        // Retrieve the pointer
+        void *nval = get_object_internal(state, target, top, false);
+
+        // shouldn't happen: this means suggested type is compatible,
+        // but its new() result isn't for some reason.
+        if (!nval)
+            field_error(state, fname_idx, "inconsistent autovivify type", "write");
+
+        *pptr = nval;
+    }
+    // otherwise use the target type
+    else
+    {
+        if (!target)
+            field_error(state, fname_idx, "trying to autovivify void*", "write");
+
+        *pptr = target->allocate();
+
+        if (!*pptr)
+            field_error(state, fname_idx, "could not allocate in autovivify", "write");
+    }
+
+    lua_pop(state, 1);
+}
+
 void df::pointer_identity::lua_write(lua_State *state, int fname_idx, void *ptr,
                                      type_identity *target, int val_index)
 {
@@ -157,6 +222,13 @@ void df::pointer_identity::lua_write(lua_State *state, int fname_idx, void *ptr,
 
     if (lua_isnil(state, val_index))
         *pptr = NULL;
+    else if (lua_istable(state, val_index))
+    {
+        if (!*pptr)
+            autovivify_ptr(state, fname_idx, pptr, target, val_index);
+
+        invoke_assign(state, target, *pptr, val_index);
+    }
     else
     {
         void *nval = get_object_internal(state, target, val_index, false);
@@ -435,10 +507,15 @@ static void write_field(lua_State *state, const struct_field_info *field, void *
 
         case struct_field_info::POINTER:
             df::pointer_identity::lua_write(state, 2, ptr, field->type, value_idx);
+            return;
 
         case struct_field_info::STATIC_ARRAY:
         case struct_field_info::STL_VECTOR_PTR:
-            field_error(state, 2, "complex object", "write");
+            lua_getfield(state, LUA_REGISTRYINDEX, DFHACK_ASSIGN_NAME);
+            read_field(state, field, ptr);
+            lua_pushvalue(state, value_idx);
+            lua_call(state, 2, 0);
+            return;
 
         case struct_field_info::END:
             return;

library/LuaWrapper.cpp

@@ -255,7 +255,7 @@ static void fetch_container_details(lua_State *state, int meta, type_identity **
 /**
  * Check if type1 and type2 are compatible, possibly using additional metatable data.
  */
-static bool is_type_compatible(lua_State *state, type_identity *type1, int meta1,
+bool LuaWrapper::is_type_compatible(lua_State *state, type_identity *type1, int meta1,
                                     type_identity *type2, int meta2, bool exact_equal)
 {
     if (type1 == type2)
@@ -417,9 +417,9 @@ static bool is_valid_metatable(lua_State *state, int objidx, int metaidx)
 /**
  * Given a DF object reference or type, safely retrieve its identity pointer.
  */
-static type_identity *get_object_identity(lua_State *state, int objidx,
-                                          const char *ctx, bool allow_type = false,
-                                          bool keep_metatable = false)
+type_identity *LuaWrapper::get_object_identity(lua_State *state, int objidx,
+                                               const char *ctx, bool allow_type,
+                                               bool keep_metatable)
 {
     if (!lua_getmetatable(state, objidx))
         luaL_error(state, "Invalid object in %s", ctx);
@@ -608,6 +608,43 @@ static int meta_new(lua_State *state)
     return 1;
 }
 
+static void invoke_resize(lua_State *state, int table, lua_Integer size)
+{
+    lua_getfield(state, table, "resize");
+    lua_pushvalue(state, table);
+    lua_pushinteger(state, size);
+    lua_call(state, 2, 0);
+}
+
+static void copy_table(lua_State *state, int dest, int src, int skipbase)
+{
+    // stack: (skipbase) skipkey skipkey |
+
+    int top = lua_gettop(state);
+
+    lua_pushnil(state);
+
+    while (lua_next(state, src))
+    {
+        for (int i = skipbase+1; i <= top; i++)
+        {
+            if (lua_rawequal(state, -2, i))
+            {
+                lua_pop(state, 1);
+                goto next_outer;
+            }
+        }
+
+        {
+            lua_pushvalue(state, -2);
+            lua_swap(state);
+            lua_settable(state, dest);
+        }
+
+    next_outer:;
+    }
+}
+
 /**
  * Method: assign data between objects.
  */
@@ -618,11 +655,105 @@ static int meta_assign(lua_State *state)
     if (argc != 2)
         luaL_error(state, "Usage: target:assign(src) or df.assign(target,src)");
 
+    if (!lua_istable(state, 2))
+    {
         type_identity *id1, *id2;
         check_type_compatible(state, 1, 2, &id1, &id2, "df.assign()", false, false);
 
         if (!id1->copy(get_object_ref(state, 1), get_object_ref(state, 2)))
             luaL_error(state, "No copy support for %s", id1->getFullName().c_str());
+    }
+    else
+    {
+        type_identity *id = get_object_identity(state, 1, "df.assign()", false);
+
+        int base = lua_gettop(state);
+
+        // x:assign{ assign = foo } => x:assign(foo)
+        bool has_assign = false;
+
+        lua_pushstring(state, "assign");
+        lua_dup(state);
+        lua_rawget(state, 2);
+
+        if (!lua_isnil(state,-1))
+        {
+            has_assign = true;
+            lua_getfield(state, LUA_REGISTRYINDEX, DFHACK_ASSIGN_NAME);
+            lua_pushvalue(state, 1);
+            lua_pushvalue(state, base+2);
+            lua_call(state, 2, 0);
+        }
+
+        lua_pop(state, 1);
+
+        // new is used by autovivification and should be skipped
+        lua_pushstring(state, "new");
+
+        if (id->isContainer())
+        {
+            // check resize field
+            lua_pushstring(state, "resize");
+            lua_dup(state);
+            lua_rawget(state, 2);
+
+            if (lua_isnil(state,-1) && !has_assign)
+            {
+                /*
+                 * no assign && nil or missing resize field => 1-based lua array
+                 */
+                int size = lua_objlen(state, 2);
+
+                lua_pop(state, 1);
+                invoke_resize(state, 1, size);
+
+                for (int i = 1; i <= size; i++)
+                {
+                    lua_pushinteger(state, i-1);
+                    lua_rawgeti(state, 2, i);
+                    lua_settable(state, 1);
+                }
+            }
+            else
+            {
+                if (lua_isboolean(state, -1) || lua_isnil(state, -1))
+                {
+                    // resize=false => just assign
+                    // resize=true => find the largest index
+                    if (lua_toboolean(state, -1))
+                    {
+                        lua_Integer size = 0;
+
+                        lua_pushnil(state);
+                        while (lua_next(state, 2))
+                        {
+                            lua_pop(state, 1);
+                            if (lua_isnumber(state,-1))
+                                size = std::max(size, lua_tointeger(state,-1)+1);
+                        }
+
+                        invoke_resize(state, 1, size);
+                    }
+                }
+                else
+                {
+                    // otherwise, must be an explicit number
+                    if (!lua_isnumber(state,-1))
+                        luaL_error(state, "Invalid container.resize value in df.assign()");
+
+                    invoke_resize(state, 1, lua_tointeger(state, -1));
+                }
+
+                lua_pop(state, 1);
+                copy_table(state, 1, 2, base);
+            }
+        }
+        else
+        {
+
+            copy_table(state, 1, 2, base);
+        }
+    }
 
     return 0;
 }

library/include/LuaWrapper.h

@@ -149,6 +149,13 @@ namespace DFHack { namespace LuaWrapper {
      */
     uint8_t *get_object_addr(lua_State *state, int obj, int field, const char *mode);
 
+    bool is_type_compatible(lua_State *state, type_identity *type1, int meta1,
+                            type_identity *type2, int meta2, bool exact_equal);
+
+    type_identity *get_object_identity(lua_State *state, int objidx,
+                                       const char *ctx, bool allow_type = false,
+                                       bool keep_metatable = false);
+
     void LookupInTable(lua_State *state, void *id, const char *tname);
     void SaveInTable(lua_State *state, void *node, const char *tname);
     void SaveTypeInfo(lua_State *state, void *node);

library/xml

@@ -1 +1 @@
-Subproject commit b41c666c6be6fe18906a98dababdc4ff681b8382
+Subproject commit 1b1fe798e553cf0ed309606f32b8448bb96b30c8

plugins/CMakeLists.txt

@@ -90,6 +90,7 @@ if (BUILD_SUPPORTED)
     DFHACK_PLUGIN(fixpositions fixpositions.cpp)
     DFHACK_PLUGIN(follow follow.cpp)
     DFHACK_PLUGIN(changevein changevein.cpp)
+    DFHACK_PLUGIN(changelayer changelayer.cpp)
     DFHACK_PLUGIN(advtools advtools.cpp)
     DFHACK_PLUGIN(tweak tweak.cpp)
     DFHACK_PLUGIN(feature feature.cpp)
@@ -104,10 +105,3 @@ OPTION(BUILD_SKELETON "Build the skeleton plugin." OFF)
 if(BUILD_SKELETON)
     add_subdirectory(skeleton)
 endif()
-
-# this is the changelayer plugin. 
-OPTION(BUILD_CHANGELAYER "Build the changelayer plugin." ON)
-if(BUILD_CHANGELAYER)
-    add_subdirectory(changelayer)
-endif()
-

plugins/Dfusion/src/lua_VersionInfo.cpp

@@ -96,7 +96,8 @@ const luaL_Reg lua_vinfo_func[]=
 	VI_FUNC(setAddress),
 	VI_FUNC(getAddress),
 	VI_FUNC(setOS),
-	VI_FUNC(getOS)
+	VI_FUNC(getOS),
+	{NULL,NULL}
 };
 #undef VI_FUNC
 void lua::RegisterVersionInfo(lua::state &st)

plugins/changelayer.cpp

@@ -71,7 +71,9 @@ const string changelayer_help =
 const string changelayer_trouble = 
     "Known problems with changelayer:\n\n"
     "  Nothing happens, the material stays the old.\n"
-    "    Try pausing/unpausing the game or moving the cursor a bit.\n\n"
+    "    Pause/unpause the game and/or move the cursor a bit. Then retry.\n"
+    "    Try changing another layer, undo the changes and try again.\n"
+    "    Try saving and loading the game.\n\n"
     "  Weird stuff happening after using the 'force' option.\n"
     "    Change former stone layers back to stone, soil back to soil.\n"
     "    If in doubt, use the 'probe' tool to find tiles with soil walls\n"
@@ -221,7 +223,7 @@ command_result changelayer (color_ostream &out, std::vector <std::string> & para
     // 2) call ReadGeology here, modify the data in the vectors without having to do all that map stuff
     // 3) write Maps::WriteGeology, pass the vectors, let it do it's work
     // Step 1) is optional, but it would make implementing 3) easier. 
-    // Otherwise that "check which geolayer is used by biome X" loop would need to be done again.
+    // Otherwise that "check which geo_index is used by biome X" loop would need to be done again.
 
     // no need to touch the same geology more than once
     // though it wouldn't matter much since there is not much data to be processed
@@ -291,7 +293,7 @@ command_result changelayer (color_ostream &out, std::vector <std::string> & para
         vector <df::world_geo_layer*> &geolayers = geo_biome->layers;
 
         // complain if layer is out of range
-        // geology has up to 16 layers currently, but size can be < 15 sometimes!
+        // geology has up to 16 layers currently, but can have less!
         if(layer >= geolayers.size() || layer < 0)
         {
             if(verbose)
@@ -378,8 +380,11 @@ bool conversionAllowed(color_ostream &out, MaterialInfo mat_new, MaterialInfo ma
     if(unsafe)
     {
         if(force)
+        {
+            if(!warned)
             {
                 out << "You've been warned, good luck." << endl;
+            }
             allowed = true;
         }
         else
@@ -389,10 +394,11 @@ bool conversionAllowed(color_ostream &out, MaterialInfo mat_new, MaterialInfo ma
                 out << "Use the option 'force' if you REALLY want to do that." << endl
                     << "Weird things can happen with your map, so save your game before trying!" << endl
                     << "Example: 'changelayer GRANITE force'" << endl;
-                warned = true;
             }
             allowed = false;
         }
+        // avoid multiple warnings for the same stuff
+        warned = true;
     }
     return allowed;
 }

plugins/changelayer/CMakeLists.txt

@@ -1,32 +0,0 @@
-PROJECT (changelayer)
-# A list of source files
-SET(PROJECT_SRCS
-    changelayer.cpp
-)
-# A list of headers
-SET(PROJECT_HDRS
-)
-SET_SOURCE_FILES_PROPERTIES( ${PROJECT_HDRS} PROPERTIES HEADER_FILE_ONLY TRUE)
-
-# mash them together (headers are marked as headers and nothing will try to compile them)
-LIST(APPEND PROJECT_SRCS ${PROJECT_HDRS})
-
-# option to use a thread for no particular reason
-OPTION(CHANGELAYER_THREAD "Use threads in the changelayer plugin." ON)
-#linux
-IF(UNIX)
-    add_definitions(-DLINUX_BUILD)
-    SET(PROJECT_LIBS
-        # add any extra linux libs here
-        ${PROJECT_LIBS}
-    )
-# windows
-ELSE(UNIX)
-    SET(PROJECT_LIBS
-        # add any extra linux libs here
-        ${PROJECT_LIBS}
-        $(NOINHERIT)
-    )
-ENDIF(UNIX)
-# this makes sure all the stuff is put in proper places and linked to dfhack
-DFHACK_PLUGIN(changelayer ${PROJECT_SRCS} LINK_LIBRARIES ${PROJECT_LIBS})