include/md_logging.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _md_logging_h
  40 #define _md_logging_h
  41
  42 #include "visibility.h"
  43 #include "types/commrec.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 GMX_LIBGMX_EXPORT
  50 void md_print_info(const t_commrec *cr, FILE *fplog,
  51                    const char *fmt, ...);
  52 /* Print an general information message to stderr on the master node
  53  * and to fplog if fplog!=NULL.
  54  * fmt is a standard printf formatting string which should end in \n,
  55  * the arguments after that contain the values to be printed, as in printf.
  56  */
  57
  58 GMX_LIBGMX_EXPORT
  59 void md_print_warn(const t_commrec *cr, FILE *fplog,
  60                    const char *fmt, ...);
  61 /* As md_print_info above, but for important notices or warnings.
  62  * The only difference with md_print_info is that a newline is printed
  63  * before and after the message such that it stands out.
  64  */
  65
  66 #ifdef __cplusplus
  67 }
  68 #endif
  69
  70 #endif  /* _md_logging_h */