-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlatexindent.pl
1784 lines (1535 loc) · 63.2 KB
/
latexindent.pl
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/perl
# 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/.
#
# For details of how to use this file, please see readme.txt
# load packages/modules
use strict;
use warnings;
use FindBin; # help find defaultSettings.yaml
use YAML::Tiny; # interpret defaultSettings.yaml
use File::Copy; # to copy the original file to backup (if overwrite option set)
use File::Basename; # to get the filename and directory path
#use Getopt::Std;
use Getopt::Long; # to get the switches/options/flags
use File::HomeDir; # to get users home directory, regardless of OS
# get the options
my $overwrite;
my $outputToFile;
my $silentMode;
my $tracingMode;
my $readLocalSettings;
my $onlyDefault;
my $showhelp;
my $cruftDirectory='./';
GetOptions ("w"=>\$overwrite,
"o"=>\$outputToFile,
"s"=>\$silentMode,
"t"=>\$tracingMode,
"l"=>\$readLocalSettings,
"d"=>\$onlyDefault,
"h"=>\$showhelp,
"c=s"=>\$cruftDirectory,
);
die "Could not find directory $cruftDirectory\nExiting, no indentation done." if(!(-d $cruftDirectory));
# version number
my $versionNumber = "1.1R";
# Check the number of input arguments- if it is 0 then simply
# display the list of options (like a manual)
if(scalar(@ARGV) < 1 or $showhelp)
{
print <<ENDQUOTE
latexindent.pl version $versionNumber
usage: latexindent.pl [options] [file][.tex]
-h help (see the documentation for detailed instructions and examples)
-o output to another file; sample usage
latexindent.pl -o myfile.tex outputfile.tex
-w overwrite the current file- a backup will be made, but still be careful
-s silent mode- no output will be given to the terminal
-t tracing mode- verbose information given to the log file
-l use localSettings.yaml (assuming it exists in the directory of your file)
-d ONLY use defaultSettings.yaml, ignore ALL user files
-c=cruft directory used to specify the location of backup files and indent.log
ENDQUOTE
;
exit(2);
}
# we'll be outputting to the logfile and to standard output
my $logfile;
my $out = *STDOUT;
# open the log file
open($logfile,">","$cruftDirectory/indent.log") or die "Can't open indent.log";
# output time to log file
my $time = localtime();
print $logfile $time;
# output version to log file
print $logfile <<ENDQUOTE
latexindent.pl version $versionNumber, a script to indent .tex files
latexindent.pl lives here: $FindBin::RealBin/
Directory for backup files and indent.log: $cruftDirectory
file: $ARGV[0]
ENDQUOTE
;
# a quick options check
if($outputToFile and $overwrite)
{
print $logfile <<ENDQUOTE
WARNING:
\t You have called latexindent.pl with both -o and -w
\t -o (output to file) will take priority, and -w (over write) will be ignored
ENDQUOTE
;
$overwrite = 0;
}
# can't call the script with MORE THAN 2 files
if(scalar(@ARGV)>2)
{
for my $fh ($out,$logfile) {print $fh <<ENDQUOTE
ERROR:
\t You're calling latexindent.pl with more than two file names
\t The script can take at MOST two file names, but you
\t need to call it with the -o switch; for example
\t latexindent.pl -o originalfile.tex outputfile.tex
No indentation done :(
Exiting...
ENDQUOTE
};
exit(2);
}
# don't call the script with 2 files unless the -o flag is active
if(!$outputToFile and scalar(@ARGV)==2)
{
for my $fh ($out,$logfile) {
print $fh <<ENDQUOTE
ERROR:
\t You're calling latexindent.pl with two file names, but not the -o flag.
\t Did you mean to use the -o flag ?
No indentation done :(
Exiting...
ENDQUOTE
};
exit(2);
}
# if the script is called with the -o switch, then check that
# a second file is present in the call, e.g
# latexindent.pl -o myfile.tex output.tex
if($outputToFile and scalar(@ARGV)==1)
{
for my $fh ($out,$logfile) {print $fh <<ENDQUOTE
ERROR: When using the -o flag you need to call latexindent.pl with 2 arguments
latexindent.pl -o "$ARGV[0]" [needs another name here]
No indentation done :(
Exiting...
ENDQUOTE
};
exit(2);
}
# Read in YAML file
my $defaultSettings = YAML::Tiny->new;
print $logfile "Reading defaultSettings.yaml from $FindBin::Bin/defaultSettings.yaml\n\n";
# Open defaultSettings.yaml
$defaultSettings = YAML::Tiny->read( "$FindBin::Bin/defaultSettings.yaml" );
if(!$defaultSettings)
{
for my $fh ($out,$logfile) {
print $fh <<ENDQUOTE
ERROR There seems to be a yaml formatting error in defaultSettings.yaml
Please check it for mistakes- you can find a working version at https://github.com/cmhughes/latexindent.plx
if you would like to overwrite your current version
Exiting, no indendation done.
ENDQUOTE
};
exit(2);
}
# setup the DEFAULT variables and hashes from the YAML file
# scalar variables
my $defaultIndent = $defaultSettings->[0]->{defaultIndent};
my $alwaysLookforSplitBraces = $defaultSettings->[0]->{alwaysLookforSplitBraces};
my $alwaysLookforSplitBrackets = $defaultSettings->[0]->{alwaysLookforSplitBrackets};
my $backupExtension = $defaultSettings->[0]->{backupExtension};
my $indentPreamble = $defaultSettings->[0]->{indentPreamble};
my $onlyOneBackUp = $defaultSettings->[0]->{onlyOneBackUp};
my $maxNumberOfBackUps = $defaultSettings->[0]->{maxNumberOfBackUps};
my $removeTrailingWhitespace = $defaultSettings->[0]->{removeTrailingWhitespace};
# hash variables
my %lookForAlignDelims= %{$defaultSettings->[0]->{lookForAlignDelims}};
my %indentRules= %{$defaultSettings->[0]->{indentRules}};
my %verbatimEnvironments= %{$defaultSettings->[0]->{verbatimEnvironments}};
my %noIndentBlock= %{$defaultSettings->[0]->{noIndentBlock}};
my %checkunmatched= %{$defaultSettings->[0]->{checkunmatched}};
my %checkunmatchedELSE= %{$defaultSettings->[0]->{checkunmatchedELSE}};
my %checkunmatchedbracket= %{$defaultSettings->[0]->{checkunmatchedbracket}};
my %noAdditionalIndent= %{$defaultSettings->[0]->{noAdditionalIndent}};
my %indentAfterHeadings= %{$defaultSettings->[0]->{indentAfterHeadings}};
# need new hashes to store the user and local data before
# overwriting the default
my %lookForAlignDelimsUSER;
my %indentRulesUSER;
my %verbatimEnvironmentsUSER;
my %noIndentBlockUSER;
my %checkunmatchedUSER;
my %checkunmatchedELSEUSER;
my %checkunmatchedbracketUSER;
my %noAdditionalIndentUSER;
my %indentAfterHeadingsUSER;
# for printing the user and local settings to the log file
my %dataDump;
# empty array to store the paths
my @absPaths;
# scalar to read user settings
my $userSettings;
# get information about user settings- first check if indentconfig.yaml exists
my $indentconfig = File::HomeDir->my_home . "/indentconfig.yaml";
if ( -e $indentconfig and !$onlyDefault )
{
print $logfile "Reading path information from ",File::HomeDir->my_home,"/indentconfig.yaml\n";
# read the absolute paths from indentconfig.yaml
$userSettings = YAML::Tiny->read( "$indentconfig" );
# integrity check
if($userSettings)
{
%dataDump = %{$userSettings->[0]};
print $logfile Dump \%dataDump;
print $logfile "\n";
@absPaths = @{$userSettings->[0]->{paths}};
}
else
{
print $logfile <<ENDQUOTE
WARNING: $indentconfig
contains some invalid .yaml formatting- unable to read from it.
No user settings loaded.
ENDQUOTE
;
}
}
else
{
if($onlyDefault)
{
print $logfile "Only default settings requested, not reading USER settings from indentconfig.yaml \n";
print $logfile "Ignoring localSettings.yaml\n" if($readLocalSettings);
$readLocalSettings = 0;
}
else
{
# give the user instructions on where to put indentconfig.yaml
print $logfile "Home directory is ",File::HomeDir->my_home,"\n";
print $logfile "To specify user settings you would put indentconfig.yaml here: \n\t",File::HomeDir->my_home,"/indentconfig.yaml\n\n";
}
}
# get information about LOCAL settings, assuming that localSettings.yaml exists
my $directoryName = dirname $ARGV[0];
# add local settings to the paths, if appropriate
if ( (-e "$directoryName/localSettings.yaml") and $readLocalSettings and !(-z "$directoryName/localSettings.yaml"))
{
print $logfile "\nAdding ./localSettings.yaml to paths\n\n";
push(@absPaths,"$directoryName/localSettings.yaml");
}
elsif ( !(-e "$directoryName/localSettings.yaml") and $readLocalSettings)
{
print $logfile "WARNING\n\t$directoryName/localSettings.yaml not found\n";
print $logfile "\tcarrying on without it.\n";
}
# read in the settings from each file
foreach my $settings (@absPaths)
{
# check that the settings file exists and that it isn't empty
if (-e $settings and !(-z $settings))
{
print $logfile "Reading USER settings from $settings\n";
$userSettings = YAML::Tiny->read( "$settings" );
# if we can read userSettings
if($userSettings)
{
# output settings to $logfile
%dataDump = %{$userSettings->[0]};
print $logfile Dump \%dataDump;
print $logfile "\n";
# scalar variables
$defaultIndent = $userSettings->[0]->{defaultIndent} if defined($userSettings->[0]->{defaultIndent});
$alwaysLookforSplitBraces = $userSettings->[0]->{alwaysLookforSplitBraces} if defined($userSettings->[0]->{alwaysLookforSplitBraces});
$alwaysLookforSplitBrackets = $userSettings->[0]->{alwaysLookforSplitBrackets} if defined($userSettings->[0]->{alwaysLookforSplitBrackets});
$backupExtension = $userSettings->[0]->{backupExtension} if defined($userSettings->[0]->{backupExtension});
$indentPreamble = $userSettings->[0]->{indentPreamble} if defined($userSettings->[0]->{indentPreamble});
$onlyOneBackUp = $userSettings->[0]->{onlyOneBackUp} if defined($userSettings->[0]->{onlyOneBackUp});
$maxNumberOfBackUps = $userSettings->[0]->{maxNumberOfBackUps} if defined($userSettings->[0]->{maxNumberOfBackUps});
$removeTrailingWhitespace = $userSettings->[0]->{removeTrailingWhitespace} if defined($userSettings->[0]->{removeTrailingWhitespace});
# hash variables - note that each one requires two lines,
# one to read in the data, one to put the keys&values in correctly
%lookForAlignDelimsUSER= %{$userSettings->[0]->{lookForAlignDelims}} if defined($userSettings->[0]->{lookForAlignDelims});
@lookForAlignDelims{ keys %lookForAlignDelimsUSER } = values %lookForAlignDelimsUSER if (%lookForAlignDelimsUSER);
%indentRulesUSER= %{$userSettings->[0]->{indentRules}} if defined($userSettings->[0]->{indentRules});
@indentRules{ keys %indentRulesUSER } = values %indentRulesUSER if (%indentRulesUSER);
%verbatimEnvironmentsUSER= %{$userSettings->[0]->{verbatimEnvironments}} if defined($userSettings->[0]->{verbatimEnvironments});
@verbatimEnvironments{ keys %verbatimEnvironmentsUSER } = values %verbatimEnvironmentsUSER if (%verbatimEnvironmentsUSER);
%noIndentBlockUSER= %{$userSettings->[0]->{noIndentBlock}} if defined($userSettings->[0]->{noIndentBlock});
@noIndentBlock{ keys %noIndentBlockUSER } = values %noIndentBlockUSER if (%noIndentBlockUSER);
%checkunmatchedUSER= %{$userSettings->[0]->{checkunmatched}} if defined($userSettings->[0]->{checkunmatched});
@checkunmatched{ keys %checkunmatchedUSER } = values %checkunmatchedUSER if (%checkunmatchedUSER);
%checkunmatchedbracketUSER= %{$userSettings->[0]->{checkunmatchedbracket}} if defined($userSettings->[0]->{checkunmatchedbracket});
@checkunmatchedbracket{ keys %checkunmatchedbracketUSER } = values %checkunmatchedbracketUSER if (%checkunmatchedbracketUSER);
%noAdditionalIndentUSER= %{$userSettings->[0]->{noAdditionalIndent}} if defined($userSettings->[0]->{noAdditionalIndent});
@noAdditionalIndent{ keys %noAdditionalIndentUSER } = values %noAdditionalIndentUSER if (%noAdditionalIndentUSER);
%indentAfterHeadingsUSER= %{$userSettings->[0]->{indentAfterHeadings}} if defined($userSettings->[0]->{indentAfterHeadings});
@indentAfterHeadings{ keys %indentAfterHeadingsUSER } = values %indentAfterHeadingsUSER if (%indentAfterHeadingsUSER);
}
else
{
# otherwise print a warning that we can not read userSettings.yaml
print $logfile "WARNING\n\t$settings \n\t contains invalid yaml format- not reading from it\n";
}
}
else
{
# otherwise keep going, but put a warning in the log file
print $logfile "\nWARNING\n\t",File::HomeDir->my_home,"/indentconfig.yaml\n";
if (-z $settings)
{
print $logfile "\tspecifies $settings \n\tbut this file is EMPTY- not reading from it\n\n"
}
else
{
print $logfile "\tspecifies $settings \n\tbut this file does not exist- unable to read settings from this file\n\n"
}
}
}
# if we want to over write the current file
# create a backup first
if ($overwrite)
{
print $logfile "\nBackup procedure:\n";
# original name of file
my $filename = $ARGV[0];
# copy it
my $backupFile = $filename;
# add the user's backup directory to the backup path
$backupFile = "$cruftDirectory/$backupFile";
# if both ($onlyOneBackUp and $maxNumberOfBackUps) then we have
# a conflict- er on the side of caution and turn off onlyOneBackUp
if($onlyOneBackUp and $maxNumberOfBackUps>1)
{
print $logfile "\t WARNING: onlyOneBackUp=$onlyOneBackUp and maxNumberOfBackUps: $maxNumberOfBackUps\n";
print $logfile "\t\t setting onlyOneBackUp=0 which will allow you to reach $maxNumberOfBackUps back ups\n";
$onlyOneBackUp = 0;
}
# if the user has specified that $maxNumberOfBackUps = 1 then
# they only want one backup
if($maxNumberOfBackUps==1)
{
$onlyOneBackUp=1 ;
print $logfile "\t FYI: you set maxNumberOfBackUps=1, so I'm setting onlyOneBackUp: 1 \n";
}
elsif($maxNumberOfBackUps<=0 and !$onlyOneBackUp)
{
# print $logfile "\t FYI: maxNumberOfBackUps=$maxNumberOfBackUps which won't have any effect\n";
# print $logfile "\t on the script- at least ONE backup is made when the -w flag is invoked.\n";
# print $logfile "\t I'm setting onlyOneBackUp: 0, which means that you'll get a new back up file \n";
# print $logfile "\t every time you run the script.\n";
$onlyOneBackUp=0 ;
$maxNumberOfBackUps=-1;
}
# if onlyOneBackUp is set, then the backup file will
# be overwritten each time
if($onlyOneBackUp)
{
$backupFile =~ s/\.tex/$backupExtension/;
print $logfile "\t copying $filename to $backupFile\n";
print $logfile "\t $backupFile was overwritten\n\n" if (-e $backupFile);
}
else
{
# start with a backup file .bak0 (or whatever $backupExtension is present)
my $backupCounter = 0;
$backupFile =~ s/\.tex$/$backupExtension$backupCounter/;
# if it exists, then keep going: .bak0, .bak1, ...
while (-e $backupFile or $maxNumberOfBackUps>1)
{
if($backupCounter==$maxNumberOfBackUps)
{
print $logfile "\t maxNumberOfBackUps reached ($maxNumberOfBackUps)\n";
$maxNumberOfBackUps=1 ;
last; # break out of the loop
}
elsif(!(-e $backupFile))
{
$maxNumberOfBackUps=1 ;
last; # break out of the loop
}
print $logfile "\t $backupFile already exists, incrementing by 1...\n";
$backupCounter++;
$backupFile =~ s/$backupExtension.*/$backupExtension$backupCounter/;
}
print $logfile "\n\t copying $filename to $backupFile\n\n";
}
# output these lines to the log file
print $logfile "\t Backup file: ",$backupFile,"\n";
print $logfile "\t Overwriting file: ",$filename,"\n\n";
copy($filename,$backupFile) or die "Could not write to backup file $backupFile. Please check permissions. Exiting.\n";
}
if(!($outputToFile or $overwrite))
{
print $logfile "Just out put to the terminal :)\n\n" if !$silentMode ;
}
# scalar variables
my $line; # $line: takes the $line of the file
my $inpreamble=!$indentPreamble;
# $inpreamble: switch to determine if in
# preamble or not
my $inverbatim=0; # $inverbatim: switch to determine if in
# a verbatim environment or not
my $delimiters=0; # $delimiters: switch that governs if
# we need to check for & or not
my $matchedbraces=0; # $matchedbraces: counter to see if { }
# are matched; it will be
# positive if too many {
# negative if too many }
# 0 if matched
my $matchedBRACKETS=0; # $matchedBRACKETS: counter to see if [ ]
# are matched; it will be
# positive if too many {
# negative if too many }
# 0 if matched
my $commandname; # $commandname: either \parbox, \marginpar,
# or anything else from %checkunmatched
my $commanddetails; # $command details: a scalar that stores
# details about the command
# that splits {} across lines
my $countzeros; # $countzeros: a counter that helps
# when determining if we're in
# an else construct
my $lookforelse=0; # $lookforelse: a boolean to help determine
# if we need to look for an
# else construct
my $trailingcomments; # $trailingcomments stores the comments at the end of
# a line
my $lineCounter=0; # $lineCounter keeps track of the line number
my $inIndentBlock=0; # $inindentblock: switch to determine if in
# a inindentblock or not
my $headingLevel=0; # $headingLevel: scalar that stores which heading
# we are under: \part, \chapter, etc
# array variables
my @indent; # @indent: stores current level of indentation
my @lines; # @lines: stores the newly indented lines
my @block; # @block: stores blocks that have & delimiters
my @commandstore; # @commandstore: stores commands that
# have split {} across lines
my @commandstorebrackets; # @commandstorebrackets: stores commands that
# have split [] across lines
my @mainfile; # @mainfile: stores input file; used to
# grep for \documentclass
my @headingStore; # @headingStore: stores headings: chapter, section, etc
my @indentNames; # @indentNames: keeps names of commands and
# environments that have caused
# indentation to increase
my @environmentStack; # @environmentStack: stores the (nested) names
# of environments
# check to see if the current file has \documentclass, if so, then
# it's the main file, if not, then it doesn't have preamble
open(MAINFILE, $ARGV[0]) or die "Could not open input file";
@mainfile=<MAINFILE>;
close(MAINFILE);
# if the MAINFILE doesn't have a \documentclass statement, then
# it shouldn't have preamble
if(scalar(@{[grep(m/^\s*\\documentclass/, @mainfile)]})==0)
{
$inpreamble=0;
print $logfile "Trace:\tNo documentclass detected, assuming no preamble\n" if($tracingMode);
}
else
{
print $logfile "Trace:\t documentclass detected, assuming preamble\n" if($tracingMode);
}
# the previous OPEN command puts us at the END of the file
open(MAINFILE, $ARGV[0]) or die "Could not open input file";
# loop through the lines in the INPUT file
while(<MAINFILE>)
{
# increment the line counter
$lineCounter++;
# tracing mode
print $logfile "\n" if($tracingMode and !($inpreamble or $inverbatim or $inIndentBlock));
# check to see if we're still in the preamble
# or in a verbatim environment or in IndentBlock
if(!($inpreamble or $inverbatim or $inIndentBlock))
{
# if not, remove all leading spaces and tabs
# from the current line, assuming it isn't empty
#s/^\ *//;
#s/^\s+//;
#s/^\t+//;
s/^\t*// if($_ !~ /^((\s*)|(\t*))*$/);
s/^\s*// if($_ !~ /^((\s*)|(\t*))*$/);
# tracing mode
print $logfile "Line $lineCounter\t removing leading spaces\n" if($tracingMode);
}
else
{
# otherwise check to see if we've reached the main
# part of the document
if(m/^\s*\\begin{document}/)
{
$inpreamble = 0;
# tracing mode
print $logfile "Line $lineCounter\t \\begin{document} found \n" if($tracingMode);
}
else
{
# tracing mode
if($inpreamble)
{
print $logfile "Line $lineCounter\t still in PREAMBLE, doing nothing\n" if($tracingMode);
}
elsif($inverbatim)
{
print $logfile "Line $lineCounter\t in VERBATIM-LIKE environment, doing nothing\n" if($tracingMode);
}
elsif($inIndentBlock)
{
print $logfile "Line $lineCounter\t in NO INDENT BLOCK, doing nothing\n" if($tracingMode);
}
}
}
# check to see if we have \end{something} or \]
&at_end_of_env_or_eq() unless ($inpreamble or $inIndentBlock);
# check to see if we're at the end of a noindent
# block %\end{noindent}
&at_end_noindent();
# only check for unmatched braces if we're not in
# a verbatim-like environment or in the preamble or in a
# noIndentBlock
if(!($inverbatim or $inpreamble or $inIndentBlock))
{
# The check for closing } and ] relies on counting, so
# we have to remove trailing comments so that any {, }, [, ]
# that are found after % are not counted
#
# note that these lines are NOT in @lines, so we
# have to store the $trailingcomments to put
# back on after the counting
#
# note the use of (?<!\\)% so that we don't match \%
if ( $_=~ m/(?<!\\)%.*/)
{
s/((?<!\\)%.*)//;
$trailingcomments=$1;
# tracing mode
print $logfile "Line $lineCounter\t Removed trailing comments to count braces and brackets: $1\n" if($tracingMode);
}
# check to see if we're at the end of a \parbox, \marginpar
# or other split-across-lines command and check that
# we're not starting another command that has split braces (nesting)
&end_command_or_key_unmatched_braces();
# check to see if we're at the end of a command that splits
# [ ] across lines
&end_command_or_key_unmatched_brackets();
# check for a heading
&indent_heading();
# add the trailing comments back to the end of the line
if(scalar($trailingcomments))
{
# some line break magic, http://stackoverflow.com/questions/881779/neatest-way-to-remove-linebreaks-in-perl
s/\R//;
$_ = $_ . $trailingcomments."\n" ;
# tracing mode
print $logfile "Line $lineCounter\t counting braces/brackets complete: added trailing comments back on $trailingcomments\n" if($tracingMode);
# empty the trailingcomments
$trailingcomments='';
}
}
# remove trailing whitespace
if ($removeTrailingWhitespace)
{
print $logfile "Line $lineCounter\t removing trailing whitespace\n" if ($tracingMode);
s/\s+$/\n/;
}
# ADD CURRENT LEVEL OF INDENTATION
# (unless we're in a delimiter-aligned block)
if(!$delimiters)
{
# make sure we're not in a verbatim block or in the preamble
if($inverbatim or $inpreamble or $inIndentBlock)
{
# just push the current line as is
push(@lines,$_);
}
else
{
# add current value of indentation to the current line
# and output it
# unless this would only create trailing whitespace and the
# corresponding option is set
unless ($_ =~ m/^$/ and $removeTrailingWhitespace){
$_ = join("",@indent).$_;
}
push(@lines,$_);
# tracing mode
print $logfile "Line $lineCounter\t Adding current level of indentation: ",join(", ",@indentNames),"\n" if($tracingMode);
}
}
else
{
# output to @block if we're in a delimiter block
push(@block,$_);
# tracing mode
print $logfile "Line $lineCounter\t In delimeter block, waiting for block formatting\n" if($tracingMode);
}
# only check for new environments or commands if we're
# not in a verbatim-like environment or in the preamble
# or in a noIndentBlock, or delimiter block
if(!($inverbatim or $inpreamble or $inIndentBlock or $delimiters))
{
# check if we are in a
# % \begin{noindent}
# block; this is similar to a verbatim block, the user
# may not want some blocks of code to be touched
#
# IMPORTANT: this needs to go before the trailing comments
# are removed!
&at_beg_noindent();
# remove trailing comments so that any {, }, [, ]
# that are found after % are not counted
#
# note that these lines are already in @lines, so we
# can remove the trailing comments WITHOUT having
# to put them back in
#
# Note that this won't match \%
s/(?<!\\)%.*// if( $_=~ m/(?<!\\)%.*/);
# tracing mode
print $logfile "Line $lineCounter\t Removing trailing comments for brace count (line is already stored)\n" if($tracingMode);
# check to see if we have \begin{something} or \[
&at_beg_of_env_or_eq();
# check to see if we have \parbox, \marginpar, or
# something similar that might split braces {} across lines,
# specified in %checkunmatched hash table
&start_command_or_key_unmatched_braces();
# check for an else statement
&check_for_else();
# check for a command that splits [] across lines
&start_command_or_key_unmatched_brackets();
# check for a heading
&indent_after_heading();
# tracing mode
print $logfile "Line $lineCounter\t Environments: ",join(", ",@environmentStack),"\n" if($tracingMode and scalar(@environmentStack));
}
}
# close the main file
close(MAINFILE);
# put line count information in the log file
print $logfile "Line Count of $ARGV[0]: ",scalar(@mainfile),"\n";
print $logfile "Line Count of indented $ARGV[0]: ",scalar(@lines);
if(scalar(@mainfile) != scalar(@lines))
{
print $logfile <<ENDQUOTE
WARNING: \t line count of original file and indented file does
\t not match- consider reverting to a back up, see $backupExtension;
ENDQUOTE
;
}
else
{
print $logfile "\n\nLine counts of original file and indented file match";
}
# output the formatted lines to the terminal
print @lines if(!$silentMode);
# if -w is active then output to $ARGV[0]
if($overwrite)
{
open(OUTPUTFILE,">",$ARGV[0]);
print OUTPUTFILE @lines;
close(OUTPUTFILE);
}
# if -o is active then output to $ARGV[1]
if($outputToFile)
{
open(OUTPUTFILE,">",$ARGV[1]);
print OUTPUTFILE @lines;
close(OUTPUTFILE);
}
# close the log file
close($logfile);
exit;
sub indent_heading{
# PURPOSE: This matches
# \part
# \chapter
# \section
# \subsection
# \subsubsection
# \paragraph
# \subparagraph
#
# and anything else listed in indentAfterHeadings
#
# This subroutine specifies the indentation for the
# heading itself, i.e the line that has \chapter, \section etc
if( $_ =~ m/^\s*\\(.*?)(\[|{)/ and $indentAfterHeadings{$1})
{
# tracing mode
print $logfile "Line $lineCounter\t Heading found: $1 \n" if($tracingMode);
# get the heading settings- it's a hash within a hash
my %currentHeading = %{$indentAfterHeadings{$1}};
# local scalar
my $previousHeadingLevel = $headingLevel;
# if current heading level < old heading level,
if($currentHeading{level}<$previousHeadingLevel)
{
# decrease indentation, but only if
# specified in indentHeadings. Note that this check
# needs to be done here- decrease_indent won't
# check a nested hash
if(scalar(@headingStore))
{
while($currentHeading{level}<$previousHeadingLevel and scalar(@headingStore))
{
my $higherHeadingName = pop(@headingStore);
my %higherLevelHeading = %{$indentAfterHeadings{$higherHeadingName}};
# tracing mode
print $logfile "Line $lineCounter\t stepping UP heading level from $higherHeadingName \n" if($tracingMode);
&decrease_indent($higherHeadingName) if($higherLevelHeading{indent});
$previousHeadingLevel=$higherLevelHeading{level};
}
# put the heading name back in to storage
push(@headingStore,$1);
}
}
elsif($currentHeading{level}==$previousHeadingLevel)
{
if(scalar(@headingStore))
{
my $higherHeadingName = pop(@headingStore);
my %higherLevelHeading = %{$indentAfterHeadings{$higherHeadingName}};
&decrease_indent($higherHeadingName) if($higherLevelHeading{indent});
}
# put the heading name back in to storage
push(@headingStore,$1);
}
else
{
# put the heading name into storage
push(@headingStore,$1);
}
}
}
sub indent_after_heading{
# PURPOSE: This matches
# \part
# \chapter
# \section
# \subsection
# \subsubsection
# \paragraph
# \subparagraph
#
# and anything else listed in indentAfterHeadings
#
# This subroutine is specifies the indentation for
# the text AFTER the heading, i.e the body of conent
# in each \chapter, \section, etc
if( $_ =~ m/^\s*\\(.*?)(\[|{)/ and $indentAfterHeadings{$1})
{
# get the heading settings- it's a hash within a hash
my %currentHeading = %{$indentAfterHeadings{$1}};
&increase_indent($1) if($currentHeading{indent});
# update heading level
$headingLevel = $currentHeading{level};
}
}
sub at_end_noindent{
# PURPOSE: This matches
# % \end{noindent}
# with any number of spaces (possibly none) between
# the comment and \end{noindent}.
#
# the comment symbol IS indended!
#
# This is for blocks of code that the user wants
# to leave untouched- similar to verbatim blocks
if( $_ =~ m/^%\s*\\end{(.*?)}/ and $noIndentBlock{$1})
{
$inIndentBlock=0;
# tracing mode
print $logfile "Line $lineCounter\t % \\end{no indent block} found, switching inIndentBlock OFF \n" if($tracingMode);
}
}
sub at_beg_noindent{
# PURPOSE: This matches
# % \begin{noindent}
# with any number of spaces (possibly none) between
# the comment and \begin{noindent}.
#
# the comment symbol IS indended!
#
# This is for blocks of code that the user wants
# to leave untouched- similar to verbatim blocks
if( $_ =~ m/^%\s*\\begin{(.*?)}/ and $noIndentBlock{$1})
{
$inIndentBlock = 1;
# tracing mode
print $logfile "Line $lineCounter\t % \\begin{no indent block} found, switching inIndentBlock ON \n" if($tracingMode);
}
}
sub start_command_or_key_unmatched_brackets{
# PURPOSE: This matches
# \pgfplotstablecreatecol[...
#
# or any other command/key that has brackets [ ]
# split across lines specified in the
# hash tables, %checkunmatchedbracket
#
# How to read: ^\s*(\\)?(.*?)(\[\s*)
#
# ^ line begins with
# \s* any (or no)spaces
# (\\)? matches a \ backslash but not necessarily
# (.*?) non-greedy character match and store the result
# ((?<!\\)\[\s*) match [ possibly leading with spaces
# but it WON'T match \[
if ($_ =~ m/^\s*(\\)?(.*?)(\s*(?<!\\)\[)/
and (scalar($checkunmatchedbracket{$2})
or $alwaysLookforSplitBrackets)
)
{
# store the command name, because $2
# will not exist after the next match
$commandname = $2;
$matchedBRACKETS=0;
# match [ but don't match \[
$matchedBRACKETS++ while ($_ =~ /(?<!\\)\[/g);
# match ] but don't match \]
$matchedBRACKETS-- while ($_ =~ /(?<!\\)\]/g);
# set the indentation
if($matchedBRACKETS != 0 )
{
# tracing mode
print $logfile "Line $lineCounter\t Found opening BRACKET [ $commandname\n" if($tracingMode);
&increase_indent($commandname);
# store the command name
# and the value of $matchedBRACKETS
push(@commandstorebrackets,{commandname=>$commandname,
matchedBRACKETS=>$matchedBRACKETS});
}
}
}
sub end_command_or_key_unmatched_brackets{
# PURPOSE: Check for the closing BRACKET of a command that
# splits its BRACKETS across lines, such as
#
# \pgfplotstablecreatecol[ ...
#
# It works by checking if we have any entries
# in the array @commandstorebrackets, and making
# sure that we're not starting another command/key
# that has split BRACKETS (nesting).
#
# It also checks that the line is not commented.
#
# We count the number of [ and ADD to the counter
# ] and SUBTRACT to the counter
if(scalar(@commandstorebrackets)
and !($_ =~ m/^\s*(\\)?(.*?)(\s*\[)/
and (scalar($checkunmatchedbracket{$2})
or $alwaysLookforSplitBrackets))
and $_ !~ m/^\s*%/
)
{
# get the details of the most recent command name
$commanddetails = pop(@commandstorebrackets);
$commandname = $commanddetails->{'commandname'};
$matchedBRACKETS = $commanddetails->{'matchedBRACKETS'};
# match [ but don't match \[
$matchedBRACKETS++ while ($_ =~ m/(?<!\\)\[/g);
# match ] but don't match \]
$matchedBRACKETS-- while ($_ =~ m/(?<!\\)\]/g);
# if we've matched up the BRACKETS then
# we can decrease the indent by 1 level
if($matchedBRACKETS == 0)
{
# tracing mode
print $logfile "Line $lineCounter\t Found closing BRACKET ] $commandname\n" if($tracingMode);
# decrease the indentation (if appropriate)
&decrease_indent($commandname);