| 1 | /* sb.h - header file for string buffer manipulation routines |
| 2 | Copyright (C) 1994-2016 Free Software Foundation, Inc. |
| 3 | |
| 4 | Written by Steve and Judy Chamberlain of Cygnus Support, |
| 5 | sac@cygnus.com |
| 6 | |
| 7 | This file is part of GAS, the GNU Assembler. |
| 8 | |
| 9 | GAS is free software; you can redistribute it and/or modify |
| 10 | it under the terms of the GNU General Public License as published by |
| 11 | the Free Software Foundation; either version 3, or (at your option) |
| 12 | any later version. |
| 13 | |
| 14 | GAS is distributed in the hope that it will be useful, |
| 15 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | GNU General Public License for more details. |
| 18 | |
| 19 | You should have received a copy of the GNU General Public License |
| 20 | along with GAS; see the file COPYING. If not, write to the Free |
| 21 | Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA |
| 22 | 02110-1301, USA. */ |
| 23 | |
| 24 | #ifndef SB_H |
| 25 | |
| 26 | #define SB_H |
| 27 | |
| 28 | /* String blocks |
| 29 | |
| 30 | I had a couple of choices when deciding upon this data structure. |
| 31 | gas uses null terminated strings for all its internal work. This |
| 32 | often means that parts of the program that want to examine |
| 33 | substrings have to manipulate the data in the string to do the |
| 34 | right thing (a common operation is to single out a bit of text by |
| 35 | saving away the character after it, nulling it out, operating on |
| 36 | the substring and then replacing the character which was under the |
| 37 | null). This is a pain and I remember a load of problems that I had with |
| 38 | code in gas which almost got this right. Also, it's harder to grow and |
| 39 | allocate null terminated strings efficiently. |
| 40 | |
| 41 | Obstacks provide all the functionality needed, but are too |
| 42 | complicated, hence the sb. |
| 43 | |
| 44 | An sb is allocated by the caller. */ |
| 45 | |
| 46 | typedef struct sb |
| 47 | { |
| 48 | char *ptr; /* Points to the current block. */ |
| 49 | size_t len; /* How much is used. */ |
| 50 | size_t max; /* The maximum length. */ |
| 51 | } |
| 52 | sb; |
| 53 | |
| 54 | extern void sb_new (sb *); |
| 55 | extern void sb_build (sb *, size_t); |
| 56 | extern void sb_kill (sb *); |
| 57 | extern void sb_add_sb (sb *, sb *); |
| 58 | extern void sb_scrub_and_add_sb (sb *, sb *); |
| 59 | extern void sb_reset (sb *); |
| 60 | extern void sb_add_char (sb *, size_t); |
| 61 | extern void sb_add_string (sb *, const char *); |
| 62 | extern void sb_add_buffer (sb *, const char *, size_t); |
| 63 | extern char *sb_terminate (sb *); |
| 64 | extern size_t sb_skip_white (size_t, sb *); |
| 65 | extern size_t sb_skip_comma (size_t, sb *); |
| 66 | |
| 67 | /* Actually in input-scrub.c. */ |
| 68 | extern void input_scrub_include_sb (sb *, char *, int); |
| 69 | |
| 70 | #endif /* SB_H */ |