include/md_logging.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _md_logging_h
  37 #define _md_logging_h
  38
  39 #include "visibility.h"
  40 #include "types/commrec.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 GMX_LIBGMX_EXPORT
  47 void md_print_info(const t_commrec *cr, FILE *fplog,
  48                    const char *fmt, ...);
  49 /* Print an general information message to stderr on the master node
  50  * and to fplog if fplog!=NULL.
  51  * fmt is a standard printf formatting string which should end in \n,
  52  * the arguments after that contain the values to be printed, as in printf.
  53  */
  54
  55 GMX_LIBGMX_EXPORT
  56 void md_print_warn(const t_commrec *cr, FILE *fplog,
  57                    const char *fmt, ...);
  58 /* As md_print_info above, but for important notices or warnings.
  59  * The only difference with md_print_info is that a newline is printed
  60  * before and after the message such that it stands out.
  61  */
  62
  63 #ifdef __cplusplus
  64 }
  65 #endif
  66
  67 #endif  /* _md_logging_h */