28eed7eabf2a7c8e68655c5dacf5aa3299624c97
[alexxy/gromacs.git] / include / txtdump.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 _txtdump_h
37 #define _txtdump_h
38
39
40 #include <stdio.h>
41 #include "visibility.h"
42 #include "typedefs.h"
43 #include "tpxio.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49
50 #define LINE_WIDTH      80
51 #define RMARGIN         10
52 #define USE_WIDTH       ((LINE_WIDTH)-(RMARGIN))
53 #define INDENT          3
54
55 GMX_LIBGMX_EXPORT
56 int pr_indent(FILE *fp,int n);
57 GMX_LIBGMX_EXPORT
58 int available(FILE *fp,void *p,int indent,const char *title);
59 GMX_LIBGMX_EXPORT
60 int pr_title(FILE *fp,int indent,const char *title);
61 int pr_title_n(FILE *fp,int indent,const char *title,int n);
62 int pr_title_nxn(FILE *fp,int indent,const char *title,int n1,int n2);
63 GMX_LIBGMX_EXPORT
64 void pr_ivec(FILE *fp,int indent,const char *title,int vec[],int n, gmx_bool bShowNumbers);
65 void pr_ivecs(FILE *fp,int indent,const char *title,ivec vec[],int n, gmx_bool bShowNumbers);
66 GMX_LIBGMX_EXPORT
67 void pr_bvec(FILE *fp,int indent,const char *title,gmx_bool vec[],int n, gmx_bool bShowNnumbers);
68 GMX_LIBGMX_EXPORT
69 void pr_rvec(FILE *fp,int indent,const char *title,real vec[],int n, gmx_bool bShowNumbers);
70 void pr_dvec(FILE *fp,int indent,const char *title,double vec[],int n, gmx_bool bShowNumbers);
71 GMX_LIBGMX_EXPORT
72 void pr_rvecs(FILE *fp,int indent,const char *title,rvec vec[],int n);
73 void pr_rvecs_len(FILE *fp,int indent,const char *title,rvec vec[],int n);
74 void pr_reals(FILE *fp,int indent,const char *title,real vec[],int n);
75 GMX_LIBGMX_EXPORT
76 void pr_doubles(FILE *fp,int indent,const char *title,double *vec,int n);
77 void pr_block(FILE *fp,int indent,const char *title,t_block *block,gmx_bool bShowNumbers);
78 GMX_LIBGMX_EXPORT
79 void pr_blocka(FILE *fp,int indent,const char *title,t_blocka *block,gmx_bool bShowNumbers);
80 void pr_ilist(FILE *fp,int indent,const char *title,
81                t_functype *functype,t_ilist *ilist, gmx_bool bShowNumbers);
82 GMX_LIBGMX_EXPORT
83 void pr_iparams(FILE *fp,t_functype ftype,t_iparams *iparams);
84 void pr_idef(FILE *fp,int indent,const char *title,t_idef *idef, gmx_bool bShowNumbers);
85 GMX_LIBGMX_EXPORT
86 void pr_inputrec(FILE *fp,int indent,const char *title,t_inputrec *ir,
87                  gmx_bool bMDPformat);
88 void pr_atoms(FILE *fp,int indent,const char *title,t_atoms *atoms, 
89               gmx_bool bShownumbers);
90 void pr_atomtypes(FILE *fp,int indent,const char *title,
91                   t_atomtypes *atomtypes,gmx_bool bShowNumbers);
92 GMX_LIBGMX_EXPORT
93 void pr_mtop(FILE *fp,int indent,const char *title,gmx_mtop_t *mtop,
94              gmx_bool bShowNumbers);
95 GMX_LIBGMX_EXPORT
96 void pr_top(FILE *fp,int indent,const char *title,t_topology *top, gmx_bool bShowNumbers);
97 /*
98  * This routine prints out a (human) readable representation of 
99  * the topology to the file fp. Ident specifies the number of 
100  * spaces the text should be indented. Title is used to print a 
101  * header text.
102  */
103 GMX_LIBGMX_EXPORT
104 void pr_header(FILE *fp,int indent,const char *title,t_tpxheader *sh);
105 /*
106  * This routine prints out a (human) readable representation of
107  * a header to the file fp. Ident specifies the number of spaces
108  * the text should be indented. Title is used to print a header text.
109  */
110
111 void pr_commrec(FILE *fp,int indent,t_commrec *cr);
112
113 #ifdef __cplusplus
114 }
115 #endif
116
117 #endif  /* _txtdump_h */