lib/SQL/Translator/Parser.pm

   1 package SQL::Translator::Parser;
   2
   3 # ----------------------------------------------------------------------
   4 # $Id: Parser.pm,v 1.1.1.1.2.1 2002-03-15 20:13:46 dlc Exp $
   5 # ----------------------------------------------------------------------
   6 # Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
   7 #                    darren chamberlain <darren@cpan.org>
   8 #
   9 # This program is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU General Public License as
  11 # published by the Free Software Foundation; version 2.
  12 #
  13 # This program is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  21 # 02111-1307  USA
  22 # ----------------------------------------------------------------------
  23
  24 use strict;
  25 use vars qw( $VERSION );
  26 $VERSION = sprintf "%d.%02d", q$Revision: 1.1.1.1.2.1 $ =~ /(\d+)\.(\d+)/;
  27
  28 sub parse { "" }
  29
  30 1;
  31
  32 #-----------------------------------------------------
  33 # Enough! or Too much.
  34 # William Blake
  35 #-----------------------------------------------------
  36
  37 =head1 NAME
  38
  39 SQL::Translator::Parser - base object for parsers
  40
  41 =head1 DESCRIPTION
  42
  43 Parser modules that get invoked by SQL::Translator need to implement
  44 a single function: B<parse>.  This function will be called by the
  45 SQL::Translator instance as $class::parse($data_as_string).  Other
  46 than that, the classes are free to define any helper functions, or
  47 use any design pattern internally that make the most sense.
  48
  49 =head1 AUTHOR
  50
  51 Ken Y. Clark, kclark@logsoft.com
  52
  53 =head1 SEE ALSO
  54
  55 perl(1).
  56
  57 =cut