]> git.lyx.org Git - lyx.git/blobdiff - lib/reLyX/BasicLyX.pm
The Box patch
[lyx.git] / lib / reLyX / BasicLyX.pm
index c9441415efd9b3cfdb528297e0e8b3a77c3e5011..d5ddc5c1fa6f91805a5a9f932bce6531affd88d8 100644 (file)
@@ -218,6 +218,32 @@ my $MathEnvironments = "(math|displaymath|xxalignat|(equation|eqnarray|align|ali
 # ListLayouts may have standard paragraphs nested inside them.
 my $ListLayouts = "Itemize|Enumerate|Description";
 
+# passed a string and an array
+# returns true if the string is an element of the array.
+sub foundIn {
+    my $name = shift;
+    return grep {$_ eq $name} @_;
+}
+
+my @NatbibCommands = map {"\\$_"} qw(citet citealt citep citealp citeauthor);
+
+# passed a string.
+# returns true if it is a valid natbib citation
+sub isNatbibCitation {
+    my $name = shift;
+
+    # These two have a single form
+    return 1 if ($name eq '\citeyear' or $name eq '\citeyearpar');
+
+    # Natbib citations can start with a 'C' or a 'c'
+    $name =~ s/^\\C/\\c/;
+    # The can end with a '*'
+    $name =~ s/\*$//;
+    # Is this doctored string found in the list of valid commands?
+    return foundIn($name, @NatbibCommands);
+    
+}
+
 #####################   PARSER INVOCATION   ##################################
 sub call_parser {
 # This subroutine calls the TeX parser & translator
@@ -290,6 +316,96 @@ sub call_parser {
     return;
 } # end subroutine call_parser
 
+# This is used as a toggle so that we know what to do when basic_lyx is
+# passed a '$' or '$$' token.
+my $inside_math=0;
+
+sub starting_math {
+    my $name = shift;
+
+    if ($name eq '\(' || $name eq '\[' ||
+       # These tokens bound both ends of a math environment so we must check
+       # $inside_math to know what action to take.
+       ($name eq '$' || $name eq '$$') && !$inside_math) {
+
+       $inside_math = 1;
+       return 1;
+    }
+
+    # All other tokens
+    return 0;
+}
+
+sub ending_math {
+    my $name = shift;
+
+    if ($name eq '\)' || $name eq '\]' ||
+       # These tokens bound both ends of a math environment so we must check
+       # $inside_math to know what action to take.
+       ($name eq '$' || $name eq '$$') && $inside_math) {
+
+       $inside_math = 0;
+       return 1;
+    }
+
+    # All other tokens
+    return 0;
+}
+
+
+sub regularizeLatexLength {
+    my $LatexLength = shift;
+
+    # Remove any whitespace
+    $LatexLength =~ s/\s//g;
+    # Remove a leading '+' as unnecessary
+    $LatexLength =~ s/^\+?(\d)/$1/;
+    # Split into value and unit parts
+    my $val;
+    my $unit;
+    if ($LatexLength =~ /(-?\d+[.,]?\d*)(\\?[a-zA-Z]*)$/) {
+       $val  = $1;
+       $unit = $2;
+    }
+    # If the input is invalid, return what we have.
+    return $LatexLength if ($val eq '' || $unit eq '');
+
+    # '4,5' is a valid LaTeX number. Change it to '4.5'
+    $val =~ s/,/./;
+    # If the unit is not a LaTeX macro, then ensure it is lower case
+    if (!($unit =~ /^\\/)) {
+       $unit =~ s/([a-z]*)/\L$1/i;
+    }
+
+    $LatexLength = $val . $unit;
+    return $LatexLength;
+}
+    
+
+sub getAsLyXLength {
+    # Straight translation of LaTeX lengths to LyX ones.
+    my %lengthAsLyXString = ('\textwidth'   => 'text%',
+                            '\columnwidth' => 'col%',
+                            '\paperwidth'  => 'page%',
+                            '\linewidth'   => 'line%',
+                            '\paperheight' => 'pheight%',
+                            '\textheight'  => 'theight%');
+
+    my $LatexLength = shift;
+    $LatexLength = regularizeLatexLength($LatexLength);
+
+    my $LyXLength = $LatexLength;
+    # If $LatexLength is something like '4.5\columnwidth', translate into
+    # LyXese.
+    if ($LatexLength =~ /([+-]?\d+\.?\d*)(\\[a-z]*)/) {
+       if (defined($lengthAsLyXString{$2})) {
+           $LyXLength = ($1 * 100) . $lengthAsLyXString{$2};
+       }
+    }
+
+    return $LyXLength;
+}
+
 ##########################   MAIN TRANSLATOR SUBROUTINE   #####################
 sub basic_lyx {
 # This subroutine is called by Text::TeX::process each time subroutine
@@ -381,14 +497,15 @@ sub basic_lyx {
                } # end special handling for \@
 
            # Handle tokens that LyX translates as a "LatexCommand" inset
-           } elsif (grep {$_ eq $name} @LatexCommands) {
+           } elsif (foundIn($name, @LatexCommands) ||
+                    isNatbibCitation($name)){
                &CheckForNewParagraph; #Start new paragraph if necessary
                print OUTFILE "$pre_space\n\\begin_inset LatexCommand ",
                               $name,
                              "\n\n\\end_inset \n\n";
 
            # Math -- copy verbatim until you're done
-           } elsif ($name eq '\(' || $name eq '\[') {
+           } elsif (starting_math($name)) {
                print "\nCopying math beginning with '$name'\n" if $debug_on;
                # copy everything until end text
                $dummy = &Verbatim::copy_verbatim($fileobject, $eaten);
@@ -399,7 +516,7 @@ sub basic_lyx {
                print $dummy if $debug_on;
                print OUTFILE $dummy;
 
-           } elsif ($name eq '\)' || $name eq '\]') {
+           } elsif (ending_math($name)) {
                # end math
                print OUTFILE "$name\n\\end_inset \n\n";
                print "\nDone copying math ending with '$name'" if $debug_on;
@@ -470,7 +587,7 @@ sub basic_lyx {
                    $thistable->nextcol;
                } else {warn "& is illegal outside a table!"}
 
-           } elsif ($name eq '\\\\' || $name eq '\\newline') {
+           } elsif ($name eq '\\\\' || $name eq '\\newline' || $name eq "\\tabularnewline") {
                &CheckForNewParagraph; # could be at beginning of par?
                 print OUTFILE "\n\\newline \n";
 
@@ -537,7 +654,7 @@ sub basic_lyx {
            print "$name" if $debug_on;
 
            # Handle things that LyX translates as a "LatexCommand" inset
-           if (grep {$_ eq $name} @LatexCommands) {
+           if (foundIn($name, @LatexCommands) || isNatbibCitation($name)){
                &CheckForNewParagraph; #Start new paragraph if necessary
 
                print OUTFILE "$pre_space\n\\begin_inset LatexCommand ";
@@ -772,7 +889,8 @@ sub basic_lyx {
 
            # Handle things that LyX translates as a "LatexCommand" inset
            # or "Include" insets
-           if (grep {$_ eq $name} @LatexCommands, @IncludeCommands) {
+           if (foundIn($name, @LatexCommands, @IncludeCommands) ||
+               isNatbibCitation($name)){
                print OUTFILE "\}\n\n\\end_inset \n\n";
 
            } elsif (exists $ReadCommands::ToLayout->{$name}) {
@@ -947,6 +1065,55 @@ sub basic_lyx {
                $tok = $fileobject->eatGroup;
                new RelyxTable::Table $tok;
 
+           # minipage
+           } elsif ($env eq "minipage") {
+               &CheckForNewParagraph;
+
+               print OUTFILE "\\begin_inset Minipage\n";
+
+               # The minipage environment is defined as:
+               # \begin{minipage}[pos][height][inner-pos]{width} <text>
+               # \end{minipage}
+
+               # Read the position optional argument, if it exists
+               $tok = $fileobject->eatOptionalArgument;
+               my $pos = $tok->print if defined($tok->print);
+
+               my %map = ('t' => '0', 'c' => '1', 'b' => '2');
+               if ($debug_on && $pos ne '' && !defined($map{$pos})) {
+                   print "\nIgnoring unknown positioning arg '$pos'\n";
+               }
+
+               # The minipage is centred by default.
+               $pos = '1' if (!defined($map{$pos}) ||
+                                 ($pos = $map{$pos}) eq '');
+
+               # Read the height optional argument, if it exists
+               my $height = '0pt';
+               $tok = $fileobject->eatOptionalArgument;
+               if (defined($tok->print)) {
+                   $height = getAsLyXLength($tok->print);
+               }
+
+               # Read the inner-pos optional argument, if it exists
+               my $innerpos = $pos;
+               $tok = $fileobject->eatOptionalArgument;
+               if (defined($tok->print)) {
+                   my $arg = $tok->print;
+                   print("\nMinipage inner-pos argument, $arg, is ",
+                         "currently ignored\n");
+               }
+
+               # Read the width as (a reference to) an array of tokens.
+               $tok = $fileobject->eatBalanced;
+               my $width = getAsLyXLength($tok->exact_print);
+
+               print OUTFILE "position $pos\n";
+               print OUTFILE "inner_position $innerpos\n";
+               print OUTFILE "height \"$height\"\n";
+               print OUTFILE "width \"$width\"\n";
+               print OUTFILE "collapsed false\n";
+
            # \begin document
            } elsif ($env eq "document") {
                # do nothing
@@ -1018,6 +1185,13 @@ sub basic_lyx {
                # Anything after a table will be a new paragraph
                $IsNewParagraph = 1; $MayBeDeeper = 1;
 
+           # minipage
+           } elsif ($env eq "minipage") {
+               print OUTFILE "\n\\end_inset \n\n";
+
+               # Next stuff will be new env.
+               # $IsNewParagraph = 1;
+
            } elsif ($env eq "document") {
                print "\nDone with document!" if $debug_on;