summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/thmtools/source/thm-listof.dtx
blob: 39603b4341d59c3cbd06f2fc77927bc72b846d53 (plain)
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
% \iffalse meta-comment
%
% Copyright (C) 2008-2014 by Ulrich M. Schwarz
% Copyright (C) 2019      by Frank Mittelbach
% Copyright (C) 2020-     by Yukai Chou
%
% This file may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, version 1.3c.
% The license can be obtained from
% http://www.latex-project.org/lppl/lppl-1-3c.txt
%
% \fi
%
%\iffalse (hide this from DocInput)
%<*listof>
%\fi
%
% This package provides two main commands:
% \DescribeMacro{\listoftheorems}
% |\listoftheorems| will generate, well, a list of all theorems, lemmas,
% etc. in your document. This list is hyperlinked if you use \pkg{hyperref},
% and it will list the optional argument to the theorem.
%
% Currently, some options can be given as an optional argument keyval list:
% \begin{description}
%  \item[numwidth] The width allocated for the numbers, default 2.3em. Since
%  you are more likely to have by-section numbering than with figures, this
%  needs to be accessible.
%  \item[ignore=foo,bar] A last-second call to |\ignoretheorems|, see below.
%  \item[onlynamed=foo,bar] Only list those foo and bar environments that
%    had an optional title. This weeds out unimportant definitions, for
%    example. If no argument is given, this applies to all environments
%    defined by |\newtheorem| and |\declaretheorem|.
%  \item[show=foo,bar] Undo a previous |\ignoretheorems| and restore default
%    formatting for these environments. Useful in combination with
%    ignoreall.
%  \item[ignoreall]
%  \item[showall] Like applying ignore or show with a list of all theorems
%    you have defined.
%  \item[title]
%    Provide a title for this list overwriting the default in |\listtheoremname|.
% \end{description}
%
% \DescribeMacro{\listtheoremname}
% The heading name is stored in the macro |\listtheoremname| and is
% ``List of Theorems'' by default. All other formatting aspects are taken
% from |\listoffigures|. (As a matter of fact, |\listoffigures| is called
% internally.)
%
% \DescribeMacro{\ignoretheorems}
% |\ignoretheorems|\marg{remark,example,...} can be used to suppress some
% types of theorem from the LoTh. Be careful not to have spaces in the list,
% those are currently \emph{not} filtered out.
%
% There's currently no interface to change the look of the list. If you're
% daring, the code for the theorem type ``lemma'' is in |\l@lemma| and so on.
%
%\StopEventually{}
%    \begin{macrocode}
\let\@xa=\expandafter
\let\@nx=\noexpand
\RequirePackage{thm-patch,keyval,kvsetkeys}

\def\thmtlo@oldchapter{0}%
\newcommand\thmtlo@chaptervspacehack{}
\ifcsname c@chapter\endcsname
  \ifx\c@chapter\relax\else
    \def\thmtlo@chaptervspacehack{%
      \ifnum \value{chapter}=\thmtlo@oldchapter\relax\else
        % new chapter, add vspace to loe.
        \addtocontents{loe}{\protect\addvspace{10\p@}}%
        \xdef\thmtlo@oldchapter{\arabic{chapter}}%
      \fi
    }%
  \fi
\fi
  

\providecommand\listtheoremname{List of Theorems}
\newcommand\listoftheorems[1][]{%
  %% much hacking here to pick up the definition from the class
  %% without oodles of conditionals.
  \bgroup
  \setlisttheoremstyle{#1}%
  \let\listfigurename\listtheoremname
  \def\contentsline##1{%
    \csname thmt@contentsline@##1\endcsname{##1}%
  }%
  \@for\thmt@envname:=\thmt@allenvs\do{%
  \@xa\protected@edef\csname l@\thmt@envname\endcsname{% CHECK: why p@edef?
    \@nx\@dottedtocline{1}{1.5em}{\@nx\thmt@listnumwidth}%
  }%
  }%
  \let\thref@starttoc\@starttoc
  \def\@starttoc##1{\thref@starttoc{loe}}%
  % new hack: to allow multiple calls, we defer the opening of the
  % loe file to AtEndDocument time. This is before the aux file is
  % read back again, that is early enough.
  % TODO: is it? crosscheck include/includeonly!
  \@fileswfalse
  \AtEndDocument{%
    \if@filesw
      \@ifundefined{tf@loe}{%
        \expandafter\newwrite\csname tf@loe\endcsname
        \immediate\openout \csname tf@loe\endcsname \jobname.loe\relax
      }{}%
    \fi
  }%
  %\expandafter
  \listoffigures
  \egroup
}

