]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - bfd/doc/proto.str
Remove RETURNS from BFD chew comments
[thirdparty/binutils-gdb.git] / bfd / doc / proto.str
1 - Source extraction program for chew.
2 - Copyright (C) 1990-2023 Free Software Foundation, Inc.
3 - This file is part of BFD, the Binary File Descriptor library.
4
5 - This program is free software; you can redistribute it and/or modify
6 - it under the terms of the GNU General Public License as published by
7 - the Free Software Foundation; either version 3 of the License, or
8 - (at your option) any later version.
9
10 - This program is distributed in the hope that it will be useful,
11 - but WITHOUT ANY WARRANTY; without even the implied warranty of
12 - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 - GNU General Public License for more details.
14
15 - You should have received a copy of the GNU General Public License
16 - along with this program; if not, write to the Free Software
17 - Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
18
19 : SYNOPSIS
20 skip_past_newline
21 get_stuff_in_command
22 indent
23 maybecatstr
24 ;
25
26 : ignore
27 skip_past_newline
28 get_stuff_in_command
29 outputdots
30 maybecatstr
31 ;
32
33 : CODE_FRAGMENT
34 ignore ;
35
36 : external
37 0 internalmode ! ignore ;
38
39 : internal
40 1 internalmode ! ignore ;
41
42 - input stack { a b } output b if internal, a if external
43 : ifinternal
44 "" swap 1 internalmode ! maybecatstr
45 swap
46 "" swap 0 internalmode ! maybecatstr
47 catstr
48 ;
49
50 - Put note in output string, regardless of internal mode.
51 : COMMENT
52 skip_past_newline
53 get_stuff_in_command
54 translatecomments
55 catstr
56 ;
57
58 - SENUM enum-type-name
59 - ENUM enum-name
60 - ENUMX addl-enum-name
61 - ENUMDOC doc for preceding enums
62 - ENDSENUM max-enum-name
63
64 : make_enum_header
65 dup
66 "enum " swap catstr
67 " {\n" catstr
68 swap " _dummy_first_" swap catstr catstr
69 ",\n" catstr
70 ;
71 : make_string_table_header
72 dup
73 "#ifdef _BFD_MAKE_TABLE_" swap catstr swap
74 "\n\nstatic const char *const " swap catstr catstr
75 "_names[] = { \"@@uninitialized@@\",\n" catstr
76 ;
77 : SENUM
78 skip_past_newline
79 copy_past_newline
80 remchar
81 dup
82 make_enum_header
83 swap
84 make_string_table_header
85 ifinternal
86 catstr
87 get_stuff_in_command catstr
88 translatecomments ;
89 : ENDSENUM
90 skip_past_newline
91 copy_past_newline strip_trailing_newlines
92 dup
93 " " swap catstr " };\n" catstr swap
94 " \"@@overflow: " swap catstr "@@\",\n};\n#endif\n\n" catstr
95 ifinternal
96 catstr
97 ;
98 : make_enumerator
99 " " swap catstr
100 ",\n" catstr
101 ;
102 : make_enumerator_string
103 " \"" swap catstr
104 "\",\n" catstr
105 ;
106 : ENUM
107 skip_past_newline
108 copy_past_newline
109 remchar
110 dup
111 make_enumerator
112 swap
113 make_enumerator_string
114 ifinternal
115 ;
116 : ENUMX ENUM catstr ;
117 : ENUMEQ
118 skip_past_newline
119 "#define "
120 copy_past_newline remchar
121 catstr
122 " "
123 catstr
124 copy_past_newline
125 catstr
126 "" swap 0 internalmode ! maybecatstr
127 ;
128 : ENUMEQX ENUMEQ catstr ;
129 : ENUMDOC
130 skip_past_newline
131 get_stuff_in_command
132 strip_trailing_newlines
133 "\n{* " swap catstr " *}\n" catstr
134 translatecomments
135 - discard it if we're doing internal mode
136 "" swap 0 internalmode ! maybecatstr
137 swap
138 catstr catstr
139 ;
140 : ENDDD external ;
141 : SECTION ignore ;
142 : SUBSECTION ignore ;
143 : SUBSUBSECTION ignore ;
144 : INTERNAL_DEFINITION internal ;
145 : DESCRIPTION ignore ;
146 : FUNCTION external ;
147 : TYPEDEF external ;
148 : INTERNAL_FUNCTION internal ;
149 : INTERNAL internal ;
150 : INODE ignore ;