tab_controller

freecad.datamanager_wb.domain.tab_controller

Generic tab controller shared by VarSets and Aliases.

Implements filtering, only-unused logic, enable-state rules, and remove-unused orchestration against a TabDataSource.

TabController(data_source)

Tab-generic controller logic shared across domains.

This controller encapsulates behavior that is the same for both the VarSets and Aliases tabs:

• Normalizing filter inputs (glob vs substring).
• Filtering parents (VarSets / Spreadsheets).
• Filtering children (Variables / Aliases), optionally restricting to "only unused" by consulting expression reference counts.
• Enable/disable rules for the "remove unused" action.
• Orchestrating remove-unused and producing a post-mutation UI update.

The controller is intentionally UI-agnostic; it delegates all domain access to a TabDataSource.

Source code in freecad/datamanager_wb/domain/tab_controller.py

def __init__(self, data_source: TabDataSource) -> None:
    self._data_source = data_source

can_remove_unused(*, only_unused, selected_items)

Return whether the given selection is eligible for remove-unused.

This is a convenience wrapper that normalizes the selection and then applies should_enable_remove_unused.

Source code in freecad/datamanager_wb/domain/tab_controller.py

def can_remove_unused(
    self,
    *,
    only_unused: bool,
    selected_items: list[ParentChildRef] | list[str],
) -> bool:
    """Return whether the given selection is eligible for remove-unused.

    This is a convenience wrapper that normalizes the selection and then
    applies `should_enable_remove_unused`.
    """
    normalized = self._normalize_items(selected_items)
    return self.should_enable_remove_unused(
        only_unused=only_unused, selected_count=len(normalized)
    )

get_expression_items(selected_child_items)

Return expression items for the selection.

Delegates to the underlying data source.

Source code in freecad/datamanager_wb/domain/tab_controller.py

def get_expression_items(
    self, selected_child_items: list[ParentChildRef] | list[str]
) -> tuple[list[ExpressionItem], dict[str, int]]:
    """Return expression items for the selection.

    Delegates to the underlying data source.
    """
    return self._data_source.get_expression_items(selected_child_items)

get_expression_reference_counts(selected_child_items)

Return expression reference counts for the selection.

Source code in freecad/datamanager_wb/domain/tab_controller.py

def get_expression_reference_counts(
    self, selected_child_items: list[ParentChildRef] | list[str]
) -> dict[str, int]:
    """Return expression reference counts for the selection."""
    return self._data_source.get_expression_reference_counts(selected_child_items)

get_filtered_child_items(*, selected_parents, child_filter_text, only_unused)

Return child refs filtered by name and optionally by "unused".

Parameters:

Name	Type	Description	Default
selected_parents	list[str]	Parent names currently selected in the UI.	required
child_filter_text	str	Filter text for child names.	required
only_unused	bool	When true, only children with zero expression references are returned.	required

Source code in freecad/datamanager_wb/domain/tab_controller.py

def get_filtered_child_items(
    self,
    *,
    selected_parents: list[str],
    child_filter_text: str,
    only_unused: bool,
) -> list[ParentChildRef]:
    """Return child refs filtered by name and optionally by "unused".

    Args:
        selected_parents: Parent names currently selected in the UI.
        child_filter_text: Filter text for child names.
        only_unused: When true, only children with zero expression
            references are returned.
    """
    pattern = self._normalize_glob_pattern(child_filter_text)
    refs = self._data_source.get_child_refs(selected_parents)

    counts = self._get_reference_counts(refs, only_unused=only_unused)
    return [
        ref
        for ref in refs
        if self._should_keep_ref(ref, pattern=pattern, only_unused=only_unused, counts=counts)
    ]

get_filtered_parents(*, filter_text, exclude_copy_on_change=False)

Return parent names filtered by the given text.

The filter supports glob patterns. If the user provides no glob characters, the filter is treated as a substring match.

Parameters:

Name	Type	Description	Default
filter_text	str	User-entered filter text.	required
exclude_copy_on_change	bool	Whether copy-on-change derived parents should be hidden.	False

Source code in freecad/datamanager_wb/domain/tab_controller.py

def get_filtered_parents(
    self,
    *,
    filter_text: str,
    exclude_copy_on_change: bool = False,
) -> list[str]:
    """Return parent names filtered by the given text.

    The filter supports glob patterns. If the user provides no glob
    characters, the filter is treated as a substring match.

    Args:
        filter_text: User-entered filter text.
        exclude_copy_on_change: Whether copy-on-change derived parents
            should be hidden.
    """
    pattern = self._normalize_glob_pattern(filter_text)
    parents = self._data_source.get_sorted_parents(
        exclude_copy_on_change=exclude_copy_on_change
    )
    if pattern is None:
        return parents
    return [p for p in parents if fnmatch.fnmatchcase(p, pattern)]

get_post_remove_unused_update(*, selected_parents, child_filter_text, only_unused)

Compute the post-mutation UI state after removing unused children.

Source code in freecad/datamanager_wb/domain/tab_controller.py

def get_post_remove_unused_update(
    self,
    *,
    selected_parents: list[str],
    child_filter_text: str,
    only_unused: bool,
) -> PostRemoveUpdate:
    """Compute the post-mutation UI state after removing unused children."""
    return PostRemoveUpdate(
        child_items=self.get_filtered_child_items(
            selected_parents=selected_parents,
            child_filter_text=child_filter_text,
            only_unused=only_unused,
        ),
        clear_expressions=True,
    )

remove_unused_and_get_update(*, selected_child_items, selected_parents, child_filter_text, only_unused)

Remove unused selected children and compute updated filtered lists.

Source code in freecad/datamanager_wb/domain/tab_controller.py

def remove_unused_and_get_update(
    self,
    *,
    selected_child_items: list[ParentChildRef] | list[str],
    selected_parents: list[str],
    child_filter_text: str,
    only_unused: bool,
) -> RemoveUnusedAndUpdateResult:
    """Remove unused selected children and compute updated filtered lists."""
    remove_result = self._data_source.remove_unused_children(selected_child_items)
    update = self.get_post_remove_unused_update(
        selected_parents=selected_parents,
        child_filter_text=child_filter_text,
        only_unused=only_unused,
    )
    return RemoveUnusedAndUpdateResult(remove_result=remove_result, update=update)

remove_unused_children(selected_child_items)

Remove unused children from the underlying data source.

Source code in freecad/datamanager_wb/domain/tab_controller.py

def remove_unused_children(
    self, selected_child_items: list[ParentChildRef] | list[str]
) -> RemoveUnusedResult:
    """Remove unused children from the underlying data source."""
    return self._data_source.remove_unused_children(selected_child_items)

should_enable_remove_unused(*, only_unused, selected_count)

Return whether the remove-unused button should be enabled.

Parameters:

Name	Type	Description	Default
only_unused	bool	Whether the tab is currently configured to show only unused children.	required
selected_count	int	Number of selected children.	required

Source code in freecad/datamanager_wb/domain/tab_controller.py

def should_enable_remove_unused(self, *, only_unused: bool, selected_count: int) -> bool:
    """Return whether the remove-unused button should be enabled.

    Args:
        only_unused: Whether the tab is currently configured to show only
            unused children.
        selected_count: Number of selected children.
    """
    return only_unused and selected_count > 0