1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
package LatexIndent::Item;
# 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::GetYamlSettings qw/%mainSettings/;
use LatexIndent::Switches qw/$is_t_switch_active $is_tt_switch_active/;
use LatexIndent::LogFile qw/$logger/;
use LatexIndent::IfElseFi qw/$ifElseFiBasicRegExp/;
use LatexIndent::Special qw/$specialBeginAndBracesBracketsBasicRegExp/;
use LatexIndent::Heading qw/$allHeadingsRegexp/;
use Data::Dumper;
use Exporter qw/import/;
our @ISA = "LatexIndent::Document"; # class inheritance, Programming Perl, pg 321
our @EXPORT_OK = qw/find_items construct_list_of_items $listOfItems/;
our $itemCounter;
our $listOfItems = q();
our $itemRegExp;
sub construct_list_of_items{
my $self = shift;
$listOfItems = q();
# put together a list of the items
while( my ($item,$lookForThisItem)= each %{$mainSettings{itemNames}}){
$listOfItems .= ($listOfItems eq "")?"$item":"|$item" if($lookForThisItem);
}
# detail items in the log
$logger->trace("*List of items: $listOfItems (see itemNames)") if $is_t_switch_active;
my $itemCanBeFollowedBy = qr/${${$mainSettings{fineTuning}}{items}}{canBeFollowedBy}/;
$itemRegExp = qr/
(
\\((?:$listOfItems)(?:$itemCanBeFollowedBy)?(?!\S))
\h*
(\R*)?
)
(
(?: # cluster-only (), don't capture
(?!
(?:\\(?:(?:$listOfItems)(?:$itemCanBeFollowedBy)?(?!\S))) # cluster-only (), don't capture
). # any character, but not \\$item
)*
)
(\R)?
/sx;
return;
}
sub find_items{
# no point carrying on if the list of items is empty
return if($listOfItems eq "");
my $self = shift;
# otherwise loop through the item names
$logger->trace("Searching for items (see itemNames) in ${$self}{name} (see indentAfterItems)") if $is_t_switch_active;
$logger->trace(Dumper(\%{$mainSettings{itemNames}})) if $is_tt_switch_active;
while(${$self}{body} =~ m/$itemRegExp\h*($trailingCommentRegExp)?/){
# log file output
$logger->trace("*Item found: $2") if $is_t_switch_active;
${$self}{body} =~ s/
$itemRegExp(\h*)($trailingCommentRegExp)?
/
# create a new Item object
my $itemObject = LatexIndent::Item->new(begin=>$1,
body=>$4,
end=>q(),
name=>$2,
linebreaksAtEnd=>{
begin=>$3?1:0,
body=>$5?1:0,
},
aliases=>{
# begin statements
BeginStartsOnOwnLine=>"ItemStartsOnOwnLine",
# body statements
BodyStartsOnOwnLine=>"ItemFinishesWithLineBreak",
},
modifyLineBreaksYamlName=>"items",
endImmediatelyFollowedByComment=>$5?0:($7?1:0),
);
# the settings and storage of most objects has a lot in common
$self->get_settings_and_store_new_object($itemObject);
${@{${$self}{children}}[-1]}{replacementText}.($6?$6:q()).($7?$7:q());
/xseg;
}
}
sub create_unique_id{
my $self = shift;
$itemCounter++;
${$self}{id} = "$tokens{items}$itemCounter";
return;
}
sub tasks_particular_to_each_object{
my $self = shift;
# the item body could hoover up line breaks; we do an additional check
${${$self}{linebreaksAtEnd}}{body}=1 if(${$self}{body} =~ m/\R+$/s );
# search for ifElseFi blocks
$self->find_ifelsefi if ${$self}{body} =~ m/$ifElseFiBasicRegExp/s;
# search for headings (part, chapter, section, setc)
$self->find_heading if ${$self}{body} =~ m/$allHeadingsRegexp/s;
# search for commands and special code blocks
$self->find_commands_or_key_equals_values_braces_and_special if ${$self}{body} =~ m/$specialBeginAndBracesBracketsBasicRegExp/s;
}
sub remove_line_breaks_begin{
# the \item command can need a trailing white space if the line breaks have been removed after it and
# there is no white space
my $self = shift;
my $BodyStringLogFile = ${$self}{aliases}{BodyStartsOnOwnLine}||"BodyStartsOnOwnLine";
$logger->trace("Removing linebreak at the end of begin (see $BodyStringLogFile)");
${$self}{begin} =~ s/\R*$//sx;
${$self}{begin} .= " " unless(${$self}{begin} =~ m/\h$/s or ${$self}{body} =~ m/^\h/s or ${$self}{body} =~ m/^\R/s );
${$self}{linebreaksAtEnd}{begin} = 0;
}
1;
|
