gcc/ada/g-regexp.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                          G N A T . R E G E X P                           --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                     Copyright (C) 1998-2010, AdaCore                     --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  17 --                                                                          --
  18 -- As a special exception under Section 7 of GPL version 3, you are granted --
  19 -- additional permissions described in the GCC Runtime Library Exception,   --
  20 -- version 3.1, as published by the Free Software Foundation.               --
  21 --                                                                          --
  22 -- You should have received a copy of the GNU General Public License and    --
  23 -- a copy of the GCC Runtime Library Exception along with this program;     --
  24 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  25 -- <http://www.gnu.org/licenses/>.                                          --
  26 --                                                                          --
  27 -- GNAT was originally developed  by the GNAT team at  New York University. --
  28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  29 --                                                                          --
  30 ------------------------------------------------------------------------------
  31
  32 --  Simple Regular expression matching
  33
  34 --  This package provides a simple implementation of a regular expression
  35 --  pattern matching algorithm, using a subset of the syntax of regular
  36 --  expressions copied from familiar Unix style utilities.
  37
  38 --  See file s-regexp.ads for full documentation of the interface
  39
  40 ------------------------------------------------------------
  41 -- Summary of Pattern Matching Packages in GNAT Hierarchy --
  42 ------------------------------------------------------------
  43
  44 --  There are three related packages that perform pattern matching functions.
  45 --  the following is an outline of these packages, to help you determine
  46 --  which is best for your needs.
  47
  48 --     GNAT.Regexp (files g-regexp.ads/s-regexp.ads/s-regexp.adb)
  49 --       This is a simple package providing Unix-style regular expression
  50 --       matching with the restriction that it matches entire strings. It
  51 --       is particularly useful for file name matching, and in particular
  52 --       it provides "globbing patterns" that are useful in implementing
  53 --       unix or DOS style wild card matching for file names.
  54
  55 --     GNAT.Regpat (files g-regpat.ads/s-regpat.ads/g-regpat.adb)
  56 --       This is a more complete implementation of Unix-style regular
  57 --       expressions, copied from the original V7 style regular expression
  58 --       library written in C by Henry Spencer. It is functionally the
  59 --       same as this library, and uses the same internal data structures
  60 --       stored in a binary compatible manner.
  61
  62 --     GNAT.Spitbol.Patterns (files g-spipat.ads/g-spipat.adb)
  63 --       This is a completely general pattern matching package based on the
  64 --       pattern language of SNOBOL4, as implemented in SPITBOL. The pattern
  65 --       language is modeled on context free grammars, with context sensitive
  66 --       extensions that provide full (type 0) computational capabilities.
  67
  68 with System.Regexp;
  69
  70 package GNAT.Regexp renames System.Regexp;