shared_source/c_datd/fcmiof.h

//$Header$
//-------------------------------------------------------------------------------------------------
//This file is part of "David T. Ashley's Shared Source Code", a set of shared components
//integrated into many of David T. Ashley's projects.
//-------------------------------------------------------------------------------------------------
//This source code and any program in which it is compiled/used is provided under the MIT License,
//reproduced below.
//-------------------------------------------------------------------------------------------------
//Permission is hereby granted, free of charge, to any person obtaining a copy of
//this software and associated documentation files(the "Software"), to deal in the
//Software without restriction, including without limitation the rights to use,
//copy, modify, merge, publish, distribute, sublicense, and / or sell copies of the
//Software, and to permit persons to whom the Software is furnished to do so,
//subject to the following conditions :
//
//The above copyright notice and this permission notice shall be included in all
//copies or substantial portions of the Software.
//
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//SOFTWARE.
//-------------------------------------------------------------------------------------------------
#ifndef FCMIOF_H_INCLUDED
   #define FCMIOF_H_INCLUDED

   #ifdef MODULE_FCMIOF
      #define DECMOD_FCMIOF
   #else
      #define DECMOD_FCMIOF extern
   #endif


   //Returns the assumed line length for formatted output.
   DECMOD_FCMIOF FCMIOF_get_line_len(void);


   /****************************************************************************/
   /* FCMIOF_repchar():                                                        */
   /*--------------------------------------------------------------------------*/ 
   /* DESCRIPTION                                                              */
   /*   Repeats a character to stdout the specified number of times.           */
   /*                                                                          */
   /* INPUTS                                                                   */
   /*   c  :  The character to repeat.                                         */
   /*                                                                          */
   /*   n  :  The number of times to repeat it.                                */
   /****************************************************************************/
   DECMOD_FCMIOF void FCMIOF_repchar(char c, unsigned n);

   //Repeats characters to a stream.
   DECMOD_FCMIOF void FCMIOF_stream_repchar(FILE *s, char c, unsigned n);

   /****************************************************************************/
   /* FCMIOF_hline():                                                          */
   /*--------------------------------------------------------------------------*/ 
   /* DESCRIPTION                                                              */
   /*   Dumps a horizontal line of the standard length to the standard output. */
   /****************************************************************************/
   DECMOD_FCMIOF void FCMIOF_hline(void);

   //Dumps horizontal line to stream.
   DECMOD_FCMIOF void FCMIOF_stream_hline(FILE *s);


   DECMOD_FCMIOF void FCMIOF_stream_bannerheading(FILE *f,
                                 char *s, 
                                 int n_extra_lines);

   /****************************************************************************/
   /* FCMIOF_bannerheading():                                                  */
   /*--------------------------------------------------------------------------*/ 
   /* DESCRIPTION                                                              */
   /*   Prints a banner heading bracketed by astreisks to the standard output. */
   /*   This function is useful for separating different sections of output.   */
   /****************************************************************************/
   DECMOD_FCMIOF void FCMIOF_bannerheading(char *s, int n_extra_lines);


   DECMOD_FCMIOF void FCMIOF_time_stream(FILE *s, time_t ltime);


   /* Two functions below return version control information for .C and
   ** .H files.
   */
   DECMOD_FCMIOF const char *FCMIOF_cvcinfo(void);
   DECMOD_FCMIOF const char *FCMIOF_hvcinfo(void);
   #define FCMIOF_H_VERSION ("$Header$")

#endif

//End of fcmiof.h.
1	dashley	71	//$Header$
2			//-------------------------------------------------------------------------------------------------
3			//This file is part of "David T. Ashley's Shared Source Code", a set of shared components
4			//integrated into many of David T. Ashley's projects.
5			//-------------------------------------------------------------------------------------------------
6			//This source code and any program in which it is compiled/used is provided under the MIT License,
7			//reproduced below.
8			//-------------------------------------------------------------------------------------------------
9			//Permission is hereby granted, free of charge, to any person obtaining a copy of
10			//this software and associated documentation files(the "Software"), to deal in the
11			//Software without restriction, including without limitation the rights to use,
12			//copy, modify, merge, publish, distribute, sublicense, and / or sell copies of the
13			//Software, and to permit persons to whom the Software is furnished to do so,
14			//subject to the following conditions :
15			//
16			//The above copyright notice and this permission notice shall be included in all
17			//copies or substantial portions of the Software.
18			//
19			//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20			//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21			//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
22			//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23			//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24			//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25			//SOFTWARE.
26			//-------------------------------------------------------------------------------------------------
27			#ifndef FCMIOF_H_INCLUDED
28			#define FCMIOF_H_INCLUDED
29
30			#ifdef MODULE_FCMIOF
31			#define DECMOD_FCMIOF
32			#else
33			#define DECMOD_FCMIOF extern
34			#endif
35
36
37			//Returns the assumed line length for formatted output.
38			DECMOD_FCMIOF FCMIOF_get_line_len(void);
39
40
41			/****************************************************************************/
42			/* FCMIOF_repchar(): */
43			/--------------------------------------------------------------------------/
44			/* DESCRIPTION */
45			/* Repeats a character to stdout the specified number of times. */
46			/* */
47			/* INPUTS */
48			/* c : The character to repeat. */
49			/* */
50			/* n : The number of times to repeat it. */
51			/****************************************************************************/
52			DECMOD_FCMIOF void FCMIOF_repchar(char c, unsigned n);
53
54			//Repeats characters to a stream.
55			DECMOD_FCMIOF void FCMIOF_stream_repchar(FILE *s, char c, unsigned n);
56
57			/****************************************************************************/
58			/* FCMIOF_hline(): */
59			/--------------------------------------------------------------------------/
60			/* DESCRIPTION */
61			/* Dumps a horizontal line of the standard length to the standard output. */
62			/****************************************************************************/
63			DECMOD_FCMIOF void FCMIOF_hline(void);
64
65			//Dumps horizontal line to stream.
66			DECMOD_FCMIOF void FCMIOF_stream_hline(FILE *s);
67
68
69			DECMOD_FCMIOF void FCMIOF_stream_bannerheading(FILE *f,
70			char *s,
71			int n_extra_lines);
72
73			/****************************************************************************/
74			/* FCMIOF_bannerheading(): */
75			/--------------------------------------------------------------------------/
76			/* DESCRIPTION */
77			/* Prints a banner heading bracketed by astreisks to the standard output. */
78			/* This function is useful for separating different sections of output. */
79			/****************************************************************************/
80			DECMOD_FCMIOF void FCMIOF_bannerheading(char *s, int n_extra_lines);
81
82
83			DECMOD_FCMIOF void FCMIOF_time_stream(FILE *s, time_t ltime);
84
85
86			/* Two functions below return version control information for .C and
87			** .H files.
88			*/
89			DECMOD_FCMIOF const char *FCMIOF_cvcinfo(void);
90			DECMOD_FCMIOF const char *FCMIOF_hvcinfo(void);
91			#define FCMIOF_H_VERSION ("$Header$")
92
93			#endif
94
95			//End of fcmiof.h.