\newcommand\setlisttheoremstyle[1]{%
  \kvsetkeys{thmt-listof}{#1}%
}
\define@key{thmt-listof}{numwidth}{\def\thmt@listnumwidth{#1}}
\define@key{thmt-listof}{ignore}[\thmt@allenvs]{\ignoretheorems{#1}}
\define@key{thmt-listof}{onlynamed}[\thmt@allenvs]{\onlynamedtheorems{#1}}
\define@key{thmt-listof}{show}[\thmt@allenvs]{\showtheorems{#1}}
\define@key{thmt-listof}{ignoreall}[true]{\ignoretheorems{\thmt@allenvs}}
\define@key{thmt-listof}{showall}[true]{\showtheorems{\thmt@allenvs}}
% FMi 2019-09-31 allow local title
\define@key{thmt-listof}{title}{\def\listtheoremname{#1}}
% -- FMi

\providecommand\thmt@listnumwidth{2.3em}

\providecommand\thmtformatoptarg[1]{ (#1)}

\newcommand\thmt@mklistcmd{%
  \@xa\protected@edef\csname l@\thmt@envname\endcsname{% CHECK: why p@edef?
    \@nx\@dottedtocline{1}{1.5em}{\@nx\thmt@listnumwidth}%
  }%
  \ifthmt@isstarred
    \@xa\def\csname ll@\thmt@envname\endcsname{%
      \protect\numberline{\protect\let\protect\autodot\protect\@empty}%
      \thmt@thmname
      \ifx\@empty\thmt@shortoptarg\else\protect\thmtformatoptarg{\thmt@shortoptarg}\fi
    }%
  \else
    \@xa\def\csname ll@\thmt@envname\endcsname{%
      \protect\numberline{\csname the\thmt@envname\endcsname}%
      \thmt@thmname
      \ifx\@empty\thmt@shortoptarg\else\protect\thmtformatoptarg{\thmt@shortoptarg}\fi
    }%
  \fi
  \@xa\gdef\csname thmt@contentsline@\thmt@envname\endcsname{%
    \thmt@contentslineShow% default:show
  }%
}
\def\thmt@allenvs{\@gobble}
\newcommand\thmt@recordenvname{%
  \edef\thmt@allenvs{\thmt@allenvs,\thmt@envname}%
}
\g@addto@macro\thmt@newtheorem@predefinition{%
  \thmt@mklistcmd
  \thmt@recordenvname
}

\addtotheorempostheadhook{%
  \thmtlo@chaptervspacehack
  \addcontentsline{loe}{\thmt@envname}{%
    \csname ll@\thmt@envname\endcsname
  }%
}

\newcommand\showtheorems[1]{%
  \@for\thmt@thm:=#1\do{%
    \typeout{showing \thmt@thm}%
    \@xa\let\csname thmt@contentsline@\thmt@thm\endcsname
      =\thmt@contentslineShow
  }%
}

\newcommand\ignoretheorems[1]{%
  \@for\thmt@thm:=#1\do{%
    \@xa\let\csname thmt@contentsline@\thmt@thm\endcsname
      =\thmt@contentslineIgnore
  }%
}
\newcommand\onlynamedtheorems[1]{%
  \@for\thmt@thm:=#1\do{%
    \global\@xa\let\csname thmt@contentsline@\thmt@thm\endcsname
      =\thmt@contentslineIfNamed
  }%
}

\AtBeginDocument{%
\@ifpackageloaded{hyperref}{%
  \let\thmt@hygobble\@gobble
}{%
  \let\thmt@hygobble\@empty
}
\let\thmt@contentsline\contentsline
}

\def\thmt@contentslineIgnore#1#2#3{%
  \thmt@hygobble
}
\def\thmt@contentslineShow{%
  \thmt@contentsline
}

\def\thmt@contentslineIfNamed#1#2#3{%
  \thmt@ifhasoptname #2\thmtformatoptarg\@nil{%
    \thmt@contentslineShow{#1}{#2}{#3}%
  }{%
    \thmt@contentslineIgnore{#1}{#2}{#3}%
    %\thmt@contentsline{#1}{#2}{#3}%
  }
}
  
\def\thmt@ifhasoptname #1\thmtformatoptarg#2\@nil{%
  \ifx\@nil#2\@nil
    \@xa\@secondoftwo
  \else
    \@xa\@firstoftwo
  \fi
}
%    \end{macrocode}
%\iffalse
%</listof>
%\fi