# -*- makefile -*-
# -----------------------------------------------------------------------
# Copyright 2017-2024 Open Networking Foundation Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# -----------------------------------------------------------------------
# SPDX-FileCopyrightText: 2017-2024 Open Networking Foundation Contributors
# SPDX-License-Identifier: Apache-2.0
# -----------------------------------------------------------------------
## Intent: Library makefile helper functions
# -----------------------------------------------------------------------
# Usage:
#
# mytarget:
#     $(call banner-enter,target $@)
#     @echo "Hello World"
#     $(call banner,(Between worlds))
#     @echo "Goodbye World"
#     $(call banner-leave,target $@)
# -----------------------------------------------------------------------

$(if $(DEBUG),$(warning ENTER))

target-banner = ** ---------------------------------------------------------------------------

## -----------------------------------------------------------------------
## Intent: Return a command line able to display a banner hilighting
##         make target processing within a logfile.
## -----------------------------------------------------------------------
banner-enter=\
    @echo -e \
    "\n"\
    "$(target-banner)\n"\
    "** $(MAKE) ENTER: $(1)\n"\
    "$(target-banner)"\

banner-leave=\
    @echo -e "** $(MAKE) LEAVE: $(1)"

banner=\
    @echo -e "** $(MAKE): $(1)"

$(if $(DEBUG),$(warning LEAVE))

# [EOF]