Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / gmxlib / oenv.cpp
index 9a88904c6499d2c2139d41c0ad0243fb2460f724..89201b8064ae4e746c653177bcae8a4781eb436b 100644 (file)
@@ -1,76 +1,71 @@
-/* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
+/*
+ * This file is part of the GROMACS molecular simulation package.
  *
- * 
- *                This source code is part of
- * 
- *                 G   R   O   M   A   C   S
- * 
- *          GROningen MAchine for Chemical Simulations
- * 
- *                        VERSION 3.2.0
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2004, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
+ * Copyright (c) 2001-2004, The GROMACS development team.
+ * Copyright (c) 2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
+ *
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
  * of the License, or (at your option) any later version.
- * 
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
- * 
+ *
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
+ *
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
+ *
  * To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- * 
- * For more info, check our website at http://www.gromacs.org
- * 
- * And Hey:
- * GROningen Mixture of Alchemy and Childrens' Stories
+ * the research papers on the package. Check out http://www.gromacs.org.
  */
-#include "oenv.h"
+#include "gmxpre.h"
 
-#include "smalloc.h"
+#include "gromacs/legacyheaders/oenv.h"
 
 #include "gromacs/utility/exceptions.h"
-#include "gromacs/utility/programinfo.h"
+#include "gromacs/utility/programcontext.h"
+#include "gromacs/utility/smalloc.h"
 
 struct output_env
 {
-    output_env()
-    {
-        setDefaults();
-    }
-    output_env(int argc, const char *const argv[])
-        : programInfo(argc, argv)
-    {
-        setDefaults();
-    }
-
-    void setDefaults()
+    explicit output_env(const gmx::ProgramContextInterface &context)
+        : programContext(context)
     {
         time_unit   = time_ps;
         view        = FALSE;
         xvg_format  = exvgNONE;
         verbosity   = 0;
-        debug_level = 0;
     }
 
-    gmx::ProgramInfo programInfo;
+    const gmx::ProgramContextInterface  &programContext;
 
-    time_unit_t time_unit; /* the time unit, enum defined in oenv.h */
-    gmx_bool view;  /* view of file requested */
-    xvg_format_t xvg_format; /* xvg output format, enum defined in oenv.h */
-    int  verbosity; /* The level of verbosity for this program */
-    int debug_level; /* the debug level */
+    /* the time unit, enum defined in oenv.h */
+    time_unit_t                          time_unit;
+    /* view of file requested */
+    gmx_bool                             view;
+    /* xvg output format, enum defined in oenv.h */
+    xvg_format_t                         xvg_format;
+    /* The level of verbosity for this program */
+    int                                  verbosity;
 };
 
-/* The source code in this file should be thread-safe. 
+/* The source code in this file should be thread-safe.
       Please keep it that way. */
 
 /******************************************************************
@@ -81,29 +76,33 @@ struct output_env
 
 /* read only time names */
 /* These must correspond to the time units type time_unit_t in oenv.h */
-static const real timefactors[] =   { 0,  1e3,  1, 1e-3, 1e-6, 1e-9, 1e-12, 0 };
-static const real timeinvfactors[] ={ 0, 1e-3,  1,  1e3,  1e6,  1e9,  1e12, 0 };
-static const char *time_units_str[] = { NULL, "fs", "ps", "ns", "us", 
-                                        "\\mus", "ms", "s" };
-static const char *time_units_xvgr[] = { NULL, "fs", "ps", "ns",  
-                                        "ms", "s", NULL };
+static const real  timefactors[] =   { 0,  1e3,  1, 1e-3, 1e-6, 1e-9, 1e-12, 0 };
+static const real  timeinvfactors[] = { 0, 1e-3,  1,  1e3,  1e6,  1e9,  1e12, 0 };
+static const char *time_units_str[] = {
+    NULL, "fs", "ps", "ns", "us",
+    "\\mus", "ms", "s"
+};
+static const char *time_units_xvgr[] = {
+    NULL, "fs", "ps", "ns",
+    "ms", "s", NULL
+};
 
 
 /***** OUTPUT_ENV MEMBER FUNCTIONS ******/
 
