<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[152524] contrib/mp-buildbot/mpbb</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="https://trac.macports.org/changeset/152524">152524</a></dd>
<dt>Author</dt> <dd>larryv@macports.org</dd>
<dt>Date</dt> <dd>2016-09-11 18:58:52 -0700 (Sun, 11 Sep 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>mpbb: Parse command-line arguments with a function
This will facilitate the separation of global options and subcommand
options because each subcommand function will be able to parse its own
arguments with only a few lines of code instead of an unwieldy `case`
statement.
The new function requires enhanced getopt(1) [*], which is not included
with macOS but is available in the `getopt` port. It recognizes flags in
`--OPT=ARG` form, permits optional arguments, and correctly handles
missing arguments.
[*]: http://frodo.looijaard.name/project/getopt</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#contribmpbuildbotmpbb">contrib/mp-buildbot/mpbb</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="contribmpbuildbotmpbb"></a>
<div class="modfile"><h4>Modified: contrib/mp-buildbot/mpbb (152523 => 152524)</h4>
<pre class="diff"><span>
<span class="info">--- contrib/mp-buildbot/mpbb 2016-09-12 01:58:50 UTC (rev 152523)
+++ contrib/mp-buildbot/mpbb 2016-09-12 01:58:52 UTC (rev 152524)
</span><span class="lines">@@ -25,36 +25,36 @@
</span><span class="cx">
</span><span class="cx"> OPTIONS
</span><span class="cx">
</span><del>- --archive-site URL
</del><ins>+ --archive-site=URL
</ins><span class="cx"> Base URL of the packages archive to check whether an archive was not
</span><span class="cx"> published yet. Default is "https://packages.macports.org".
</span><span class="cx">
</span><span class="cx"> --help
</span><span class="cx"> Print this usage message.
</span><span class="cx">
</span><del>- --prefix PREFIX
</del><ins>+ --prefix=PREFIX
</ins><span class="cx"> The prefix of the MacPorts installation that will build the ports. Defaults
</span><span class="cx"> to "/opt/local".
</span><span class="cx">
</span><del>- --svn BINARY
</del><ins>+ --svn=BINARY
</ins><span class="cx"> Absolute path to the svn binary that you want to use for SVN operations. The
</span><span class="cx"> default is to find svn in your path.
</span><span class="cx">
</span><del>- --svn-url SVNURL
</del><ins>+ --svn-url=SVNURL
</ins><span class="cx"> URL to a Subversion repository in a format accepted by Subversion. The
</span><span class="cx"> referenced folder must contain a dports and a base folder. The default is
</span><span class="cx"> "https://svn.macports.org/repository/macports/trunk".
</span><span class="cx">
</span><del>- --svn-revision REVISION
</del><ins>+ --svn-revision=REVISION
</ins><span class="cx"> Revision number in the specified Subversion repository to checkout. Defaults
</span><span class="cx"> to "HEAD".
</span><span class="cx">
</span><del>- --staging-dir DIR
</del><ins>+ --staging-dir=DIR
</ins><span class="cx"> Directory where new distributable archives should be copied for deployment
</span><span class="cx"> on the archive server. Defaults to the 'archive-staging' subfolder in the
</span><span class="cx"> current directory.
</span><span class="cx">
</span><del>- --work-dir WORKDIR
</del><ins>+ --work-dir=WORKDIR
</ins><span class="cx"> A scratch area that mpbb will use to put temporary files, ideally kept
</span><span class="cx"> between builds. Your MacPorts installation in --prefix needs to be able to
</span><span class="cx"> access this location. Defaults to your current directory, or
</span><span class="lines">@@ -96,73 +96,76 @@
</span><span class="cx"> usage
</span><span class="cx"> fi
</span><span class="cx">
</span><del>-## Flag Parsing
-while [[ $# -gt 0 ]]; do
- key=$1
</del><ins>+# TODO Documentation, obviously :)
+parseopt() {
+ # Be stricter about this than getopt(1) is.
+ if ! [[ ${1-} =~ ^[[:alnum:]-]+:{0,2}(,[[:alnum:]-]+:{0,2})*$ ]]; then
+ err 'Invalid argument given to parseopt'
+ return 3
+ fi
</ins><span class="cx">
</span><del>- case "$key" in
- --*)
- # Shellcheck doesn't see the invocations in the sourced
- # scripts, so we'll have to disable a number of false
- # positives here.
-
- # shellcheck disable=SC2034
- case "$key" in
- --archive-site)
- option_archive_site=$2
- shift
- ;;
- --help)
- option_help=1
- ;;
- --port)
- # Deprecated and will be removed in the near future.
- option_port=$2
- shift
- ;;
- --prefix)
- option_prefix=$2
- shift
- ;;
- --staging-dir)
- option_staging_dir=$2
- shift
- ;;
- --svn)
- option_svn=$2
- shift
- ;;
- --svn-url)
- option_svn_url=$2
- shift
- ;;
- --svn-revision)
- option_svn_revision=$2
- shift
- ;;
- --work-dir)
- option_work_dir=$2
- shift
- ;;
- --)
- shift
- break
- ;;
- *)
- err "Unknown option: ${key}"
- option_help=1
- break
- ;;
- esac
-
- shift
</del><ins>+ # Use "--options +" to prevent arguments from being rearranged.
+ local opts
+ opts=$(getopt --name "$0" --opt + --longopt "$1" -- "${@:2}")
+ case $? in
+ 0)
</ins><span class="cx"> ;;
</span><ins>+ 1)
+ # getopt(1) will print the bad argument to standard error.
+ echo >&2 "Try \`$0 --help' for more information."
+ return 2
+ ;;
</ins><span class="cx"> *)
</span><del>- break
</del><ins>+ err 'getopt encountered an internal error'
+ return 3
</ins><span class="cx"> ;;
</span><span class="cx"> esac
</span><del>-done
</del><ins>+ readonly opts
</ins><span class="cx">
</span><ins>+ local -a validopts
+ IFS=, read -ra validopts <<<"$1"
+ readonly validopts=("${validopts[@]/#/--}")
+
+ eval set -- "$opts"
+
+ local opt validopt
+ # getopt(1) ensures that the options are always terminated with "--".
+ while [[ $1 != -- ]]; do
+ opt=$1
+ shift
+ # XXX Do NOT touch anything below unless you know exactly what
+ # you're doing (http://mywiki.wooledge.org/BashFAQ/006#eval).
+ for validopt in "${validopts[@]}"; do
+ if [[ $validopt == "$opt:" || $validopt == "$opt::" ]]; then
+ opt=${opt#--}
+ # $1 is null for omitted optional arguments.
+ eval option_"${opt//-/_}"'=$1'
+ shift
+ continue 2
+ fi
+ if [[ $validopt == "$opt" ]]; then
+ opt=${opt#--}
+ eval option_"${opt//-/_}"'=1'
+ continue 2
+ fi
+ done
+ # Unreachable unless there is a bug in this function or in getopt(1).
+ err 'parseopt encountered an internal error'
+ return 3
+ done
+ args=("${@:2}")
+}
+
+unset GETOPT_COMPATIBLE
+if getopt -T >/dev/null; then
+ # http://frodo.looijaard.name/project/getopt
+ err "Cannot find an enhanced getopt(1)"
+ exit 3
+fi
+
+# Process options.
+parseopt archive-site:,help,port:,prefix:,svn:,svn_revision:,svn_url:,staging-dir:,work-dir: "$@" || exit
+
</ins><span class="cx"> # Use sensible defaults for options that weren't set on the command line.
</span><span class="cx"> : "${option_port=}"
</span><span class="cx"> : "${option_prefix=/opt/local}"
</span><span class="lines">@@ -178,6 +181,11 @@
</span><span class="cx"> # Not really options, but pretend they are because they're global.
</span><span class="cx"> option_log_dir=${option_work_dir}/logs
</span><span class="cx">
</span><ins>+# shellcheck disable=SC2086
+# Set up the positional arguments for the subcommand. With "set -u"
+# enabled, "${foo[@]}" doesn't work if foo is empty.
+set -- ${args+"${args[@]}"}
+
</ins><span class="cx"> ## If subcommand help is requested, print that
</span><span class="cx"> if [[ $option_help -eq 1 ]]; then
</span><span class="cx"> usage
</span></span></pre>
</div>
</div>
</body>
</html>