Slic3r::GUI::ShortcutRegistry Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Shortcuts.hpp>

Collaboration diagram for Slic3r::GUI::ShortcutRegistry:

Classes
struct	Match

Public Member Functions
	ShortcutRegistry ()
KeyChord	binding (Shortcut shortcut) const
bool	is_customized (Shortcut shortcut) const
std::string	display (Shortcut shortcut) const
std::string	with_key (const std::string &text, Shortcut shortcut) const
std::string	accelerator (Shortcut shortcut) const
std::optional< Shortcut >	lookup (ShortcutContext context, const KeyChord &chord) const
std::optional< Match >	match (ShortcutContext context, const KeyChord &chord) const
std::vector< Shortcut >	conflicts (Shortcut shortcut, const KeyChord &chord) const
std::optional< Shortcut >	step_owner (Shortcut shortcut, const KeyChord &chord) const
void	bind (Shortcut shortcut, const KeyChord &chord)
void	reset (Shortcut shortcut)
void	reset_all ()
void	load (const AppConfig &config)
void	save (AppConfig &config) const

Private Member Functions
void	rebuild_index ()

Private Attributes
std::array< std::optional< KeyChord >, size_t(Shortcut::Count)>	m_overrides
std::unordered_map< KeyChord, std::vector< Shortcut >, KeyChordHash >	m_index

Detailed Description

---

Class Documentation

Slic3r::GUI::ShortcutRegistry::Match

struct Slic3r::GUI::ShortcutRegistry::Match

Class Members
Shortcut	shortcut
int	step_modifiers

Constructor & Destructor Documentation

ShortcutRegistry()

Slic3r::GUI::ShortcutRegistry::ShortcutRegistry

(

)

{ rebuild_index(); }

References rebuild_index().

Here is the call graph for this function:

Member Function Documentation

accelerator()

std::string Slic3r::GUI::ShortcutRegistry::accelerator

(

Shortcut

shortcut

)

const

{
    const KeyChord chord = binding(shortcut);
    return chord.is_menu_accelerator() ? chord.to_string() : std::string();
}

References binding(), Slic3r::GUI::KeyChord::is_menu_accelerator(), and Slic3r::GUI::KeyChord::to_string().

Referenced by Slic3r::GUI::MainFrame::shortcut_label().

Here is the call graph for this function:

Here is the caller graph for this function:

bind()

void Slic3r::GUI::ShortcutRegistry::bind	(	Shortcut	shortcut,
		const KeyChord &	chord )

{
    const ShortcutInfo& info = shortcut_info(shortcut);
    if (chord == info.default_chord)
        m_overrides[size_t(shortcut)].reset();
    else
        m_overrides[size_t(shortcut)] = chord;
    rebuild_index();
}

References Slic3r::GUI::ShortcutInfo::default_chord, m_overrides, rebuild_index(), and Slic3r::GUI::shortcut_info().

Here is the call graph for this function:

binding()

KeyChord Slic3r::GUI::ShortcutRegistry::binding

(

Shortcut

shortcut

)

const

{
    const std::optional<KeyChord>& override = m_overrides[size_t(shortcut)];
    return override.has_value() ? *override : shortcut_info(shortcut).default_chord;
}

References Slic3r::GUI::ShortcutInfo::default_chord, m_overrides, and Slic3r::GUI::shortcut_info().

Referenced by accelerator(), Slic3r::GUI::KBShortcutsDialog::apply_bindings(), conflicts(), display(), match(), rebuild_index(), and step_owner().

Here is the call graph for this function:

Here is the caller graph for this function:

conflicts()

std::vector< Shortcut > Slic3r::GUI::ShortcutRegistry::conflicts	(	Shortcut	shortcut,
		const KeyChord &	chord ) const

{
    std::vector<Shortcut> out;
    if (!chord.valid())
        return out;
    const uint8_t contexts = shortcut_info(shortcut).contexts;
    for (const ShortcutInfo& other : shortcut_table)
        if (other.id != shortcut && share_context(contexts, other.contexts) && binding(other.id) == chord)
            out.push_back(other.id);
    return out;
}

References binding(), Slic3r::GUI::ShortcutInfo::contexts, Slic3r::GUI::shortcut_info(), and Slic3r::GUI::KeyChord::valid().

Here is the call graph for this function:

display()

std::string Slic3r::GUI::ShortcutRegistry::display

(

Shortcut

shortcut

)

const

{ return binding(shortcut).display(); }

References binding(), and Slic3r::GUI::KeyChord::display().

Referenced by Slic3r::GUI::MainFrame::shortcut_label(), and with_key().

Here is the call graph for this function:

Here is the caller graph for this function:

is_customized()

bool Slic3r::GUI::ShortcutRegistry::is_customized

(

Shortcut

shortcut

)

const

{ return m_overrides[size_t(shortcut)].has_value(); }

References m_overrides.

Referenced by Slic3r::GUI::KBShortcutsDialog::apply_bindings().

Here is the caller graph for this function:

load()

void Slic3r::GUI::ShortcutRegistry::load

(

const AppConfig &

config

)

