lib/SQL/Translator/Producer/Latex.pm

   1 package SQL::Translator::Producer::Latex;
   2
   3 # -------------------------------------------------------------------
   4 # $Id: Latex.pm,v 1.1 2006-03-21 20:07:21 cmungall Exp $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2002-6 SQLFairy Authors
   7 #
   8 # This program is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU General Public License as
  10 # published by the Free Software Foundation; version 2.
  11 #
  12 # This program is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  20 # 02111-1307  USA
  21 # -------------------------------------------------------------------
  22
  23 =pod
  24
  25 =head1 NAME
  26
  27 SQL::Translator::Producer::Latex -
  28     Produces latex formatted tables ready for import from schema.
  29
  30 =head1 SYNOPSIS
  31
  32   use SQL::Translator;
  33   my $translator     = SQL::Translator->new(
  34       from           => 'MySQL',
  35       filename       => 'foo_schema.sql',
  36       to             => 'Latex',
  37   );
  38   print $translator->translate;
  39
  40 =head1 DESCRIPTION
  41
  42 Currently you will get one class (with the a table
  43 stereotype) generated per table in the schema. The fields are added as
  44 attributes of the classes and their datatypes set. It doesn't currently set any
  45 of the relationships. It doesn't do any layout, all the classses are in one big
  46 stack. However it is still useful as you can use the layout tools in Dia to
  47 automatically arrange them horizontally or vertically.
  48
  49 =head2 Producer Args
  50
  51 =over 4
  52
  53 =back
  54
  55 =cut
  56
  57 # -------------------------------------------------------------------
  58
  59 use strict;
  60
  61 use vars qw[ $DEBUG $VERSION @EXPORT_OK ];
  62 $VERSION = sprintf "%d.%02d", q$Revision: 1.1 $ =~ /(\d+)\.(\d+)/;
  63 $DEBUG   = 0 unless defined $DEBUG;
  64
  65 use SQL::Translator::Utils 'debug';
  66
  67 sub produce {
  68     my $translator     = shift;
  69     my $schema         = $translator->schema;
  70     my $o = '';
  71     for my $table ( $schema->get_tables ) {
  72         my $table_name    = $table->name or next;
  73         my $n = latex($table_name);
  74         $o .=
  75           sprintf '
  76 \subsubsection{%s}
  77 %s
  78 \begin{table}[htb]
  79 \caption{%s}
  80 \label{tab:%s}
  81 \center
  82 { \small
  83   \begin{tabular}{l l p{8cm}}
  84   Column & Datatype & Description \\\\ \hline
  85 ',
  86  $n, latex($table->comments), $n, $table_name;
  87
  88         foreach my $f ($table->get_fields) {
  89             $o .= sprintf '%s & %s & %s \\\\', map {latex($_)} ($f->name, $f->data_type, $f->comments || '');
  90             $o .= "\n";
  91
  92         }
  93 $o .= sprintf '
  94 \end{tabular}
  95 }
  96 \end{table}
  97 \clearpage
  98 ';
  99     }
 100     return $o;
 101 }
 102 sub latex {
 103     my $s = shift;
 104     return '' unless defined $s;
 105     $s =~ s/([\&\_\$\{\#])/\\$1/g;
 106     return $s;
 107 }
 108
 109 1;
 110
 111 # -------------------------------------------------------------------
 112
 113 =pod
 114
 115 =head1 AUTHOR
 116
 117 Chris Mungall
 118
 119 =head1 SEE ALSO
 120
 121 SQL::Translator.
 122
 123 =cut