GPLization banner introduced to *.[hc] files
[sip-router] / trim.h
1 /* $Id$ */
2 /*
3  *
4  * Copyright (C) 2001-2003 Fhg Fokus
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License 
24  * along with this program; if not, write to the Free Software 
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  */
27
28
29 #ifndef TRIM_H
30 #define TRIM_H
31
32 #include "str.h"
33
34
35 /*
36  * This switch-case statement is used in
37  * trim_leading and trim_trailing. You can
38  * define char that should be skipped here.
39  */
40 #define TRIM_SWITCH(c) switch(c) {     \
41                        case ' ':       \
42                        case '\t':      \
43                        case '\r':      \
44                        case '\n':      \
45                                break;  \
46                                        \
47                        default:        \
48                                return; \
49                        }
50
51
52 /*
53  * Remove any leading whitechars, like spaces,
54  * horizontal tabs, carriage returns and line
55  * feeds
56  *
57  * WARNING: String descriptor structure will be
58  *          modified ! Make a copy otherwise you
59  *          might be unable to free _s->s for
60  *          example !
61  *
62  */
63 static inline void trim_leading(str* _s)
64 {
65         for(; _s->len > 0; _s->len--, _s->s++) {
66                 TRIM_SWITCH(*(_s->s));
67         }
68 }
69
70
71 /*
72  * Remove any trailing white char, like spaces,
73  * horizontal tabs, carriage returns and line feeds
74  *
75  * WARNING: String descriptor structure will be
76  *          modified ! Make a copy otherwise you
77  *          might be unable to free _s->s for
78  *          example !
79  */
80 static inline void trim_trailing(str* _s)
81 {
82         for(; _s->len > 0; _s->len--) {
83                 TRIM_SWITCH(_s->s[_s->len - 1]);
84         }
85 }
86
87
88 /*
89  * Do trim_leading and trim_trailing
90  *
91  * WARNING: String structure will be modified !
92  *          Make a copy otherwise you might be
93  *          unable to free _s->s for example !
94  */
95 static inline void trim(str* _s)
96 {
97         trim_leading(_s);
98         trim_trailing(_s);
99 }
100
101
102 #endif /* TRIM_H */