{
    m_overrides.fill(std::nullopt);
    if (config.has_section(CONFIG_SECTION)) {
        const std::map<std::string, std::string>& section = config.get_section(CONFIG_SECTION);
        for (const ShortcutInfo& info : shortcut_table) {
            auto it = section.find(info.key);
            if (it == section.end())
                continue;
            if (it->second == UNBOUND)
                m_overrides[size_t(info.id)] = KeyChord{};
            else if (std::optional<KeyChord> chord = KeyChord::parse(it->second); chord.has_value())
                // A Global chord is seen before any text field, so it needs a modifier or a non-typing key.
                if ((info.contexts & GLOBAL) == 0 || chord->is_menu_accelerator())
                    m_overrides[size_t(info.id)] = *chord;
        }
    }
    rebuild_index();
}

References Slic3r::AppConfig::get_section(), Slic3r::AppConfig::has_section(), m_overrides, Slic3r::GUI::KeyChord::parse(), and rebuild_index().

Here is the call graph for this function:

lookup()

std::optional< Shortcut > Slic3r::GUI::ShortcutRegistry::lookup	(	ShortcutContext	context,
		const KeyChord &	chord ) const

{
    if (!chord.valid())
        return std::nullopt;
    auto it = m_index.find(chord);
    if (it == m_index.end())
        return std::nullopt;
    for (Shortcut shortcut : it->second)
        if (shortcut_info(shortcut).contexts & context_bit(context))
            return shortcut;
    return std::nullopt;
}

References Slic3r::GUI::context_bit(), m_index, Slic3r::GUI::shortcut_info(), and Slic3r::GUI::KeyChord::valid().

Referenced by match().

Here is the call graph for this function:

Here is the caller graph for this function:

match()

std::optional< ShortcutRegistry::Match > Slic3r::GUI::ShortcutRegistry::match	(	ShortcutContext	context,
		const KeyChord &	chord ) const

{
    if (const std::optional<Shortcut> exact = lookup(context, chord); exact.has_value())
        return Match{ *exact, 0 };
    if ((chord.modifiers & STEP_MODIFIERS) == 0)
        return std::nullopt;
    for (const ShortcutInfo& info : shortcut_table)
        if (info.modifier_variants && (info.contexts & context_bit(context)))
            if (const int step = step_modifiers(chord, binding(info.id)); step != 0)
                return Match{ info.id, step };
    return std::nullopt;
}

References binding(), Slic3r::GUI::context_bit(), lookup(), and Slic3r::GUI::KeyChord::modifiers.

Here is the call graph for this function:

rebuild_index()

void Slic3r::GUI::ShortcutRegistry::rebuild_index ( )

private

{
    m_index.clear();
    for (const ShortcutInfo& info : shortcut_table)
        if (const KeyChord chord = binding(info.id); chord.valid())
            m_index[chord].push_back(info.id);
}

References binding(), m_index, and Slic3r::GUI::KeyChord::valid().

Referenced by ShortcutRegistry(), bind(), load(), reset(), and reset_all().

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

void Slic3r::GUI::ShortcutRegistry::reset

(

Shortcut

shortcut

)

{
    m_overrides[size_t(shortcut)].reset();
    rebuild_index();
}

References m_overrides, and rebuild_index().

Here is the call graph for this function:

reset_all()

void Slic3r::GUI::ShortcutRegistry::reset_all

(

)

{
    m_overrides.fill(std::nullopt);
    rebuild_index();
}

References m_overrides, and rebuild_index().

Here is the call graph for this function:

save()

void Slic3r::GUI::ShortcutRegistry::save

(

AppConfig &

config

)

const

{
    for (const ShortcutInfo& info : shortcut_table) {
        const std::optional<KeyChord>& override = m_overrides[size_t(info.id)];
        if (override.has_value())
            config.set(CONFIG_SECTION, info.key, override->valid() ? override->to_string() : UNBOUND);
        else
            config.erase(CONFIG_SECTION, info.key);
    }
}

References Slic3r::AppConfig::erase(), m_overrides, and Slic3r::AppConfig::set().

Here is the call graph for this function:

step_owner()

std::optional< Shortcut > Slic3r::GUI::ShortcutRegistry::step_owner	(	Shortcut	shortcut,
		const KeyChord &	chord ) const

{
    const uint8_t contexts = shortcut_info(shortcut).contexts;
    for (const ShortcutInfo& other : shortcut_table)
        if (other.modifier_variants && other.id != shortcut && share_context(contexts, other.contexts))
            if (const int step = step_modifiers(chord, binding(other.id)); step == wxMOD_SHIFT || step == wxMOD_CONTROL)   // the combined step stays assignable
                return other.id;
    return std::nullopt;
}

References binding(), Slic3r::GUI::ShortcutInfo::contexts, and Slic3r::GUI::shortcut_info().

Here is the call graph for this function:

with_key()

std::string Slic3r::GUI::ShortcutRegistry::with_key	(	const std::string &	text,
		Shortcut	shortcut ) const

{
    const std::string key = display(shortcut);
    return key.empty() ? text : text + " [" + key + "]";
}

References display().

Referenced by Slic3r::GUI::GLCanvas3D::update_shortcut_tooltips().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_index

std::unordered_map<KeyChord, std::vector<Shortcut>, KeyChordHash> Slic3r::GUI::ShortcutRegistry::m_index

private

Referenced by lookup(), and rebuild_index().

m_overrides

std::array<std::optional<KeyChord>, size_t(Shortcut::Count)> Slic3r::GUI::ShortcutRegistry::m_overrides

private

Referenced by bind(), binding(), is_customized(), load(), reset(), reset_all(), and save().

---

The documentation for this class was generated from the following files:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Shortcuts.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Shortcuts.cpp