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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
package LatexIndent::Special;
# 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/%masterSettings/;
use LatexIndent::Switches qw/$is_t_switch_active $is_tt_switch_active/;
use LatexIndent::LogFile qw/$logger/;
use LatexIndent::IfElseFi qw/$ifElseFiBasicRegExp/;
use Data::Dumper;
use Exporter qw/import/;
our @ISA = "LatexIndent::Document"; # class inheritance, Programming Perl, pg 321
our @EXPORT_OK = qw/find_special construct_special_begin $specialBeginAndBracesBracketsBasicRegExp $specialBeginBasicRegExp/;
our $specialCounter;
our $specialBegins = q();
our $specialAllMatchesRegExp = q();
our %individualSpecialRegExps;
our $specialBeginAndBracesBracketsBasicRegExp;
our $specialBeginBasicRegExp;
sub construct_special_begin{
my $self = shift;
# put together a list of the begin terms in special
while( my ($specialName,$BeginEnd)= each %{$masterSettings{specialBeginEnd}}){
if(ref($BeginEnd) eq "HASH"){
# only append the regexps if lookForThis is 1
$specialBegins .= ($specialBegins eq ""?q():"|").${$BeginEnd}{begin} if(${$BeginEnd}{lookForThis}=~m/\d/s and ${$BeginEnd}{lookForThis} == 1);
}
}
# put together a list of the begin terms in special
while( my ($specialName,$BeginEnd)= each %{$masterSettings{specialBeginEnd}}){
# only append the regexps if lookForThis is 1
if( (ref($BeginEnd) eq "HASH") and ${$BeginEnd}{lookForThis}=~m/\d/s and ${$BeginEnd}{lookForThis} == 1){
# the overall regexp
$specialAllMatchesRegExp .= ($specialAllMatchesRegExp eq ""?q():"|")
.qr/
${$BeginEnd}{begin}
(?: # cluster-only (), don't capture
(?!
(?:$specialBegins) # cluster-only (), don't capture
). # any character, but not anything in $specialBegins
)*?
${$BeginEnd}{end}
/sx;
# store the individual special regexp
$individualSpecialRegExps{$specialName} = qr/
(
${$BeginEnd}{begin}
\h*
(\R*)?
)
(
(?: # cluster-only (), don't capture
(?!
(?:$specialBegins) # cluster-only (), don't capture
). # any character, but not anything in $specialBegins
)*?
(\R*)?
)
(
${$BeginEnd}{end}
)
(\h*)
(\R)?
/sx
} else {
$logger->trace("*The special regexps won't include anything from $specialName (see lookForThis)") if $is_t_switch_active ;
}
}
# move $$ to the beginning
if($specialBegins =~ m/\|\\\$\\\$/){
$specialBegins =~ s/\|(\\\$\\\$)//;
$specialBegins = $1."|".$specialBegins;
}
# info to the log file
$logger->trace("*The special beginnings regexp is: (see specialBeginEnd)") if $is_tt_switch_active;
$logger->trace($specialBegins) if $is_tt_switch_active;
# overall special regexp
$logger->trace("*The overall special regexp is: (see specialBeginEnd)") if $is_tt_switch_active;
$logger->trace($specialAllMatchesRegExp) if $is_tt_switch_active;
# basic special begin regexp
$specialBeginBasicRegExp = qr/$specialBegins/;
$specialBeginAndBracesBracketsBasicRegExp = $specialBegins."|\\{|\\[";
$specialBeginAndBracesBracketsBasicRegExp = qr/$specialBeginAndBracesBracketsBasicRegExp/;
}
sub find_special{
my $self = shift;
# no point carrying on if the list of specials is empty
return if($specialBegins eq "");
# otherwise loop through the special begin/end
$logger->trace("*Searching ${$self}{name} for special begin/end (see specialBeginEnd)") if $is_t_switch_active ;
$logger->trace(Dumper(\%{$masterSettings{specialBeginEnd}})) if $is_tt_switch_active;
# keep looping as long as there is a special match of some kind
while(${$self}{body} =~ m/$specialAllMatchesRegExp/sx){
# loop through each special match
while( my ($specialName,$BeginEnd)= each %{$masterSettings{specialBeginEnd}}){
# log file
if((ref($BeginEnd) eq "HASH") and ${$BeginEnd}{lookForThis}=~m/\d/s and ${$BeginEnd}{lookForThis} == 1){
$logger->trace("Looking for $specialName") if $is_t_switch_active ;
} else {
$logger->trace("Not looking for $specialName (see lookForThis)") if ($is_t_switch_active and (ref($BeginEnd) eq "HASH"));
next;
}
# the regexp
my $specialRegExp = $individualSpecialRegExps{$specialName};
$logger->trace("$specialName regexp: \n$specialRegExp") if $is_tt_switch_active ;
while(${$self}{body} =~ m/$specialRegExp(\h*)($trailingCommentRegExp)?/){
# global substitution
${$self}{body} =~ s/
$specialRegExp(\h*)($trailingCommentRegExp)?
/
# create a new special object
my $specialObject = LatexIndent::Special->new(begin=>$1,
body=>$3,
end=>$5,
name=>$specialName,
linebreaksAtEnd=>{
begin=>$2?1:0,
body=>$4?1:0,
end=>$7?1:0,
},
aliases=>{
# begin statements
BeginStartsOnOwnLine=>"SpecialBeginStartsOnOwnLine",
# body statements
BodyStartsOnOwnLine=>"SpecialBodyStartsOnOwnLine",
# end statements
EndStartsOnOwnLine=>"SpecialEndStartsOnOwnLine",
# after end statements
EndFinishesWithLineBreak=>"SpecialEndFinishesWithLineBreak",
},
modifyLineBreaksYamlName=>"specialBeginEnd",
endImmediatelyFollowedByComment=>$7?0:($9?1:0),
horizontalTrailingSpace=>$6?$6:q(),
);
# log file output
$logger->trace("*Special found: $specialName") if $is_t_switch_active;
# the settings and storage of most objects has a lot in common
$self->get_settings_and_store_new_object($specialObject);
${@{${$self}{children}}[-1]}{replacementText}.($8?$8:q()).($9?$9:q());
/xseg;
$self->wrap_up_tasks;
}
}
}
}
sub tasks_particular_to_each_object{
my $self = shift;
if( defined ${${$masterSettings{specialBeginEnd}}{${$self}{name}}}{middle}){
$logger->trace("middle specified for ${$self}{name} (see specialBeginEnd -> ${$self}{name} -> middle)") if $is_t_switch_active ;
# initiate the middle regexp
my $specialMiddle = q();
# we can specify middle as either an array or a hash
if(ref(${${$masterSettings{specialBeginEnd}}{${$self}{name}}}{middle}) eq "ARRAY"){
$logger->trace("looping through middle array for ${$self}{name}") if $is_t_switch_active ;
foreach(@{${${$masterSettings{specialBeginEnd}}{${$self}{name}}}{middle}}){
$specialMiddle .= ($specialMiddle eq ""?q():"|").$_;
}
$specialMiddle = qr/$specialMiddle/;
} else {
$specialMiddle = qr/${${$masterSettings{specialBeginEnd}}{${$self}{name}}}{middle}/;
}
$logger->trace("overall middle regexp for ${$self}{name}: $specialMiddle") if $is_t_switch_active ;
# store the middle regexp for later
${$self}{middleRegExp} = $specialMiddle;
# check for existence of a 'middle' statement, and associated line break information
$self->check_for_else_statement(
# else name regexp
elseNameRegExp=>$specialMiddle,
# else statements name
ElseStartsOnOwnLine=>"SpecialMiddleStartsOnOwnLine",
# end statements
ElseFinishesWithLineBreak=>"SpecialMiddleFinishesWithLineBreak",
# for the YAML settings storage
storageNameAppend=>"middle",
# logfile information
logName=>"special middle",
);
}
return unless(${$masterSettings{specialBeginEnd}}{specialBeforeCommand});
# search for commands with arguments
$self->find_commands_or_key_equals_values_braces;
# search for arguments
$self->find_opt_mand_arguments;
# search for ifElseFi blocks
$self->find_ifelsefi;
}
sub post_indentation_check{
# needed to remove leading horizontal space before \else
my $self = shift;
return unless ( defined ${${$masterSettings{specialBeginEnd}}{${$self}{name}}}{middle});
$logger->trace("post indentation check for ${$self}{name} to account for middle") if $is_t_switch_active ;
# loop through \else and \or
foreach ({regExp=>${$self}{middleRegExp}}){
my %else = %{$_};
if(${$self}{body} =~ m/^\h*$else{regExp}/sm
and
!(${$self}{body} =~ m/^\h*$else{regExp}/s and ${$self}{linebreaksAtEnd}{begin}==0)
){
$logger->trace("*Adding surrounding indentation to $else{regExp} statement(s) ('${$self}{surroundingIndentation}')") if $is_t_switch_active;
${$self}{body} =~ s/^\h*($else{regExp})/${$self}{surroundingIndentation}$1/smg;
}
}
return;
}
sub create_unique_id{
my $self = shift;
$specialCounter++;
${$self}{id} = "$tokens{specialBeginEnd}$specialCounter";
return;
}
1;
|
