Skip to content

Commit

Permalink
avoid check for file when adding known commands to safecmd, textcmd e…
Browse files Browse the repository at this point in the history 
…tc list. Might fix issue #70
  • Loading branch information
@ftilmann
ftilmann committed Dec 29, 2016
1 parent 2698013 commit 035b8e7
Show file tree
Hide file tree
Showing 5 changed files with 100 additions and 71 deletions.
154 changes: 85 additions & 69 deletions latexdiff
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
#
# Version 1.2.1a
# - bug fix: deleted figures when endfloat package was activated
# - bug fix: alignat environment now always processed correctly (fix issues #65)
#
# Version 1.2.0:
# - highlight new and deleted figures
Expand Down Expand Up @@ -845,7 +846,7 @@ if ($graphicsmarkup != NONE ) {

# only change required for highlighting both is to declare \includegraphics safe, as preamble already contains commands for deleted environment
if ( $graphicsmarkup == BOTH ) {
init_regex_arr_ext(\@SAFECMDLIST,'includegraphics');
init_regex_arr_list(\@SAFECMDLIST,'includegraphics');
}
}

Expand Down Expand Up @@ -921,11 +922,11 @@ if (defined $packages{"siunitx"} ) {
# this is done to get around an incompatibility between the ulem and siunitx package
print STDERR "siunitx package detected.\n" if $verbose ;
my $mboxcmds='SI,ang,numlist,numrange,SIlist,SIrange';
init_regex_arr_ext(\@SAFECMDLIST,'num,si');
init_regex_arr_list(\@SAFECMDLIST,'num,si');
if ( $enablecitmark || ( $ulem && ! $disablecitmark )) {
init_regex_arr_ext(\@MBOXCMDLIST,$mboxcmds);
init_regex_arr_list(\@MBOXCMDLIST,$mboxcmds);
} else {
init_regex_arr_ext(\@SAFECMDLIST,$mboxcmds);
init_regex_arr_list(\@SAFECMDLIST,$mboxcmds);
}
}

Expand All @@ -935,9 +936,9 @@ if (defined $packages{"cleveref"} ) {
print STDERR "cleveref package detected.\n" if $verbose ;
my $mboxcmds='[Cc]ref(?:range)?\*?,labelcref,(?:lc)?name[cC]refs?' ;
if ( $enablecitmark || ( $ulem && ! $disablecitmark )) {
init_regex_arr_ext(\@MBOXCMDLIST,$mboxcmds);
init_regex_arr_list(\@MBOXCMDLIST,$mboxcmds);
} else {
init_regex_arr_ext(\@SAFECMDLIST,$mboxcmds);
init_regex_arr_list(\@SAFECMDLIST,$mboxcmds);
}
}

Expand All @@ -946,17 +947,17 @@ if (defined $packages{"glossaries"} ) {
# this is done to get around an incompatibility between ulem and glossaries package
print STDERR "glossaries package detected.\n" if $verbose ;
my $mboxcmds='[gG][lL][sS](?:|pl|disp|link|first|firstplural|desc|user[iv][iv]?[iv]?),[aA][cC][rR](?:long|longpl|full|fullpl),[aA][cC][lfp]?[lfp]?';
init_regex_arr_ext(\@SAFECMDLIST,'[gG][lL][sS](?:(?:entry)?(?:text|plural|name|symbol)|displaynumberlist|entryfirst|entryfirstplural|entrydesc|entrydescplural|entrysymbolplural|entryuser[iv][iv]?[iv]?|entrynumberlist|entrydisplaynumberlist|entrylong|entrylongpl|entryshort|entryshortpl|entryfull|entryfullpl),[gG]lossentry(?:name|desc|symbol),[aA][cC][rR](?:short|shortpl),[aA]csp?');
init_regex_arr_list(\@SAFECMDLIST,'[gG][lL][sS](?:(?:entry)?(?:text|plural|name|symbol)|displaynumberlist|entryfirst|entryfirstplural|entrydesc|entrydescplural|entrysymbolplural|entryuser[iv][iv]?[iv]?|entrynumberlist|entrydisplaynumberlist|entrylong|entrylongpl|entryshort|entryshortpl|entryfull|entryfullpl),[gG]lossentry(?:name|desc|symbol),[aA][cC][rR](?:short|shortpl),[aA]csp?');
if ( $enablecitmark || ( $ulem && ! $disablecitmark )) {
init_regex_arr_ext(\@MBOXCMDLIST,$mboxcmds);
init_regex_arr_list(\@MBOXCMDLIST,$mboxcmds);
} else {
init_regex_arr_ext(\@SAFECMDLIST,$mboxcmds);
init_regex_arr_list(\@SAFECMDLIST,$mboxcmds);
}
}

