#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2002-2006  Donald N. Allingham
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, see <https://www.gnu.org/licenses/>.
#

# -------------------------------------------------------------------------
#
# Standard Python modules
#
# -------------------------------------------------------------------------
from ....const import GRAMPS_LOCALE as glocale

_ = glocale.translation.gettext

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from ..person import RegExpName

# -------------------------------------------------------------------------
#
# Typing modules
#
# -------------------------------------------------------------------------
from ....lib import Family
from ....db import Database


# -------------------------------------------------------------------------
#
# RegExpChildName
#
# -------------------------------------------------------------------------
class RegExpChildName(RegExpName):
    """Rule that checks for full or partial name matches"""

    name = _("Families with child matching the <regex_name>")
    description = _(
        "Matches families where some child has a name "
        "that matches a specified regular expression"
    )
    category = _("Child filters")

    def apply_to_one(self, db: Database, family: Family) -> bool:  # type: ignore[override]
        for child_ref in family.child_ref_list:
            child = db.get_person_from_handle(child_ref.ref)
            if super().apply_to_one(db, child):
                return True
        return False
