src/gromacs/legacyheaders/copyrite.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 _copyrite_h
  37 #define _copyrite_h
  38
  39
  40 #include <stdio.h>
  41 #include "types/simple.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /* Has to be a function, so we can get version number from autoconf */
  48 const char *GromacsVersion(void);
  49
  50 void
  51 gmx_print_version_info(FILE *fp);
  52
  53 void
  54 pr_difftime(FILE *out, double dt);
  55
  56 void
  57 CopyRight(FILE *out, const char *szProgram);
  58
  59
  60 /* For both bromacs() and cool_quote() you have to provide a pointer to
  61  * a string of reasonable length (say 256) and the string length. This
  62  * is necessary to make the routines threadsafe and avoid allocating
  63  * a new string each time. The retstring pointer will be the return value.
  64  */
  65 void
  66 bromacs(char *retstring, int retsize);
  67
  68 /* For cool_quote, the number of the quote used will be returned in cqnum
  69  * if it is non-NULL.
  70  */
  71 void
  72 cool_quote(char *retstring, int retsize, int *cqnum);
  73
  74 gmx_bool
  75 be_cool(void);
  76 /* Return TRUE when the user is COOL, FALSE otherwise */
  77
  78 void
  79 thanx(FILE *fp);
  80
  81 enum {
  82     eCITEGMX, eCITEBATH, eCITESHAKE, eCITESETTLE, eCITESOR,
  83     eCITEDISRE, eCITERF, eCITELINCS, eCITENR
  84 };
  85
  86 void
  87 please_cite(FILE *fp, const char *key);
  88 /* Print a message asking to cite something... */
  89
  90 #ifdef __cplusplus
  91 }
  92 #endif
  93
  94 #endif  /* _copyright_h */