beautified code

Author: Birkow

eggwatch.lua

@@ -6,7 +6,7 @@ local utils = require("utils")
 
 local GLOBAL_KEY = "eggwatch"
 local default_table = {10, false, false}
-local stringtoboolean={ ["true"]=true, ["false"]=false, ["1"] = true , ["0"] =  false , ["Y"] = true , ["N"] =  false}
+local stringtoboolean = {["true"] = true, ["false"] = false, ["1"] = true, ["0"] = false, ["Y"] = true, ["N"] = false}
 
 function dump(o)
     if type(o) == "table" then
@@ -41,7 +41,7 @@ function isEnabled()
 end
 
 local function print_local(text)
-    print(GLOBAL_KEY ..": " .. text)
+    print(GLOBAL_KEY .. ": " .. text)
 end
 
 local function handle_error(text)
@@ -53,33 +53,33 @@ local function print_details(details)
         print_local(details)
     end
 end
-local function format_target_count_row (header, row)
-return header..": " .. "target count: " .. row[1] .. "; count children: " .. tostring(row[2]) .. "; count adults: " .. tostring(row[3])
+local function format_target_count_row(header, row)
+    return header ..
+        ": " ..
+            "target count: " ..
+                row[1] .. "; count children: " .. tostring(row[2]) .. "; count adults: " .. tostring(row[3])
 end
 local function print_status()
     print_local(("eggwatch is currently %s."):format(state.enabled and "enabled" or "disabled"))
-    print_local (("egg stack splitting is %s"):format(state.split_stacks and "enabled" or "disabled"))
+    print_local(("egg stack splitting is %s"):format(state.split_stacks and "enabled" or "disabled"))
     print_local(format_target_count_row("Default", state.default))
     if state.target_eggs_count_per_race ~= nil then
-         for k, v in pairs(state.target_eggs_count_per_race) do
-         print_local(format_target_count_row(df.global.world.raws.creatures.all[k].creature_id, v))
-         end
+        for k, v in pairs(state.target_eggs_count_per_race) do
+            print_local(format_target_count_row(df.global.world.raws.creatures.all[k].creature_id, v))
+        end
     end
-        print_details("eggwatch is in verbose mode")
-        print_details(dump(state))
-
+    print_details("eggwatch is in verbose mode")
+    print_details(dump(state))
 end
 
-
-
 local function persist_state()
     print_details(("start load_state"))
     local state_to_persist = {}
     state_to_persist = utils.clone(state)
     state_to_persist.target_eggs_count_per_race = {}
     if state.target_eggs_count_per_race ~= nil then
         for k, v in pairs(state.target_eggs_count_per_race) do
-            state_to_persist.target_eggs_count_per_race[tostring(k)]= v
+            state_to_persist.target_eggs_count_per_race[tostring(k)] = v
         end
     end
     dfhack.persistent.saveSiteData(GLOBAL_KEY, state_to_persist)
@@ -91,13 +91,13 @@ local function load_state()
     print_details(("start load_state"))
     -- load persistent data
     local persisted_data = dfhack.persistent.getSiteData(GLOBAL_KEY, {})
-    local processed_persisted_data= {}
-    if  persisted_data ~= nil then
+    local processed_persisted_data = {}
+    if persisted_data ~= nil then
         processed_persisted_data = utils.clone(persisted_data)
         processed_persisted_data.target_eggs_count_per_race = {}
         if persisted_data.target_eggs_count_per_race ~= nil then
             for k, v in pairs(persisted_data.target_eggs_count_per_race) do
-                processed_persisted_data.target_eggs_count_per_race[tonumber(k)]= v
+                processed_persisted_data.target_eggs_count_per_race[tonumber(k)] = v
             end
         end
     end
@@ -165,9 +165,9 @@ local function copy_egg_fields(source_egg, target_egg)
     target_egg.hatchling_flags4 = utils.clone(source_egg.hatchling_flags4, true)
     print_details("flags done")
     target_egg.hatchling_training_level = utils.clone(source_egg.hatchling_training_level, true)
-    utils.assign(target_egg.hatchling_animal_population,source_egg.hatchling_animal_population)
+    utils.assign(target_egg.hatchling_animal_population, source_egg.hatchling_animal_population)
     print_details("hatchling_animal_population done")
-    target_egg.hatchling_mother_id= source_egg.hatchling_mother_id
+    target_egg.hatchling_mother_id = source_egg.hatchling_mother_id
     print_details("hatchling_mother_id done")
     target_egg.mother_hf = source_egg.mother_hf
     target_egg.father_hf = source_egg.mother_hf
