2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2013,2014, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
37 * Implements functions from cmdlineinit.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_commandline
44 #include "gromacs/commandline/cmdlineinit.h"
48 #include <boost/scoped_ptr.hpp>
50 #include "gromacs/legacyheaders/network.h"
51 #include "gromacs/legacyheaders/types/commrec.h"
53 #include "gromacs/commandline/cmdlinemodulemanager.h"
54 #include "gromacs/commandline/cmdlineprogramcontext.h"
55 #include "gromacs/utility/exceptions.h"
56 #include "gromacs/utility/gmxassert.h"
57 #include "gromacs/utility/init.h"
58 #include "gromacs/utility/programcontext.h"
59 #include "gromacs/utility/smalloc.h"
67 //! \addtogroup module_commandline
70 //! Global context instance initialized in initForCommandLine().
71 boost::scoped_ptr<CommandLineProgramContext> g_commandLineContext;
74 void broadcastArguments(const t_commrec *cr, int *argc, char ***argv)
76 gmx_bcast(sizeof(*argc), argc, cr);
82 for (int i = 0; i < *argc; i++)
87 len = std::strlen((*argv)[i])+1;
89 gmx_bcast(sizeof(len), &len, cr);
92 snew((*argv)[i], len);
94 gmx_bcast(len, (*argv)[i], cr);
103 CommandLineProgramContext &initForCommandLine(int *argc, char ***argv)
105 gmx::init(argc, argv);
106 GMX_RELEASE_ASSERT(!g_commandLineContext,
107 "initForCommandLine() calls cannot be nested");
109 // TODO: Rewrite this to not use t_commrec once there is clarity on
110 // the approach for MPI in C++ code.
111 // TODO: Consider whether the argument broadcast would better be done
112 // in CommandLineModuleManager.
114 std::memset(&cr, 0, sizeof(cr));
116 gmx_fill_commrec_from_mpi(&cr);
119 broadcastArguments(&cr, argc, argv);
124 g_commandLineContext.reset(new CommandLineProgramContext(*argc, *argv));
125 setProgramContext(g_commandLineContext.get());
127 catch (const std::exception &ex)
129 printFatalErrorMessage(stderr, ex);
130 std::exit(processExceptionAtExit(ex));
132 return *g_commandLineContext;
135 void finalizeForCommandLine()
138 setProgramContext(NULL);
139 g_commandLineContext.reset();
142 int runCommandLineModule(int argc, char *argv[],
143 CommandLineModuleInterface *module)
145 return gmx::CommandLineModuleManager::runAsMainSingleModule(argc, argv, module);
150 int gmx_run_cmain(int argc, char *argv[], int (*mainFunction)(int, char *[]))
152 return gmx::CommandLineModuleManager::runAsMainCMain(argc, argv, mainFunction);