File: ad-printers-xml.ads

package info (click to toggle)
adabrowse 4.0.2-5
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 2,332 kB
  • ctags: 253
  • sloc: ada: 29,773; makefile: 160; ansic: 4
file content (258 lines) | stat: -rw-r--r-- 7,047 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
-------------------------------------------------------------------------------
--
--  This file is part of AdaBrowse.
--
-- <STRONG>Copyright (c) 2002 by Thomas Wolf.</STRONG>
-- <BLOCKQUOTE>
--    AdaBrowse is free software; you can redistribute it and/or modify it
--    under the terms of the  GNU General Public License as published by the
--    Free Software  Foundation; either version 2, or (at your option) any
--    later version. AdaBrowse is distributed in the hope that it will be
--    useful, but <EM>without any warranty</EM>; without even the implied
--    warranty of <EM>merchantability or fitness for a particular purpose.</EM>
--    See the GNU General Public License for  more details. You should have
--    received a copy of the GNU General Public License with this distribution,
--    see file "<A HREF="GPL.txt">GPL.txt</A>". If not, write to the Free
--    Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
--    USA.
-- </BLOCKQUOTE>
--
-- <DL><DT><STRONG>
-- Author:</STRONG><DD>
--   Thomas Wolf  (TW)
--   <ADDRESS><A HREF="mailto:twolf@acm.org">twolf@acm.org</A></ADDRESS></DL>
--
-- <DL><DT><STRONG>
-- Purpose:</STRONG><DD>
--   Abstract root type for the various output producers (HTML, XML, DocBook,
--   and so on).</DL>
--
-- <!--
-- Revision History
--
--   22-JUL-2002   TW  Initial version.
--   30-MAY-2003   TW  Added the 'Is_Private' parameter for 'Open_Unit' and
--                     'Add_Child'.
--   07-JUL-2003   TW  Rewrote the indexing stuff completely.
-- -->
-------------------------------------------------------------------------------

pragma License (GPL);

with Asis.Text;

with AD.Crossrefs;

package AD.Printers.XML is

   pragma Elaborate_Body;

   type Printer is new AD.Printers.Printer with private;

   procedure Open_Unit
     (Self       : access Printer;
      Unit_Kind  : in     Item_Kind;
      Unit_Name  : in     Wide_String;
      Is_Private : in     Boolean;
      XRef       : in     AD.Crossrefs.Cross_Reference);

   procedure Close_Unit
     (Self : access Printer);

   procedure Write_Comment
     (Self  : access Printer;
      Lines : in     Asis.Text.Line_List);

   procedure Open_Section
     (Self    : access Printer;
      Section : in     Section_Type);

   procedure Close_Section
     (Self    : access Printer;
      Section : in     Section_Type);

   procedure Open_Item
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference;
      Kind : in     Item_Kind   := Not_An_Item;
      Name : in     Wide_String := "");

   procedure Close_Item
     (Self    : access Printer;
      Is_Last : in     Boolean := False);

   procedure Other_Declaration
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference;
      Text : in     String);

   procedure Open_Container
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference;
      Kind : in     Item_Kind;
      Name : in     Wide_String := "");

   procedure Close_Container
     (Self    : access Printer;
      Is_Last : in     Boolean := False);

   procedure Add_Child
     (Self       : access Printer;
      Kind       : in     Item_Kind;
      Is_Private : in     Boolean;
      XRef       : in     AD.Crossrefs.Cross_Reference);

   procedure Add_Exception
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference);

   procedure Type_Name
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference);

   procedure Type_Kind
     (Self : access Printer;
      Info : in     String);

   procedure Parent_Type
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference);

   procedure Open_Operation_List
     (Self : access Printer;
      Kind : in     Operation_Kind);

   procedure Close_Operation_List
     (Self : access Printer);

   procedure Add_Type_Operation
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference);

   procedure Add_Private
     (Self        : access Printer;
      For_Package : in     Boolean);

   procedure Open_Anchor
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference);

   procedure Close_Anchor
     (Self : access Printer);

   procedure Open_XRef
     (Self : access Printer;
      XRef : in     AD.Crossrefs.Cross_Reference);

   procedure Close_XRef
     (Self : access Printer);

   procedure Put_XRef
     (Self     : access Printer;
      XRef     : in     AD.Crossrefs.Cross_Reference;
      Code     : in     Boolean := True;
      Is_Index : in     Boolean := False);
   --  Open_XRef, emit XRef.Image, Close_XRef.

   procedure Inline_Error
     (Self : access Printer;
      Msg  : in     String);

   ----------------------------------------------------------------------------
   --  Basic inline elements.

   procedure Write_Keyword
     (Self : access Printer;
      S    : in     String);

   procedure Write_Literal
     (Self : access Printer;
      S    : in     String);

   procedure Write_Attribute
     (Self : access Printer;
      S    : in     String);

   procedure Write_Comment
     (Self : access Printer;
      S    : in     String);

   procedure Write
     (Self : access Printer;
      S    : in     String);

   procedure Write_Plain
     (Self : access Printer;
      S    : in     String);

   procedure Write_Code
     (Self : access Printer;
      S    : in     String);

   ----------------------------------------------------------------------------

   procedure Open_Index
     (Self      : access Printer;
      File_Name : in     String;
      Title     : in     String;
      Present   : in     Ada.Strings.Maps.Character_Set);

   procedure Close_Index
     (Self : access Printer);

   procedure XRef_Index
     (Self      : access Printer;
      File_Name : in     String;
      Title     : in     String);

   procedure Open_Char_Section
     (Self : access Printer;
      Char : in     Character);

   procedure Close_Char_Section
     (Self : access Printer);

   procedure Open_Index_Structure
     (Self : access Printer);

   procedure Close_Index_Structure
     (Self : access Printer);

   procedure Open_Index_Item
     (Self : access Printer);

   procedure Close_Index_Item
     (Self : access Printer);

private

   type Printer is new AD.Printers.Real_Printer with
      record
         Initial          : Boolean := True;
         Indent           : Natural := 0;
         No_XRef          : Boolean := False;
         Idx_Section_Open : Boolean := False;
      end record;

   procedure Finalize
     (Self : in out Printer);

   function Get_Suffix
     (Self : in Printer)
     return String;

   procedure Emit_XRef_Data
     (Self   : access Printer;
      XRef   : in     AD.Crossrefs.Cross_Reference;
      Anchor : in     Boolean := False);

   procedure Put_XRef
     (Self   : access Printer;
      Tag    : in     String;
      XRef   : in     AD.Crossrefs.Cross_Reference;
      Anchor : in     Boolean := False);

   procedure Indent
     (Self : access Printer);

end AD.Printers.XML;