home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gnat-2.06-src.tgz / tar.out / fsf / gnat / ada / krunch.ads < prev    next >
Text File  |  1996-09-28  |  6KB  |  122 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                               K R U N C H                                --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.8 $                              --
  10. --                                                                          --
  11. --        Copyright (c) 1992,1993,1994,1995 NYU, All Rights Reserved        --
  12. --                                                                          --
  13. -- The GNAT library is free software; you can redistribute it and/or modify --
  14. -- it under terms of the GNU Library General Public License as published by --
  15. -- the Free Software  Foundation; either version 2, or (at your option) any --
  16. -- later version.  The GNAT library is distributed in the hope that it will --
  17. -- be useful, but WITHOUT ANY WARRANTY;  without even  the implied warranty --
  18. -- of MERCHANTABILITY  or  FITNESS FOR  A PARTICULAR PURPOSE.  See the  GNU --
  19. -- Library  General  Public  License for  more  details.  You  should  have --
  20. -- received  a copy of the GNU  Library  General Public License  along with --
  21. -- the GNAT library;  see the file  COPYING.LIB.  If not, write to the Free --
  22. -- Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.        --
  23. --                                                                          --
  24. ------------------------------------------------------------------------------
  25.  
  26. --  This procedure implements file name crunching
  27.  
  28. --    First, the name is divided into segments separated by minus signs and
  29. --    underscores, then all minus signs and underscores are eliminated. If
  30. --    this leaves the name short enough, we are done.
  31.  
  32. --    If not, then the longest segment is located (left-most if there are
  33. --    two of equal length), and shortened by dropping its last character.
  34. --    This is repeated until the name is short enough.
  35.  
  36. --    As an example, consider the krunch of our-strings-wide_fixed.adb
  37. --    to fit the name into 8 characters as required by DOS:
  38.  
  39. --      our-strings-wide_fixed      22
  40. --      our strings wide fixed      19
  41. --      our string  wide fixed      18
  42. --      our strin   wide fixed      17
  43. --      our stri    wide fixed      16
  44. --      our stri    wide fixe       15
  45. --      our str     wide fixe       14
  46. --      our str     wid  fixe       13
  47. --      our str     wid  fix        12
  48. --      ou  str     wid  fix        11
  49. --      ou  st      wid  fix        10
  50. --      ou  st      wi   fix         9
  51. --      ou  st      wi   fi          8
  52.  
  53. --      Final file name: OUSTWIFX.ADB
  54.  
  55. --    A special rule applies for children of System, Ada, Gnat, and Interfaces.
  56. --    In these cases, the following special prefix replacements occur:
  57.  
  58. --       ada-        replaced by  a-
  59. --       gnat-       replaced by  g-
  60. --       interfaces- replaced by  i-
  61. --       system-     replaced by  s-
  62.  
  63. --    The rest of the name is krunched in the usual manner described above.
  64. --    In addition, these names, as well as the names of the renamed packages
  65. --    from the obsolescent features annex, are always krunched to 8 characters
  66. --    regardless of the setting of Maxlen.
  67.  
  68. --    As an example of this special rule, consider ada-strings-wide_fixed.adb
  69. --    which gets krunched as follows:
  70.  
  71. --      ada-strings-wide_fixed      22
  72. --      a-  strings wide fixed      18
  73. --      a-  string  wide fixed      17
  74. --      a-  strin   wide fixed      16
  75. --      a-  stri    wide fixed      15
  76. --      a-  stri    wide fixe       14
  77. --      a-  str     wide fixe       13
  78. --      a-  str     wid  fixe       12
  79. --      a-  str     wid  fix        11
  80. --      a-  st      wid  fix        10
  81. --      a-  st      wi   fix         9
  82. --      a-  st      wi   fi          8
  83.  
  84. --      Final file name: A-STWIFX.ADB
  85.  
  86. --  Since children of units named A, G, I or S might conflict with the names
  87. --  of predefined units, the naming rule in that case is that the first hyphen
  88. --  is replaced by a plus sign.
  89.  
  90. --  Note: as described below, this special treatment of predefined library
  91. --  unit file names can be inhibited by setting the No_Predef flag.
  92.  
  93. --  Of course there is no guarantee that this algorithm results in uniquely
  94. --  crunched names (nor, obviously, is there any algorithm which would do so)
  95. --  In fact we run into such a case in the standard library routines with
  96. --  children of Text_IO.Wide_Text_IO, so a special rule is applied to deal
  97. --  with this clash, namely the prefix ada-text_io-wide_text_io- is replaced
  98. --  by a-wt- and then the normal crunching rules are applied, so that for
  99. --  example, the unit:
  100.  
  101. --    Ada.Text_IO.Wide_Text_IO.Float_IO
  102.  
  103. --  has the file name
  104.  
  105. --    a-wtflio
  106.  
  107. --  This is the only irregularity required (so far!) to keep the file names
  108. --  unique in the standard predefined libraries.
  109.  
  110. procedure Krunch
  111.   (Buffer    : in out String;
  112.    Len       : in out Natural;
  113.    Maxlen    : Natural;
  114.    No_Predef : Boolean);
  115. --  The full file name is stored in Buffer (1 .. Len) on entry. The file
  116. --  name is crunched in place and on return Len is updated, so that the
  117. --  resulting krunched name is in Buffer (1 .. Len) where Len <= Maxlen.
  118. --  Note that Len may be less than or equal to Maxlen on entry, in which
  119. --  case it may be possible that Krunch does not modify Buffer. The fourth
  120. --  parameter, No_Predef, is a switch which, if set to True, disables the
  121. --  normal special treatment of predefined library unit file names.
  122.