]> git.sesse.net Git - nageru/blobdiff - nageru/scene.cpp
Support disabling optional effects if a given other effect is _enabled_.
[nageru] / nageru / scene.cpp
index 2612de639961e8336d3eb4a6a8d8f8fb1f5f842a..04f15ed827437fb87b8340d17ee77aa9cc513119 100644 (file)
@@ -35,6 +35,16 @@ int find_index_of(const Block *block, EffectType val)
        return -1;
 }
 
+string get_declaration_point(lua_State *L)
+{
+       lua_Debug ar;
+       lua_getstack(L, 1, &ar);
+       lua_getinfo(L, "nSl", &ar);
+       char buf[256];
+       snprintf(buf, sizeof(buf), "%s:%d", ar.source, ar.currentline);
+       return buf;
+}
+
 Scene::Scene(Theme *theme, float aspect_nom, float aspect_denom)
        : theme(theme), aspect_nom(aspect_nom), aspect_denom(aspect_denom), resource_pool(theme->get_resource_pool()) {}
 
@@ -59,9 +69,9 @@ size_t Scene::compute_chain_number_for_block(size_t block_idx, const bitset<256>
 
        size_t currently_chosen_alternative;
        if (disabled.test(block_idx)) {
-               // It doesn't matter, so pick 0 as the canonical choice
+               // It doesn't matter, so pick the canonical choice
                // (this is the only one that is actually instantiated).
-               currently_chosen_alternative = 0;
+               currently_chosen_alternative = block->canonical_alternative;
        } else {
                currently_chosen_alternative = block->currently_chosen_alternative;
        }
@@ -80,8 +90,50 @@ bitset<256> Scene::find_disabled_blocks(size_t chain_idx) const
 {
        assert(blocks.size() < 256);
 
-       bitset<256> ret;
-       find_disabled_blocks(chain_idx, blocks.size() - 1, /*currently_disabled=*/false, &ret);
+       // The find_disabled_blocks() recursion logic needs only one pass by itself,
+       // but the disabler logic is not so smart, so we just run multiple times
+       // until it converges.
+       bitset<256> prev, ret;
+       do {
+               find_disabled_blocks(chain_idx, blocks.size() - 1, /*currently_disabled=*/false, &ret);
+               prev = ret;
+
+               // Propagate DISABLE_IF_OTHER_DISABLED constraints (we can always do this).
+               for (Block *block : blocks) {
+                       if (ret.test(block->idx)) continue;  // Already disabled.
+
+                       EffectType chosen_type = block->alternatives[block->chosen_alternative(chain_idx)]->effect_type;
+                       if (chosen_type == IDENTITY_EFFECT) {
+                               ret.set(block->idx);
+                               continue;
+                       }
+
+                       for (const Block::Disabler &disabler : block->disablers) {
+                               Block *other = blocks[disabler.block_idx];
+                               EffectType chosen_type = other->alternatives[other->chosen_alternative(chain_idx)]->effect_type;
+                               bool other_disabled = ret.test(disabler.block_idx) || chosen_type == IDENTITY_EFFECT;
+                               if (other_disabled && disabler.condition == Block::Disabler::DISABLE_IF_OTHER_DISABLED) {
+                                       ret.set(block->idx);
+                                       break;
+                               }
+                       }
+               }
+
+               // We cannot propagate DISABLE_IF_OTHER_ENABLED in all cases;
+               // the problem is that if A is disabled if B is enabled,
+               // then we cannot disable A unless we actually know for sure
+               // that B _is_ enabled. (E.g., imagine that B is disabled
+               // if C is enabled -- we couldn't disable A before we knew if
+               // C was enabled or not!)
+               //
+               // We could probably fix a fair amount of these, but the
+               // primary use case for DISABLE_IF_OTHER_ENABLED is really
+               // mutual exclusion; A must be disabled if B is enabled
+               // _and_ vice versa. These loops cannot be automatically
+               // resolved; it would depend on what A and B is. Thus,
+               // we simply declare this kind of constraint to be a promise
+               // from the user, not something that we'll solve for them.
+       } while (prev != ret);
        return ret;
 }
 
@@ -108,14 +160,23 @@ void Scene::find_disabled_blocks(size_t chain_idx, size_t block_idx, bool curren
 bool Scene::is_noncanonical_chain(size_t chain_idx) const
 {
        bitset<256> disabled = find_disabled_blocks(chain_idx);
-       if (disabled.none()) {
-               return false;
-       }
        assert(blocks.size() < 256);
        for (size_t block_idx = 0; block_idx < blocks.size(); ++block_idx) {
-               if (disabled.test(block_idx) && blocks[block_idx]->chosen_alternative(chain_idx) != 0) {
+               Block *block = blocks[block_idx];
+               if (disabled.test(block_idx) && block->chosen_alternative(chain_idx) != block->canonical_alternative) {
                        return true;
                }
+
+               // Test if we're supposed to be disabled by some other block being enabled;
+               // the disabled bit mask does not fully capture this.
+               if (!disabled.test(block_idx)) {
+                       for (const Block::Disabler &disabler : block->disablers) {
+                               if (disabler.condition == Block::Disabler::DISABLE_IF_OTHER_ENABLED &&
+                                   !disabled.test(disabler.block_idx)) {
+                                       return true;
+                               }
+                       }
+               }
        }
        return false;
 }
@@ -126,6 +187,7 @@ int Scene::add_input(lua_State* L)
        Scene *scene = (Scene *)luaL_checkudata(L, 1, "Scene");
 
        Block *block = new Block;
+       block->declaration_point = get_declaration_point(L);
        block->idx = scene->blocks.size();
        if (lua_gettop(L) == 1) {
                // No parameter given, so a flexible input.
@@ -202,6 +264,7 @@ int Scene::add_effect(lua_State* L)
        Scene *scene = (Scene *)luaL_checkudata(L, 1, "Scene");
 
        Block *block = new Block;
+       block->declaration_point = get_declaration_point(L);
        block->idx = scene->blocks.size();
 
        if (lua_istable(L, 2)) {
@@ -217,6 +280,15 @@ int Scene::add_effect(lua_State* L)
                block->alternatives.push_back(blueprint);
        }
 
+       int identity_index = find_index_of(block, IDENTITY_EFFECT);
+       if (identity_index == -1) {
+               block->canonical_alternative = 0;
+       } else {
+               // Pick the IdentityEffect as the canonical alternative, in case it
+               // helps us disable more stuff.
+               block->canonical_alternative = identity_index;
+       }
+
        find_inputs_for_block(L, scene, block);
        scene->blocks.push_back(block);
 
@@ -229,6 +301,7 @@ int Scene::add_optional_effect(lua_State* L)
        Scene *scene = (Scene *)luaL_checkudata(L, 1, "Scene");
 
        Block *block = new Block;
+       block->declaration_point = get_declaration_point(L);
        block->idx = scene->blocks.size();
 
        EffectBlueprint *blueprint = *(EffectBlueprint **)luaL_checkudata(L, 2, "EffectBlueprint");
@@ -237,6 +310,8 @@ int Scene::add_optional_effect(lua_State* L)
        // An IdentityEffect will be the alternative for when the effect is disabled.
        block->alternatives.push_back(new EffectBlueprint(IDENTITY_EFFECT));
 
+       block->canonical_alternative = 1;
+
        find_inputs_for_block(L, scene, block);
        scene->blocks.push_back(block);
 
@@ -376,6 +451,23 @@ Scene::get_chain(Theme *theme, lua_State *L, unsigned num, const InputState &inp
        // the Lua code later.
        bool is_main_chain = (num == 0);
        size_t chain_idx = compute_chain_number(is_main_chain);
+       if (is_noncanonical_chain(chain_idx)) {
+               // This should be due to promise_to_disable_if_enabled(). Find out what
+               // happened, to give the user some help.
+               bitset<256> disabled = find_disabled_blocks(chain_idx);
+               for (size_t block_idx = 0; block_idx < blocks.size(); ++block_idx) {
+                       Block *block = blocks[block_idx];
+                       if (disabled.test(block_idx)) continue;
+                       for (const Block::Disabler &disabler : block->disablers) {
+                               if (disabler.condition == Block::Disabler::DISABLE_IF_OTHER_ENABLED &&
+                                   !disabled.test(disabler.block_idx)) {
+                                       fprintf(stderr, "Promise declared at %s violated.\n", disabler.declaration_point.c_str());
+                                       abort();
+                               }
+                       }
+               }
+               assert(false);  // Something else happened, seemingly.
+       }
        const Scene::Instantiation &instantiation = chains[chain_idx];
        EffectChain *effect_chain = instantiation.chain.get();
 
@@ -419,8 +511,19 @@ Scene::get_chain(Theme *theme, lua_State *L, unsigned num, const InputState &inp
                Block *block = blocks[index_and_effect.first];
                Effect *effect = index_and_effect.second;
 
+               bool missing_width = (current_type(block) == RESIZE_EFFECT ||
+                       current_type(block) == RESAMPLE_EFFECT ||
+                       current_type(block) == PADDING_EFFECT);
+               bool missing_height = missing_width;
+
                // Get the effects currently set on the block.
                if (current_type(block) != IDENTITY_EFFECT) {  // Ignore settings on optional effects.
+                       if (block->int_parameters.count("width") && block->int_parameters["width"] > 0) {
+                               missing_width = false;
+                       }
+                       if (block->int_parameters.count("height") && block->int_parameters["height"] > 0) {
+                               missing_height = false;
+                       }
                        for (const auto &key_and_tuple : block->int_parameters) {
                                int_to_set.emplace(make_pair(effect, key_and_tuple.first), key_and_tuple.second);
                        }
@@ -439,6 +542,12 @@ Scene::get_chain(Theme *theme, lua_State *L, unsigned num, const InputState &inp
                // so they are set afterwards.
                if (!block->alternatives.empty()) {
                        EffectBlueprint *blueprint = block->alternatives[block->currently_chosen_alternative];
+                       if (blueprint->int_parameters.count("width") && blueprint->int_parameters["width"] > 0) {
+                               missing_width = false;
+                       }
+                       if (blueprint->int_parameters.count("height") && blueprint->int_parameters["height"] > 0) {
+                               missing_height = false;
+                       }
                        for (const auto &key_and_tuple : blueprint->int_parameters) {
                                int_to_set[make_pair(effect, key_and_tuple.first)] = key_and_tuple.second;
                        }
@@ -452,6 +561,14 @@ Scene::get_chain(Theme *theme, lua_State *L, unsigned num, const InputState &inp
                                vec4_to_set[make_pair(effect, key_and_tuple.first)] = key_and_tuple.second;
                        }
                }
+
+               if (missing_width || missing_height) {
+                       fprintf(stderr, "WARNING: Unset or nonpositive width/height for effect declared at %s "
+                               "when getting scene for signal %u; setting to 1x1 to avoid crash.\n",
+                               block->declaration_point.c_str(), num);
+                       int_to_set[make_pair(effect, "width")] = 1;
+                       int_to_set[make_pair(effect, "height")] = 1;
+               }
        }
 
        lua_pop(L, 1);
@@ -633,6 +750,49 @@ int Block_disable(lua_State *L)
        return 0;
 }
 
+int Block_always_disable_if_disabled(lua_State *L)
+{
+       assert(lua_gettop(L) == 2);
+       Block *block = *(Block **)luaL_checkudata(L, 1, "Block");
+       Block *disabler_block = *(Block **)luaL_checkudata(L, 2, "Block");
+
+       int my_alternative = find_index_of(block, IDENTITY_EFFECT);
+       int their_alternative = find_index_of(disabler_block, IDENTITY_EFFECT);
+       if (my_alternative == -1) {
+               luaL_error(L, "always_disable_if_disabled() called on something that didn't have an IdentityEffect fallback (try add_optional_effect())");
+       }
+       if (their_alternative == -1) {
+               luaL_error(L, "always_disable_if_disabled() with an argument that didn't have an IdentityEffect fallback (try add_optional_effect())");
+       }
+
+       // The declaration point isn't actually used, but it's nice for completeness.
+       block->disablers.push_back(Block::Disabler{ disabler_block->idx, Block::Disabler::DISABLE_IF_OTHER_DISABLED, get_declaration_point(L) });
+
+       lua_pop(L, 2);
+       return 0;
+}
+
+int Block_promise_to_disable_if_enabled(lua_State *L)
+{
+       assert(lua_gettop(L) == 2);
+       Block *block = *(Block **)luaL_checkudata(L, 1, "Block");
+       Block *disabler_block = *(Block **)luaL_checkudata(L, 2, "Block");
+
+       int my_alternative = find_index_of(block, IDENTITY_EFFECT);
+       int their_alternative = find_index_of(disabler_block, IDENTITY_EFFECT);
+       if (my_alternative == -1) {
+               luaL_error(L, "promise_to_disable_if_enabled() called on something that didn't have an IdentityEffect fallback (try add_optional_effect())");
+       }
+       if (their_alternative == -1) {
+               luaL_error(L, "promise_to_disable_if_enabled() with an argument that didn't have an IdentityEffect fallback (try add_optional_effect())");
+       }
+
+       block->disablers.push_back(Block::Disabler{ disabler_block->idx, Block::Disabler::DISABLE_IF_OTHER_ENABLED, get_declaration_point(L) });
+
+       lua_pop(L, 2);
+       return 0;
+}
+
 int Block_set_int(lua_State *L)
 {
        assert(lua_gettop(L) == 3);