/[ascend]/trunk/base/generic/general/pretty.h
ViewVC logotype

Contents of /trunk/base/generic/general/pretty.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 593 - (show annotations) (download) (as text)
Fri May 12 10:03:59 2006 UTC (13 years, 10 months ago) by johnpye
File MIME type: text/x-chdr
File size: 4004 byte(s)
Bumped version to 0.9.5.91.
Changed WITH_CUNIT_TESTS to WITH_CUNIT.
Added GCOV scons option.
Fixed up 'test' target for SCons.
Added lots of export symbols to libascend.so.

1 /*
2 * pretty.h
3 * I/O Formatting Functions
4 * by Ben Allan
5 * Created: 01/98
6 * Version: $Revision: 1.4 $
7 * Version control file: $RCSfile: pretty.h,v $
8 * Date last modified: $Date: 2001/01/28 03:39:39 $
9 * Last modified by: $Author: ballan $
10 *
11 * This file is part of the ASCEND Language Interpreter
12 *
13 * Copyright (C) 1998 Carnegie Mellon University
14 *
15 * The ASCEND Language Interpreter is free software; you can
16 * redistribute it and/or modify it under the terms of the GNU
17 * General Public License as published by the Free Software
18 * Foundation; either version 2 of the License, or (at your option)
19 * any later version.
20 *
21 * The ASCEND Language Interpreter is distributed in hope that it
22 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
23 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
24 * See the GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with the program; if not, write to the Free Software
28 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check
29 * the file named COPYING. COPYING is found in ../compiler.
30 */
31
32 /** @file
33 * I/O Formatting Functions.
34 * <pre>
35 * Requires:
36 * #include "utilities/ascConfig.h"
37 * </pre>
38 */
39
40 #ifndef __pretty_h_seen__
41 #define __pretty_h_seen__
42
43 /**
44 * Writes a string to a file, splitting it at whitespace characters to
45 * try to limit each line to the specified width. The string is split
46 * at the blank characters, tabs, or returns. Long words are not broken,
47 * which can result in lines longer than requested. The printed string
48 * will always have a trailing '\n', possibly 2 if the original string
49 * ends in a '\n'. This function is not very bright, but works ok on
50 * nonpathological input.<br><br>
51 *
52 * Each line written is indented by indent spaces. Note that width does
53 * not include the indent, so print_long_string(f,s,70,2) -> 72 char
54 * lines. If fp or string is NULL, nothing is printed. If width < 4
55 * or indent < 0, no formatting is attempted and the string is simply
56 * printed as-is.<br><br>
57 *
58 * Note that \n and \t count as a character when determining line length,
59 * so you won't get perfect formatting. If you want perfect formatting,
60 * fix it. How big is a tab? In particular, \n will cause a missing
61 * indent. See print_long_string_EOL() for somewhat more controlled
62 * formatting.<br><br>
63 *
64 * Passing this function a constant string may result in a crash
65 * on platforms/compilers in which assigning characters through a
66 * pointer is disallowed for const strings.
67 *
68 * @param fp The file stream to receive the output. If NULL,
69 * nothing is printed.
70 * @param string The string to format into lines and print to fp.
71 * If NULL, nothing is printed.
72 * @param width The maximum requested line length. If less than 4,
73 * no formatting is performed.
74 * @param indent The number of spaces by which to indent each line.
75 * If less than 0, no formatting is performed.
76 * @return The total number of characters printed.
77 */
78 ASC_DLLSPEC(int ) print_long_string(FILE *fp, char *string, int width, int indent);
79
80 /**
81 * Writes a string to a file, splitting it at special delimiter
82 * characters. This function works like print_long_string(), except
83 * the string is broken at occurences of /{star}EOL{star}/ (commented EOL).
84 *
85 * @param fp The file stream to receive the output. If NULL,
86 * nothing is printed.
87 * @param string The string to format into lines and print to fp.
88 * If NULL, nothing is printed.
89 * @param indent The number of spaces by which to indent each line.
90 * If less than 0, no formatting is performed.
91 * @return The total number of characters printed.
92 */
93 ASC_DLLSPEC(int ) print_long_string_EOL(FILE *fp, char *string, int indent);
94
95 #endif /* __pretty_h_seen__ */
96

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22