@@ -181,25 +181,32 @@ local function copy_egg_fields(source_egg, target_egg)
     target_egg.hatchling_civ_id = source_egg.hatchling_civ_id
     print_details("hatchling_civ_id done")
     print_details("end copy_egg_fields")
- end
+end
 
- local function resize_egg_stack(egg_stack, new_stack_size)
+local function resize_egg_stack(egg_stack, new_stack_size)
     print_details("start resize_egg_stack")
-    egg_stack.stack_size=new_stack_size
+    egg_stack.stack_size = new_stack_size
     --TODO check if weight or size need adjustment
     print_details("end resize_egg_stack")
- end
+end
 
-local function create_new_egg_stack (original_eggs, remaining_eggs)
+local function create_new_egg_stack(original_eggs, remaining_eggs)
     print_details("start create_new_egg_stack")
 
     print_details("about to split create new egg stack")
     print_details(("type= %s"):format(original_eggs:getType()))
-    print_details(("creature= %s"):format( original_eggs.race))
+    print_details(("creature= %s"):format(original_eggs.race))
     print_details(("caste= %s "):format(original_eggs.caste))
-    print_details (remaining_eggs)
-
-    local created_items = dfhack.items.createItem(df.unit.find(original_eggs.hatchling_mother_id), original_eggs:getType(), -1 , original_eggs.race, original_eggs.caste)
+    print_details(remaining_eggs)
+
+    local created_items =
+        dfhack.items.createItem(
+        df.unit.find(original_eggs.hatchling_mother_id),
+        original_eggs:getType(),
+        -1,
+        original_eggs.race,
+        original_eggs.caste
+    )
     print_details("created new egg stack")
     local created_egg_stack = created_items[0] or created_items[1]
     print_details(df.creature_raw.find(created_egg_stack.race).creature_id)
@@ -218,14 +225,14 @@ local function create_new_egg_stack (original_eggs, remaining_eggs)
     print_details("end create_new_egg_stack")
 end
 
-local function split_egg_stack (source_egg_stack, to_be_left_in_source_stack)
+local function split_egg_stack(source_egg_stack, to_be_left_in_source_stack)
     print_details("start split_egg_stack")
     local egg_count_in_new_stack_size = source_egg_stack.stack_size - to_be_left_in_source_stack
     if egg_count_in_new_stack_size > 0 then
-    create_new_egg_stack (source_egg_stack, egg_count_in_new_stack_size)
-    resize_egg_stack(source_egg_stack, to_be_left_in_source_stack)
+        create_new_egg_stack(source_egg_stack, egg_count_in_new_stack_size)
+        resize_egg_stack(source_egg_stack, to_be_left_in_source_stack)
     else
-    print_details("nothing to do, wrong egg_count_in_new_stack_size")
+        print_details("nothing to do, wrong egg_count_in_new_stack_size")
     end
     print_details("end split_egg_stack")
 end
@@ -280,31 +287,32 @@ local function get_config_for_race(race)
 end
 
 local function is_valid_animal(unit)
-    return unit and
-        dfhack.units.isActive(unit) and
-        dfhack.units.isAnimal(unit) and
-        dfhack.units.isFortControlled(unit) and
+    return unit and dfhack.units.isActive(unit) and dfhack.units.isAnimal(unit) and dfhack.units.isFortControlled(unit) and
         dfhack.units.isTame(unit) and
         not dfhack.units.isDead(unit)
 end
 
 local function count_live_animals(race, count_children, count_adults)
     print_details(("start count_live_animals"))
-    if count_adults then print_details(("we are counting adults for %s"):format(race)) end
-    if count_children then print_details(("we are counting children and babies for %s"):format(race)) end
+    if count_adults then
+        print_details(("we are counting adults for %s"):format(race))
+    end
+    if count_children then
+        print_details(("we are counting children and babies for %s"):format(race))
+    end
 
     local count = 0
     if not count_adults and not count_children then
         print_details(("end 1 count_live_animals"))
         return count
     end
 
-    for _,unit in ipairs(df.global.world.units.active) do
-        if race ==  unit.race
-        and is_valid_animal(unit)
-        and ( (count_adults and dfhack.units.isAdult(unit))
-            or (count_children and ( dfhack.units.isChild(unit) or dfhack.units.isBaby(unit)))
-            ) then
+    for _, unit in ipairs(df.global.world.units.active) do
+        if
+            race == unit.race and is_valid_animal(unit) and
+                ((count_adults and dfhack.units.isAdult(unit)) or
+                    (count_children and (dfhack.units.isChild(unit) or dfhack.units.isBaby(unit))))
+         then
             count = count + 1
         end
     end
