From owner-svn-src-all@FreeBSD.ORG  Tue Feb 10 03:15:54 2015
Return-Path: <owner-svn-src-all@FreeBSD.ORG>
Delivered-To: svn-src-all@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id D22DBF4B;
 Tue, 10 Feb 2015 03:15:54 +0000 (UTC)
Received: from svn.freebsd.org (svn.freebsd.org
 [IPv6:2001:1900:2254:2068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id BD952694;
 Tue, 10 Feb 2015 03:15:54 +0000 (UTC)
Received: from svn.freebsd.org ([127.0.1.70])
 by svn.freebsd.org (8.14.9/8.14.9) with ESMTP id t1A3Fs0V015659;
 Tue, 10 Feb 2015 03:15:54 GMT (envelope-from dteske@FreeBSD.org)
Received: (from dteske@localhost)
 by svn.freebsd.org (8.14.9/8.14.9/Submit) id t1A3FsNu015658;
 Tue, 10 Feb 2015 03:15:54 GMT (envelope-from dteske@FreeBSD.org)
Message-Id: <201502100315.t1A3FsNu015658@svn.freebsd.org>
X-Authentication-Warning: svn.freebsd.org: dteske set sender to
 dteske@FreeBSD.org using -f
From: Devin Teske <dteske@FreeBSD.org>
Date: Tue, 10 Feb 2015 03:15:54 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
 svn-src-head@freebsd.org
Subject: svn commit: r278491 - head/usr.sbin/bsdconfig/share
X-SVN-Group: head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-src-all@freebsd.org
X-Mailman-Version: 2.1.18-1
Precedence: list
List-Id: "SVN commit messages for the entire src tree \(except for &quot;
 user&quot; and &quot; projects&quot; \)" <svn-src-all.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/svn-src-all>,
 <mailto:svn-src-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-all/>
List-Post: <mailto:svn-src-all@freebsd.org>
List-Help: <mailto:svn-src-all-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-all>,
 <mailto:svn-src-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 10 Feb 2015 03:15:54 -0000

Author: dteske
Date: Tue Feb 10 03:15:54 2015
New Revision: 278491
URL: https://svnweb.freebsd.org/changeset/base/278491

Log:
  Add bsdconfig api function f_dialog_menutag2help()

Modified:
  head/usr.sbin/bsdconfig/share/dialog.subr

Modified: head/usr.sbin/bsdconfig/share/dialog.subr
==============================================================================
--- head/usr.sbin/bsdconfig/share/dialog.subr	Tue Feb 10 03:12:11 2015	(r278490)
+++ head/usr.sbin/bsdconfig/share/dialog.subr	Tue Feb 10 03:15:54 2015	(r278491)
@@ -2116,6 +2116,39 @@ f_dialog_menutag2index_with_help()
 	return $FAILURE
 }
 
+# f_dialog_menutag2help $tag_chosen $tag1 $item1 $help1 $tag2 $item2 $help2 ...
+#
+# To use the `--menu' option of dialog(1) with the `--item-help' option, you
+# must pass an ordered list of tag/item/help triplets on the command-line. When
+# the user selects a menu option the tag for that item is printed to stderr.
+#
+# This function allows you to dereference the tag chosen by the user back into
+# the help associated with said tag (item is discarded/ignored).
+#
+# Pass the tag chosen by the user as the first argument, followed by the
+# ordered list of tag/item/help triplets (HINT: use the same tag/item/help list
+# as was passed to dialog(1) for consistency).
+#
+# If the tag cannot be found, NULL is returned.
+#
+f_dialog_menutag2help()
+{
+	local tag="$1" tagn help
+	shift 1 # tag
+
+	while [ $# -gt 0 ]; do
+		tagn="$1"
+		help="$3"
+		shift 3 # tagn/item/help
+
+		if [ "$tag" = "$tagn" ]; then
+			echo "$help"
+			return $SUCCESS
+		fi
+	done
+	return $FAILURE
+}
+
 ############################################################ INIT FUNCTIONS
 
 # f_dialog_init