summaryrefslogtreecommitdiff
path: root/Locale/Po4a/Text.pm
blob: fad995a56bb9dddee07d2760315e4f39b7f6e62d (plain)
  1. #!/usr/bin/perl -w
  2. # Po4a::Text.pm
  3. # extract and translate translatable strings from a text documents
  4. #
  5. # This program is free software; you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation; either version 2 of the License, or
  8. # (at your option) any later version.
  9. #
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program; if not, write to the Free Software
  17. # Foundation, Inc.,
  18. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. #
  20. ########################################################################
  21. =head1 NAME
  22. Locale::Po4a::Text - Convert text documents from/to PO files
  23. =head1 DESCRIPTION
  24. The po4a (po for anything) project goal is to ease translations (and more
  25. interestingly, the maintenance of translations) using gettext tools on
  26. areas where they were not expected like documentation.
  27. Locale::Po4a::Text is a module to help the translation of text documents into
  28. other [human] languages.
  29. Paragraphs are splitted on empty lines (or lines containing only spaces or
  30. tabulations).
  31. If a paragraph contains a line starting by a space (or tabulation), this
  32. paragraph won't be rewrapped.
  33. =cut
  34. package Locale::Po4a::Text;
  35. use 5.006;
  36. use strict;
  37. use warnings;
  38. require Exporter;
  39. use vars qw(@ISA @EXPORT);
  40. @ISA = qw(Locale::Po4a::TransTractor);
  41. @EXPORT qw();
  42. use Locale::Po4a::TransTractor;
  43. use Locale::Po4a::Common;
  44. =head1 OPTIONS ACCEPTED BY THIS MODULE
  45. These are this module's particular options:
  46. =over
  47. =item B<nobullet>
  48. Deactivate detection of bullets.
  49. By default, when a bullet is detected, the bullet paragraph is not considered
  50. as a verbatim paragraph (with the no-wrap flag in the PO file), but the module
  51. rewrap this paragraph in the generated PO file and in the translation.
  52. =cut
  53. my $bullets 1;
  54. =item B<debianchangelog>
  55. Handle the header and footer of
  56. released versions, which only contain non translatable informations.
  57. =cut
  58. my $debianchangelog 0;
  59. =item B<fortunes>
  60. Handle the fortunes format, which separate fortunes with a line which
  61. consists in '%' or '%%', and use '%%' as the beginning of a comment.
  62. =cut
  63. my $fortunes 0;
  64. =item B<markdown>
  65. Handle some special markup in Markdown-formatted texts.
  66. =cut
  67. my $markdown 0;
  68. sub initialize {
  69.     my $self shift;
  70.     my %options @_;
  71.     $self->{options}{'nobullets'}='';
  72.     if (defined $options{'nobullets'}) {
  73.         $bullets 0;
  74.     }
  75.     if (defined $options{'debianchangelog'}) {
  76.         $debianchangelog=1;
  77.     }
  78.     if (defined $options{'fortunes'}) {
  79.         $fortunes=1;
  80.     }
  81.     if (defined $options{'markdown'}) {
  82.         $markdown=1;
  83.     }
  84. }
  85. sub parse {
  86.     my $self shift;
  87.     my ($line,$ref);
  88.     my $paragraph="";
  89.     my $wrapped_mode 1;
  90.     my $expect_header 1;
  91.     ($line,$ref)=$self->shiftline();
  92.     my $file $ref;
  93.     $file =~ s/:[0-9]+$//;
  94.     while (defined($line)) {
  95.         $ref =~ m/^(.*):[0-9]+$/;
  96.         if ($1 ne $file) {
  97.             $file $1;
  98.             do_paragraph($self,$paragraph,$wrapped_mode);
  99.             $paragraph="";
  100.         }
  101.         # TODO: preserve original line ends throughout the code instead
  102.         chomp($line);
  103.         $self->{ref}="$ref";
  104.         if ($debianchangelog and
  105.             $expect_header and
  106.             $line =~ /^(\w[-+0-9a-z.]*)\ \(([^\(\\t]+)\# src, version
  107.                        \s+([-+0-9a-z.]+);                 # distribution
  108.                        \s*urgency\s*\=\s*(.*\S)\s*$/ix) { #
  109.             do_paragraph($self,$paragraph,$wrapped_mode);
  110.             $paragraph="";
  111.             $self->pushline("$line\n");
  112.             $expect_header=0;
  113.         elsif ($debianchangelog and
  114.                  $line =~ m/^ \-\- (.*) <(.*)> ((\w+\,\s*)?\d{1,2}\s+\w+\s+\d{4}\s+\d{1,2}:\d\d:\d\d\s+[-+]\d{4}(\s+\([^\\\(\)]\))?)$/) {
  115.             # Found trailer
  116.             do_paragraph($self,$paragraph,$wrapped_mode);
  117.             $paragraph="";
  118.             $self->pushline("$line\n");
  119.             $expect_header=1;
  120.         elsif ($fortunes and
  121.                  $line =~ m/^%%?\s*$/) {
  122.             # Found end of fortune
  123.             do_paragraph($self,$paragraph,$wrapped_mode);
  124.             # FIXME: test if this is still needed when always adding
  125.             #        newline in do_paragraph()
  126.             $self->pushline("\n"unless (   $wrapped_mode == 0
  127.                                           or $paragraph eq "");
  128.             $paragraph="";
  129.             $wrapped_mode 1;
  130.             $self->pushline("$line\n");
  131.         elsif ($line =~ /^\s*$/) {
  132.             # Break paragraphs on lines containing only spaces
  133.             do_paragraph($self,$paragraph,$wrapped_mode);
  134.             $paragraph="";
  135.             $wrapped_mode 1;
  136.             $self->pushline($line."\n");
  137.         elsif (   $line =~ /^=*$/
  138.                  or $line =~ /^_*$/
  139.                  or $line =~ /^-*$/) {
  140.             $wrapped_mode 0;
  141.             $paragraph .= $line."\n";
  142.             do_paragraph($self,$paragraph,$wrapped_mode);
  143.             $paragraph="";
  144.             $wrapped_mode 1;
  145.         elsif ($markdown and
  146.                  (   $line =~ /^#/            # headline
  147.                   or $line =~ /^\s*\[\[\!\S[^\]]*\]\]\s*$/)) { # sole macro
  148.             # Found Markdown markup that should be preserved as a single line
  149.             do_paragraph($self,$paragraph,$wrapped_mode);
  150.             $paragraph="$line\n";
  151.             $wrapped_mode 0;
  152.             do_paragraph($self,$paragraph,$wrapped_mode);
  153.             $wrapped_mode 1;
  154.             $paragraph="";
  155.         elsif ($markdown and
  156.                  (   $paragraph =~ m/^>/       # blockquote
  157.                   or $paragraph =~ m/[<>]/     # maybe html
  158.                   or $paragraph =~ m/^"""/     # textblock inside macro end
  159.                   or $paragraph =~ m/"""$/)) { # textblock inside macro begin
  160.             # Found Markdown markup that might not survive wrapping
  161.             $wrapped_mode 0;
  162.             $paragraph .= $line."\n";
  163.         else {
  164.             if ($line =~ /^\s/) {
  165.                 # A line starting by a space indicates a non-wrap
  166.                 # paragraph
  167.                 $wrapped_mode 0;
  168.             }
  169.             if ($fortunes) {
  170.                 $line =~ s/%%(.*)$//;
  171.             }
  172. # TODO: comments
  173.             $paragraph .= $line."\n";
  174.         }
  175.         # paragraphs starting by a bullet, or numbered
  176.         # or paragraphs with a line containing many consecutive spaces
  177.         # (more than 3)
  178.         # are considered as verbatim paragraphs
  179.         $wrapped_mode if (   $paragraph =~ m/^(\*|[0-9]+[.)] )/s
  180.                               or $paragraph =~ m/[ \t][ \t][ \t]/s);
  181.         ($line,$ref)=$self->shiftline();
  182.     }
  183.     if (length $paragraph) {
  184.         do_paragraph($self,$paragraph,$wrapped_mode);
  185.     }
  186. }
  187. sub do_paragraph {
  188.     my ($self$paragraph$wrap) = (shiftshiftshift);
  189.     return if ($paragraph eq "");
  190.     if ($bullets) {
  191.         # Detect bullets
  192.         # |        * blah blah
  193.         # |<spaces>  blah
  194.         # |          ^-- aligned
  195.         # <empty line>
  196.         #
  197.         # Other bullets supported:
  198.         # - blah         o blah         + blah
  199.         # 1. blah       1) blah       (1) blah
  200. TEST_BULLET:
  201.         if ($paragraph =~ m/^(\s*)((?:[-*o+]|([0-9]+[.\)])|\([0-9]+\))\s+)([^\n]*\n)(.*)$/s) {
  202.             my $para $5;
  203.             my $bullet $2;
  204.             my $indent1 $1;
  205.             my $indent2 "$1".(' ' x length $bullet);
  206.             my $text $4;
  207.             while ($para !~ m/$indent2(?:[-*o+]|([0-9]+[.\)])|\([0-9]+\))\s+/
  208.                    and $para =~ s/^$indent2(\S[^\n]*\n)//s) {
  209.                 $text .= $1;
  210.             }
  211.             # TODO: detect if a line starts with the same bullet
  212.             if ($text !~ m/\S[ \t][ \t][ \t]+\S/s) {
  213.                 my $bullet_regex quotemeta($indent1.$bullet);
  214.                 $bullet_regex =~ s/[0-9]+/\\d\+/;
  215.                 if ($para eq '' or $para =~ m/^$bullet_regex\S/s) {
  216.                     my $trans $self->translate($text,
  217.                                                  $self->{ref},
  218.                                                  "Bullet: '$indent1$bullet'",
  219.                                                  "wrap" => 1,
  220.                                                  "wrapcol" => - (length $indent2));
  221.                     $trans =~ s/^/$indent1$bullet/s;
  222.                     $trans =~ s/\n(.)/\n$indent2$1/sg;
  223.                     $self->pushline$trans."\n" );
  224.                     if ($para eq '') {
  225.                         return;
  226.                     else {
  227.                         # Another bullet
  228.                         $paragraph $para;
  229.                         goto TEST_BULLET;
  230.                     }
  231.                 }
  232.             }
  233.         }
  234.     }
  235.     # TODO: detect indented paragraphs
  236.     my $transfinal $self->translate($paragraph,
  237.                                       $self->{ref},
  238.                                       "Plain text",
  239.                                       "wrap" => $wrap);
  240.     # TODO: preserve original line ends throughout the code instead
  241.     chomp $transfinal;
  242.     $transfinal .= "\n";
  243.     $self->pushline$transfinal );
  244. }
  245. 1;
  246. =head1 STATUS OF THIS MODULE
  247. Tested successfully on simple text files and NEWS.Debian files.
  248. =head1 AUTHORS
  249.  Nicolas François <nicolas.francois@centraliens.net>
  250. =head1 COPYRIGHT AND LICENSE
  251.  Copyright 2005-2008 by Nicolas FRANÇOIS <nicolas.francois@centraliens.net>.
  252. This program is free software; you may redistribute it and/or modify it
  253. under the terms of GPL (see the COPYING file).