dynamo_1.3.0_956f1e71/src/gen-artifacts-docs.adb

  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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
-----------------------------------------------------------------------
--  gen-artifacts-docs -- Artifact for documentation
--  Copyright (C) 2012 - 2022 Stephane Carrez
--  Written by Stephane Carrez (Stephane.Carrez@gmail.com)
--
--  Licensed under the Apache License, Version 2.0 (the "License");
--  you may not use this file except in compliance with the License.
--  You may obtain a copy of the License at
--
--      http://www.apache.org/licenses/LICENSE-2.0
--
--  Unless required by applicable law or agreed to in writing, software
--  distributed under the License is distributed on an "AS IS" BASIS,
--  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
--  See the License for the specific language governing permissions and
--  limitations under the License.
-----------------------------------------------------------------------
with Util.Files;
with Util.Log.Loggers;
with Util.Strings;
with Util.Strings.Vectors;
with Util.Streams.Pipes;
with Util.Streams.Texts;
with Util.Processes;

with Ada.Directories;
with Ada.Strings.Fixed;
with Ada.Characters.Handling;
with Ada.Strings.Maps;
with Ada.Exceptions;

with Gen.Utils;

with Gen.Artifacts.Docs.Googlecode;
with Gen.Artifacts.Docs.Markdown;
package body Gen.Artifacts.Docs is

   use Util.Log;
   use type Ada.Strings.Maps.Character_Set;

   Log : constant Loggers.Logger := Loggers.Create ("Gen.Artifacts.Docs");

   Spaces : constant Ada.Strings.Maps.Character_Set
     := Ada.Strings.Maps.To_Set (' ')
     or Ada.Strings.Maps.To_Set (ASCII.HT)
     or Ada.Strings.Maps.To_Set (ASCII.VT)
     or Ada.Strings.Maps.To_Set (ASCII.CR)
     or Ada.Strings.Maps.To_Set (ASCII.LF);

   Google_Formatter   : aliased Gen.Artifacts.Docs.Googlecode.Document_Formatter;
   Markdown_Formatter : aliased Gen.Artifacts.Docs.Markdown.Document_Formatter;

   --  Get the header level of the line if the line is a header.
   --  Returns 0 if the line is not a header.
   function Get_Header_Level (Line : in String) return Natural;

   --  Get the header from the line, removing any markup.
   function Get_Header (Line : in String) return String;

   --  ------------------------------
   --  Prepare the model after all the configuration files have been read and before
   --  actually invoking the generation.
   --  ------------------------------
   overriding
   procedure Prepare (Handler : in out Artifact;
                      Model   : in out Gen.Model.Packages.Model_Definition'Class;
                      Project : in out Gen.Model.Projects.Project_Definition'Class;
                      Context : in out Generator'Class) is
      pragma Unreferenced (Model, Project);
   begin
      Handler.Generate (Context);
   end Prepare;

   procedure Generate (Handler : in out Artifact;
                       Context : in out Generator'Class) is
      Docs    : Doc_Maps.Map;
      Name    : constant String := (if Handler.Format = DOC_WIKI_GOOGLE
                                    then "generator.doc.xslt.command"
                                    else "generator.markdown.xslt.command");
      Command : constant String := Context.Get_Parameter (Name);
   begin
      Log.Info ("Using command: {0}", Command);

      Handler.Xslt_Command := To_UString (Command);
      Handler.Scan_Files ("src", Docs);
      Handler.Scan_Files ("config", Docs);
      Handler.Scan_Files ("db", Docs);
      Handler.Scan_Files ("plugins", Docs);
      Handler.Generate (Docs, Context.Get_Result_Directory);
   end Generate;

   --  ------------------------------
   --  Set the output document format to generate.
   --  ------------------------------
   procedure Set_Format (Handler : in out Artifact;
                         Format  : in Doc_Format;
                         Footer  : in Boolean) is
   begin
      Handler.Format := Format;
      Handler.Print_Footer := Footer;
      case Format is
         when DOC_WIKI_GOOGLE =>
            Handler.Formatter := Google_Formatter'Access;

         when DOC_MARKDOWN =>
            Handler.Formatter := Markdown_Formatter'Access;

      end case;
   end Set_Format;

   --  ------------------------------
   --  Load from the file a list of link definitions which can be injected in the generated doc.
   --  This allows to avoid polluting the Ada code with external links.
   --  ------------------------------
   procedure Read_Links (Handler : in out Artifact;
                         Path    : in String) is
      use Ada.Strings.Fixed;
      procedure Read (Line : in String);
      procedure Read (Line : in String) is
         Pos : constant Natural := Util.Strings.Rindex (Line, ' ');
      begin
         if Pos > 0 and then Line (Line'First) /= '#' then
            Handler.Formatter.Links.Include
              (Key      => Trim (Line (Line'First .. Pos), Ada.Strings.Both),
               New_Item => Trim (Line (Pos .. Line'Last), Ada.Strings.Both));
         end if;
      end Read;
   begin
      if Ada.Directories.Exists (Path) then
         Log.Info ("Reading documentation links file {0}", Path);
         Util.Files.Read_File (Path, Read'Access);
      end if;
   end Read_Links;

   --  ------------------------------
   --  Include the document extract represented by <b>Name</b> into the document <b>Into</b>.
   --  The included document is marked so that it will not be generated.
   --  ------------------------------
   procedure Include (Docs     : in out Doc_Maps.Map;
                      Source   : in String;
                      Into     : in out File_Document;
                      Name     : in String;
                      Mode     : in Line_Include_Kind;
                      Position : in Natural) is
      --  Include the lines from the document into another.
      procedure Do_Include (Source : in String;
                            Doc    : in out File_Document);

      --  ------------------------------
      --  Include the lines from the document into another.
      --  ------------------------------
      procedure Do_Include (Source : in String;
                            Doc    : in out File_Document) is
         Last_Kind : Line_Kind := L_LIST;
      begin
         Log.Debug ("Merge {0} in {1}", Source, To_String (Into.Name));
         for Line of reverse Doc.Lines (Mode) loop
            Last_Kind := Line.Kind;
            Into.Lines (L_INCLUDE).Insert (Before   => Position,
                                           New_Item => Line);
         end loop;
         Doc.Was_Included := True;
         if Last_Kind /= L_TEXT then
            Into.Lines (L_INCLUDE).Insert (Before => Position,
                                           New_Item => (Len => 0,
                                                        Kind => L_TEXT,
                                                        Content => ""));
         end if;
      end Do_Include;

      Pos  : constant Doc_Maps.Cursor := Docs.Find (Name);
      Line : Natural;
   begin
      if not Doc_Maps.Has_Element (Pos) then
         Line := Into.Line_Number + Natural (Into.Lines (L_INCLUDE).Length) - Position;
         Log.Error ("{0}:{1}: Cannot include document '{2}'",
                    Source, Util.Strings.Image (Line), Name);
         return;
      end if;
      Docs.Update_Element (Pos, Do_Include'Access);
   end Include;

   --  ------------------------------
   --  Generate the project documentation that was collected in <b>Docs</b>.
   --  The documentation is merged so that the @include tags are replaced by the matching
   --  document extracts.
   --  ------------------------------
   procedure Generate (Handler : in out Artifact;
                       Docs    : in out Doc_Maps.Map;
                       Dir     : in String) is

      --  Scan for external documents to include.
      procedure Scan_For_Documents (Docs : in out Doc_Maps.Map);

      --  Merge the documentation.
      procedure Merge (Source : in String;
                       Doc    : in out File_Document);

      --  Generate the documentation.
      procedure Generate (Source : in String;
                          Doc    : in File_Document);

      --  ------------------------------
      --  Merge the documentation.
      --  ------------------------------
      procedure Merge (Source : in String;
                       Doc    : in out File_Document) is
         Pos : Natural := 1;
      begin
         while Pos <= Natural (Doc.Lines (L_INCLUDE).Length) loop
            declare
               L : constant Line_Type := Line_Vectors.Element (Doc.Lines (L_INCLUDE), Pos);
            begin
               if L.Kind in L_INCLUDE | L_INCLUDE_QUERY |
               L_INCLUDE_PERMISSION | L_INCLUDE_CONFIG |
               L_INCLUDE_BEAN
               then
                  Line_Vectors.Delete (Doc.Lines (L_INCLUDE), Pos);
                  Include (Docs, Source, Doc, L.Content, L.Kind, Pos);
               elsif L.Kind = L_INCLUDE_DOC then
                  Line_Vectors.Delete (Doc.Lines (L_INCLUDE), Pos);
                  Include (Docs, Source, Doc, L.Content, L_INCLUDE, Pos);
               else
                  Pos := Pos + 1;
               end if;
            end;
         end loop;
      end Merge;

      --  ------------------------------
      --  Generate the documentation.
      --  ------------------------------
      procedure Generate (Source : in String;
                          Doc    : in File_Document) is
         Name       : constant String := Doc.Formatter.Get_Document_Name (Doc);
         Path       : constant String := Util.Files.Compose (Dir, Name);
         File       : Ada.Text_IO.File_Type;
         Prev_Empty : Boolean := False;
         Is_Empty   : Boolean;
      begin
         if Doc.Lines (L_INCLUDE).Is_Empty or else Doc.Was_Included then
            return;
         end if;

         Log.Info ("Generating doc {0}", Path);
         Ada.Directories.Create_Path (Dir);

         Ada.Text_IO.Create (File => File,
                             Mode => Ada.Text_IO.Out_File,
                             Name => Path);
         Doc.Formatter.Start_Document (Document => Doc,
                                       File     => File);

         for Line of Doc.Lines (L_INCLUDE) loop
            Is_Empty := Line.Len = 0 and then Line.Kind = L_TEXT;
            if not Prev_Empty or not Is_Empty then
               Doc.Formatter.Write_Line (File => File,
                                         Line => Line);
            end if;
            Prev_Empty := Is_Empty;
         end loop;
         Doc.Formatter.Finish_Document (Document => Doc,
                                        File     => File,
                                        Source   => Source);
         Ada.Text_IO.Close (File);
      end Generate;

      procedure Scan_For_Documents (Docs : in out Doc_Maps.Map) is
         procedure Scan (Doc : in out File_Document);

         Scan_List : Doc_Maps.Map := Docs;
         List      : Util.Strings.Vectors.Vector;

         procedure Scan (Doc : in out File_Document) is
            Pos : Natural := 1;
         begin
            while Pos <= Natural (Doc.Lines (L_INCLUDE).Length) loop
               declare
                  L : constant Line_Type := Line_Vectors.Element (Doc.Lines (L_INCLUDE), Pos);
               begin
                  if L.Kind = L_INCLUDE_DOC and then not Docs.Contains (L.Content) then
                     if not Ada.Directories.Exists (L.Content) then
                        Log.Error ("{0}: Cannot include document: {1}",
                                   To_String (Doc.Name), L.Content);
                        Line_Vectors.Delete (Doc.Lines (L_INCLUDE), Pos);
                     else
                        List.Append (L.Content);
                        Pos := Pos + 1;
                     end if;
                  else
                     Pos := Pos + 1;
                  end if;
               end;
            end loop;
         end Scan;

      begin
         loop
            for Doc of Scan_List loop
               Scan (Doc);
            end loop;
            exit when List.Is_Empty;

            Scan_List.Clear;
            for Path of List loop
               declare
                  Doc       : File_Document;
               begin
                  Doc.Print_Footer := Handler.Print_Footer;
                  Doc.Formatter := Handler.Formatter;
                  Handler.Read_Doc_File (Path, Doc);
                  Docs.Include (Path, Doc);
                  Scan_List.Include (Path, Doc);
               end;
            end loop;
            List.Clear;
         end loop;
      end Scan_For_Documents;

      Iter : Doc_Maps.Cursor;
   begin
      Scan_For_Documents (Docs);

      --  First pass: merge the documentation.
      Iter := Docs.First;
      while Doc_Maps.Has_Element (Iter) loop
         Docs.Update_Element (Position => Iter, Process => Merge'Access);
         Doc_Maps.Next (Iter);
      end loop;

      --  Second pass: build the documentation.
      Iter := Docs.First;
      while Doc_Maps.Has_Element (Iter) loop
         Doc_Maps.Query_Element (Iter, Generate'Access);
         Doc_Maps.Next (Iter);
      end loop;
   end Generate;

   --  ------------------------------
   --  Scan the files in the directory referred to by <b>Path</b> and collect the documentation
   --  in the <b>Docs</b> hashed map.
   --  ------------------------------
   procedure Scan_Files (Handler : in out Artifact;
                         Path    : in String;
                         Docs    : in out Doc_Maps.Map) is
      use Ada.Directories;

      File_Filter  : constant Filter_Type := (Ordinary_File => True,
                                              Directory     => False,
                                              others        => False);
      Dir_Filter  : constant Filter_Type := (Ordinary_File => False,
                                             Directory     => True,
                                             others        => False);
      Ent     : Ada.Directories.Directory_Entry_Type;
      Search  : Search_Type;

   begin
      if not Ada.Directories.Exists (Path) then
         return;
      end if;
      Start_Search (Search, Directory => Path,
                    Pattern => "*", Filter => File_Filter);
      while More_Entries (Search) loop
         Get_Next_Entry (Search, Ent);
         declare
            Name      : constant String := Simple_Name (Ent);
            Full_Path : constant String := Ada.Directories.Full_Name (Ent);
            Doc       : File_Document;
            Pos       : constant Natural := Util.Strings.Rindex (Name, '.');
         begin
            if Gen.Utils.Is_File_Ignored (Name) or else Pos = 0 then
               Log.Debug ("File {0} ignored", Name);

            else
               Log.Debug ("Collect {0}", Full_Path);

               Doc.Print_Footer := Handler.Print_Footer;
               Doc.Formatter := Handler.Formatter;
               if Name (Pos .. Name'Last) in ".ads" | ".adb" then
                  Handler.Read_Ada_File (Full_Path, Doc);

               elsif Name (Pos .. Name'Last) = ".xml" then
                  Handler.Read_Xml_File (Full_Path, Doc);

               end if;
               Log.Info ("Adding document '{0}'", Name);
               Docs.Include (Name, Doc);
            end if;
         end;
      end loop;

      Start_Search (Search, Directory => Path,
                    Pattern => "*", Filter => Dir_Filter);
      while More_Entries (Search) loop
         Get_Next_Entry (Search, Ent);
         declare
            Name      : constant String := Simple_Name (Ent);
         begin
            if not Gen.Utils.Is_File_Ignored (Name)
              and then Name /= "regtests"
            then
               Handler.Scan_Files (Ada.Directories.Full_Name (Ent), Docs);
            end if;
         end;
      end loop;
   end Scan_Files;

   --  ------------------------------
   --  Returns True if the line indicates a bullet or numbered list.
   --  ------------------------------
   function Is_List (Line : in String) return Boolean is
   begin
      if Line'Length <= 3 then
         return False;
      elsif Line (Line'First) = '*' and then Line (Line'First + 1) = ' ' then
         return True;
      else
         return Line (Line'First .. Line'First + 3) = "  * ";
      end if;
   end Is_List;

   --  ------------------------------
   --  Returns True if the line indicates a code sample.
   --  ------------------------------
   function Is_Code (Line : in String) return Boolean is
   begin
      if Line'Length <= 3 then
         return False;
      else
         return Line (Line'First) =  ' ' and then Line (Line'First + 1) = ' ';
      end if;
   end Is_Code;

   --  ------------------------------
   --  Get the header level of the line if the line is a header.
   --  Returns 0 if the line is not a header.
   --  ------------------------------
   function Get_Header_Level (Line : in String) return Natural is
      Result : Natural := 0;
   begin
      for I in Line'Range loop
         exit when Line (I) /= '=';
         Result := Result + 1;
         exit when Result >= 4;
      end loop;
      return Result;
   end Get_Header_Level;

   --  ------------------------------
   --  Get the header from the line, removing any markup.
   --  ------------------------------
   function Get_Header (Line : in String) return String is
      Start  : Natural := Line'First;
      Finish : Natural := Line'Last;
   begin
      while Start < Finish and then Line (Start) in '=' | ' ' loop
         Start := Start + 1;
      end loop;
      while Start < Finish and then Line (Finish) in '=' | ' ' loop
         Finish := Finish - 1;
      end loop;
      return Line (Start .. Finish);
   end Get_Header;

   --  ------------------------------
   --  Append a raw text line to the document.
   --  ------------------------------
   procedure Append_Line (Doc  : in out File_Document;
                          Line : in String) is
      Level : Natural;
   begin
      if Doc.State = IN_LIST then
         Doc.Lines (L_INCLUDE).Append (Line_Type '(Len  => Line'Length,
                                                   Kind => L_LIST_ITEM,
                                                   Content => Line));
      else
         Level := Get_Header_Level (Line);
         if Level = 0 then
            Doc.Lines (L_INCLUDE).Append (Line_Type '(Len  => Line'Length,
                                                      Kind => L_TEXT,
                                                      Content => Line));
         else
            declare
               Header : constant String := Get_Header (Line);
            begin
               case Level is
                  when 1 =>
                     Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => Header'Length,
                                                               Kind => L_HEADER_1,
                                                               Content => Header));

                  when 2 =>
                     Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => Header'Length,
                                                               Kind => L_HEADER_2,
                                                               Content => Header));
                  when 3 =>
                     Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => Header'Length,
                                                               Kind => L_HEADER_3,
                                                               Content => Header));
                  when others =>
                     Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => Header'Length,
                                                               Kind => L_HEADER_4,
                                                               Content => Header));
               end case;
            end;
         end if;
      end if;
   end Append_Line;

   --  ------------------------------
   --  Look and analyze the tag defined on the line.
   --  ------------------------------
   procedure Append_Tag (Doc : in out File_Document;
                         Tag : in String) is

      --  Scan for document files matching a pattern and include them.
      procedure Include_Files (Path    : in String;
                               Pattern : in String);

      procedure Include_Files (Path    : in String;
                               Pattern : in String) is
         use Ada.Directories;

         File_Filter  : constant Filter_Type := (Ordinary_File => True,
                                                 Directory     => False,
                                                 others        => False);
         Ent     : Ada.Directories.Directory_Entry_Type;
         Search  : Search_Type;
         Files   : Gen.Utils.String_Set.Set;
      begin
         Log.Info ("Scanning {0} for document files matching {1}", Path, Pattern);

         if not Ada.Directories.Exists (Path) then
            Log.Error ("Cannot search documents from '{0}'", Path);
            return;
         end if;

         --  Step #1: collect the files matching the pattern.
         Start_Search (Search, Directory => Path,
                       Pattern => Pattern, Filter => File_Filter);
         while More_Entries (Search) loop
            Get_Next_Entry (Search, Ent);
            Files.Include (To_UString (Ada.Directories.Full_Name (Ent)));
         end loop;

         --  Step #2: iterate on the list of files sorted on their path
         for File of Files loop
            declare
               Path : constant String := To_String (File);
            begin
               Doc.Lines (L_INCLUDE).Append (Line_Type '(Len     => Path'Length,
                                                         Kind    => L_INCLUDE_DOC,
                                                         Content => Path));
            end;
         end loop;
      end Include_Files;

      Pos : constant Natural := Util.Strings.Index (Tag, ' ');
   begin
      if Pos = 0 then
         return;
      end if;
      declare
         Value : constant String := Ada.Strings.Fixed.Trim (Tag (Pos .. Tag'Last), Spaces, Spaces);
      begin
         if Tag (Tag'First .. Pos - 1) = TAG_TITLE then
            Doc.Title := To_UString (Value);

         elsif Tag (Tag'First .. Pos - 1) = TAG_SEE then
            Doc.Lines (L_INCLUDE).Append (Line_Type '(Len     => Value'Length,
                                          Kind    => L_SEE,
                                          Content => Value));

         elsif Tag (Tag'First .. Pos - 1) = TAG_INCLUDE then
            Doc.Lines (L_INCLUDE).Append (Line_Type '(Len     => Value'Length,
                                          Kind    => L_INCLUDE,
                                          Content => Value));

         elsif Tag (Tag'First .. Pos - 1) = TAG_INCLUDE_PERM then
            Doc.Lines (L_INCLUDE).Append (Line_Type '(Len     => Value'Length,
                                          Kind    => L_INCLUDE_PERMISSION,
                                          Content => Value));

         elsif Tag (Tag'First .. Pos - 1) = TAG_INCLUDE_CONFIG then
            Doc.Lines (L_INCLUDE).Append (Line_Type '(Len     => Value'Length,
                                          Kind    => L_INCLUDE_CONFIG,
                                          Content => Value));

         elsif Tag (Tag'First .. Pos - 1) = TAG_INCLUDE_BEAN then
            Doc.Lines (L_INCLUDE).Append (Line_Type '(Len     => Value'Length,
                                          Kind    => L_INCLUDE_BEAN,
                                          Content => Value));

         elsif Tag (Tag'First .. Pos - 1) = TAG_INCLUDE_QUERY then
            Doc.Lines (L_INCLUDE).Append (Line_Type '(Len     => Value'Length,
                                          Kind    => L_INCLUDE_QUERY,
                                          Content => Value));

         elsif Tag (Tag'First .. Pos - 1) = TAG_INCLUDE_DOC then
            declare
               Sep : constant Natural := Util.Strings.Index (Value, '*');
            begin
               if Sep = 0 then
                  Doc.Lines (L_INCLUDE).Append (Line_Type '(Len     => Value'Length,
                                                            Kind    => L_INCLUDE_DOC,
                                                            Content => Value));
               else
                  Include_Files (Value (Value'First .. Sep - 1),
                                 Value (Sep .. Value'Last));
               end if;
            end;

         else
            raise Unknown_Tag with Tag (Tag'First .. Pos - 1);
         end if;
      end;
   end Append_Tag;

   --  ------------------------------
   --  Analyse the documentation line and collect the documentation text.
   --  ------------------------------
   procedure Append (Doc   : in out File_Document;
                     Line  : in String) is
   begin
      if Line'Length >= 1 and then Line (Line'First) = TAG_CHAR then
         --  Force a close of the code extract if we see some @xxx command.
         if Doc.State in IN_CODE | IN_CODE_SEPARATOR then
            Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => 0,
                                                      Kind => L_END_CODE,
                                                      Content => ""));
            Append_Line (Doc, "");
         end if;
         Doc.State := IN_PARA;
         Append_Tag (Doc, Line (Line'First + 1 .. Line'Last));
         return;
      end if;

      case Doc.State is
         when IN_PARA =>
            if Line'Length = 0 then
               Doc.State := IN_SEPARATOR;

            elsif Is_List (Line) then
               Doc.State := IN_LIST;
            end if;
            Append_Line (Doc, Line);

         when IN_SEPARATOR =>
            if Is_List (Line) then
               Doc.State := IN_LIST;

            elsif Is_Code (Line) then
               Doc.State := IN_CODE;
               Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => 0,
                                                         Kind => L_START_CODE,
                                                         Content => ""));
            end if;
            Append_Line (Doc, Line);

         when IN_CODE =>
            if Line'Length = 0 then
               Doc.State := IN_CODE_SEPARATOR;
               return;
            end if;
            Append_Line (Doc, Line);

         when IN_CODE_SEPARATOR =>
            if Line'Length > 0 and
            then (Ada.Characters.Handling.Is_Letter (Line (Line'First))
                  or else Line (Line'First) = '=')
            then
               Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => 0,
                                                         Kind => L_END_CODE,
                                                         Content => ""));
               Append_Line (Doc, "");
               Doc.State := IN_PARA;
            end if;
            Append_Line (Doc, Line);

         when IN_LIST =>
            if Is_List (Line) then
               Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => Line'Length,
                                                         Kind => L_LIST_ITEM, Content => Line));

            elsif Line'Length = 0 then
               Doc.State := IN_SEPARATOR;
               Append_Line (Doc, Line);

            else
               Append_Line (Doc, " " & Ada.Strings.Fixed.Trim (Line, Ada.Strings.Left));
            end if;

      end case;
   end Append;

   --  ------------------------------
   --  After having collected the documentation, terminate the document by making sure
   --  the opened elements are closed.
   --  ------------------------------
   procedure Finish (Doc : in out File_Document) is
   begin
      if Doc.State in IN_CODE | IN_CODE_SEPARATOR then
         Doc.Lines (L_INCLUDE).Append (Line_Type '(Len => 0, Kind => L_END_CODE, Content => ""));
         Doc.State := IN_PARA;
      end if;
   end Finish;

   --  ------------------------------
   --  Set the name associated with the document extract.
   --  ------------------------------
   procedure Set_Name (Doc  : in out File_Document;
                       Name : in String) is
      S1 : String := Ada.Strings.Fixed.Trim (Name, Ada.Strings.Both);
   begin
      for I in S1'Range loop
         if S1 (I) in '.' | '/' | '\' then
            S1 (I) := '_';
         end if;
      end loop;
      Doc.Name := To_UString (S1);
   end Set_Name;

   --  ------------------------------
   --  Set the title associated with the document extract.
   --  ------------------------------
   procedure Set_Title (Doc   : in out File_Document;
                        Title : in String) is
      use Ada.Strings;

      Pos : Natural := Ada.Strings.Fixed.Index (Title, " -- ");
   begin
      if Pos = 0 then
         Pos := Title'First;
      else
         Pos := Pos + 4;
      end if;
      Doc.Title := To_UString (Fixed.Trim (Title (Pos .. Title'Last), Both));
   end Set_Title;

   --  ------------------------------
   --  Read the Ada specification/body file and collect the useful documentation.
   --  To keep the implementation simple, we don't use the ASIS packages to scan and extract
   --  the documentation.  We don't need to look at the Ada specification itself.  Instead,
   --  we assume that the Ada source follows some Ada style guidelines.
   --  ------------------------------
   procedure Read_Ada_File (Handler : in out Artifact;
                            File    : in String;
                            Result  : in out File_Document) is
      pragma Unreferenced (Handler);

      procedure Process (Line : in String);

      Done              : Boolean := False;
      Doc_Block         : Boolean := False;

      procedure Process (Line : in String) is
      begin
         if Done then
            return;
         end if;

         Result.Line_Number := Result.Line_Number + 1;
         if Line'Length <= 1 then
            Doc_Block := False;

         elsif Line (Line'Last) = ASCII.CR then
            Result.Line_Number := Result.Line_Number - 1;
            Process (Line (Line'First .. Line'Last - 1));

         elsif Line (Line'First) = '-' and then Line (Line'First + 1) = '-' then
            if Doc_Block then
               if Line'Length < 4 then
                  Append (Result, "");

               elsif Line (Line'First + 2) = ' ' and then Line (Line'First + 3) = ' ' then
                  Append (Result, Line (Line'First + 4 .. Line'Last));
               end if;
            elsif Line'Length >= 5 and then Line (Line'First .. Line'First + 4) = "--  =" then
               Doc_Block := True;
               Append (Result, Line (Line'First + 4 .. Line'Last));

            elsif Result.Line_Number = 2 then
               Set_Title (Result, Line (Line'First + 2 .. Line'Last));

            end if;

         else
            declare
               Pos  : Natural := Ada.Strings.Fixed.Index (Line, "package");
               Last : Natural;
            begin
               if Pos > 0 then
                  Done := True;
                  Pos := Ada.Strings.Fixed.Index (Line, " ", Pos);
                  if Pos > 0 then
                     Last := Ada.Strings.Fixed.Index (Line, " ", Pos + 1);
                     if Ada.Strings.Fixed.Index (Line (Pos .. Last), "body") = 0 then
                        Set_Name (Result,  Line (Pos .. Last));
                     else
                        Pos := Last;
                        Last := Ada.Strings.Fixed.Index (Line, " ", Pos + 1);
                        Set_Name (Result,  Line (Pos .. Last));
                     end if;
                  end if;
               end if;
            end;

         end if;

      exception
         when E : Unknown_Tag =>
            Log.Error ("{0}:{1}: Unknown comment tag '@{2}'",
                       Ada.Directories.Base_Name (File),
                       Util.Strings.Image (Result.Line_Number),
                       Ada.Exceptions.Exception_Message (E));
      end Process;
   begin
      Util.Files.Read_File (File, Process'Access);
      Finish (Result);
   end Read_Ada_File;

   --  ------------------------------
   --  Read the XML file and extract the documentation.  For this extraction we use
   --  an XSLT stylesheet and run the external tool <b>xstlproc</b>.
   --  ------------------------------
   procedure Read_Xml_File (Handler : in out Artifact;
                            File    : in String;
                            Result  : in out File_Document) is
      function Find_Mode (Line : in String) return Line_Include_Kind;
      procedure Append (Line : in UString);

      Is_Empty       : Boolean := True;
      Current_Mode   : Line_Include_Kind := L_INCLUDE;

      function Find_Mode (Line : in String) return Line_Include_Kind is
      begin
         if Line = "### Permissions" then
            return L_INCLUDE_PERMISSION;
         elsif Line = "### Queries" then
            return L_INCLUDE_QUERY;
         elsif Line = "### Beans" or else Line = "### Mapping" then
            return L_INCLUDE_BEAN;
         elsif Line = "### Configuration" then
            return L_INCLUDE_CONFIG;
         else
            return L_INCLUDE;
         end if;
      end Find_Mode;

      procedure Append (Line : in UString) is
         Content : constant String := To_String (Line);
         Trimmed : constant String := Ada.Strings.Fixed.Trim (Content, Spaces, Spaces);
         Mode    : constant Line_Include_Kind := Find_Mode (Content);
      begin
         if Trimmed'Length > 0 then
            Is_Empty := False;
         end if;
         Result.Lines (L_INCLUDE).Append (Line_Type '(Len  => Trimmed'Length,
                                                      Kind => L_TEXT,
                                                      Content => Trimmed));
         if Mode /= L_INCLUDE then
            Current_Mode := Mode;
            return;
         end if;
         if Current_Mode /= L_INCLUDE then
            Result.Lines (Current_Mode).Append (Line_Type '(Len  => Trimmed'Length,
                                                            Kind => L_TEXT,
                                                            Content => Trimmed));
         end if;
      end Append;

      Pipe    : aliased Util.Streams.Pipes.Pipe_Stream;
      Reader  : Util.Streams.Texts.Reader_Stream;
      Name    : constant String := Ada.Directories.Base_Name (File);
      Command : constant String := To_String (Handler.Xslt_Command);
   begin
      Log.Info ("Running {0} {1}", Command, File);
      Pipe.Open (Command & " " & File, Util.Processes.READ);
      Reader.Initialize (Pipe'Unchecked_Access);

      while not Reader.Is_Eof loop
         declare
            Line : UString;
         begin
            Reader.Read_Line (Line, True);
            Log.Debug ("Doc: {0}", Line);

            Append (Line);
         end;
      end loop;
      Pipe.Close;
      Set_Title (Result, Name);
      Set_Name (Result, Name);
      if Pipe.Get_Exit_Status /= 0 then
         Log.Error ("Command {0} exited with status {1}", Command,
                    Integer'Image (Pipe.Get_Exit_Status));
      end if;
      if Is_Empty then
         Line_Vectors.Clear (Result.Lines (L_INCLUDE));
      end if;

   exception
      when E : Util.Processes.Process_Error =>
         Log.Error ("Command {0} failed: {1}", Command, Ada.Exceptions.Exception_Message (E));
   end Read_Xml_File;

   --  ------------------------------
   --  Read some general purpose documentation files.  The documentation file
   --  can be integrated and merged by using the @include-doc tags and it may
   --  contain various @ tags.
   --  ------------------------------
   procedure Read_Doc_File (Handler : in out Artifact;
                            File    : in String;
                            Result  : in out File_Document) is
      pragma Unreferenced (Handler);

      procedure Process (Line : in String);

      procedure Process (Line : in String) is
      begin
         Result.Line_Number := Result.Line_Number + 1;
         Append (Result, Line);
         Result.State := IN_PARA;

      exception
         when E : Unknown_Tag =>
            Log.Error ("{0}:{1}: Unknown comment tag '@{2}'",
                       Ada.Directories.Base_Name (File),
                       Util.Strings.Image (Result.Line_Number),
                       Ada.Exceptions.Exception_Message (E));
      end Process;
   begin
      Util.Files.Read_File (File, Process'Access);
      Finish (Result);
   end Read_Doc_File;

end Gen.Artifacts.Docs;