package LatexIndent::IfElseFi; # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # See http://www.gnu.org/licenses/. # # Chris Hughes, 2017 # # For all communication, please visit: https://github.com/cmhughes/latexindent.pl use strict; use warnings; use LatexIndent::Tokens qw/%tokens/; use LatexIndent::TrailingComments qw/$trailingCommentRegExp/; use LatexIndent::Switches qw/$is_m_switch_active $is_t_switch_active $is_tt_switch_active/; use Data::Dumper; use Exporter qw/import/; our @ISA = "LatexIndent::Document"; # class inheritance, Programming Perl, pg 321 our @EXPORT_OK = qw/find_ifelsefi/; our %previouslyFoundSettings; our $ifElseFiCounter; # store the regular expresssion for matching and replacing the \if...\else...\fi statements # note: we search for \else separately in an attempt to keep this regexp a little more managable our $ifElseFiRegExp = qr/ ( \\ (@?if[a-zA-Z@]*?) \h* (\R*) ) # begin statement, e.g \ifnum, \ifodd ( \\(?!if)|\R|\h|\#|!-! # up until a \\, linebreak # or !-!, which is ) # part of the tokens used for latexindent ( (?: (?!\\if). )*? # body, which can't include another \if ) (\R*) # linebreaks after body ( \\fi(?![a-zA-Z]) # \fi statement ) (\h*) # 0 or more horizontal spaces (\R)? # linebreaks after \fi /sx; sub indent{ my $self = shift; # determine the surrounding and current indentation $self->determine_total_indentation; # line break checks after \if statement, can get messy if we # have, for example # \ifnum # something # which might be changed into # \ifnumsomething # which is undeserible if (defined ${$self}{BodyStartsOnOwnLine} and ${$self}{BodyStartsOnOwnLine}==-1 and ${$self}{body} !~ m/^(\h|\\|(?:!-!))/s ){ ${$self}{begin} .= " "; } # indent the body $self->indent_body; # calculate and grab the surrounding indentation for the \else statement adjustment $self->get_surrounding_indentation; my $surroundingIndentation = ${$self}{surroundingIndentation}?${$self}{surroundingIndentation}:q(); if(${$self}{elsePresent} and ${$self}{linebreaksAtEnd}{ifbody}){ $self->logger("Adding surrounding indentation to \\else statement ('$surroundingIndentation')")if $is_t_switch_active; ${$self}{body} =~ s/\h*\\else/$surroundingIndentation\\else/; $self->logger("Body (${$self}{name}) after \\else adjustment:\n${$self}{body}") if $is_t_switch_active; } # indent the end statement $self->indent_end_statement; # wrap-up statement $self->wrap_up_statement; # line break checks *after* \end{statement} if (defined ${$self}{EndFinishesWithLineBreak} and ${$self}{EndFinishesWithLineBreak}==-1 ) { # add a single horizontal space after the child id, otherwise we can end up # with things like # before: # \fi # text # after: # \fitext $self->logger("Adding a single space after \\fi statement (otherwise \\fi can be comined with next line of text in an unwanted way)",'heading') if $is_t_switch_active; ${$self}{end} =${$self}{end}." "; } return $self; } sub find_ifelsefi{ my $self = shift; while( ${$self}{body} =~ m/$ifElseFiRegExp\h*($trailingCommentRegExp)?/){ ${$self}{body} =~ s/ $ifElseFiRegExp(\h*)($trailingCommentRegExp)? / # log file output $self->logger("IfElseFi found: $2",'heading')if $is_t_switch_active; # create a new IfElseFi object my $ifElseFi = LatexIndent::IfElseFi->new(begin=>$1.(($4 eq "\n" and !$3)?"\n":q()), name=>$2, # if $4 is a line break, don't count it twice (it will already be in 'begin') body=>($4 eq "\n") ? $5.$6 : $4.$5.$6, end=>$7, linebreaksAtEnd=>{ begin=>(($4 eq "\n")||$3)?1:0, body=>$6?1:0, end=>$9?1:0, }, aliases=>{ # begin statements BeginStartsOnOwnLine=>"IfStartsOnOwnLine", # end statements EndStartsOnOwnLine=>"FiStartsOnOwnLine", # after end statements EndFinishesWithLineBreak=>"FiFinishesWithLineBreak", }, elsePresent=>0, modifyLineBreaksYamlName=>"ifElseFi", additionalAssignments=>["ElseStartsOnOwnLine","ElseFinishesWithLineBreak"], endImmediatelyFollowedByComment=>$9?0:($11?1:0), horizontalTrailingSpace=>$8?$8:q(), ); # the settings and storage of most objects has a lot in common $self->get_settings_and_store_new_object($ifElseFi); ${@{${$self}{children}}[-1]}{replacementText}.($10?$10:q()).($11?$11:q()); /xse; } return; } sub tasks_particular_to_each_object{ my $self = shift; # check for existence of \else statement, and associated line break information $self->check_for_else_statement; # search for headings (important to do this before looking for commands!) $self->find_heading; # search for commands, keys, named grouping braces $self->find_commands_or_key_equals_values_braces; # search for arguments $self->find_opt_mand_arguments; # search for ifElseFi blocks $self->find_ifelsefi; # search for special begin/end $self->find_special; } sub create_unique_id{ my $self = shift; $ifElseFiCounter++; ${$self}{id} = "$tokens{ifelsefi}$ifElseFiCounter"; return; } sub check_for_else_statement{ my $self = shift; $self->logger("Looking for \\else statement (${$self}{name})",'heading') if $is_t_switch_active; if(${$self}{body} =~ m/ (\R*) # possible line breaks before \else statement \\else \h* # possible horizontal space (\R*) # possible line breaks after \else statement /x){ $self->logger("found \\else statement, storing line break information:") if($is_t_switch_active); # linebreaks *before* \else statement ${$self}{linebreaksAtEnd}{ifbody} = $1?1:0; $self->logger("linebreaksAtEnd of ifbody: ${$self}{linebreaksAtEnd}{ifbody}") if($is_t_switch_active); # linebreaks *after* \else statement ${$self}{linebreaksAtEnd}{else} = $2?1:0; $self->logger("linebreaksAtEnd of else: ${$self}{linebreaksAtEnd}{else}") if($is_t_switch_active); ${$self}{elsePresent}=1; # check that \else isn't the first thing in body if(${$self}{body} =~ m/^\\else/s and ${$self}{linebreaksAtEnd}{begin}){ ${$self}{linebreaksAtEnd}{ifbody} = 1; $self->logger("\\else *begins* the ifbody, linebreaksAtEnd of ifbody: ${$self}{linebreaksAtEnd}{ifbody}") if($is_t_switch_active); } # check if -m switch is active return unless $is_m_switch_active; # possibly modify line break *before* \else statement if(defined ${$self}{ElseStartsOnOwnLine}){ if(${$self}{ElseStartsOnOwnLine}>=1 and !${$self}{linebreaksAtEnd}{ifbody}){ # by default, assume that no trailing comment token is needed my $trailingCommentToken = q(); if(${$self}{ElseStartsOnOwnLine}==2){ $self->logger("Adding a % immediately before else statement of ${$self}{name} (ElseStartsOnOwnLine==2)") if $is_t_switch_active; $trailingCommentToken = "%".$self->add_comment_symbol; } # add a line break after ifbody, if appropriate $self->logger("Adding a linebreak before the \\else statement (see ElseStartsOnOwnLine)"); ${$self}{body} =~ s/\\else/$trailingCommentToken\n\\else/s; ${$self}{linebreaksAtEnd}{ifbody} = 1; } elsif (${$self}{ElseStartsOnOwnLine}==-1 and ${$self}{linebreaksAtEnd}{ifbody}){ # remove line break *after* ifbody, if appropriate $self->logger("Removing linebreak before \\else statement (see ElseStartsOnOwnLine)"); ${$self}{body} =~ s/\R*(\h*)\\else/$1\\else/sx; ${$self}{linebreaksAtEnd}{ifbody} = 0; } } # possibly modify line break *before* \else statement if(defined ${$self}{ElseFinishesWithLineBreak}){ if(${$self}{ElseFinishesWithLineBreak}>=1 and !${$self}{linebreaksAtEnd}{else}){ # by default, assume that no trailing comment token is needed my $trailingCommentToken = q(); if(${$self}{ElseFinishesWithLineBreak}==2){ return if(${$self}{body} =~ m/\\else\h*$trailingCommentRegExp/s); $self->logger("Adding a % immediately after else statement of ${$self}{name} (ElseFinishesWithLineBreak==2)") if $is_t_switch_active; $trailingCommentToken = "%".$self->add_comment_symbol; } # add a line break after else, if appropriate $self->logger("Adding a linebreak after the \\else statement (see ElseFinishesWithLineBreak)")if $is_t_switch_active; ${$self}{body} =~ s/\\else\h*/\\else$trailingCommentToken\n/s; ${$self}{linebreaksAtEnd}{else} = 1; } elsif (${$self}{ElseFinishesWithLineBreak}==-1 and ${$self}{linebreaksAtEnd}{else}){ # remove line break *after* else, if appropriate, # note the space so that, for example, # \else # some text # becomes # \else some text # and not # \elsesome text $self->logger("Removing linebreak after \\else statement (see ElseFinishesWithLineBreak)")if $is_t_switch_active; ${$self}{body} =~ s/\\else\h*\R*/\\else /sx; ${$self}{linebreaksAtEnd}{else} = 0; } } return; } else { $self->logger("\\else statement not found") if($is_t_switch_active); } } 1;