@@ -336,10 +344,21 @@ local function handle_eggs(eggs)
     total_count = total_count + count_forbidden_eggs_for_race_in_claimed_nestobxes(race)
 
     if total_count - current_eggs < max_eggs then
-        print_details(("Total count for %s only existing eggs is %s, about to count life animals if enabled"):format(race, total_count - current_eggs))
+        print_details(
+            ("Total count for %s only existing eggs is %s, about to count life animals if enabled"):format(
+                race,
+                total_count - current_eggs
+            )
+        )
         total_count = total_count + count_live_animals(race, count_children, count_adults)
     else
-        print_details(("Total count for %s eggs only is %s greater than maximum %s, no need to count life animals"):format(race, total_count, max_eggs))
+        print_details(
+            ("Total count for %s eggs only is %s greater than maximum %s, no need to count life animals"):format(
+                race,
+                total_count,
+                max_eggs
+            )
+        )
         print_details(("end 1 handle_eggs"))
         return
     end
@@ -348,8 +367,8 @@ local function handle_eggs(eggs)
 
     if total_count - current_eggs < max_eggs then
         if state.split_stacks and total_count > max_eggs then
-        local egg_count_to_leave_in_source_stack = max_eggs - total_count + current_eggs
-        split_egg_stack (eggs, egg_count_to_leave_in_source_stack)
+            local egg_count_to_leave_in_source_stack = max_eggs - total_count + current_eggs
+            split_egg_stack(eggs, egg_count_to_leave_in_source_stack)
         end
 
         eggs.flags.forbid = true
@@ -378,7 +397,7 @@ function check_item_created(item_id)
     --print_details(("start check_item_created"))
     local item = df.item.find(item_id)
     if not item or not is_egg(item) then
-    --print_details(("end 1 check_item_created"))
+        --print_details(("end 1 check_item_created"))
         return
     end
     --print_local(("item_id for original eggs: %s"):format (item_id))
@@ -412,17 +431,24 @@ local function set_target(target_race, target_count, count_children, count_adult
     end
     local race = validate_creature_id(target_race_upper)
     if target_race_upper == "DEFAULT" then
-        state.default = {tonumber(target_count), stringtoboolean[count_children] or false, stringtoboolean[count_adult] or false}
+        state.default = {
+            tonumber(target_count),
+            stringtoboolean[count_children] or false,
+            stringtoboolean[count_adult] or false
+        }
     elseif race >= 0 then
-    print(race)
-        state.target_eggs_count_per_race[race] = {tonumber(target_count), stringtoboolean[count_children] or false, stringtoboolean[count_adult] or false}
+        print(race)
+        state.target_eggs_count_per_race[race] = {
+            tonumber(target_count),
+            stringtoboolean[count_children] or false,
+            stringtoboolean[count_adult] or false
+        }
     else
         handle_error("must specify DEFAULT or valid creature_id")
     end
     print_details(("end set_target"))
 end
 
-
 if df.global.gamemode ~= df.game_mode.DWARF or not dfhack.isMapLoaded() then
     dfhack.printerr("eggwatch needs a loaded fortress to work")
     return
@@ -438,17 +464,21 @@ local positionals =
     argparse.processArgsGetopt(
     args,
     {
-        {"h", "help", handler = function()
+        {
+            "h",
+            "help",
+            handler = function()
                 opts.help = true
-            end}
+            end
+        }
     }
 )
 
 if dfhack_flags.enable then
     if dfhack_flags.enable_state then
         do_enable()
         print_status()
-        else
+    else
         do_disable()
         print_status()
     end
@@ -459,7 +489,7 @@ local command = positionals[1]
 if command == "help" or opts.help then
     print(dfhack.script_help())
 elseif command == "target" then
-    set_target(positionals[2], positionals[3], positionals[4],  positionals[5])
+    set_target(positionals[2], positionals[3], positionals[4], positionals[5])
     print_status()
 elseif command == "verbose" then
     state.verbose = not state.verbose
@@ -468,11 +498,11 @@ elseif command == "clear" then
     state = get_default_state()
     update_event_listener()
 elseif command == "split_stacks" then
-    state.split_stacks  = stringtoboolean[positionals[2]]
+    state.split_stacks = stringtoboolean[positionals[2]]
     print_status()
 elseif not command or command == "status" then
     print_status()
 elseif (command ~= "enable" or command ~= "disable") and not dfhack_flags.enable then
-    handle_error(("Command "%s" is not recognized"):format(command))
+    handle_error(("Command " % s " is not recognized"):format(command))
 end
 persist_state()