summaryrefslogtreecommitdiff
path: root/perl/Locale/Po4a/Text.pm
blob: d9fcc88e4271ce1aa65391907ca7ca12b3058fea (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. =item B<asciidoc>
  69. Handle documents in the asciidoc format.
  70. =cut
  71. my $asciidoc 0;
  72. =back
  73. =cut
  74. sub initialize {
  75.     my $self shift;
  76.     my %options @_;
  77.     $self->{options}{'nobullets'}='';
  78.     if (defined $options{'nobullets'}) {
  79.         $bullets 0;
  80.     }
  81.     if (defined $options{'debianchangelog'}) {
  82.         $debianchangelog=1;
  83.     }
  84.     if (defined $options{'fortunes'}) {
  85.         $fortunes=1;
  86.     }
  87.     if (defined $options{'markdown'}) {
  88.         $markdown=1;
  89.     }
  90.     $asciidoc=if (defined $options{'asciidoc'});
  91. }
  92. sub parse {
  93.     my $self shift;
  94.     my ($line,$ref);
  95.     my $paragraph="";
  96.     my $wrapped_mode 1;
  97.     my $expect_header 1;
  98.     my $end_of_paragraph 0;
  99.     ($line,$ref)=$self->shiftline();
  100.     my $file $ref;
  101.     $file =~ s/:[0-9]+$//;
  102.     while (defined($line)) {
  103.         $ref =~ m/^(.*):[0-9]+$/;
  104.         if ($1 ne $file) {
  105.             $file $1;
  106.             do_paragraph($self,$paragraph,$wrapped_mode);
  107.             $paragraph="";
  108.             $wrapped_mode 1;
  109.             $expect_header 1;
  110.         }
  111.         chomp($line);
  112.         $self->{ref}="$ref";
  113.         if ($debianchangelog and
  114.             $expect_header and
  115.             $line =~ /^(\w[-+0-9a-z.]*)\ \(([^\(\\t]+)\# src, version
  116.                        \s+([-+0-9a-z.]+);                 # distribution
  117.                        \s*urgency\s*\=\s*(.*\S)\s*$/ix) { #
  118.             do_paragraph($self,$paragraph,$wrapped_mode);
  119.             $paragraph="";
  120.             $self->pushline("$line\n");
  121.             $expect_header=0;
  122.         elsif ($debianchangelog and
  123.                  $line =~ m/^ \-\- (.*) <(.*)> ((\w+\,\s*)?\d{1,2}\s+\w+\s+\d{4}\s+\d{1,2}:\d\d:\d\d\s+[-+]\d{4}(\s+\([^\\\(\)]\))?)$/) {
  124.             # Found trailer
  125.             do_paragraph($self,$paragraph,$wrapped_mode);
  126.             $paragraph="";
  127.             $self->pushline("$line\n");
  128.             $expect_header=1;
  129.         elsif ($fortunes and
  130.                  $line =~ m/^%%?\s*$/) {
  131.             # Found end of fortune
  132.             do_paragraph($self,$paragraph,$wrapped_mode);
  133.             $self->pushline("\n"unless (   $wrapped_mode == 0
  134.                                           or $paragraph eq "");
  135.             $paragraph="";
  136.             $wrapped_mode 1;
  137.             $self->pushline("$line\n");
  138.         elsif (    (defined $self->{verbatim})
  139.                  and ($self->{verbatim} == 2)) {
  140.             # Untranslated blocks
  141.             $self->pushline($line."\n");
  142.             if ($asciidoc and
  143.                 ($line =~ m/^(\/{4,}|~{4,})$/)) {
  144.                 undef $self->{verbatim};
  145.                 undef $self->{type};
  146.                 $wrapped_mode 1;
  147.             }
  148.         elsif ($line =~ /^\s*$/) {
  149.             # Break paragraphs on lines containing only spaces
  150.             do_paragraph($self,$paragraph,$wrapped_mode);
  151.             $paragraph="";
  152.             $wrapped_mode unless defined($self->{verbatim});
  153.             $self->pushline($line."\n");
  154.         elsif ($asciidoc and (not defined($self->{verbatim})) and
  155.                  ($line =~ m/^(\+|--)$/)) {
  156.             # List Item Continuation or List Block
  157.             do_paragraph($self,$paragraph,$wrapped_mode);
  158.             $paragraph="";
  159.             $self->pushline($line."\n");
  160.         elsif ($asciidoc and (not defined($self->{verbatim})) and
  161.                  ($line =~ m/^(={4,}|-{4,}|~{4,}|\^{4,}|\+{4,})$/and
  162.                  (defined($paragraph) )and
  163.                  ($paragraph =~ m/^[^\n]*\n$/sand
  164.                  (length($paragraph) == (length($line)+1))) {
  165.             # Found title
  166.             $wrapped_mode 0;
  167.             my $level $line;
  168.             $level =~ s/^(.).*$/$1/;
  169.             my $t $self->translate($paragraph,
  170.                                      $self->{ref},
  171.                                      "Title $level",
  172.                                      "wrap" => 0);
  173.             $self->pushline($t);
  174.             $paragraph="";
  175.             $wrapped_mode 1;
  176.             $self->pushline(($level (length($t)-1))."\n");
  177.         elsif ($asciidoc and
  178.                  ($line =~ m/^(={1,5})( +)(.*?)( +\1)?$/)) {
  179.             my $titlelevel1 $1;
  180.             my $titlespaces $2;
  181.             my $title $3;
  182.             my $titlelevel2 $4||"";
  183.             # Found one line title
  184.             do_paragraph($self,$paragraph,$wrapped_mode);
  185.             $wrapped_mode 0;
  186.             $paragraph="";
  187.             my $t $self->translate($title,
  188.                                      $self->{ref},
  189.                                      "Title $titlelevel1",
  190.                                      "wrap" => 0);
  191.             $self->pushline($titlelevel1.$titlespaces.$t.$titlelevel2."\n");
  192.             $wrapped_mode 1;
  193.         elsif ($asciidoc and
  194.                  ($line =~ m/^(\/{4,}|\+{4,}|-{4,}|\.{4,}|\*{4,}|_{4,}|={4,}|~{4,})$/)) {
  195.             # Found one delimited block
  196.             my $t $line;
  197.             $t =~ s/^(.).*$/$1/;
  198.             my $type "delimited block $t";
  199.             if (defined $self->{verbatimand ($self->{typene $type)) {
  200.                 $paragraph .= "$line\n";
  201.             else {
  202.             do_paragraph($self,$paragraph,$wrapped_mode);
  203.             if (    (defined $self->{type})
  204.                 and ($self->{typeeq $type)) {
  205.                 undef $self->{type};
  206.                 undef $self->{verbatim};
  207.                 $wrapped_mode 1;
  208.             else {
  209.                 if ($t eq "\/") {
  210.                     # CommentBlock, should not be treated
  211.                     $self->{verbatim} = 2;
  212.                 elsif ($t eq "+") {
  213.                     # PassthroughBlock
  214.                     $wrapped_mode 0;
  215.                     $self->{verbatim} = 1;
  216.                 elsif ($t eq "-") {
  217.                     # ListingBlock
  218.                     $wrapped_mode 0;
  219.                     $self->{verbatim} = 1;
  220.                 elsif ($t eq ".") {
  221.                     # LiteralBlock
  222.                     $wrapped_mode 0;
  223.                     $self->{verbatim} = 1;
  224.                 elsif ($t eq "*") {
  225.                     # SidebarBlock
  226.                     $wrapped_mode 1;
  227.                 elsif ($t eq "_") {
  228.                     # QuoteBlock
  229.                     if (    (defined $self->{type})
  230.                         and ($self->{typeeq "verse")) {
  231.                         $wrapped_mode 0;
  232.                         $self->{verbatim} = 1;
  233.                     else {
  234.                         $wrapped_mode 1;
  235.             &nb