if (defined $packages{"chemformula"} or defined $packages{"chemmacros"} ) {
print STDERR "chemformula package detected.\n" if $verbose ;
init_regex_arr_ext(\@SAFECMDLIST,'ch');
init_regex_arr_list(\@SAFECMDLIST,'ch');
push(@UNSAFEMATHCMD,'ch');
# The next command would be needed to allow highlighting the interior of \ch commands in math environments
# but the redefinitions in chemformula are too deep to make this viable
Expand All @@ -965,7 +966,7 @@ if (defined $packages{"chemformula"} or defined $packages{"chemmacros"} ) {

if (defined $packages{"mhchem"} ) {
print STDERR "mhchem package detected.\n" if $verbose ;
init_regex_arr_ext(\@SAFECMDLIST,'ce');
init_regex_arr_list(\@SAFECMDLIST,'ce');
push(@UNSAFEMATHCMD,'ce','cee');
# The next command would be needed to allow highlighting the interior of \cee commands in math environments
# but the redefinitions in chemformula are too deep to make this viable
Expand Down Expand Up @@ -1020,7 +1021,7 @@ if (defined $packages{"amsmath"} or defined $packages{"amsart"} or defined $pac

# add commands in MBOXCMDLIST to SAFECMDLIST
foreach $mboxcmd ( @MBOXCMDLIST ) {
init_regex_arr_ext(\@SAFECMDLIST, $mboxcmd);
init_regex_arr_list(\@SAFECMDLIST, $mboxcmd);
}

# check if \label is in SAFECMDLIST, and if yes replace "label" in $LABELCMD by something that never matches (we hope!)
Expand Down Expand Up @@ -1180,53 +1181,45 @@ sub list_packages {
# scans the argument for \newcommand and \DeclareMathOperator,
# and adds the created commands which are clearly safe to @SAFECMDLIST
sub add_safe_commands {
### my (@preamble)=@_;
my ($preamble)=@_;
my $added_command = 1;

# get rid of comments
$preamble=~s/(?<!\\)%.*$//mg ;

while ($added_command) {
$added_command = 0;
### foreach $line ( @preamble ) {
# get rid of comments
my $to_test = "";
# test for \DeclareMathOperator{\foo}{myoperator}
while ( $preamble =~ m/\DeclareMathOperator\s*\*?\{\\(\w*?)\}/osg) {
$to_test=$1;
if ($to_test ne "" and not iscmd($to_test,\@SAFECMDLIST,\@SAFECMDEXCL) and not iscmd($to_test, \@SAFECMDEXCL, [])) {
# one should add $to_test to the list of safe commands.
init_regex_arr_ext(\@SAFECMDLIST, $to_test);
$added_command = 1;
print STDERR "Adding $to_test to the list of safe commands\n" if $verbose;
}
my $to_test = "";
# test for \DeclareMathOperator{\foo}{myoperator}
while ( $preamble =~ m/\DeclareMathOperator\s*\*?\{\\(\w*?)\}/osg) {
$to_test=$1;
if ($to_test ne "" and not iscmd($to_test,\@SAFECMDLIST,\@SAFECMDEXCL) and not iscmd($to_test, \@SAFECMDEXCL, [])) {
# one should add $to_test to the list of safe commands.
init_regex_arr_list(\@SAFECMDLIST, $to_test);
print STDERR "Adding $to_test to the list of safe commands\n" if $verbose;
}
}

while ( $preamble =~ m/\\(?:new|renew|provide)command\s*{\\(\w*)\}(?:|\[\d*\])\s*\{(${pat_n})\}/osg ) {
my $maybe_to_test = $1;
my $should_be_safe = $2;
### print STDERR "DEBUG maybe_to_test, should_be_safe: $1 $2\n";
my $success = 0;
### if (($should_be_safe =~ tr/\{/\{/) < ($should_be_safe =~ tr/\}/\}/)) {
### # There are more closing braces than opening braces, therefore
### # the newcommand is completely on the current line.
# test if all latex commands inside it are safe
$success = 1;
if ($should_be_safe =~ m/\\\\/) {
$success = 0;
} else {
while ($should_be_safe =~ m/\\(\w+)/g) {
$success = 0 unless iscmd($1,\@SAFECMDLIST,\@SAFECMDEXCL); ### or $1 eq "";
}
while ( $preamble =~ m/\\(?:new|renew|provide)command\s*{\\(\w*)\}(?:|\[\d*\])\s*\{(${pat_n})\}/osg ) {
my $maybe_to_test = $1;
my $should_be_safe = $2;
print STDERR "DEBUG Checking new command: maybe_to_test, should_be_safe: $1 $2\n" if $debug;
my $success = 0;
# test if all latex commands inside it are safe
$success = 1;
if ($should_be_safe =~ m/\\\\/) {
$success = 0;
} else {
while ($should_be_safe =~ m/\\(\w+)/g) {
### print STDERR "DEBUG: Testing command $1 " if $debug;
$success = 0 unless iscmd($1,\@SAFECMDLIST,\@SAFECMDEXCL); ### or $1 eq "";
### print STDERR " success=$success\n" if $debug;
}
### }
$to_test = $maybe_to_test if $success;
if ($to_test ne "" and not iscmd($to_test,\@SAFECMDLIST,\@SAFECMDEXCL) and not iscmd($to_test, \@SAFECMDEXCL, [])) {
# # one should add $to_test to the list of safe commands.
init_regex_arr_ext(\@SAFECMDLIST, $to_test);
$added_command = 1;
print STDERR "Adding $to_test to the list of safe commands\n" if $verbose;
}
### }
if ($success) {
$to_test = $maybe_to_test;
if ( not iscmd($to_test,\@SAFECMDLIST,\@SAFECMDEXCL) and not iscmd($to_test, \@SAFECMDEXCL, [])) {
# # one should add $to_test to the list of safe commands.
init_regex_arr_list(\@SAFECMDLIST, $to_test);
print STDERR "Adding $to_test to the list of safe commands\n" if $verbose;
}
}
}
Expand Down Expand Up @@ -2127,9 +2120,11 @@ sub preprocess {
### s/^(\s*)//s;
### push(@leadin,$1);
# Change \{ to \QLEFTBRACE, \} to \QRIGHTBRACE, and \& to \AMPERSAND
### print STDERR "Preprocess 0\n" if $debug;
s/(?<!\\)\\\{/\\QLEFTBRACE /sg;
s/(?<!\\)\\\}/\\QRIGHTBRACE /sg;
s/(?<!\\)\\&/\\AMPERSAND /sg;
### print STDERR "Preprocess 2\n" if $debug;
### pre 1.0.4
### # change begin and end commands within comments such that they
### # don't disturb the pattern matching (if there are several \begin or \end in one line
Expand All @@ -2138,8 +2133,9 @@ sub preprocess {
### s/(%.*)\\end\{(.*)$/$1\\ENDDIF\{$2/mg ;
# replace {,} in comments with \\CLEFTBRACE,\\CRIGHTBRACE
1 while s/((?<!\\)%.*)\{(.*)$/$1\\CLEFTBRACE $2/mg ;
### print STDERR "Preprocess 3\n" if $debug;
1 while s/((?<!\\)%.*)\}(.*)$/$1\\CRIGHTBRACE $2/mg ;

### print STDERR "Preprocess 10\n" if $debug;
### s/\n(\s*)\n((?:\s*\n)*)/\\PAR\n$2/g ;
s/\n(\s*?)\n((?:\s*\n)*)/\n$1\\PAR\n$2/g ;
s/(?<!\\)\\%/\\PERCENTAGE /g ; # (?<! is negative lookbehind assertion to prevent \\% from being converted
Expand All @@ -2165,6 +2161,8 @@ sub preprocess {
# For --block-math-markup option -convert all \begin{MATH} .. \end{MATH}
# into \MATHBLOCKMATH{...} commands, where MATH is any valid math environment
# Also convert all array environments into ARRAYBLOCK environments
### print STDERR "Preprocess 20\n" if $debug;

if ( $mathmarkup != FINE ) {
s/\\begin\{($ARRENV)}(.*?)\\end\{\1}/\\ARRAYBLOCK$1\{$2\}/sg;
print STDERR "vvvvvvvvvvvvvvvvvv\n$_\nvvvvvvvvvvvvvvvv\n" if $debug;
Expand All @@ -2175,6 +2173,8 @@ sub preprocess {

s/\\begin\{($MATHENV|$MATHARRENV|SQUAREBRACKET)\}(.*?)\\end\{\1\}/\\MATHBLOCK$1\{$2\}/sg;
}
### print STDERR "Preprocess 30\n" if $debug;

# add final token " STOP"
$_ .= " STOP"
}
Expand Down Expand Up @@ -2887,26 +2887,42 @@ sub init_regex_arr_data {
# Otherwise treat arg as a comma separated list of regular expressions
sub init_regex_arr_ext {
my ($arr,$arg)=@_;
my $regex;
if ( -f $ arg ) {
open(FILE,"$arg") or die ("Couldn't open $arg: $!");
while (<FILE>) {
chomp;
next if /^\s*#/ || /^\s*%/ || /^\s*$/ ;
push (@$arr,qr/^$_$/);
}
close(FILE);
if ( -f $arg ) {
init_regex_arr_file($arr,$arg);
} else {
init_regex_arr_list($arr,$arg);
}
else {
# assume it is a comma-separated list of reg-ex
### print STDERR "DEBUG init_regex_arr_ext arg >$arg<\n";
foreach $regex (split(qr/(?<!\\),/,$arg)) {
$regex =~ s/\\,/,/g;
push (@$arr,qr/^$regex$/);
}
}
# init_regex_arr_file(\@array,$fname)
# appends array with regular expressions.
# Read in list of regular expressions from $fname
# (one expression per line)
sub init_regex_arr_file {
my ($arr,$fname)=@_;
open(FILE,"$fname") or die ("Couldn't open $fname: $!");
while (<FILE>) {
chomp;
next if /^\s*#/ || /^\s*%/ || /^\s*$/ ;
push (@$arr,qr/^$_$/);
}
close(FILE);
}
# init_regex_arr_list(\@array,$arg)
# appends array with regular expressions.
# read from comma separated list of regular expressions ($arg)
sub init_regex_arr_list {
my ($arr,$arg)=@_;
my $regex;
### print STDERR "DEBUG init_regex_arr_list arg >$arg<\n" if $debug;
foreach $regex (split(qr/(?<!\\),/,$arg)) {
$regex =~ s/\\,/,/g;
push (@$arr,qr/^$regex$/);
}
}
#exetime() returns time since last execution of this command
#exetime(1) resets this time
my $lasttime=-1; # global variable for persistence
Expand Down
2 changes: 1 addition & 1 deletion testsuite/endfloat2-old.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ \section{My section}
\end{align}
%
%
\begin{figure}[t]
\begin{figure}[t] %blabla
\centering
\caption{Necessity depends on, when thus treated as the practical employment of
the never-ending regress in the series of empirical conditions, time.}
Expand Down
8 changes: 8 additions & 0 deletions testsuite/safecmd-new.tex
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
\documentclass{article}
\newcommand{\degree}{$^\circ$}
\newcommand{\remark}[1]{\textsf{\small F1: \emph{#1}}}
\begin{document}
Some shared text.
Some new text \remark{with a remark}. They found this at 10\degree N, 5\degree E.
\end{document}

5 changes: 5 additions & 0 deletions testsuite/safecmd-old.tex
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
\documentclass{article}
\begin{document}
Some shared text.
\end{document}

2 changes: 1 addition & 1 deletion testsuite/verify
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ set testroots=( test rapine_et_al island_obs2004 texdiffsample gershwin12 "gersh
delequ latin9 pollack move-equation nomarkup subscript doubledollar \
DIFDELCMDBUG eqnarray subscriptm delequ2 schneider gennady umesh underwood endfloat endfloat2 outerrise \
delequ3 delequ4 "simplefrac --allow-spaces" "master --flatten" titlediffTest2 exampleDiff bornd2 \
"rolla --math-markup=2" mini "complex-maths --math-markup=1" margalit circonflex mwe-comment "apacite-test --flatten" quoteddollarunderscore units complicated-math move-equation2 lists "figures --graphics-markup=both" alignat \
"rolla --math-markup=2" mini "complex-maths --math-markup=1" margalit circonflex mwe-comment "apacite-test --flatten" quoteddollarunderscore units complicated-math move-equation2 lists "figures --graphics-markup=both" alignat "safecmd --append-safecmd=remark" \
)

#set testroots= ( test subscript )
Expand Down

0 comments on commit 035b8e7

Please sign in to comment.