-void output_env_init(output_env_t *oenvp, int argc, char *argv[],
+void output_env_init(output_env_t *oenvp,
+                     const gmx::ProgramContextInterface &context,
                      time_unit_t tmu, gmx_bool view, xvg_format_t xvg_format,
-                     int verbosity, int debug_level)
+                     int verbosity)
 {
     try
     {
-        output_env_t oenv = new output_env(argc, argv);
-        *oenvp = oenv;
+        output_env_t oenv = new output_env(context);
+        *oenvp            = oenv;
         oenv->time_unit   = tmu;
         oenv->view        = view;
         oenv->xvg_format  = xvg_format;
         oenv->verbosity   = verbosity;
-        oenv->debug_level = debug_level;
     }
     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 }
@@ -112,7 +111,7 @@ void output_env_init_default(output_env_t *oenvp)
 {
     try
     {
-        output_env_t oenv = new output_env();
+        output_env_t oenv = new output_env(gmx::getProgramContext());
         *oenvp = oenv;
     }
     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
@@ -129,11 +128,6 @@ int output_env_get_verbosity(const output_env_t oenv)
     return oenv->verbosity;
 }
 
-int output_env_get_debug_level(const output_env_t oenv)
-{
-    return oenv->debug_level;
-}
-
 const char *output_env_get_time_unit(const output_env_t oenv)
 {
     return time_units_str[oenv->time_unit];
@@ -143,10 +137,10 @@ const char *output_env_get_time_label(const output_env_t oenv)
 {
     char *label;
     snew(label, 20);
-    
-    sprintf(label,"Time (%s)",time_units_str[oenv->time_unit] ? 
-            time_units_str[oenv->time_unit]: "ps");
-    
+
+    sprintf(label, "Time (%s)", time_units_str[oenv->time_unit] ?
+            time_units_str[oenv->time_unit] : "ps");
+
     return label;
 }
 
@@ -154,10 +148,10 @@ const char *output_env_get_xvgr_tlabel(const output_env_t oenv)
 {
     char *label;
     snew(label, 20);
-    
-    sprintf(label,"Time (%s)", time_units_xvgr[oenv->time_unit] ?
+
+    sprintf(label, "Time (%s)", time_units_xvgr[oenv->time_unit] ?
             time_units_xvgr[oenv->time_unit] : "ps");
-    
+
     return label;
 }
 
@@ -178,12 +172,16 @@ real output_env_conv_time(const output_env_t oenv, real time)
 
 void output_env_conv_times(const output_env_t oenv, int n, real *time)
 {
-    int i;
-    double fact=timefactors[oenv->time_unit];
-    
-    if (fact!=1.)
-        for(i=0; i<n; i++)
+    int    i;
+    double fact = timefactors[oenv->time_unit];
+
+    if (fact != 1.)
+    {
+        for (i = 0; i < n; i++)
+        {
             time[i] *= fact;
+        }
+    }
 }
 
 gmx_bool output_env_get_view(const output_env_t oenv)
@@ -196,29 +194,21 @@ xvg_format_t output_env_get_xvg_format(const output_env_t oenv)
     return oenv->xvg_format;
 }
 
-const char *output_env_get_program_name(const output_env_t oenv)
+const char *output_env_get_program_display_name(const output_env_t oenv)
 {
-    try
-    {
-        return oenv->programInfo.programNameWithPath().c_str();
-    }
-    GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
-}
+    const char *displayName = NULL;
 
-const char *output_env_get_short_program_name(const output_env_t oenv)
-{
     try
     {
-        return oenv->programInfo.programName().c_str();
+        displayName = oenv->programContext.displayName();
     }
     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
+
+    return displayName;
 }
 
-const char *output_env_get_cmd_line(const output_env_t oenv)
+const gmx::ProgramContextInterface &
+output_env_get_program_context(const output_env_t oenv)
 {
-    try
-    {
-        return oenv->programInfo.commandLine().c_str();
-    }
-    GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
+    return oenv->programContext;
 }