implement saving and retrieving item quality filters

plugins/buildingplan/buildingplan.cpp

@@ -629,12 +629,22 @@ static bool hasFilter(color_ostream &out, df::building_type type, int16_t subtyp
     BuildingTypeKey key(type, subtype, custom);
     auto &filters = get_item_filters(out, key);
     for (auto &filter : filters.getItemFilters()) {
-        if (filter.isEmpty())
+        if (!filter.isEmpty())
             return true;
     }
     return false;
 }
 
+static void clearFilter(color_ostream &out, df::building_type type, int16_t subtype, int32_t custom, int index) {
+    TRACE(status,out).print("entering clearFilter\n");
+    BuildingTypeKey key(type, subtype, custom);
+    auto &filters = get_item_filters(out, key);
+    if (filters.getItemFilters().size() <= index)
+        return;
+    filters.setItemFilter(out, ItemFilter(), index);
+    call_buildingplan_lua(&out, "signal_reset");
+}
+
 static void setMaterialFilter(color_ostream &out, df::building_type type, int16_t subtype, int32_t custom, int index, string filter) {
     DEBUG(status,out).print("entering setMaterialFilter\n");
     call_buildingplan_lua(&out, "signal_reset");
@@ -682,6 +692,45 @@ static int getHeatSafetyFilter(lua_State *L) {
     return 1;
 }
 
+static void setQualityFilter(color_ostream &out, df::building_type type, int16_t subtype, int32_t custom, int index,
+        int decorated, int min_quality, int max_quality) {
+    DEBUG(status,out).print("entering setQualityFilter\n");
+    BuildingTypeKey key(type, subtype, custom);
+    auto &filters = get_item_filters(out, key).getItemFilters();
+    if (filters.size() <= index)
+        return;
+    ItemFilter filter = filters[index];
+    filter.setDecoratedOnly(decorated != 0);
+    filter.setMinQuality(min_quality);
+    filter.setMaxQuality(max_quality);
+    get_item_filters(out, key).setItemFilter(out, filter, index);
+    call_buildingplan_lua(&out, "signal_reset");
+}
+
+static int getQualityFilter(lua_State *L) {
+    color_ostream *out = Lua::GetOutput(L);
+    if (!out)
+        out = &Core::getInstance().getConsole();
+    df::building_type type = (df::building_type)luaL_checkint(L, 1);
+    int16_t subtype = luaL_checkint(L, 2);
+    int32_t custom = luaL_checkint(L, 3);
+    int index = luaL_checkint(L, 4);
+    DEBUG(status,*out).print(
+            "entering getQualityFilter building_type=%d subtype=%d custom=%d index=%d\n",
+            type, subtype, custom, index);
+    BuildingTypeKey key(type, subtype, custom);
+    auto &filters = get_item_filters(*out, key).getItemFilters();
+    if (filters.size() <= index)
+        return 0;
+    auto &filter = filters[index];
+    map<string, int> ret;
+    ret.emplace("decorated", filter.getDecoratedOnly());
+    ret.emplace("min_quality", filter.getMinQuality());
+    ret.emplace("max_quality", filter.getMaxQuality());
+    Lua::Push(L, ret);
+    return 1;
+}
+
 static bool validate_pb(color_ostream &out, df::building *bld, int index) {
     if (!isPlannedBuilding(out, bld) || bld->jobs.size() != 1)
         return false;
@@ -778,8 +827,10 @@ DFHACK_PLUGIN_LUA_FUNCTIONS {
     DFHACK_LUA_FUNCTION(doCycle),
     DFHACK_LUA_FUNCTION(scheduleCycle),    DFHACK_LUA_FUNCTION(countAvailableItems),
     DFHACK_LUA_FUNCTION(hasFilter),
+    DFHACK_LUA_FUNCTION(clearFilter),
     DFHACK_LUA_FUNCTION(setMaterialFilter),
     DFHACK_LUA_FUNCTION(setHeatSafetyFilter),
+    DFHACK_LUA_FUNCTION(setQualityFilter),
     DFHACK_LUA_FUNCTION(getDescString),
     DFHACK_LUA_FUNCTION(getQueuePosition),
     DFHACK_LUA_FUNCTION(makeTopPriority),
@@ -791,5 +842,6 @@ DFHACK_PLUGIN_LUA_COMMANDS {
     DFHACK_LUA_COMMAND(getAvailableItems),
     DFHACK_LUA_COMMAND(getMaterialFilter),
     DFHACK_LUA_COMMAND(getHeatSafetyFilter),
+    DFHACK_LUA_COMMAND(getQualityFilter),
     DFHACK_LUA_END
 };

plugins/lua/buildingplan.lua

@@ -310,7 +310,7 @@ end
 
 function ItemSelection:get_choices(sort_fn)
     local item_ids = getAvailableItems(uibs.building_type,
-            uibs.building_subtype, uibs.custom_type, self.index - 1)
+            uibs.building_subtype, uibs.custom_type, self.index-1)
     local buckets = {}
     for _,item_id in ipairs(item_ids) do
         local item = df.item.find(item_id)
@@ -641,6 +641,9 @@ end
 
 function QualityAndMaterialsPage:init()
     self.lowest_other_item_heat_safety = 2
+    self.dirty = true
+
+    local enable_item_quality =  can_be_improved(self.index)
 
     self:addviews{
         widgets.Panel{
@@ -665,6 +668,7 @@ function QualityAndMaterialsPage:init()
                         {label='Fire Magma', value=2, pen=COLOR_RED},
                         {label='Fire', value=1, pen=COLOR_LIGHTRED},
                     },
+                    on_change=self:callback('set_heat_safety'),
                 },
                 widgets.Label{
                     frame={t=2, l=30},
@@ -745,11 +749,16 @@ function QualityAndMaterialsPage:init()
             frame_title='Item quality',
             subviews={
                 widgets.CycleHotkeyLabel{
+                    view_id='decorated',
                     frame={l=0, t=1, w=23},
                     key='CUSTOM_SHIFT_D',
                     label='Decorated only:',
-                    options={'No', 'Yes'},
+                    options={
-                    enabled=function() return can_be_improved(self.index) end,
+                        {label='No', value=false},
+                        {label='Yes', value=true},
+                    },
+                    enabled=enable_item_quality,
+                    on_change=self:callback('set_decorated'),
                 },
                 widgets.CycleHotkeyLabel{
                     view_id='min_quality',
@@ -767,6 +776,7 @@ function QualityAndMaterialsPage:init()
                         {label='Masterful', value=5},
                         {label='Artifact', value=6},
                     },
+                    enabled=enable_item_quality,
                     on_change=function(val) self:set_min_quality(val+1) end,
                 },
                 widgets.CycleHotkeyLabel{
@@ -785,6 +795,7 @@ function QualityAndMaterialsPage:init()
                         {label='Masterful', value=5},
                         {label='Artifact', value=6},
                     },
+                    enabled=enable_item_quality,
                     on_change=function(val) self:set_max_quality(val+1) end,
                 },
                 Slider{
@@ -798,6 +809,7 @@ function QualityAndMaterialsPage:init()
                     end,
                     on_left_change=self:callback('set_min_quality'),
                     on_right_change=self:callback('set_max_quality'),
+                    active=enable_item_quality,
                 },
             },
         },
