doxygen: add newline after \file
[blender.git] / intern / itasc / kdl / utilities / utility_io.h
1 /***************************************************************************** 
2  *      Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven
3  *
4  * \version 
5  *              ORO_Geometry V0.2
6  *
7  *      \par History
8  *              - $log$
9  *
10  *      \par Release
11  *              $Name:  $ 
12  *
13  * \file   utility_io.h
14  *     Included by most lrl-files to provide some general
15  *     functions and macro definitions related to file/stream I/O.
16  */
17
18 #ifndef KDL_UTILITY_IO_H_84822
19 #define KDL_UTILITY_IO_H_84822
20
21 //#include <kdl/kdl-config.h>
22
23
24 // Standard includes
25 #include <iostream>
26 #include <iomanip>
27 #include <fstream>
28
29
30 namespace KDL {
31
32
33 /**
34  * checks validity of basic io of is
35  */
36 void _check_istream(std::istream& is);
37
38
39 /** 
40  * Eats characters of the stream until the character delim is encountered
41  * @param is a stream
42  * @param delim eat until this character is encountered
43  */
44 void Eat(std::istream& is, int delim );
45
46 /** 
47  * Eats characters of the stream as long as they satisfy the description in descript
48  * @param is a stream
49  * @param descript description string. A sequence of spaces, tabs, 
50  *           new-lines and comments is regarded as 1 space in the description string.
51  */
52 void Eat(std::istream& is,const char* descript);
53
54 /**
55  * Eats a word of the stream delimited by the letters in delim or space(tabs...)
56  * @param is a stream
57  * @param delim a string containing the delimmiting characters
58  * @param storage for returning the word
59  * @param maxsize a word can be maximally maxsize-1 long.
60  */
61 void EatWord(std::istream& is,const char* delim,char* storage,int maxsize);
62
63 /** 
64  * Eats characters of the stream until the character delim is encountered
65  * similar to Eat(is,delim) but spaces at the end are not read.
66  * @param is a stream
67  * @param delim eat until this character is encountered
68  */
69 void EatEnd( std::istream& is, int delim );
70
71
72
73
74 }
75
76
77 #endif