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
|
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 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/;
our $specialCounter;
our $specialBegins = q();
our $specialAllMatchesRegExp = q();
our %individualSpecialRegExps;
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});
}
}
# 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}){
# the beginning parts
$specialBegins .= ($specialBegins eq ""?q():"|").${$BeginEnd}{begin};
# 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 {
$self->logger("The special regexps won't include anything from $specialName (see lookForThis)",'heading') if $is_t_switch_active ;
}
}
# move $$ to the beginning
if($specialBegins =~ m/\|\\\$\\\$/){
$specialBegins =~ s/\|(\\\$\\\$)//;
$specialBegins = $1."|".$specialBegins;
}
# info to the log file
$self->logger("The special beginnings regexp is: $specialBegins (see specialBeginEnd)",'heading') if $is_t_switch_active;
# overall special regexp
$self->logger("The overall special regexp is: $specialAllMatchesRegExp(see specialBeginEnd)",'heading') if $is_t_switch_active;
}
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
$self->logger("Searching for special begin/end (see specialBeginEnd)") if $is_t_switch_active ;
$self->logger(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}){
$self->logger("Looking for $specialName",'heading') if $is_t_switch_active ;
} else {
$self->logger("Not looking for $specialName (see lookForThis)",'heading') if ($is_t_switch_active and (ref($BeginEnd) eq "HASH"));
next;
}
# the regexp
my $specialRegExp = $individualSpecialRegExps{$specialName};
while(${$self}{body} =~ m/$specialRegExp(\h*)($trailingCommentRegExp)?/){
# global substitution
${$self}{body} =~ s/
$specialRegExp(\h*)($trailingCommentRegExp)?
/
# log file output
$self->logger("special found: $specialName",'heading') if $is_t_switch_active;
# 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(),
);
# 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;
return unless(${$masterSettings{specialBeginEnd}}{specialBeforeCommand});
# search for commands with arguments
$self->find_commands_or_key_equals_values_braces;
# search for ifElseFi blocks
$self->find_ifelsefi;
}
sub create_unique_id{
my $self = shift;
$specialCounter++;
${$self}{id} = "$tokens{specialBeginEnd}$specialCounter";
return;
}
1;
|