@@ -841,20 +853,64 @@ function QualityAndMaterialsPage:init()
     }
 end
 
+function QualityAndMaterialsPage:refresh()
+    local summary = ''
+    local subviews = self.subviews
+
+    local heat = getHeatSafetyFilter(uibs.building_type, uibs.building_subtype, uibs.custom_type)
+    subviews.safety:setOption(heat)
+    if heat >= 2 then summary = summary .. 'Magma safe '
+    elseif heat == 1 then summary = summary .. 'Fire safe '
+    end
+
+    local quality = getQualityFilter(uibs.building_type, uibs.building_subtype, uibs.custom_type, self.index-1)
+    subviews.decorated:setOption(quality.decorated ~= 0)
+    subviews.min_quality:setOption(quality.min_quality)
+    subviews.max_quality:setOption(quality.max_quality)
+
+    self.summary = summary
+    self.dirty = false
+end
+
+function QualityAndMaterialsPage:get_summary()
+    -- TODO: summarize materials
+    return self.summary
+end
+
+function QualityAndMaterialsPage:set_heat_safety(heat)
+    setHeatSafetyFilter(uibs.building_type, uibs.building_subtype, uibs.custom_type, heat)
+    self.dirty = true
+end
+
+function QualityAndMaterialsPage:set_decorated(decorated)
+    local subviews = self.subviews
+    setQualityFilter(uibs.building_type, uibs.building_subtype, uibs.custom_type, self.index-1,
+            decorated and 1 or 0, subviews.min_quality:getOptionValue(), subviews.max_quality:getOptionValue())
+    self.dirty = true
+end
+
 function QualityAndMaterialsPage:set_min_quality(idx)
     idx = math.min(6, math.max(0, idx-1))
-    self.subviews.min_quality:setOption(idx)
+    local subviews = self.subviews
-    if self.subviews.max_quality:getOptionValue() < idx then
+    subviews.min_quality:setOption(idx)
-        self.subviews.max_quality:setOption(idx)
+    if subviews.max_quality:getOptionValue() < idx then
+        subviews.max_quality:setOption(idx)
     end
+    setQualityFilter(uibs.building_type, uibs.building_subtype, uibs.custom_type, self.index-1,
+            subviews.decorated:getOptionValue() and 1 or 0, idx, subviews.max_quality:getOptionValue())
+    self.dirty = true
 end
 
 function QualityAndMaterialsPage:set_max_quality(idx)
     idx = math.min(6, math.max(0, idx-1))
-    self.subviews.max_quality:setOption(idx)
+    local subviews = self.subviews
-    if self.subviews.min_quality:getOptionValue() > idx then
+    subviews.max_quality:setOption(idx)
-        self.subviews.min_quality:setOption(idx)
+    if subviews.min_quality:getOptionValue() > idx then
+        subviews.min_quality:setOption(idx)
     end
+    setQualityFilter(uibs.building_type, uibs.building_subtype, uibs.custom_type, self.index-1,
+            subviews.decorated:getOptionValue() and 1 or 0, subviews.min_quality:getOptionValue(), idx)
+    self.dirty = true
 end
 
 local texpos = dfhack.textures.getThinBordersTexposStart()
@@ -881,8 +937,11 @@ function QualityAndMaterialsPage:draw_divider(dc)
     end
 end
 
-function QualityAndMaterialsPage:get_summary()
+function QualityAndMaterialsPage:onRenderFrame(dc, rect)
-    return 'filter summary'
+    QualityAndMaterialsPage.super.onRenderFrame(self, dc, rect)
+    if self.dirty then
+        self:refresh()
+    end
 end
 
 --------------------------------
@@ -1444,7 +1503,7 @@ function PlannerOverlay:set_filter(idx)
 end
 
 function PlannerOverlay:clear_filter(idx)
-    setMaterialFilter(uibs.building_type, uibs.building_subtype, uibs.custom_type, idx - 1, "")
+    clearFilter(uibs.building_type, uibs.building_subtype, uibs.custom_type, idx-1)
 end
 
 local function get_placement_data()