From 30b8b3c61feaaf7ea439ee549c57143cb26fd3c3 Mon Sep 17 00:00:00 2001
From: "Gustavo J. A. M. Carneiro" <gjc@inescporto.pt>
Date: Wed, 18 Jul 2007 12:20:31 +0100
Subject: [PATCH] WAF: add a --command-template option to e.g. allow running
 programs with valgrind, gdb, etc.

---
 doc/build.txt |  9 +++++++
 wscript       | 68 ++++++++++++++++++++++++++++++++++++++-------------
 2 files changed, 60 insertions(+), 17 deletions(-)

diff --git a/doc/build.txt b/doc/build.txt
index 1e2f45cd3..bfb2b518d 100644
--- a/doc/build.txt
+++ b/doc/build.txt
@@ -60,6 +60,15 @@ with --enable-gcov)
     before running the program.  Note: the "program [args]" string is
     parsed using POSIX shell rules.
 
+ 4.1 waf --run programname --command-template "... %s ..."
+
+    Same as --run, but uses a command template with %s replaced by the
+    actual program (whose name is given by --run).  This can be use to
+    run ns-3 programs with helper tools.  For example, to run unit
+    tests with valgrind, use the command:
+
+         waf --run run-tests --command-template "valgrind %s"
+
  5. waf --shell
     Starts a nested system shell with modified environment to run ns3 programs.
 
diff --git a/wscript b/wscript
index bfa1d96de..35c17074a 100644
--- a/wscript
+++ b/wscript
@@ -1,5 +1,4 @@
 ## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
-import os
 import sys
 import shlex
 import shutil
@@ -66,8 +65,14 @@ def set_options(opt):
                    dest='doxygen')
 
     opt.add_option('--run',
-                   help=('Run a locally built program'),
+                   help=('Run a locally built program; argument can be a program name,'
+                         ' or a command starting with the program name.'),
                    type="string", default='', dest='run')
+    opt.add_option('--command-template',
+                   help=('Template of the command used to run the program given by --run;'
+                         ' It should be a shell command string containing %s inside,'
+                         ' which will be replaced by the actual program.'),
+                   type="string", default=None, dest='command_template')
 
     opt.add_option('--shell',
                    help=('Run a shell with an environment suitably modified to run locally built programs'),
@@ -163,7 +168,11 @@ def shutdown():
         doxygen()
 
     if Params.g_options.run:
-        run_program(Params.g_options.run)
+        run_program(Params.g_options.run, Params.g_options.command_template)
+        raise SystemExit(0)
+
+    if Params.g_options.command_template:
+        Params.fatal("Option --command-template requires the option --run to be given")
 
 def _find_program(program_name, env):
     launch_dir = os.path.abspath(Params.g_cwd_launch)
@@ -212,33 +221,58 @@ def _run_argv(argv):
 
     retval = subprocess.Popen(argv, env=os_env).wait()
     if retval:
-        raise SystemExit(retval)
+        Params.fatal("Command %s exited with code %i" % (argv, retval))
 
 
-def run_program(program_string):
+def run_program(program_string, command_template=None):
+    """
+    if command_template is not None, then program_string == program
+    name and argv is given by command_template with %s replaced by the
+    full path to the program.  Else, program_string is interpreted as
+    a shell command with first name being the program name.
+    """
     env = Params.g_build.env_of_name('default')
-    argv = shlex.split(program_string)
-    program_name = argv[0]
 
-    try:
-        program_obj = _find_program(program_name, env)
-    except ValueError, ex:
-        Params.fatal(str(ex))
+    if command_template is None:
+        argv = shlex.split(program_string)
+        program_name = argv[0]
 
-    try:
-        program_node, = program_obj.m_linktask.m_outputs
-    except AttributeError:
-        Params.fatal("%s does not appear to be a program" % (program_name,))
+        try:
+            program_obj = _find_program(program_name, env)
+        except ValueError, ex:
+            Params.fatal(str(ex))
+
+        try:
+            program_node, = program_obj.m_linktask.m_outputs
+        except AttributeError:
+            Params.fatal("%s does not appear to be a program" % (program_name,))
+
+        execvec = [program_node.abspath(env)] + argv[1:]
+
+    else:
+
+        program_name = program_string
+        try:
+            program_obj = _find_program(program_name, env)
+        except ValueError, ex:
+            Params.fatal(str(ex))
+        try:
+            program_node, = program_obj.m_linktask.m_outputs
+        except AttributeError:
+            Params.fatal("%s does not appear to be a program" % (program_name,))
+
+        execvec = shlex.split(command_template % (program_node.abspath(env),))
 
-    execvec = [program_node.abspath(env)] + argv[1:]
 
     former_cwd = os.getcwd()
     os.chdir(Params.g_cwd_launch)
     try:
-        return _run_argv(execvec)
+        retval = _run_argv(execvec)
     finally:
         os.chdir(former_cwd)
 
+    return retval
+
 
 def run_shell():
     if sys.platform == 'win32':